OSDN Git Service

PR c/12802
[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 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 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}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
147
148 @c man begin OPTIONS
149
150 @node Option Summary
151 @section Option Summary
152
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
155
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
206
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
240
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement}
246
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-ipa-all -fdump-ipa-cgraph @gol
253 -fdump-tree-all @gol
254 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
255 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
258 -fdump-tree-ch @gol
259 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-nrv -fdump-tree-vect @gol
268 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
270 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
271 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
272 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
273 -ftest-coverage  -ftime-report -fvar-tracking @gol
274 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
275 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
276 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
277 -print-multi-directory  -print-multi-lib @gol
278 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
279 -save-temps  -time}
280
281 @item Optimization Options
282 @xref{Optimize Options,,Options that Control Optimization}.
283 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
284 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
285 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
286 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
287 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
288 -fcaller-saves  -fcprop-registers @gol
289 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
290 -fdelayed-branch  -fdelete-null-pointer-checks @gol
291 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
292 -fforce-addr  -fforce-mem  -ffunction-sections @gol
293 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
294 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
295 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
296 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
297 -fmodulo-sched -fnew-ra  -fno-branch-count-reg @gol
298 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
299 -fno-function-cse  -fno-guess-branch-probability @gol
300 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
301 -funsafe-math-optimizations  -ffinite-math-only @gol
302 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
303 -fomit-frame-pointer  -foptimize-register-move @gol
304 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
305 -fprofile-generate -fprofile-use @gol
306 -fregmove  -frename-registers @gol
307 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
308 -frerun-cse-after-loop  -frerun-loop-opt @gol
309 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
310 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
311 -fsched-spec-load-dangerous  @gol
312 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
313 -fsched2-use-superblocks @gol
314 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
315 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
316 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
317 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
318 -fsplit-ivs-in-unroller -funswitch-loops @gol
319 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
320 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
321 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
322 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
323 --param @var{name}=@var{value}
324 -O  -O0  -O1  -O2  -O3  -Os}
325
326 @item Preprocessor Options
327 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
328 @gccoptlist{-A@var{question}=@var{answer} @gol
329 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
330 -C  -dD  -dI  -dM  -dN @gol
331 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
332 -idirafter @var{dir} @gol
333 -include @var{file}  -imacros @var{file} @gol
334 -iprefix @var{file}  -iwithprefix @var{dir} @gol
335 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
336 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
337 -P  -fworking-directory  -remap @gol
338 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
339 -Xpreprocessor @var{option}}
340
341 @item Assembler Option
342 @xref{Assembler Options,,Passing Options to the Assembler}.
343 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
344
345 @item Linker Options
346 @xref{Link Options,,Options for Linking}.
347 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
348 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
349 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
350 -Wl,@var{option}  -Xlinker @var{option} @gol
351 -u @var{symbol}}
352
353 @item Directory Options
354 @xref{Directory Options,,Options for Directory Search}.
355 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
356
357 @item Target Options
358 @c I wrote this xref this way to avoid overfull hbox. -- rms
359 @xref{Target Options}.
360 @gccoptlist{-V @var{version}  -b @var{machine}}
361
362 @item Machine Dependent Options
363 @xref{Submodel Options,,Hardware Models and Configurations}.
364 @c This list is ordered alphanumerically by subsection name.
365 @c Try and put the significant identifier (CPU or system) first,
366 @c so users have a clue at guessing where the ones they want will be.
367
368 @emph{ARC Options}
369 @gccoptlist{-EB  -EL @gol
370 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
371 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
372
373 @emph{ARM Options}
374 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
375 -mabi=@var{name} @gol
376 -mapcs-stack-check  -mno-apcs-stack-check @gol
377 -mapcs-float  -mno-apcs-float @gol
378 -mapcs-reentrant  -mno-apcs-reentrant @gol
379 -msched-prolog  -mno-sched-prolog @gol
380 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
381 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
382 -mthumb-interwork  -mno-thumb-interwork @gol
383 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
384 -mstructure-size-boundary=@var{n} @gol
385 -mabort-on-noreturn @gol
386 -mlong-calls  -mno-long-calls @gol
387 -msingle-pic-base  -mno-single-pic-base @gol
388 -mpic-register=@var{reg} @gol
389 -mnop-fun-dllimport @gol
390 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
391 -mpoke-function-name @gol
392 -mthumb  -marm @gol
393 -mtpcs-frame  -mtpcs-leaf-frame @gol
394 -mcaller-super-interworking  -mcallee-super-interworking}
395
396 @emph{AVR Options}
397 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
398 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
399
400 @emph{CRIS Options}
401 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
402 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
403 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
404 -mstack-align  -mdata-align  -mconst-align @gol
405 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
406 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
407 -mmul-bug-workaround  -mno-mul-bug-workaround}
408
409 @emph{Darwin Options}
410 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
411 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
412 -client_name  -compatibility_version  -current_version @gol
413 -dead_strip @gol
414 -dependency-file  -dylib_file  -dylinker_install_name @gol
415 -dynamic  -dynamiclib  -exported_symbols_list @gol
416 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
417 -force_flat_namespace  -headerpad_max_install_names @gol
418 -image_base  -init  -install_name  -keep_private_externs @gol
419 -multi_module  -multiply_defined  -multiply_defined_unused @gol
420 -noall_load   -no_dead_strip_inits_and_terms @gol
421 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
422 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
423 -private_bundle  -read_only_relocs  -sectalign @gol
424 -sectobjectsymbols  -whyload  -seg1addr @gol
425 -sectcreate  -sectobjectsymbols  -sectorder @gol
426 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
427 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
428 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
429 -single_module  -static  -sub_library  -sub_umbrella @gol
430 -twolevel_namespace  -umbrella  -undefined @gol
431 -unexported_symbols_list  -weak_reference_mismatches @gol
432 -whatsloaded -F -gused -gfull -mone-byte-bool}
433
434 @emph{DEC Alpha Options}
435 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
436 -mieee  -mieee-with-inexact  -mieee-conformant @gol
437 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
438 -mtrap-precision=@var{mode}  -mbuild-constants @gol
439 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
440 -mbwx  -mmax  -mfix  -mcix @gol
441 -mfloat-vax  -mfloat-ieee @gol
442 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
443 -msmall-text  -mlarge-text @gol
444 -mmemory-latency=@var{time}}
445
446 @emph{DEC Alpha/VMS Options}
447 @gccoptlist{-mvms-return-codes}
448
449 @emph{FRV Options}
450 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
451 -mhard-float  -msoft-float @gol
452 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
453 -mdouble  -mno-double @gol
454 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
455 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
456 -mlinked-fp  -mlong-calls  -malign-labels @gol
457 -mlibrary-pic  -macc-4  -macc-8 @gol
458 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
459 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
460 -mvliw-branch  -mno-vliw-branch @gol
461 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
462 -mno-nested-cond-exec  -mtomcat-stats @gol
463 -mcpu=@var{cpu}}
464
465 @emph{H8/300 Options}
466 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
467
468 @emph{HPPA Options}
469 @gccoptlist{-march=@var{architecture-type} @gol
470 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
471 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
472 -mfixed-range=@var{register-range} @gol
473 -mjump-in-delay -mlinker-opt -mlong-calls @gol
474 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
475 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
476 -mno-jump-in-delay  -mno-long-load-store @gol
477 -mno-portable-runtime  -mno-soft-float @gol
478 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
479 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
480 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
481 -munix=@var{unix-std}  -nolibdld  -static  -threads}
482
483 @emph{i386 and x86-64 Options}
484 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
485 -mfpmath=@var{unit} @gol
486 -masm=@var{dialect}  -mno-fancy-math-387 @gol
487 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
488 -mno-wide-multiply  -mrtd  -malign-double @gol
489 -mpreferred-stack-boundary=@var{num} @gol
490 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
491 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
492 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
493 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
494 -mno-red-zone -mno-tls-direct-seg-refs @gol
495 -mcmodel=@var{code-model} @gol
496 -m32  -m64}
497
498 @emph{IA-64 Options}
499 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
500 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
501 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
502 -minline-float-divide-max-throughput @gol
503 -minline-int-divide-min-latency @gol
504 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
505 -mfixed-range=@var{register-range}}
506
507 @emph{M32R/D Options}
508 @gccoptlist{-m32r2 -m32rx -m32r @gol
509 -mdebug @gol
510 -malign-loops -mno-align-loops @gol
511 -missue-rate=@var{number} @gol
512 -mbranch-cost=@var{number} @gol
513 -mmodel=@var{code-size-model-type} @gol
514 -msdata=@var{sdata-type} @gol
515 -mno-flush-func -mflush-func=@var{name} @gol
516 -mno-flush-trap -mflush-trap=@var{number} @gol
517 -G @var{num}}
518
519 @emph{M680x0 Options}
520 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
521 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
522 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
523 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
524 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
525
526 @emph{M68hc1x Options}
527 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
528 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
529 -msoft-reg-count=@var{count}}
530
531 @emph{MCore Options}
532 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
533 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
534 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
535 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
536 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
537
538 @emph{MIPS Options}
539 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
540 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
541 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
542 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
543 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
544 -mpaired-single  -mips3d @gol
545 -mint64  -mlong64  -mlong32 @gol
546 -G@var{num}  -membedded-data  -mno-embedded-data @gol
547 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
548 -msplit-addresses  -mno-split-addresses  @gol
549 -mexplicit-relocs  -mno-explicit-relocs  @gol
550 -mcheck-zero-division  -mno-check-zero-division @gol
551 -mdivide-traps  -mdivide-breaks @gol
552 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
553 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
554 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
555 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
556 -mflush-func=@var{func}  -mno-flush-func @gol
557 -mbranch-likely  -mno-branch-likely @gol
558 -mfp-exceptions -mno-fp-exceptions @gol
559 -mvr4130-align -mno-vr4130-align}
560
561 @emph{MMIX Options}
562 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
563 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
564 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
565 -mno-base-addresses  -msingle-exit  -mno-single-exit}
566
567 @emph{MN10300 Options}
568 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
569 -mam33  -mno-am33 @gol
570 -mam33-2  -mno-am33-2 @gol
571 -mno-crt0  -mrelax}
572
573 @emph{NS32K Options}
574 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
575 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
576 -mregparam  -mnoregparam  -msb  -mnosb @gol
577 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
578
579 @emph{PDP-11 Options}
580 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
581 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
582 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
583 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
584 -mbranch-expensive  -mbranch-cheap @gol
585 -msplit  -mno-split  -munix-asm  -mdec-asm}
586
587 @emph{PowerPC Options}
588 See RS/6000 and PowerPC Options.
589
590 @emph{RS/6000 and PowerPC Options}
591 @gccoptlist{-mcpu=@var{cpu-type} @gol
592 -mtune=@var{cpu-type} @gol
593 -mpower  -mno-power  -mpower2  -mno-power2 @gol
594 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
595 -maltivec  -mno-altivec @gol
596 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
597 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
598 -mnew-mnemonics  -mold-mnemonics @gol
599 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
600 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
601 -malign-power  -malign-natural @gol
602 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
603 -mstring  -mno-string  -mupdate  -mno-update @gol
604 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
605 -mstrict-align  -mno-strict-align  -mrelocatable @gol
606 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
607 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
608 -mdynamic-no-pic @gol
609 -mprioritize-restricted-insns=@var{priority} @gol
610 -msched-costly-dep=@var{dependence_type} @gol
611 -minsert-sched-nops=@var{scheme} @gol
612 -mcall-sysv  -mcall-netbsd @gol
613 -maix-struct-return  -msvr4-struct-return @gol
614 -mabi=altivec  -mabi=no-altivec @gol
615 -mabi=spe  -mabi=no-spe @gol
616 -misel=yes  -misel=no @gol
617 -mspe=yes  -mspe=no @gol
618 -mfloat-gprs=yes  -mfloat-gprs=no @gol
619 -mprototype  -mno-prototype @gol
620 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
621 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
622
623 @emph{S/390 and zSeries Options}
624 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
625 -mhard-float  -msoft-float  -mbackchain  -mno-backchain -mkernel-backchain @gol
626 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
627 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
628 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
629 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
630
631 @emph{SH Options}
632 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
633 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
634 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
635 -m5-64media  -m5-64media-nofpu @gol
636 -m5-32media  -m5-32media-nofpu @gol
637 -m5-compact  -m5-compact-nofpu @gol
638 -mb  -ml  -mdalign  -mrelax @gol
639 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
640 -mieee  -misize  -mpadstruct  -mspace @gol
641 -mprefergot  -musermode}
642
643 @emph{SPARC Options}
644 @gccoptlist{-mcpu=@var{cpu-type} @gol
645 -mtune=@var{cpu-type} @gol
646 -mcmodel=@var{code-model} @gol
647 -m32  -m64  -mapp-regs  -mno-app-regs @gol
648 -mfaster-structs  -mno-faster-structs @gol
649 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
650 -mhard-quad-float  -msoft-quad-float @gol
651 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
652 -mstack-bias  -mno-stack-bias @gol
653 -munaligned-doubles  -mno-unaligned-doubles @gol
654 -mv8plus  -mno-v8plus  -mvis  -mno-vis
655 -threads -pthreads}
656
657 @emph{System V Options}
658 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
659
660 @emph{TMS320C3x/C4x Options}
661 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
662 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
663 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
664 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
665
666 @emph{V850 Options}
667 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
668 -mprolog-function  -mno-prolog-function  -mspace @gol
669 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
670 -mapp-regs  -mno-app-regs @gol
671 -mdisable-callt  -mno-disable-callt @gol
672 -mv850e1 @gol
673 -mv850e @gol
674 -mv850  -mbig-switch}
675
676 @emph{VAX Options}
677 @gccoptlist{-mg  -mgnu  -munix}
678
679 @emph{x86-64 Options}
680 See i386 and x86-64 Options.
681
682 @emph{Xstormy16 Options}
683 @gccoptlist{-msim}
684
685 @emph{Xtensa Options}
686 @gccoptlist{-mconst16 -mno-const16 @gol
687 -mfused-madd  -mno-fused-madd @gol
688 -mtext-section-literals  -mno-text-section-literals @gol
689 -mtarget-align  -mno-target-align @gol
690 -mlongcalls  -mno-longcalls}
691
692 @emph{zSeries Options}
693 See S/390 and zSeries Options.
694
695 @item Code Generation Options
696 @xref{Code Gen Options,,Options for Code Generation Conventions}.
697 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
698 -ffixed-@var{reg}  -fexceptions @gol
699 -fnon-call-exceptions  -funwind-tables @gol
700 -fasynchronous-unwind-tables @gol
701 -finhibit-size-directive  -finstrument-functions @gol
702 -fno-common  -fno-ident @gol
703 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
704 -freg-struct-return  -fshared-data  -fshort-enums @gol
705 -fshort-double  -fshort-wchar @gol
706 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
707 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
708 -fargument-alias  -fargument-noalias @gol
709 -fargument-noalias-global  -fleading-underscore @gol
710 -ftls-model=@var{model} @gol
711 -ftrapv  -fwrapv  -fbounds-check @gol
712 -fvisibility}
713 @end table
714
715 @menu
716 * Overall Options::     Controlling the kind of output:
717                         an executable, object files, assembler files,
718                         or preprocessed source.
719 * C Dialect Options::   Controlling the variant of C language compiled.
720 * C++ Dialect Options:: Variations on C++.
721 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
722                         and Objective-C++.
723 * Language Independent Options:: Controlling how diagnostics should be
724                         formatted.
725 * Warning Options::     How picky should the compiler be?
726 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
727 * Optimize Options::    How much optimization?
728 * Preprocessor Options:: Controlling header files and macro definitions.
729                          Also, getting dependency information for Make.
730 * Assembler Options::   Passing options to the assembler.
731 * Link Options::        Specifying libraries and so on.
732 * Directory Options::   Where to find header files and libraries.
733                         Where to find the compiler executable files.
734 * Spec Files::          How to pass switches to sub-processes.
735 * Target Options::      Running a cross-compiler, or an old version of GCC.
736 @end menu
737
738 @node Overall Options
739 @section Options Controlling the Kind of Output
740
741 Compilation can involve up to four stages: preprocessing, compilation
742 proper, assembly and linking, always in that order.  GCC is capable of
743 preprocessing and compiling several files either into several
744 assembler input files, or into one assembler input file; then each
745 assembler input file produces an object file, and linking combines all
746 the object files (those newly compiled, and those specified as input)
747 into an executable file.
748
749 @cindex file name suffix
750 For any given input file, the file name suffix determines what kind of
751 compilation is done:
752
753 @table @gcctabopt
754 @item @var{file}.c
755 C source code which must be preprocessed.
756
757 @item @var{file}.i
758 C source code which should not be preprocessed.
759
760 @item @var{file}.ii
761 C++ source code which should not be preprocessed.
762
763 @item @var{file}.m
764 Objective-C source code.  Note that you must link with the @file{libobjc}
765 library to make an Objective-C program work.
766
767 @item @var{file}.mi
768 Objective-C source code which should not be preprocessed.
769
770 @item @var{file}.mm
771 @itemx @var{file}.M
772 Objective-C++ source code.  Note that you must link with the @file{libobjc}
773 library to make an Objective-C++ program work.  Note that @samp{.M} refers
774 to a literal capital M@.
775
776 @item @var{file}.mii
777 Objective-C++ source code which should not be preprocessed.
778
779 @item @var{file}.h
780 C, C++, Objective-C or Objective-C++ header file to be turned into a
781 precompiled header.
782
783 @item @var{file}.cc
784 @itemx @var{file}.cp
785 @itemx @var{file}.cxx
786 @itemx @var{file}.cpp
787 @itemx @var{file}.CPP
788 @itemx @var{file}.c++
789 @itemx @var{file}.C
790 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
791 the last two letters must both be literally @samp{x}.  Likewise,
792 @samp{.C} refers to a literal capital C@.
793
794 @item @var{file}.hh
795 @itemx @var{file}.H
796 C++ header file to be turned into a precompiled header.
797
798 @item @var{file}.f
799 @itemx @var{file}.for
800 @itemx @var{file}.FOR
801 Fortran source code which should not be preprocessed.
802
803 @item @var{file}.F
804 @itemx @var{file}.fpp
805 @itemx @var{file}.FPP
806 Fortran source code which must be preprocessed (with the traditional
807 preprocessor).
808
809 @item @var{file}.r
810 Fortran source code which must be preprocessed with a RATFOR
811 preprocessor (not included with GCC)@.
812
813 @item @var{file}.f90
814 @itemx @var{file}.f95
815 Fortran 90/95 source code which should not be preprocessed.
816
817 @c FIXME: Descriptions of Java file types.
818 @c @var{file}.java
819 @c @var{file}.class
820 @c @var{file}.zip
821 @c @var{file}.jar
822
823 @item @var{file}.ads
824 Ada source code file which contains a library unit declaration (a
825 declaration of a package, subprogram, or generic, or a generic
826 instantiation), or a library unit renaming declaration (a package,
827 generic, or subprogram renaming declaration).  Such files are also
828 called @dfn{specs}.
829
830 @itemx @var{file}.adb
831 Ada source code file containing a library unit body (a subprogram or
832 package body).  Such files are also called @dfn{bodies}.
833
834 @c GCC also knows about some suffixes for languages not yet included:
835 @c Pascal:
836 @c @var{file}.p
837 @c @var{file}.pas
838
839 @item @var{file}.s
840 Assembler code.
841
842 @item @var{file}.S
843 Assembler code which must be preprocessed.
844
845 @item @var{other}
846 An object file to be fed straight into linking.
847 Any file name with no recognized suffix is treated this way.
848 @end table
849
850 @opindex x
851 You can specify the input language explicitly with the @option{-x} option:
852
853 @table @gcctabopt
854 @item -x @var{language}
855 Specify explicitly the @var{language} for the following input files
856 (rather than letting the compiler choose a default based on the file
857 name suffix).  This option applies to all following input files until
858 the next @option{-x} option.  Possible values for @var{language} are:
859 @smallexample
860 c  c-header  c-cpp-output
861 c++  c++-header  c++-cpp-output
862 objective-c  objective-c-header  objective-c-cpp-output
863 objective-c++ objective-c++-header objective-c++-cpp-output
864 assembler  assembler-with-cpp
865 ada
866 f77  f77-cpp-input  ratfor
867 f95
868 java
869 treelang
870 @end smallexample
871
872 @item -x none
873 Turn off any specification of a language, so that subsequent files are
874 handled according to their file name suffixes (as they are if @option{-x}
875 has not been used at all).
876
877 @item -pass-exit-codes
878 @opindex pass-exit-codes
879 Normally the @command{gcc} program will exit with the code of 1 if any
880 phase of the compiler returns a non-success return code.  If you specify
881 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
882 numerically highest error produced by any phase that returned an error
883 indication.
884 @end table
885
886 If you only want some of the stages of compilation, you can use
887 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
888 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
889 @command{gcc} is to stop.  Note that some combinations (for example,
890 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
891
892 @table @gcctabopt
893 @item -c
894 @opindex c
895 Compile or assemble the source files, but do not link.  The linking
896 stage simply is not done.  The ultimate output is in the form of an
897 object file for each source file.
898
899 By default, the object file name for a source file is made by replacing
900 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
901
902 Unrecognized input files, not requiring compilation or assembly, are
903 ignored.
904
905 @item -S
906 @opindex S
907 Stop after the stage of compilation proper; do not assemble.  The output
908 is in the form of an assembler code file for each non-assembler input
909 file specified.
910
911 By default, the assembler file name for a source file is made by
912 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
913
914 Input files that don't require compilation are ignored.
915
916 @item -E
917 @opindex E
918 Stop after the preprocessing stage; do not run the compiler proper.  The
919 output is in the form of preprocessed source code, which is sent to the
920 standard output.
921
922 Input files which don't require preprocessing are ignored.
923
924 @cindex output file option
925 @item -o @var{file}
926 @opindex o
927 Place output in file @var{file}.  This applies regardless to whatever
928 sort of output is being produced, whether it be an executable file,
929 an object file, an assembler file or preprocessed C code.
930
931 If @option{-o} is not specified, the default is to put an executable
932 file in @file{a.out}, the object file for
933 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
934 assembler file in @file{@var{source}.s}, a precompiled header file in
935 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
936 standard output.
937
938 @item -v
939 @opindex v
940 Print (on standard error output) the commands executed to run the stages
941 of compilation.  Also print the version number of the compiler driver
942 program and of the preprocessor and the compiler proper.
943
944 @item -###
945 @opindex ###
946 Like @option{-v} except the commands are not executed and all command
947 arguments are quoted.  This is useful for shell scripts to capture the
948 driver-generated command lines.
949
950 @item -pipe
951 @opindex pipe
952 Use pipes rather than temporary files for communication between the
953 various stages of compilation.  This fails to work on some systems where
954 the assembler is unable to read from a pipe; but the GNU assembler has
955 no trouble.
956
957 @item -combine
958 @opindex combine
959 If you are compiling multiple source files, this option tells the driver
960 to pass all the source files to the compiler at once (for those
961 languages for which the compiler can handle this).  This will allow
962 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
963 language for which this is supported is C.  If you pass source files for
964 multiple languages to the driver, using this option, the driver will invoke
965 the compiler(s) that support IMA once each, passing each compiler all the
966 source files appropriate for it.  For those languages that do not support
967 IMA this option will be ignored, and the compiler will be invoked once for
968 each source file in that language.  If you use this option in conjunction
969 with -save-temps, the compiler will generate multiple pre-processed files
970 (one for each source file), but only one (combined) .o or .s file.
971
972 @item --help
973 @opindex help
974 Print (on the standard output) a description of the command line options
975 understood by @command{gcc}.  If the @option{-v} option is also specified
976 then @option{--help} will also be passed on to the various processes
977 invoked by @command{gcc}, so that they can display the command line options
978 they accept.  If the @option{-Wextra} option is also specified then command
979 line options which have no documentation associated with them will also
980 be displayed.
981
982 @item --target-help
983 @opindex target-help
984 Print (on the standard output) a description of target specific command
985 line options for each tool.
986
987 @item --version
988 @opindex version
989 Display the version number and copyrights of the invoked GCC.
990 @end table
991
992 @node Invoking G++
993 @section Compiling C++ Programs
994
995 @cindex suffixes for C++ source
996 @cindex C++ source file suffixes
997 C++ source files conventionally use one of the suffixes @samp{.C},
998 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
999 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1000 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1001 files with these names and compiles them as C++ programs even if you
1002 call the compiler the same way as for compiling C programs (usually
1003 with the name @command{gcc}).
1004
1005 @findex g++
1006 @findex c++
1007 However, C++ programs often require class libraries as well as a
1008 compiler that understands the C++ language---and under some
1009 circumstances, you might want to compile programs or header files from
1010 standard input, or otherwise without a suffix that flags them as C++
1011 programs.  You might also like to precompile a C header file with a
1012 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1013 program that calls GCC with the default language set to C++, and
1014 automatically specifies linking against the C++ library.  On many
1015 systems, @command{g++} is also installed with the name @command{c++}.
1016
1017 @cindex invoking @command{g++}
1018 When you compile C++ programs, you may specify many of the same
1019 command-line options that you use for compiling programs in any
1020 language; or command-line options meaningful for C and related
1021 languages; or options that are meaningful only for C++ programs.
1022 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1023 explanations of options for languages related to C@.
1024 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1025 explanations of options that are meaningful only for C++ programs.
1026
1027 @node C Dialect Options
1028 @section Options Controlling C Dialect
1029 @cindex dialect options
1030 @cindex language dialect options
1031 @cindex options, dialect
1032
1033 The following options control the dialect of C (or languages derived
1034 from C, such as C++, Objective-C and Objective-C++) that the compiler
1035 accepts:
1036
1037 @table @gcctabopt
1038 @cindex ANSI support
1039 @cindex ISO support
1040 @item -ansi
1041 @opindex ansi
1042 In C mode, support all ISO C90 programs.  In C++ mode,
1043 remove GNU extensions that conflict with ISO C++.
1044
1045 This turns off certain features of GCC that are incompatible with ISO
1046 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1047 such as the @code{asm} and @code{typeof} keywords, and
1048 predefined macros such as @code{unix} and @code{vax} that identify the
1049 type of system you are using.  It also enables the undesirable and
1050 rarely used ISO trigraph feature.  For the C compiler,
1051 it disables recognition of C++ style @samp{//} comments as well as
1052 the @code{inline} keyword.
1053
1054 The alternate keywords @code{__asm__}, @code{__extension__},
1055 @code{__inline__} and @code{__typeof__} continue to work despite
1056 @option{-ansi}.  You would not want to use them in an ISO C program, of
1057 course, but it is useful to put them in header files that might be included
1058 in compilations done with @option{-ansi}.  Alternate predefined macros
1059 such as @code{__unix__} and @code{__vax__} are also available, with or
1060 without @option{-ansi}.
1061
1062 The @option{-ansi} option does not cause non-ISO programs to be
1063 rejected gratuitously.  For that, @option{-pedantic} is required in
1064 addition to @option{-ansi}.  @xref{Warning Options}.
1065
1066 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1067 option is used.  Some header files may notice this macro and refrain
1068 from declaring certain functions or defining certain macros that the
1069 ISO standard doesn't call for; this is to avoid interfering with any
1070 programs that might use these names for other things.
1071
1072 Functions which would normally be built in but do not have semantics
1073 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1074 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1075 built-in functions provided by GCC}, for details of the functions
1076 affected.
1077
1078 @item -std=
1079 @opindex std
1080 Determine the language standard.  This option is currently only
1081 supported when compiling C or C++.  A value for this option must be
1082 provided; possible values are
1083
1084 @table @samp
1085 @item c89
1086 @itemx iso9899:1990
1087 ISO C90 (same as @option{-ansi}).
1088
1089 @item iso9899:199409
1090 ISO C90 as modified in amendment 1.
1091
1092 @item c99
1093 @itemx c9x
1094 @itemx iso9899:1999
1095 @itemx iso9899:199x
1096 ISO C99.  Note that this standard is not yet fully supported; see
1097 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1098 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1099
1100 @item gnu89
1101 Default, ISO C90 plus GNU extensions (including some C99 features).
1102
1103 @item gnu99
1104 @itemx gnu9x
1105 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1106 this will become the default.  The name @samp{gnu9x} is deprecated.
1107
1108 @item c++98
1109 The 1998 ISO C++ standard plus amendments.
1110
1111 @item gnu++98
1112 The same as @option{-std=c++98} plus GNU extensions.  This is the
1113 default for C++ code.
1114 @end table
1115
1116 Even when this option is not specified, you can still use some of the
1117 features of newer standards in so far as they do not conflict with
1118 previous C standards.  For example, you may use @code{__restrict__} even
1119 when @option{-std=c99} is not specified.
1120
1121 The @option{-std} options specifying some version of ISO C have the same
1122 effects as @option{-ansi}, except that features that were not in ISO C90
1123 but are in the specified version (for example, @samp{//} comments and
1124 the @code{inline} keyword in ISO C99) are not disabled.
1125
1126 @xref{Standards,,Language Standards Supported by GCC}, for details of
1127 these standard versions.
1128
1129 @item -aux-info @var{filename}
1130 @opindex aux-info
1131 Output to the given filename prototyped declarations for all functions
1132 declared and/or defined in a translation unit, including those in header
1133 files.  This option is silently ignored in any language other than C@.
1134
1135 Besides declarations, the file indicates, in comments, the origin of
1136 each declaration (source file and line), whether the declaration was
1137 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1138 @samp{O} for old, respectively, in the first character after the line
1139 number and the colon), and whether it came from a declaration or a
1140 definition (@samp{C} or @samp{F}, respectively, in the following
1141 character).  In the case of function definitions, a K&R-style list of
1142 arguments followed by their declarations is also provided, inside
1143 comments, after the declaration.
1144
1145 @item -fno-asm
1146 @opindex fno-asm
1147 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1148 keyword, so that code can use these words as identifiers.  You can use
1149 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1150 instead.  @option{-ansi} implies @option{-fno-asm}.
1151
1152 In C++, this switch only affects the @code{typeof} keyword, since
1153 @code{asm} and @code{inline} are standard keywords.  You may want to
1154 use the @option{-fno-gnu-keywords} flag instead, which has the same
1155 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1156 switch only affects the @code{asm} and @code{typeof} keywords, since
1157 @code{inline} is a standard keyword in ISO C99.
1158
1159 @item -fno-builtin
1160 @itemx -fno-builtin-@var{function}
1161 @opindex fno-builtin
1162 @cindex built-in functions
1163 Don't recognize built-in functions that do not begin with
1164 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1165 functions provided by GCC}, for details of the functions affected,
1166 including those which are not built-in functions when @option{-ansi} or
1167 @option{-std} options for strict ISO C conformance are used because they
1168 do not have an ISO standard meaning.
1169
1170 GCC normally generates special code to handle certain built-in functions
1171 more efficiently; for instance, calls to @code{alloca} may become single
1172 instructions that adjust the stack directly, and calls to @code{memcpy}
1173 may become inline copy loops.  The resulting code is often both smaller
1174 and faster, but since the function calls no longer appear as such, you
1175 cannot set a breakpoint on those calls, nor can you change the behavior
1176 of the functions by linking with a different library.  In addition,
1177 when a function is recognized as a built-in function, GCC may use
1178 information about that function to warn about problems with calls to
1179 that function, or to generate more efficient code, even if the
1180 resulting code still contains calls to that function.  For example,
1181 warnings are given with @option{-Wformat} for bad calls to
1182 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1183 known not to modify global memory.
1184
1185 With the @option{-fno-builtin-@var{function}} option
1186 only the built-in function @var{function} is
1187 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1188 function is named this is not built-in in this version of GCC, this
1189 option is ignored.  There is no corresponding
1190 @option{-fbuiltin-@var{function}} option; if you wish to enable
1191 built-in functions selectively when using @option{-fno-builtin} or
1192 @option{-ffreestanding}, you may define macros such as:
1193
1194 @smallexample
1195 #define abs(n)          __builtin_abs ((n))
1196 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1197 @end smallexample
1198
1199 @item -fhosted
1200 @opindex fhosted
1201 @cindex hosted environment
1202
1203 Assert that compilation takes place in a hosted environment.  This implies
1204 @option{-fbuiltin}.  A hosted environment is one in which the
1205 entire standard library is available, and in which @code{main} has a return
1206 type of @code{int}.  Examples are nearly everything except a kernel.
1207 This is equivalent to @option{-fno-freestanding}.
1208
1209 @item -ffreestanding
1210 @opindex ffreestanding
1211 @cindex hosted environment
1212
1213 Assert that compilation takes place in a freestanding environment.  This
1214 implies @option{-fno-builtin}.  A freestanding environment
1215 is one in which the standard library may not exist, and program startup may
1216 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1217 This is equivalent to @option{-fno-hosted}.
1218
1219 @xref{Standards,,Language Standards Supported by GCC}, for details of
1220 freestanding and hosted environments.
1221
1222 @item -fms-extensions
1223 @opindex fms-extensions
1224 Accept some non-standard constructs used in Microsoft header files.
1225
1226 Some cases of unnamed fields in structures and unions are only
1227 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1228 fields within structs/unions}, for details.
1229
1230 @item -trigraphs
1231 @opindex trigraphs
1232 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1233 options for strict ISO C conformance) implies @option{-trigraphs}.
1234
1235 @item -no-integrated-cpp
1236 @opindex no-integrated-cpp
1237 Performs a compilation in two passes: preprocessing and compiling.  This
1238 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1239 @option{-B} option. The user supplied compilation step can then add in
1240 an additional preprocessing step after normal preprocessing but before
1241 compiling. The default is to use the integrated cpp (internal cpp)
1242
1243 The semantics of this option will change if "cc1", "cc1plus", and
1244 "cc1obj" are merged.
1245
1246 @cindex traditional C language
1247 @cindex C language, traditional
1248 @item -traditional
1249 @itemx -traditional-cpp
1250 @opindex traditional-cpp
1251 @opindex traditional
1252 Formerly, these options caused GCC to attempt to emulate a pre-standard
1253 C compiler.  They are now only supported with the @option{-E} switch.
1254 The preprocessor continues to support a pre-standard mode.  See the GNU
1255 CPP manual for details.
1256
1257 @item -fcond-mismatch
1258 @opindex fcond-mismatch
1259 Allow conditional expressions with mismatched types in the second and
1260 third arguments.  The value of such an expression is void.  This option
1261 is not supported for C++.
1262
1263 @item -funsigned-char
1264 @opindex funsigned-char
1265 Let the type @code{char} be unsigned, like @code{unsigned char}.
1266
1267 Each kind of machine has a default for what @code{char} should
1268 be.  It is either like @code{unsigned char} by default or like
1269 @code{signed char} by default.
1270
1271 Ideally, a portable program should always use @code{signed char} or
1272 @code{unsigned char} when it depends on the signedness of an object.
1273 But many programs have been written to use plain @code{char} and
1274 expect it to be signed, or expect it to be unsigned, depending on the
1275 machines they were written for.  This option, and its inverse, let you
1276 make such a program work with the opposite default.
1277
1278 The type @code{char} is always a distinct type from each of
1279 @code{signed char} or @code{unsigned char}, even though its behavior
1280 is always just like one of those two.
1281
1282 @item -fsigned-char
1283 @opindex fsigned-char
1284 Let the type @code{char} be signed, like @code{signed char}.
1285
1286 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1287 the negative form of @option{-funsigned-char}.  Likewise, the option
1288 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1289
1290 @item -fsigned-bitfields
1291 @itemx -funsigned-bitfields
1292 @itemx -fno-signed-bitfields
1293 @itemx -fno-unsigned-bitfields
1294 @opindex fsigned-bitfields
1295 @opindex funsigned-bitfields
1296 @opindex fno-signed-bitfields
1297 @opindex fno-unsigned-bitfields
1298 These options control whether a bit-field is signed or unsigned, when the
1299 declaration does not use either @code{signed} or @code{unsigned}.  By
1300 default, such a bit-field is signed, because this is consistent: the
1301 basic integer types such as @code{int} are signed types.
1302 @end table
1303
1304 @node C++ Dialect Options
1305 @section Options Controlling C++ Dialect
1306
1307 @cindex compiler options, C++
1308 @cindex C++ options, command line
1309 @cindex options, C++
1310 This section describes the command-line options that are only meaningful
1311 for C++ programs; but you can also use most of the GNU compiler options
1312 regardless of what language your program is in.  For example, you
1313 might compile a file @code{firstClass.C} like this:
1314
1315 @smallexample
1316 g++ -g -frepo -O -c firstClass.C
1317 @end smallexample
1318
1319 @noindent
1320 In this example, only @option{-frepo} is an option meant
1321 only for C++ programs; you can use the other options with any
1322 language supported by GCC@.
1323
1324 Here is a list of options that are @emph{only} for compiling C++ programs:
1325
1326 @table @gcctabopt
1327
1328 @item -fabi-version=@var{n}
1329 @opindex fabi-version
1330 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1331 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1332 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1333 the version that conforms most closely to the C++ ABI specification.
1334 Therefore, the ABI obtained using version 0 will change as ABI bugs
1335 are fixed.
1336
1337 The default is version 2.
1338
1339 @item -fno-access-control
1340 @opindex fno-access-control
1341 Turn off all access checking.  This switch is mainly useful for working
1342 around bugs in the access control code.
1343
1344 @item -fcheck-new
1345 @opindex fcheck-new
1346 Check that the pointer returned by @code{operator new} is non-null
1347 before attempting to modify the storage allocated.  This check is
1348 normally unnecessary because the C++ standard specifies that
1349 @code{operator new} will only return @code{0} if it is declared
1350 @samp{throw()}, in which case the compiler will always check the
1351 return value even without this option.  In all other cases, when
1352 @code{operator new} has a non-empty exception specification, memory
1353 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1354 @samp{new (nothrow)}.
1355
1356 @item -fconserve-space
1357 @opindex fconserve-space
1358 Put uninitialized or runtime-initialized global variables into the
1359 common segment, as C does.  This saves space in the executable at the
1360 cost of not diagnosing duplicate definitions.  If you compile with this
1361 flag and your program mysteriously crashes after @code{main()} has
1362 completed, you may have an object that is being destroyed twice because
1363 two definitions were merged.
1364
1365 This option is no longer useful on most targets, now that support has
1366 been added for putting variables into BSS without making them common.
1367
1368 @item -fno-const-strings
1369 @opindex fno-const-strings
1370 Give string constants type @code{char *} instead of type @code{const
1371 char *}.  By default, G++ uses type @code{const char *} as required by
1372 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1373 actually modify the value of a string constant.
1374
1375 This option might be removed in a future release of G++.  For maximum
1376 portability, you should structure your code so that it works with
1377 string constants that have type @code{const char *}.
1378
1379 @item -fno-elide-constructors
1380 @opindex fno-elide-constructors
1381 The C++ standard allows an implementation to omit creating a temporary
1382 which is only used to initialize another object of the same type.
1383 Specifying this option disables that optimization, and forces G++ to
1384 call the copy constructor in all cases.
1385
1386 @item -fno-enforce-eh-specs
1387 @opindex fno-enforce-eh-specs
1388 Don't check for violation of exception specifications at runtime.  This
1389 option violates the C++ standard, but may be useful for reducing code
1390 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1391 will still optimize based on the exception specifications.
1392
1393 @item -ffor-scope
1394 @itemx -fno-for-scope
1395 @opindex ffor-scope
1396 @opindex fno-for-scope
1397 If @option{-ffor-scope} is specified, the scope of variables declared in
1398 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1399 as specified by the C++ standard.
1400 If @option{-fno-for-scope} is specified, the scope of variables declared in
1401 a @i{for-init-statement} extends to the end of the enclosing scope,
1402 as was the case in old versions of G++, and other (traditional)
1403 implementations of C++.
1404
1405 The default if neither flag is given to follow the standard,
1406 but to allow and give a warning for old-style code that would
1407 otherwise be invalid, or have different behavior.
1408
1409 @item -fno-gnu-keywords
1410 @opindex fno-gnu-keywords
1411 Do not recognize @code{typeof} as a keyword, so that code can use this
1412 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1413 @option{-ansi} implies @option{-fno-gnu-keywords}.
1414
1415 @item -fno-implicit-templates
1416 @opindex fno-implicit-templates
1417 Never emit code for non-inline templates which are instantiated
1418 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1419 @xref{Template Instantiation}, for more information.
1420
1421 @item -fno-implicit-inline-templates
1422 @opindex fno-implicit-inline-templates
1423 Don't emit code for implicit instantiations of inline templates, either.
1424 The default is to handle inlines differently so that compiles with and
1425 without optimization will need the same set of explicit instantiations.
1426
1427 @item -fno-implement-inlines
1428 @opindex fno-implement-inlines
1429 To save space, do not emit out-of-line copies of inline functions
1430 controlled by @samp{#pragma implementation}.  This will cause linker
1431 errors if these functions are not inlined everywhere they are called.
1432
1433 @item -fms-extensions
1434 @opindex fms-extensions
1435 Disable pedantic warnings about constructs used in MFC, such as implicit
1436 int and getting a pointer to member function via non-standard syntax.
1437
1438 @item -fno-nonansi-builtins
1439 @opindex fno-nonansi-builtins
1440 Disable built-in declarations of functions that are not mandated by
1441 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1442 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1443
1444 @item -fno-operator-names
1445 @opindex fno-operator-names
1446 Do not treat the operator name keywords @code{and}, @code{bitand},
1447 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1448 synonyms as keywords.
1449
1450 @item -fno-optional-diags
1451 @opindex fno-optional-diags
1452 Disable diagnostics that the standard says a compiler does not need to
1453 issue.  Currently, the only such diagnostic issued by G++ is the one for
1454 a name having multiple meanings within a class.
1455
1456 @item -fpermissive
1457 @opindex fpermissive
1458 Downgrade some diagnostics about nonconformant code from errors to
1459 warnings.  Thus, using @option{-fpermissive} will allow some
1460 nonconforming code to compile.
1461
1462 @item -frepo
1463 @opindex frepo
1464 Enable automatic template instantiation at link time.  This option also
1465 implies @option{-fno-implicit-templates}.  @xref{Template
1466 Instantiation}, for more information.
1467
1468 @item -fno-rtti
1469 @opindex fno-rtti
1470 Disable generation of information about every class with virtual
1471 functions for use by the C++ runtime type identification features
1472 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1473 of the language, you can save some space by using this flag.  Note that
1474 exception handling uses the same information, but it will generate it as
1475 needed.
1476
1477 @item -fstats
1478 @opindex fstats
1479 Emit statistics about front-end processing at the end of the compilation.
1480 This information is generally only useful to the G++ development team.
1481
1482 @item -ftemplate-depth-@var{n}
1483 @opindex ftemplate-depth
1484 Set the maximum instantiation depth for template classes to @var{n}.
1485 A limit on the template instantiation depth is needed to detect
1486 endless recursions during template class instantiation.  ANSI/ISO C++
1487 conforming programs must not rely on a maximum depth greater than 17.
1488
1489 @item -fno-threadsafe-statics
1490 @opindex fno-threadsafe-statics
1491 Do not emit the extra code to use the routines specified in the C++
1492 ABI for thread-safe initialization of local statics.  You can use this
1493 option to reduce code size slightly in code that doesn't need to be
1494 thread-safe.
1495
1496 @item -fuse-cxa-atexit
1497 @opindex fuse-cxa-atexit
1498 Register destructors for objects with static storage duration with the
1499 @code{__cxa_atexit} function rather than the @code{atexit} function.
1500 This option is required for fully standards-compliant handling of static
1501 destructors, but will only work if your C library supports
1502 @code{__cxa_atexit}.
1503
1504 @item -fvisibility-inlines-hidden
1505 @opindex fvisibility-inlines-hidden
1506 Causes all inlined methods to be marked with
1507 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1508 appear in the export table of a DSO and do not require a PLT indirection
1509 when used within the DSO. Enabling this option can have a dramatic effect
1510 on load and link times of a DSO as it massively reduces the size of the
1511 dynamic export table when the library makes heavy use of templates. While
1512 it can cause bloating through duplication of code within each DSO where
1513 it is used, often the wastage is less than the considerable space occupied
1514 by a long symbol name in the export table which is typical when using
1515 templates and namespaces. For even more savings, combine with the
1516 @option{-fvisibility=hidden} switch.
1517
1518 @item -fno-weak
1519 @opindex fno-weak
1520 Do not use weak symbol support, even if it is provided by the linker.
1521 By default, G++ will use weak symbols if they are available.  This
1522 option exists only for testing, and should not be used by end-users;
1523 it will result in inferior code and has no benefits.  This option may
1524 be removed in a future release of G++.
1525
1526 @item -nostdinc++
1527 @opindex nostdinc++
1528 Do not search for header files in the standard directories specific to
1529 C++, but do still search the other standard directories.  (This option
1530 is used when building the C++ library.)
1531 @end table
1532
1533 In addition, these optimization, warning, and code generation options
1534 have meanings only for C++ programs:
1535
1536 @table @gcctabopt
1537 @item -fno-default-inline
1538 @opindex fno-default-inline
1539 Do not assume @samp{inline} for functions defined inside a class scope.
1540 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1541 functions will have linkage like inline functions; they just won't be
1542 inlined by default.
1543
1544 @item -Wabi @r{(C++ only)}
1545 @opindex Wabi
1546 Warn when G++ generates code that is probably not compatible with the
1547 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1548 all such cases, there are probably some cases that are not warned about,
1549 even though G++ is generating incompatible code.  There may also be
1550 cases where warnings are emitted even though the code that is generated
1551 will be compatible.
1552
1553 You should rewrite your code to avoid these warnings if you are
1554 concerned about the fact that code generated by G++ may not be binary
1555 compatible with code generated by other compilers.
1556
1557 The known incompatibilities at this point include:
1558
1559 @itemize @bullet
1560
1561 @item
1562 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1563 pack data into the same byte as a base class.  For example:
1564
1565 @smallexample
1566 struct A @{ virtual void f(); int f1 : 1; @};
1567 struct B : public A @{ int f2 : 1; @};
1568 @end smallexample
1569
1570 @noindent
1571 In this case, G++ will place @code{B::f2} into the same byte
1572 as@code{A::f1}; other compilers will not.  You can avoid this problem
1573 by explicitly padding @code{A} so that its size is a multiple of the
1574 byte size on your platform; that will cause G++ and other compilers to
1575 layout @code{B} identically.
1576
1577 @item
1578 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1579 tail padding when laying out virtual bases.  For example:
1580
1581 @smallexample
1582 struct A @{ virtual void f(); char c1; @};
1583 struct B @{ B(); char c2; @};
1584 struct C : public A, public virtual B @{@};
1585 @end smallexample
1586
1587 @noindent
1588 In this case, G++ will not place @code{B} into the tail-padding for
1589 @code{A}; other compilers will.  You can avoid this problem by
1590 explicitly padding @code{A} so that its size is a multiple of its
1591 alignment (ignoring virtual base classes); that will cause G++ and other
1592 compilers to layout @code{C} identically.
1593
1594 @item
1595 Incorrect handling of bit-fields with declared widths greater than that
1596 of their underlying types, when the bit-fields appear in a union.  For
1597 example:
1598
1599 @smallexample
1600 union U @{ int i : 4096; @};
1601 @end smallexample
1602
1603 @noindent
1604 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1605 union too small by the number of bits in an @code{int}.
1606
1607 @item
1608 Empty classes can be placed at incorrect offsets.  For example:
1609
1610 @smallexample
1611 struct A @{@};
1612
1613 struct B @{
1614   A a;
1615   virtual void f ();
1616 @};
1617
1618 struct C : public B, public A @{@};
1619 @end smallexample
1620
1621 @noindent
1622 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1623 it should be placed at offset zero.  G++ mistakenly believes that the
1624 @code{A} data member of @code{B} is already at offset zero.
1625
1626 @item
1627 Names of template functions whose types involve @code{typename} or
1628 template template parameters can be mangled incorrectly.
1629
1630 @smallexample
1631 template <typename Q>
1632 void f(typename Q::X) @{@}
1633
1634 template <template <typename> class Q>
1635 void f(typename Q<int>::X) @{@}
1636 @end smallexample
1637
1638 @noindent
1639 Instantiations of these templates may be mangled incorrectly.
1640
1641 @end itemize
1642
1643 @item -Wctor-dtor-privacy @r{(C++ only)}
1644 @opindex Wctor-dtor-privacy
1645 Warn when a class seems unusable because all the constructors or
1646 destructors in that class are private, and it has neither friends nor
1647 public static member functions.
1648
1649 @item -Wnon-virtual-dtor @r{(C++ only)}
1650 @opindex Wnon-virtual-dtor
1651 Warn when a class appears to be polymorphic, thereby requiring a virtual
1652 destructor, yet it declares a non-virtual one.
1653 This warning is enabled by @option{-Wall}.
1654
1655 @item -Wreorder @r{(C++ only)}
1656 @opindex Wreorder
1657 @cindex reordering, warning
1658 @cindex warning for reordering of member initializers
1659 Warn when the order of member initializers given in the code does not
1660 match the order in which they must be executed.  For instance:
1661
1662 @smallexample
1663 struct A @{
1664   int i;
1665   int j;
1666   A(): j (0), i (1) @{ @}
1667 @};
1668 @end smallexample
1669
1670 The compiler will rearrange the member initializers for @samp{i}
1671 and @samp{j} to match the declaration order of the members, emitting
1672 a warning to that effect.  This warning is enabled by @option{-Wall}.
1673 @end table
1674
1675 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1676
1677 @table @gcctabopt
1678 @item -Weffc++ @r{(C++ only)}
1679 @opindex Weffc++
1680 Warn about violations of the following style guidelines from Scott Meyers'
1681 @cite{Effective C++} book:
1682
1683 @itemize @bullet
1684 @item
1685 Item 11:  Define a copy constructor and an assignment operator for classes
1686 with dynamically allocated memory.
1687
1688 @item
1689 Item 12:  Prefer initialization to assignment in constructors.
1690
1691 @item
1692 Item 14:  Make destructors virtual in base classes.
1693
1694 @item
1695 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1696
1697 @item
1698 Item 23:  Don't try to return a reference when you must return an object.
1699
1700 @end itemize
1701
1702 Also warn about violations of the following style guidelines from
1703 Scott Meyers' @cite{More Effective C++} book:
1704
1705 @itemize @bullet
1706 @item
1707 Item 6:  Distinguish between prefix and postfix forms of increment and
1708 decrement operators.
1709
1710 @item
1711 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1712
1713 @end itemize
1714
1715 When selecting this option, be aware that the standard library
1716 headers do not obey all of these guidelines; use @samp{grep -v}
1717 to filter out those warnings.
1718
1719 @item -Wno-deprecated @r{(C++ only)}
1720 @opindex Wno-deprecated
1721 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1722
1723 @item -Wno-non-template-friend @r{(C++ only)}
1724 @opindex Wno-non-template-friend
1725 Disable warnings when non-templatized friend functions are declared
1726 within a template.  Since the advent of explicit template specification
1727 support in G++, if the name of the friend is an unqualified-id (i.e.,
1728 @samp{friend foo(int)}), the C++ language specification demands that the
1729 friend declare or define an ordinary, nontemplate function.  (Section
1730 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1731 could be interpreted as a particular specialization of a templatized
1732 function.  Because this non-conforming behavior is no longer the default
1733 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1734 check existing code for potential trouble spots and is on by default.
1735 This new compiler behavior can be turned off with
1736 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1737 but disables the helpful warning.
1738
1739 @item -Wold-style-cast @r{(C++ only)}
1740 @opindex Wold-style-cast
1741 Warn if an old-style (C-style) cast to a non-void type is used within
1742 a C++ program.  The new-style casts (@samp{static_cast},
1743 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1744 unintended effects and much easier to search for.
1745
1746 @item -Woverloaded-virtual @r{(C++ only)}
1747 @opindex Woverloaded-virtual
1748 @cindex overloaded virtual fn, warning
1749 @cindex warning for overloaded virtual fn
1750 Warn when a function declaration hides virtual functions from a
1751 base class.  For example, in:
1752
1753 @smallexample
1754 struct A @{
1755   virtual void f();
1756 @};
1757
1758 struct B: public A @{
1759   void f(int);
1760 @};
1761 @end smallexample
1762
1763 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1764 like:
1765
1766 @smallexample
1767 B* b;
1768 b->f();
1769 @end smallexample
1770
1771 will fail to compile.
1772
1773 @item -Wno-pmf-conversions @r{(C++ only)}
1774 @opindex Wno-pmf-conversions
1775 Disable the diagnostic for converting a bound pointer to member function
1776 to a plain pointer.
1777
1778 @item -Wsign-promo @r{(C++ only)}
1779 @opindex Wsign-promo
1780 Warn when overload resolution chooses a promotion from unsigned or
1781 enumerated type to a signed type, over a conversion to an unsigned type of
1782 the same size.  Previous versions of G++ would try to preserve
1783 unsignedness, but the standard mandates the current behavior.
1784
1785 @item -Wsynth @r{(C++ only)}
1786 @opindex Wsynth
1787 @cindex warning for synthesized methods
1788 @cindex synthesized methods, warning
1789 Warn when G++'s synthesis behavior does not match that of cfront.  For
1790 instance:
1791
1792 @smallexample
1793 struct A @{
1794   operator int ();
1795   A& operator = (int);
1796 @};
1797
1798 main ()
1799 @{
1800   A a,b;
1801   a = b;
1802 @}
1803 @end smallexample
1804
1805 In this example, G++ will synthesize a default @samp{A& operator =
1806 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1807 @end table
1808
1809 @node Objective-C and Objective-C++ Dialect Options
1810 @section Options Controlling Objective-C and Objective-C++ Dialects
1811
1812 @cindex compiler options, Objective-C and Objective-C++
1813 @cindex Objective-C and Objective-C++ options, command line
1814 @cindex options, Objective-C and Objective-C++
1815 (NOTE: This manual does not describe the Objective-C and Objective-C++
1816 languages themselves.  See @xref{Standards,,Language Standards
1817 Supported by GCC}, for references.)
1818
1819 This section describes the command-line options that are only meaningful
1820 for Objective-C and Objective-C++ programs, but you can also use most of
1821 the language-independent GNU compiler options.
1822 For example, you might compile a file @code{some_class.m} like this:
1823
1824 @smallexample
1825 gcc -g -fgnu-runtime -O -c some_class.m
1826 @end smallexample
1827
1828 @noindent
1829 In this example, @option{-fgnu-runtime} is an option meant only for
1830 Objective-C and Objective-C++ programs; you can use the other options with
1831 any language supported by GCC@.
1832
1833 Note that since Objective-C is an extension of the C language, Objective-C
1834 compilations may also use options specific to the C front-end (e.g., 
1835 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1836 C++-specific options (e.g., @option{-Wabi}).
1837
1838 Here is a list of options that are @emph{only} for compiling Objective-C
1839 and Objective-C++ programs:
1840
1841 @table @gcctabopt
1842 @item -fconstant-string-class=@var{class-name}
1843 @opindex fconstant-string-class
1844 Use @var{class-name} as the name of the class to instantiate for each
1845 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1846 class name is @code{NXConstantString} if the GNU runtime is being used, and
1847 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1848 @option{-fconstant-cfstrings} option, if also present, will override the
1849 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1850 to be laid out as constant CoreFoundation strings.
1851
1852 @item -fgnu-runtime
1853 @opindex fgnu-runtime
1854 Generate object code compatible with the standard GNU Objective-C
1855 runtime.  This is the default for most types of systems.
1856
1857 @item -fnext-runtime
1858 @opindex fnext-runtime
1859 Generate output compatible with the NeXT runtime.  This is the default
1860 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1861 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1862 used.
1863
1864 @item -fno-nil-receivers
1865 @opindex fno-nil-receivers
1866 Assume that all Objective-C message dispatches (e.g.,
1867 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1868 is not @code{nil}.  This allows for more efficient entry points in the runtime
1869 to be used.  Currently, this option is only available in conjunction with
1870 the NeXT runtime on Mac OS X 10.3 and later.
1871
1872 @item -fobjc-exceptions
1873 @opindex fobjc-exceptions
1874 Enable syntactic support for structured exception handling in Objective-C,
1875 similar to what is offered by C++ and Java.  Currently, this option is only
1876 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1877
1878 @smallexample
1879   @@try @{
1880     @dots{}
1881        @@throw expr;
1882     @dots{}
1883   @}
1884   @@catch (AnObjCClass *exc) @{
1885     @dots{}
1886       @@throw expr;
1887     @dots{}
1888       @@throw;
1889     @dots{}
1890   @}
1891   @@catch (AnotherClass *exc) @{
1892     @dots{}
1893   @}
1894   @@catch (id allOthers) @{
1895     @dots{}
1896   @}
1897   @@finally @{
1898     @dots{}
1899       @@throw expr;
1900     @dots{}
1901   @}
1902 @end smallexample
1903
1904 The @code{@@throw} statement may appear anywhere in an Objective-C or
1905 Objective-C++ program; when used inside of a @code{@@catch} block, the
1906 @code{@@throw} may appear without an argument (as shown above), in which case
1907 the object caught by the @code{@@catch} will be rethrown.
1908
1909 Note that only (pointers to) Objective-C objects may be thrown and
1910 caught using this scheme.  When an object is thrown, it will be caught
1911 by the nearest @code{@@catch} clause capable of handling objects of that type,
1912 analogously to how @code{catch} blocks work in C++ and Java.  A
1913 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1914 any and all Objective-C exceptions not caught by previous @code{@@catch}
1915 clauses (if any).
1916
1917 The @code{@@finally} clause, if present, will be executed upon exit from the
1918 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1919 regardless of whether any exceptions are thrown, caught or rethrown
1920 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1921 of the @code{finally} clause in Java.
1922
1923 There are several caveats to using the new exception mechanism:
1924
1925 @itemize @bullet
1926 @item
1927 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1928 idioms provided by the @code{NSException} class, the new
1929 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1930 systems, due to additional functionality needed in the (NeXT) Objective-C
1931 runtime.
1932
1933 @item
1934 As mentioned above, the new exceptions do not support handling
1935 types other than Objective-C objects.   Furthermore, when used from
1936 Objective-C++, the Objective-C exception model does not interoperate with C++
1937 exceptions at this time.  This means you cannot @code{@@throw} an exception
1938 from Objective-C and @code{catch} it in C++, or vice versa
1939 (i.e., @code{throw @dots{} @@catch}).
1940 @end itemize
1941
1942 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1943 blocks for thread-safe execution:
1944
1945 @smallexample
1946   @@synchronized (ObjCClass *guard) @{
1947     @dots{}
1948   @}
1949 @end smallexample
1950
1951 Upon entering the @code{@@synchronized} block, a thread of execution shall
1952 first check whether a lock has been placed on the corresponding @code{guard}
1953 object by another thread.  If it has, the current thread shall wait until
1954 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1955 the current thread will place its own lock on it, execute the code contained in
1956 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1957 making @code{guard} available to other threads).
1958
1959 Unlike Java, Objective-C does not allow for entire methods to be marked
1960 @code{@@synchronized}.  Note that throwing exceptions out of
1961 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1962 to be unlocked properly.
1963
1964 @item -freplace-objc-classes
1965 @opindex freplace-objc-classes
1966 Emit a special marker instructing @command{ld(1)} not to statically link in
1967 the resulting object file, and allow @command{dyld(1)} to load it in at
1968 run time instead.  This is used in conjunction with the Fix-and-Continue
1969 debugging mode, where the object file in question may be recompiled and
1970 dynamically reloaded in the course of program execution, without the need
1971 to restart the program itself.  Currently, Fix-and-Continue functionality
1972 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1973 and later.
1974
1975 @item -fzero-link
1976 @opindex fzero-link
1977 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1978 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1979 compile time) with static class references that get initialized at load time,
1980 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1981 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1982 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1983 for individual class implementations to be modified during program execution.
1984
1985 @item -gen-decls
1986 @opindex gen-decls
1987 Dump interface declarations for all classes seen in the source file to a
1988 file named @file{@var{sourcename}.decl}.
1989
1990 @item -Wno-protocol
1991 @opindex Wno-protocol
1992 If a class is declared to implement a protocol, a warning is issued for
1993 every method in the protocol that is not implemented by the class.  The
1994 default behavior is to issue a warning for every method not explicitly
1995 implemented in the class, even if a method implementation is inherited
1996 from the superclass.  If you use the @option{-Wno-protocol} option, then
1997 methods inherited from the superclass are considered to be implemented,
1998 and no warning is issued for them.
1999
2000 @item -Wselector
2001 @opindex Wselector
2002 Warn if multiple methods of different types for the same selector are
2003 found during compilation.  The check is performed on the list of methods
2004 in the final stage of compilation.  Additionally, a check is performed
2005 for each selector appearing in a @code{@@selector(@dots{})}
2006 expression, and a corresponding method for that selector has been found
2007 during compilation.  Because these checks scan the method table only at
2008 the end of compilation, these warnings are not produced if the final
2009 stage of compilation is not reached, for example because an error is
2010 found during compilation, or because the @option{-fsyntax-only} option is
2011 being used.
2012
2013 @item -Wundeclared-selector
2014 @opindex Wundeclared-selector
2015 Warn if a @code{@@selector(@dots{})} expression referring to an
2016 undeclared selector is found.  A selector is considered undeclared if no
2017 method with that name has been declared before the
2018 @code{@@selector(@dots{})} expression, either explicitly in an
2019 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2020 an @code{@@implementation} section.  This option always performs its
2021 checks as soon as a @code{@@selector(@dots{})} expression is found,
2022 while @option{-Wselector} only performs its checks in the final stage of
2023 compilation.  This also enforces the coding style convention
2024 that methods and selectors must be declared before being used.
2025
2026 @item -print-objc-runtime-info
2027 @opindex print-objc-runtime-info
2028 Generate C header describing the largest structure that is passed by
2029 value, if any.
2030
2031 @end table
2032
2033 @node Language Independent Options
2034 @section Options to Control Diagnostic Messages Formatting
2035 @cindex options to control diagnostics formatting
2036 @cindex diagnostic messages
2037 @cindex message formatting
2038
2039 Traditionally, diagnostic messages have been formatted irrespective of
2040 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2041 below can be used to control the diagnostic messages formatting
2042 algorithm, e.g.@: how many characters per line, how often source location
2043 information should be reported.  Right now, only the C++ front end can
2044 honor these options.  However it is expected, in the near future, that
2045 the remaining front ends would be able to digest them correctly.
2046
2047 @table @gcctabopt
2048 @item -fmessage-length=@var{n}
2049 @opindex fmessage-length
2050 Try to format error messages so that they fit on lines of about @var{n}
2051 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2052 the front ends supported by GCC@.  If @var{n} is zero, then no
2053 line-wrapping will be done; each error message will appear on a single
2054 line.
2055
2056 @opindex fdiagnostics-show-location
2057 @item -fdiagnostics-show-location=once
2058 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2059 reporter to emit @emph{once} source location information; that is, in
2060 case the message is too long to fit on a single physical line and has to
2061 be wrapped, the source location won't be emitted (as prefix) again,
2062 over and over, in subsequent continuation lines.  This is the default
2063 behavior.
2064
2065 @item -fdiagnostics-show-location=every-line
2066 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2067 messages reporter to emit the same source location information (as
2068 prefix) for physical lines that result from the process of breaking
2069 a message which is too long to fit on a single line.
2070
2071 @end table
2072
2073 @node Warning Options
2074 @section Options to Request or Suppress Warnings
2075 @cindex options to control warnings
2076 @cindex warning messages
2077 @cindex messages, warning
2078 @cindex suppressing warnings
2079
2080 Warnings are diagnostic messages that report constructions which
2081 are not inherently erroneous but which are risky or suggest there
2082 may have been an error.
2083
2084 You can request many specific warnings with options beginning @samp{-W},
2085 for example @option{-Wimplicit} to request warnings on implicit
2086 declarations.  Each of these specific warning options also has a
2087 negative form beginning @samp{-Wno-} to turn off warnings;
2088 for example, @option{-Wno-implicit}.  This manual lists only one of the
2089 two forms, whichever is not the default.
2090
2091 The following options control the amount and kinds of warnings produced
2092 by GCC; for further, language-specific options also refer to
2093 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2094 Options}.
2095
2096 @table @gcctabopt
2097 @cindex syntax checking
2098 @item -fsyntax-only
2099 @opindex fsyntax-only
2100 Check the code for syntax errors, but don't do anything beyond that.
2101
2102 @item -pedantic
2103 @opindex pedantic
2104 Issue all the warnings demanded by strict ISO C and ISO C++;
2105 reject all programs that use forbidden extensions, and some other
2106 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2107 version of the ISO C standard specified by any @option{-std} option used.
2108
2109 Valid ISO C and ISO C++ programs should compile properly with or without
2110 this option (though a rare few will require @option{-ansi} or a
2111 @option{-std} option specifying the required version of ISO C)@.  However,
2112 without this option, certain GNU extensions and traditional C and C++
2113 features are supported as well.  With this option, they are rejected.
2114
2115 @option{-pedantic} does not cause warning messages for use of the
2116 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2117 warnings are also disabled in the expression that follows
2118 @code{__extension__}.  However, only system header files should use
2119 these escape routes; application programs should avoid them.
2120 @xref{Alternate Keywords}.
2121
2122 Some users try to use @option{-pedantic} to check programs for strict ISO
2123 C conformance.  They soon find that it does not do quite what they want:
2124 it finds some non-ISO practices, but not all---only those for which
2125 ISO C @emph{requires} a diagnostic, and some others for which
2126 diagnostics have been added.
2127
2128 A feature to report any failure to conform to ISO C might be useful in
2129 some instances, but would require considerable additional work and would
2130 be quite different from @option{-pedantic}.  We don't have plans to
2131 support such a feature in the near future.
2132
2133 Where the standard specified with @option{-std} represents a GNU
2134 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2135 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2136 extended dialect is based.  Warnings from @option{-pedantic} are given
2137 where they are required by the base standard.  (It would not make sense
2138 for such warnings to be given only for features not in the specified GNU
2139 C dialect, since by definition the GNU dialects of C include all
2140 features the compiler supports with the given option, and there would be
2141 nothing to warn about.)
2142
2143 @item -pedantic-errors
2144 @opindex pedantic-errors
2145 Like @option{-pedantic}, except that errors are produced rather than
2146 warnings.
2147
2148 @item -w
2149 @opindex w
2150 Inhibit all warning messages.
2151
2152 @item -Wno-import
2153 @opindex Wno-import
2154 Inhibit warning messages about the use of @samp{#import}.
2155
2156 @item -Wchar-subscripts
2157 @opindex Wchar-subscripts
2158 Warn if an array subscript has type @code{char}.  This is a common cause
2159 of error, as programmers often forget that this type is signed on some
2160 machines.
2161
2162 @item -Wcomment
2163 @opindex Wcomment
2164 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2165 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2166
2167 @item -Wfatal-errors
2168 @opindex Wfatal-errors
2169 This option causes the compiler to abort compilation on the first error
2170 occurred rather than trying to keep going and printing further error
2171 messages.
2172
2173 @item -Wformat
2174 @opindex Wformat
2175 @opindex ffreestanding
2176 @opindex fno-builtin
2177 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2178 the arguments supplied have types appropriate to the format string
2179 specified, and that the conversions specified in the format string make
2180 sense.  This includes standard functions, and others specified by format
2181 attributes (@pxref{Function Attributes}), in the @code{printf},
2182 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2183 not in the C standard) families (or other target-specific families).
2184 Which functions are checked without format attributes having been
2185 specified depends on the standard version selected, and such checks of
2186 functions without the attribute specified are disabled by
2187 @option{-ffreestanding} or @option{-fno-builtin}.
2188
2189 The formats are checked against the format features supported by GNU
2190 libc version 2.2.  These include all ISO C90 and C99 features, as well
2191 as features from the Single Unix Specification and some BSD and GNU
2192 extensions.  Other library implementations may not support all these
2193 features; GCC does not support warning about features that go beyond a
2194 particular library's limitations.  However, if @option{-pedantic} is used
2195 with @option{-Wformat}, warnings will be given about format features not
2196 in the selected standard version (but not for @code{strfmon} formats,
2197 since those are not in any version of the C standard).  @xref{C Dialect
2198 Options,,Options Controlling C Dialect}.
2199
2200 Since @option{-Wformat} also checks for null format arguments for
2201 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2202
2203 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2204 aspects of format checking, the options @option{-Wformat-y2k},
2205 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2206 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2207 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2208
2209 @item -Wformat-y2k
2210 @opindex Wformat-y2k
2211 If @option{-Wformat} is specified, also warn about @code{strftime}
2212 formats which may yield only a two-digit year.
2213
2214 @item -Wno-format-extra-args
2215 @opindex Wno-format-extra-args
2216 If @option{-Wformat} is specified, do not warn about excess arguments to a
2217 @code{printf} or @code{scanf} format function.  The C standard specifies
2218 that such arguments are ignored.
2219
2220 Where the unused arguments lie between used arguments that are
2221 specified with @samp{$} operand number specifications, normally
2222 warnings are still given, since the implementation could not know what
2223 type to pass to @code{va_arg} to skip the unused arguments.  However,
2224 in the case of @code{scanf} formats, this option will suppress the
2225 warning if the unused arguments are all pointers, since the Single
2226 Unix Specification says that such unused arguments are allowed.
2227
2228 @item -Wno-format-zero-length
2229 @opindex Wno-format-zero-length
2230 If @option{-Wformat} is specified, do not warn about zero-length formats.
2231 The C standard specifies that zero-length formats are allowed.
2232
2233 @item -Wformat-nonliteral
2234 @opindex Wformat-nonliteral
2235 If @option{-Wformat} is specified, also warn if the format string is not a
2236 string literal and so cannot be checked, unless the format function
2237 takes its format arguments as a @code{va_list}.
2238
2239 @item -Wformat-security
2240 @opindex Wformat-security
2241 If @option{-Wformat} is specified, also warn about uses of format
2242 functions that represent possible security problems.  At present, this
2243 warns about calls to @code{printf} and @code{scanf} functions where the
2244 format string is not a string literal and there are no format arguments,
2245 as in @code{printf (foo);}.  This may be a security hole if the format
2246 string came from untrusted input and contains @samp{%n}.  (This is
2247 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2248 in future warnings may be added to @option{-Wformat-security} that are not
2249 included in @option{-Wformat-nonliteral}.)
2250
2251 @item -Wformat=2
2252 @opindex Wformat=2
2253 Enable @option{-Wformat} plus format checks not included in
2254 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2255 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2256
2257 @item -Wnonnull
2258 @opindex Wnonnull
2259 Warn about passing a null pointer for arguments marked as
2260 requiring a non-null value by the @code{nonnull} function attribute.
2261
2262 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2263 can be disabled with the @option{-Wno-nonnull} option.
2264
2265 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2266 @opindex Winit-self
2267 Warn about uninitialized variables which are initialized with themselves.
2268 Note this option can only be used with the @option{-Wuninitialized} option,
2269 which in turn only works with @option{-O1} and above.
2270
2271 For example, GCC will warn about @code{i} being uninitialized in the
2272 following snippet only when @option{-Winit-self} has been specified:
2273 @smallexample
2274 @group
2275 int f()
2276 @{
2277   int i = i;
2278   return i;
2279 @}
2280 @end group
2281 @end smallexample
2282
2283 @item -Wimplicit-int
2284 @opindex Wimplicit-int
2285 Warn when a declaration does not specify a type.
2286
2287 @item -Wimplicit-function-declaration
2288 @itemx -Werror-implicit-function-declaration
2289 @opindex Wimplicit-function-declaration
2290 @opindex Werror-implicit-function-declaration
2291 Give a warning (or error) whenever a function is used before being
2292 declared.
2293
2294 @item -Wimplicit
2295 @opindex Wimplicit
2296 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2297
2298 @item -Wmain
2299 @opindex Wmain
2300 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2301 function with external linkage, returning int, taking either zero
2302 arguments, two, or three arguments of appropriate types.
2303
2304 @item -Wmissing-braces
2305 @opindex Wmissing-braces
2306 Warn if an aggregate or union initializer is not fully bracketed.  In
2307 the following example, the initializer for @samp{a} is not fully
2308 bracketed, but that for @samp{b} is fully bracketed.
2309
2310 @smallexample
2311 int a[2][2] = @{ 0, 1, 2, 3 @};
2312 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2313 @end smallexample
2314
2315 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2316 @opindex Wmissing-include-dirs
2317 Warn if a user-supplied include directory does not exist.
2318
2319 @item -Wparentheses
2320 @opindex Wparentheses
2321 Warn if parentheses are omitted in certain contexts, such
2322 as when there is an assignment in a context where a truth value
2323 is expected, or when operators are nested whose precedence people
2324 often get confused about.  Only the warning for an assignment used as
2325 a truth value is supported when compiling C++; the other warnings are
2326 only supported when compiling C@.
2327
2328 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2329 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2330 interpretation from that of ordinary mathematical notation.
2331
2332 Also warn about constructions where there may be confusion to which
2333 @code{if} statement an @code{else} branch belongs.  Here is an example of
2334 such a case:
2335
2336 @smallexample
2337 @group
2338 @{
2339   if (a)
2340     if (b)
2341       foo ();
2342   else
2343     bar ();
2344 @}
2345 @end group
2346 @end smallexample
2347
2348 In C, every @code{else} branch belongs to the innermost possible @code{if}
2349 statement, which in this example is @code{if (b)}.  This is often not
2350 what the programmer expected, as illustrated in the above example by
2351 indentation the programmer chose.  When there is the potential for this
2352 confusion, GCC will issue a warning when this flag is specified.
2353 To eliminate the warning, add explicit braces around the innermost
2354 @code{if} statement so there is no way the @code{else} could belong to
2355 the enclosing @code{if}.  The resulting code would look like this:
2356
2357 @smallexample
2358 @group
2359 @{
2360   if (a)
2361     @{
2362       if (b)
2363         foo ();
2364       else
2365         bar ();
2366     @}
2367 @}
2368 @end group
2369 @end smallexample
2370
2371 @item -Wsequence-point
2372 @opindex Wsequence-point
2373 Warn about code that may have undefined semantics because of violations
2374 of sequence point rules in the C standard.
2375
2376 The C standard defines the order in which expressions in a C program are
2377 evaluated in terms of @dfn{sequence points}, which represent a partial
2378 ordering between the execution of parts of the program: those executed
2379 before the sequence point, and those executed after it.  These occur
2380 after the evaluation of a full expression (one which is not part of a
2381 larger expression), after the evaluation of the first operand of a
2382 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2383 function is called (but after the evaluation of its arguments and the
2384 expression denoting the called function), and in certain other places.
2385 Other than as expressed by the sequence point rules, the order of
2386 evaluation of subexpressions of an expression is not specified.  All
2387 these rules describe only a partial order rather than a total order,
2388 since, for example, if two functions are called within one expression
2389 with no sequence point between them, the order in which the functions
2390 are called is not specified.  However, the standards committee have
2391 ruled that function calls do not overlap.
2392
2393 It is not specified when between sequence points modifications to the
2394 values of objects take effect.  Programs whose behavior depends on this
2395 have undefined behavior; the C standard specifies that ``Between the
2396 previous and next sequence point an object shall have its stored value
2397 modified at most once by the evaluation of an expression.  Furthermore,
2398 the prior value shall be read only to determine the value to be
2399 stored.''.  If a program breaks these rules, the results on any
2400 particular implementation are entirely unpredictable.
2401
2402 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2403 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2404 diagnosed by this option, and it may give an occasional false positive
2405 result, but in general it has been found fairly effective at detecting
2406 this sort of problem in programs.
2407
2408 The present implementation of this option only works for C programs.  A
2409 future implementation may also work for C++ programs.
2410
2411 The C standard is worded confusingly, therefore there is some debate
2412 over the precise meaning of the sequence point rules in subtle cases.
2413 Links to discussions of the problem, including proposed formal
2414 definitions, may be found on the GCC readings page, at
2415 @w{@uref{http://gcc.gnu.org/readings.html}}.
2416
2417 @item -Wreturn-type
2418 @opindex Wreturn-type
2419 Warn whenever a function is defined with a return-type that defaults to
2420 @code{int}.  Also warn about any @code{return} statement with no
2421 return-value in a function whose return-type is not @code{void}.
2422
2423 For C, also warn if the return type of a function has a type qualifier
2424 such as @code{const}.  Such a type qualifier has no effect, since the
2425 value returned by a function is not an lvalue.  ISO C prohibits
2426 qualified @code{void} return types on function definitions, so such
2427 return types always receive a warning even without this option.
2428
2429 For C++, a function without return type always produces a diagnostic
2430 message, even when @option{-Wno-return-type} is specified.  The only
2431 exceptions are @samp{main} and functions defined in system headers.
2432
2433 @item -Wswitch
2434 @opindex Wswitch
2435 Warn whenever a @code{switch} statement has an index of enumerated type
2436 and lacks a @code{case} for one or more of the named codes of that
2437 enumeration.  (The presence of a @code{default} label prevents this
2438 warning.)  @code{case} labels outside the enumeration range also
2439 provoke warnings when this option is used.
2440
2441 @item -Wswitch-default
2442 @opindex Wswitch-switch
2443 Warn whenever a @code{switch} statement does not have a @code{default}
2444 case.
2445
2446 @item -Wswitch-enum
2447 @opindex Wswitch-enum
2448 Warn whenever a @code{switch} statement has an index of enumerated type
2449 and lacks a @code{case} for one or more of the named codes of that
2450 enumeration.  @code{case} labels outside the enumeration range also
2451 provoke warnings when this option is used.
2452
2453 @item -Wtrigraphs
2454 @opindex Wtrigraphs
2455 Warn if any trigraphs are encountered that might change the meaning of
2456 the program (trigraphs within comments are not warned about).
2457
2458 @item -Wunused-function
2459 @opindex Wunused-function
2460 Warn whenever a static function is declared but not defined or a
2461 non\-inline static function is unused.
2462
2463 @item -Wunused-label
2464 @opindex Wunused-label
2465 Warn whenever a label is declared but not used.
2466
2467 To suppress this warning use the @samp{unused} attribute
2468 (@pxref{Variable Attributes}).
2469
2470 @item -Wunused-parameter
2471 @opindex Wunused-parameter
2472 Warn whenever a function parameter is unused aside from its declaration.
2473
2474 To suppress this warning use the @samp{unused} attribute
2475 (@pxref{Variable Attributes}).
2476
2477 @item -Wunused-variable
2478 @opindex Wunused-variable
2479 Warn whenever a local variable or non-constant static variable is unused
2480 aside from its declaration
2481
2482 To suppress this warning use the @samp{unused} attribute
2483 (@pxref{Variable Attributes}).
2484
2485 @item -Wunused-value
2486 @opindex Wunused-value
2487 Warn whenever a statement computes a result that is explicitly not used.
2488
2489 To suppress this warning cast the expression to @samp{void}.
2490
2491 @item -Wunused
2492 @opindex Wunused
2493 All the above @option{-Wunused} options combined.
2494
2495 In order to get a warning about an unused function parameter, you must
2496 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2497 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2498
2499 @item -Wuninitialized
2500 @opindex Wuninitialized
2501 Warn if an automatic variable is used without first being initialized or
2502 if a variable may be clobbered by a @code{setjmp} call.
2503
2504 These warnings are possible only in optimizing compilation,
2505 because they require data flow information that is computed only
2506 when optimizing.  If you don't specify @option{-O}, you simply won't
2507 get these warnings.
2508
2509 If you want to warn about code which uses the uninitialized value of the
2510 variable in its own initializer, use the @option{-Winit-self} option.
2511
2512 These warnings occur only for variables that are candidates for
2513 register allocation.  Therefore, they do not occur for a variable that
2514 is declared @code{volatile}, or whose address is taken, or whose size
2515 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2516 structures, unions or arrays, even when they are in registers.
2517
2518 Note that there may be no warning about a variable that is used only
2519 to compute a value that itself is never used, because such
2520 computations may be deleted by data flow analysis before the warnings
2521 are printed.
2522
2523 These warnings are made optional because GCC is not smart
2524 enough to see all the reasons why the code might be correct
2525 despite appearing to have an error.  Here is one example of how
2526 this can happen:
2527
2528 @smallexample
2529 @group
2530 @{
2531   int x;
2532   switch (y)
2533     @{
2534     case 1: x = 1;
2535       break;
2536     case 2: x = 4;
2537       break;
2538     case 3: x = 5;
2539     @}
2540   foo (x);
2541 @}
2542 @end group
2543 @end smallexample
2544
2545 @noindent
2546 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2547 always initialized, but GCC doesn't know this.  Here is
2548 another common case:
2549
2550 @smallexample
2551 @{
2552   int save_y;
2553   if (change_y) save_y = y, y = new_y;
2554   @dots{}
2555   if (change_y) y = save_y;
2556 @}
2557 @end smallexample
2558
2559 @noindent
2560 This has no bug because @code{save_y} is used only if it is set.
2561
2562 @cindex @code{longjmp} warnings
2563 This option also warns when a non-volatile automatic variable might be
2564 changed by a call to @code{longjmp}.  These warnings as well are possible
2565 only in optimizing compilation.
2566
2567 The compiler sees only the calls to @code{setjmp}.  It cannot know
2568 where @code{longjmp} will be called; in fact, a signal handler could
2569 call it at any point in the code.  As a result, you may get a warning
2570 even when there is in fact no problem because @code{longjmp} cannot
2571 in fact be called at the place which would cause a problem.
2572
2573 Some spurious warnings can be avoided if you declare all the functions
2574 you use that never return as @code{noreturn}.  @xref{Function
2575 Attributes}.
2576
2577 @item -Wunknown-pragmas
2578 @opindex Wunknown-pragmas
2579 @cindex warning for unknown pragmas
2580 @cindex unknown pragmas, warning
2581 @cindex pragmas, warning of unknown
2582 Warn when a #pragma directive is encountered which is not understood by
2583 GCC@.  If this command line option is used, warnings will even be issued
2584 for unknown pragmas in system header files.  This is not the case if
2585 the warnings were only enabled by the @option{-Wall} command line option.
2586
2587 @item -Wstrict-aliasing
2588 @opindex Wstrict-aliasing
2589 This option is only active when @option{-fstrict-aliasing} is active.
2590 It warns about code which might break the strict aliasing rules that the
2591 compiler is using for optimization. The warning does not catch all
2592 cases, but does attempt to catch the more common pitfalls. It is
2593 included in @option{-Wall}.
2594
2595 @item -Wstrict-aliasing=2
2596 @opindex Wstrict-aliasing=2
2597 This option is only active when @option{-fstrict-aliasing} is active.
2598 It warns about all code which might break the strict aliasing rules that the
2599 compiler is using for optimization.  This warning catches all cases, but
2600 it will also give a warning for some ambiguous cases that are safe.
2601
2602 @item -Wall
2603 @opindex Wall
2604 All of the above @samp{-W} options combined.  This enables all the
2605 warnings about constructions that some users consider questionable, and
2606 that are easy to avoid (or modify to prevent the warning), even in
2607 conjunction with macros.  This also enables some language-specific
2608 warnings described in @ref{C++ Dialect Options} and
2609 @ref{Objective-C and Objective-C++ Dialect Options}.
2610 @end table
2611
2612 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2613 Some of them warn about constructions that users generally do not
2614 consider questionable, but which occasionally you might wish to check
2615 for; others warn about constructions that are necessary or hard to avoid
2616 in some cases, and there is no simple way to modify the code to suppress
2617 the warning.
2618
2619 @table @gcctabopt
2620 @item -Wextra
2621 @opindex W
2622 @opindex Wextra
2623 (This option used to be called @option{-W}.  The older name is still
2624 supported, but the newer name is more descriptive.)  Print extra warning
2625 messages for these events:
2626
2627 @itemize @bullet
2628 @item
2629 A function can return either with or without a value.  (Falling
2630 off the end of the function body is considered returning without
2631 a value.)  For example, this function would evoke such a
2632 warning:
2633
2634 @smallexample
2635 @group
2636 foo (a)
2637 @{
2638   if (a > 0)
2639     return a;
2640 @}
2641 @end group
2642 @end smallexample
2643
2644 @item
2645 An expression-statement or the left-hand side of a comma expression
2646 contains no side effects.
2647 To suppress the warning, cast the unused expression to void.
2648 For example, an expression such as @samp{x[i,j]} will cause a warning,
2649 but @samp{x[(void)i,j]} will not.
2650
2651 @item
2652 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2653
2654 @item
2655 Storage-class specifiers like @code{static} are not the first things in
2656 a declaration.  According to the C Standard, this usage is obsolescent.
2657
2658 @item
2659 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2660 arguments.
2661
2662 @item
2663 A comparison between signed and unsigned values could produce an
2664 incorrect result when the signed value is converted to unsigned.
2665 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2666
2667 @item
2668 An aggregate has an initializer which does not initialize all members.
2669 This warning can be independently controlled by
2670 @option{-Wmissing-field-initializers}.
2671
2672 @item
2673 A function parameter is declared without a type specifier in K&R-style
2674 functions:
2675
2676 @smallexample
2677 void foo(bar) @{ @}
2678 @end smallexample
2679
2680 @item
2681 An empty body occurs in an @samp{if} or @samp{else} statement.
2682
2683 @item
2684 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2685 @samp{>}, or @samp{>=}.
2686
2687 @item
2688 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2689
2690 @item
2691 Any of several floating-point events that often indicate errors, such as
2692 overflow, underflow, loss of precision, etc.
2693
2694 @item @r{(C++ only)}
2695 An enumerator and a non-enumerator both appear in a conditional expression.
2696
2697 @item @r{(C++ only)}
2698 A non-static reference or non-static @samp{const} member appears in a
2699 class without constructors.
2700
2701 @item @r{(C++ only)}
2702 Ambiguous virtual bases.
2703
2704 @item @r{(C++ only)}
2705 Subscripting an array which has been declared @samp{register}.
2706
2707 @item @r{(C++ only)}
2708 Taking the address of a variable which has been declared @samp{register}.
2709
2710 @item @r{(C++ only)}
2711 A base class is not initialized in a derived class' copy constructor.
2712 @end itemize
2713
2714 @item -Wno-div-by-zero
2715 @opindex Wno-div-by-zero
2716 @opindex Wdiv-by-zero
2717 Do not warn about compile-time integer division by zero.  Floating point
2718 division by zero is not warned about, as it can be a legitimate way of
2719 obtaining infinities and NaNs.
2720
2721 @item -Wsystem-headers
2722 @opindex Wsystem-headers
2723 @cindex warnings from system headers
2724 @cindex system headers, warnings from
2725 Print warning messages for constructs found in system header files.
2726 Warnings from system headers are normally suppressed, on the assumption
2727 that they usually do not indicate real problems and would only make the
2728 compiler output harder to read.  Using this command line option tells
2729 GCC to emit warnings from system headers as if they occurred in user
2730 code.  However, note that using @option{-Wall} in conjunction with this
2731 option will @emph{not} warn about unknown pragmas in system
2732 headers---for that, @option{-Wunknown-pragmas} must also be used.
2733
2734 @item -Wfloat-equal
2735 @opindex Wfloat-equal
2736 Warn if floating point values are used in equality comparisons.
2737
2738 The idea behind this is that sometimes it is convenient (for the
2739 programmer) to consider floating-point values as approximations to
2740 infinitely precise real numbers.  If you are doing this, then you need
2741 to compute (by analyzing the code, or in some other way) the maximum or
2742 likely maximum error that the computation introduces, and allow for it
2743 when performing comparisons (and when producing output, but that's a
2744 different problem).  In particular, instead of testing for equality, you
2745 would check to see whether the two values have ranges that overlap; and
2746 this is done with the relational operators, so equality comparisons are
2747 probably mistaken.
2748
2749 @item -Wtraditional @r{(C only)}
2750 @opindex Wtraditional
2751 Warn about certain constructs that behave differently in traditional and
2752 ISO C@.  Also warn about ISO C constructs that have no traditional C
2753 equivalent, and/or problematic constructs which should be avoided.
2754
2755 @itemize @bullet
2756 @item
2757 Macro parameters that appear within string literals in the macro body.
2758 In traditional C macro replacement takes place within string literals,
2759 but does not in ISO C@.
2760
2761 @item
2762 In traditional C, some preprocessor directives did not exist.
2763 Traditional preprocessors would only consider a line to be a directive
2764 if the @samp{#} appeared in column 1 on the line.  Therefore
2765 @option{-Wtraditional} warns about directives that traditional C
2766 understands but would ignore because the @samp{#} does not appear as the
2767 first character on the line.  It also suggests you hide directives like
2768 @samp{#pragma} not understood by traditional C by indenting them.  Some
2769 traditional implementations would not recognize @samp{#elif}, so it
2770 suggests avoiding it altogether.
2771
2772 @item
2773 A function-like macro that appears without arguments.
2774
2775 @item
2776 The unary plus operator.
2777
2778 @item
2779 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2780 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2781 constants.)  Note, these suffixes appear in macros defined in the system
2782 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2783 Use of these macros in user code might normally lead to spurious
2784 warnings, however GCC's integrated preprocessor has enough context to
2785 avoid warning in these cases.
2786
2787 @item
2788 A function declared external in one block and then used after the end of
2789 the block.
2790
2791 @item
2792 A @code{switch} statement has an operand of type @code{long}.
2793
2794 @item
2795 A non-@code{static} function declaration follows a @code{static} one.
2796 This construct is not accepted by some traditional C compilers.
2797
2798 @item
2799 The ISO type of an integer constant has a different width or
2800 signedness from its traditional type.  This warning is only issued if
2801 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2802 typically represent bit patterns, are not warned about.
2803
2804 @item
2805 Usage of ISO string concatenation is detected.
2806
2807 @item
2808 Initialization of automatic aggregates.
2809
2810 @item
2811 Identifier conflicts with labels.  Traditional C lacks a separate
2812 namespace for labels.
2813
2814 @item
2815 Initialization of unions.  If the initializer is zero, the warning is
2816 omitted.  This is done under the assumption that the zero initializer in
2817 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2818 initializer warnings and relies on default initialization to zero in the
2819 traditional C case.
2820
2821 @item
2822 Conversions by prototypes between fixed/floating point values and vice
2823 versa.  The absence of these prototypes when compiling with traditional
2824 C would cause serious problems.  This is a subset of the possible
2825 conversion warnings, for the full set use @option{-Wconversion}.
2826
2827 @item
2828 Use of ISO C style function definitions.  This warning intentionally is
2829 @emph{not} issued for prototype declarations or variadic functions
2830 because these ISO C features will appear in your code when using
2831 libiberty's traditional C compatibility macros, @code{PARAMS} and
2832 @code{VPARAMS}.  This warning is also bypassed for nested functions
2833 because that feature is already a GCC extension and thus not relevant to
2834 traditional C compatibility.
2835 @end itemize
2836
2837 @item -Wdeclaration-after-statement @r{(C only)}
2838 @opindex Wdeclaration-after-statement
2839 Warn when a declaration is found after a statement in a block.  This
2840 construct, known from C++, was introduced with ISO C99 and is by default
2841 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2842 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2843
2844 @item -Wundef
2845 @opindex Wundef
2846 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2847
2848 @item -Wendif-labels
2849 @opindex Wendif-labels
2850 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2851
2852 @item -Wshadow
2853 @opindex Wshadow
2854 Warn whenever a local variable shadows another local variable, parameter or
2855 global variable or whenever a built-in function is shadowed.
2856
2857 @item -Wlarger-than-@var{len}
2858 @opindex Wlarger-than
2859 Warn whenever an object of larger than @var{len} bytes is defined.
2860
2861 @item -Wpointer-arith
2862 @opindex Wpointer-arith
2863 Warn about anything that depends on the ``size of'' a function type or
2864 of @code{void}.  GNU C assigns these types a size of 1, for
2865 convenience in calculations with @code{void *} pointers and pointers
2866 to functions.
2867
2868 @item -Wbad-function-cast @r{(C only)}
2869 @opindex Wbad-function-cast
2870 Warn whenever a function call is cast to a non-matching type.
2871 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2872
2873 @item -Wcast-qual
2874 @opindex Wcast-qual
2875 Warn whenever a pointer is cast so as to remove a type qualifier from
2876 the target type.  For example, warn if a @code{const char *} is cast
2877 to an ordinary @code{char *}.
2878
2879 @item -Wcast-align
2880 @opindex Wcast-align
2881 Warn whenever a pointer is cast such that the required alignment of the
2882 target is increased.  For example, warn if a @code{char *} is cast to
2883 an @code{int *} on machines where integers can only be accessed at
2884 two- or four-byte boundaries.
2885
2886 @item -Wwrite-strings
2887 @opindex Wwrite-strings
2888 When compiling C, give string constants the type @code{const
2889 char[@var{length}]} so that
2890 copying the address of one into a non-@code{const} @code{char *}
2891 pointer will get a warning; when compiling C++, warn about the
2892 deprecated conversion from string constants to @code{char *}.
2893 These warnings will help you find at
2894 compile time code that can try to write into a string constant, but
2895 only if you have been very careful about using @code{const} in
2896 declarations and prototypes.  Otherwise, it will just be a nuisance;
2897 this is why we did not make @option{-Wall} request these warnings.
2898
2899 @item -Wconversion
2900 @opindex Wconversion
2901 Warn if a prototype causes a type conversion that is different from what
2902 would happen to the same argument in the absence of a prototype.  This
2903 includes conversions of fixed point to floating and vice versa, and
2904 conversions changing the width or signedness of a fixed point argument
2905 except when the same as the default promotion.
2906
2907 Also, warn if a negative integer constant expression is implicitly
2908 converted to an unsigned type.  For example, warn about the assignment
2909 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2910 casts like @code{(unsigned) -1}.
2911
2912 @item -Wsign-compare
2913 @opindex Wsign-compare
2914 @cindex warning for comparison of signed and unsigned values
2915 @cindex comparison of signed and unsigned values, warning
2916 @cindex signed and unsigned values, comparison warning
2917 Warn when a comparison between signed and unsigned values could produce
2918 an incorrect result when the signed value is converted to unsigned.
2919 This warning is also enabled by @option{-Wextra}; to get the other warnings
2920 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2921
2922 @item -Waggregate-return
2923 @opindex Waggregate-return
2924 Warn if any functions that return structures or unions are defined or
2925 called.  (In languages where you can return an array, this also elicits
2926 a warning.)
2927
2928 @item -Wstrict-prototypes @r{(C only)}
2929 @opindex Wstrict-prototypes
2930 Warn if a function is declared or defined without specifying the
2931 argument types.  (An old-style function definition is permitted without
2932 a warning if preceded by a declaration which specifies the argument
2933 types.)
2934
2935 @item -Wold-style-definition @r{(C only)}
2936 @opindex Wold-style-definition
2937 Warn if an old-style function definition is used.  A warning is given
2938 even if there is a previous prototype.
2939
2940 @item -Wmissing-prototypes @r{(C only)}
2941 @opindex Wmissing-prototypes
2942 Warn if a global function is defined without a previous prototype
2943 declaration.  This warning is issued even if the definition itself
2944 provides a prototype.  The aim is to detect global functions that fail
2945 to be declared in header files.
2946
2947 @item -Wmissing-declarations @r{(C only)}
2948 @opindex Wmissing-declarations
2949 Warn if a global function is defined without a previous declaration.
2950 Do so even if the definition itself provides a prototype.
2951 Use this option to detect global functions that are not declared in
2952 header files.
2953
2954 @item -Wmissing-field-initializers
2955 @opindex Wmissing-field-initializers
2956 @opindex W
2957 @opindex Wextra
2958 Warn if a structure's initializer has some fields missing.  For
2959 example, the following code would cause such a warning, because
2960 @code{x.h} is implicitly zero:
2961
2962 @smallexample
2963 struct s @{ int f, g, h; @};
2964 struct s x = @{ 3, 4 @};
2965 @end smallexample
2966
2967 This option does not warn about designated initializers, so the following
2968 modification would not trigger a warning:
2969
2970 @smallexample
2971 struct s @{ int f, g, h; @};
2972 struct s x = @{ .f = 3, .g = 4 @};
2973 @end smallexample
2974
2975 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2976 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2977
2978 @item -Wmissing-noreturn
2979 @opindex Wmissing-noreturn
2980 Warn about functions which might be candidates for attribute @code{noreturn}.
2981 Note these are only possible candidates, not absolute ones.  Care should
2982 be taken to manually verify functions actually do not ever return before
2983 adding the @code{noreturn} attribute, otherwise subtle code generation
2984 bugs could be introduced.  You will not get a warning for @code{main} in
2985 hosted C environments.
2986
2987 @item -Wmissing-format-attribute
2988 @opindex Wmissing-format-attribute
2989 @opindex Wformat
2990 If @option{-Wformat} is enabled, also warn about functions which might be
2991 candidates for @code{format} attributes.  Note these are only possible
2992 candidates, not absolute ones.  GCC will guess that @code{format}
2993 attributes might be appropriate for any function that calls a function
2994 like @code{vprintf} or @code{vscanf}, but this might not always be the
2995 case, and some functions for which @code{format} attributes are
2996 appropriate may not be detected.  This option has no effect unless
2997 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2998
2999 @item -Wno-multichar
3000 @opindex Wno-multichar
3001 @opindex Wmultichar
3002 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3003 Usually they indicate a typo in the user's code, as they have
3004 implementation-defined values, and should not be used in portable code.
3005
3006 @item -Wno-deprecated-declarations
3007 @opindex Wno-deprecated-declarations
3008 Do not warn about uses of functions, variables, and types marked as
3009 deprecated by using the @code{deprecated} attribute.
3010 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3011 @pxref{Type Attributes}.)
3012
3013 @item -Wpacked
3014 @opindex Wpacked
3015 Warn if a structure is given the packed attribute, but the packed
3016 attribute has no effect on the layout or size of the structure.
3017 Such structures may be mis-aligned for little benefit.  For
3018 instance, in this code, the variable @code{f.x} in @code{struct bar}
3019 will be misaligned even though @code{struct bar} does not itself
3020 have the packed attribute:
3021
3022 @smallexample
3023 @group
3024 struct foo @{
3025   int x;
3026   char a, b, c, d;
3027 @} __attribute__((packed));
3028 struct bar @{
3029   char z;
3030   struct foo f;
3031 @};
3032 @end group
3033 @end smallexample
3034
3035 @item -Wpadded
3036 @opindex Wpadded
3037 Warn if padding is included in a structure, either to align an element
3038 of the structure or to align the whole structure.  Sometimes when this
3039 happens it is possible to rearrange the fields of the structure to
3040 reduce the padding and so make the structure smaller.
3041
3042 @item -Wredundant-decls
3043 @opindex Wredundant-decls
3044 Warn if anything is declared more than once in the same scope, even in
3045 cases where multiple declaration is valid and changes nothing.
3046
3047 @item -Wnested-externs @r{(C only)}
3048 @opindex Wnested-externs
3049 Warn if an @code{extern} declaration is encountered within a function.
3050
3051 @item -Wunreachable-code
3052 @opindex Wunreachable-code
3053 Warn if the compiler detects that code will never be executed.
3054
3055 This option is intended to warn when the compiler detects that at
3056 least a whole line of source code will never be executed, because
3057 some condition is never satisfied or because it is after a
3058 procedure that never returns.
3059
3060 It is possible for this option to produce a warning even though there
3061 are circumstances under which part of the affected line can be executed,
3062 so care should be taken when removing apparently-unreachable code.
3063
3064 For instance, when a function is inlined, a warning may mean that the
3065 line is unreachable in only one inlined copy of the function.
3066
3067 This option is not made part of @option{-Wall} because in a debugging
3068 version of a program there is often substantial code which checks
3069 correct functioning of the program and is, hopefully, unreachable
3070 because the program does work.  Another common use of unreachable
3071 code is to provide behavior which is selectable at compile-time.
3072
3073 @item -Winline
3074 @opindex Winline
3075 Warn if a function can not be inlined and it was declared as inline.
3076 Even with this option, the compiler will not warn about failures to
3077 inline functions declared in system headers.
3078
3079 The compiler uses a variety of heuristics to determine whether or not
3080 to inline a function.  For example, the compiler takes into account
3081 the size of the function being inlined and the the amount of inlining
3082 that has already been done in the current function.  Therefore,
3083 seemingly insignificant changes in the source program can cause the
3084 warnings produced by @option{-Winline} to appear or disappear.
3085
3086 @item -Wno-invalid-offsetof @r{(C++ only)}
3087 @opindex Wno-invalid-offsetof
3088 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3089 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3090 to a non-POD type is undefined.  In existing C++ implementations,
3091 however, @samp{offsetof} typically gives meaningful results even when
3092 applied to certain kinds of non-POD types. (Such as a simple
3093 @samp{struct} that fails to be a POD type only by virtue of having a
3094 constructor.)  This flag is for users who are aware that they are
3095 writing nonportable code and who have deliberately chosen to ignore the
3096 warning about it.
3097
3098 The restrictions on @samp{offsetof} may be relaxed in a future version
3099 of the C++ standard.
3100
3101 @item -Winvalid-pch
3102 @opindex Winvalid-pch
3103 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3104 the search path but can't be used.
3105
3106 @item -Wlong-long
3107 @opindex Wlong-long
3108 @opindex Wno-long-long
3109 Warn if @samp{long long} type is used.  This is default.  To inhibit
3110 the warning messages, use @option{-Wno-long-long}.  Flags
3111 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3112 only when @option{-pedantic} flag is used.
3113
3114 @item -Wvariadic-macros
3115 @opindex Wvariadic-macros
3116 @opindex Wno-variadic-macros
3117 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3118 alternate syntax when in pedantic ISO C99 mode.  This is default.
3119 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3120
3121 @item -Wdisabled-optimization
3122 @opindex Wdisabled-optimization
3123 Warn if a requested optimization pass is disabled.  This warning does
3124 not generally indicate that there is anything wrong with your code; it
3125 merely indicates that GCC's optimizers were unable to handle the code
3126 effectively.  Often, the problem is that your code is too big or too
3127 complex; GCC will refuse to optimize programs when the optimization
3128 itself is likely to take inordinate amounts of time.
3129
3130 @item -Werror
3131 @opindex Werror
3132 Make all warnings into errors.
3133 @end table
3134
3135 @node Debugging Options
3136 @section Options for Debugging Your Program or GCC
3137 @cindex options, debugging
3138 @cindex debugging information options
3139
3140 GCC has various special options that are used for debugging
3141 either your program or GCC:
3142
3143 @table @gcctabopt
3144 @item -g
3145 @opindex g
3146 Produce debugging information in the operating system's native format
3147 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3148 information.
3149
3150 On most systems that use stabs format, @option{-g} enables use of extra
3151 debugging information that only GDB can use; this extra information
3152 makes debugging work better in GDB but will probably make other debuggers
3153 crash or
3154 refuse to read the program.  If you want to control for certain whether
3155 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3156 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3157
3158 GCC allows you to use @option{-g} with
3159 @option{-O}.  The shortcuts taken by optimized code may occasionally
3160 produce surprising results: some variables you declared may not exist
3161 at all; flow of control may briefly move where you did not expect it;
3162 some statements may not be executed because they compute constant
3163 results or their values were already at hand; some statements may
3164 execute in different places because they were moved out of loops.
3165
3166 Nevertheless it proves possible to debug optimized output.  This makes
3167 it reasonable to use the optimizer for programs that might have bugs.
3168
3169 The following options are useful when GCC is generated with the
3170 capability for more than one debugging format.
3171
3172 @item -ggdb
3173 @opindex ggdb
3174 Produce debugging information for use by GDB@.  This means to use the
3175 most expressive format available (DWARF 2, stabs, or the native format
3176 if neither of those are supported), including GDB extensions if at all
3177 possible.
3178
3179 @item -gstabs
3180 @opindex gstabs
3181 Produce debugging information in stabs format (if that is supported),
3182 without GDB extensions.  This is the format used by DBX on most BSD
3183 systems.  On MIPS, Alpha and System V Release 4 systems this option
3184 produces stabs debugging output which is not understood by DBX or SDB@.
3185 On System V Release 4 systems this option requires the GNU assembler.
3186
3187 @item -feliminate-unused-debug-symbols
3188 @opindex feliminate-unused-debug-symbols
3189 Produce debugging information in stabs format (if that is supported),
3190 for only symbols that are actually used.
3191
3192 @item -gstabs+
3193 @opindex gstabs+
3194 Produce debugging information in stabs format (if that is supported),
3195 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3196 use of these extensions is likely to make other debuggers crash or
3197 refuse to read the program.
3198
3199 @item -gcoff
3200 @opindex gcoff
3201 Produce debugging information in COFF format (if that is supported).
3202 This is the format used by SDB on most System V systems prior to
3203 System V Release 4.
3204
3205 @item -gxcoff
3206 @opindex gxcoff
3207 Produce debugging information in XCOFF format (if that is supported).
3208 This is the format used by the DBX debugger on IBM RS/6000 systems.
3209
3210 @item -gxcoff+
3211 @opindex gxcoff+
3212 Produce debugging information in XCOFF format (if that is supported),
3213 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3214 use of these extensions is likely to make other debuggers crash or
3215 refuse to read the program, and may cause assemblers other than the GNU
3216 assembler (GAS) to fail with an error.
3217
3218 @item -gdwarf-2
3219 @opindex gdwarf-2
3220 Produce debugging information in DWARF version 2 format (if that is
3221 supported).  This is the format used by DBX on IRIX 6.  With this
3222 option, GCC uses features of DWARF version 3 when they are useful;
3223 version 3 is upward compatible with version 2, but may still cause
3224 problems for older debuggers.
3225
3226 @item -gvms
3227 @opindex gvms
3228 Produce debugging information in VMS debug format (if that is
3229 supported).  This is the format used by DEBUG on VMS systems.
3230
3231 @item -g@var{level}
3232 @itemx -ggdb@var{level}
3233 @itemx -gstabs@var{level}
3234 @itemx -gcoff@var{level}
3235 @itemx -gxcoff@var{level}
3236 @itemx -gvms@var{level}
3237 Request debugging information and also use @var{level} to specify how
3238 much information.  The default level is 2.
3239
3240 Level 1 produces minimal information, enough for making backtraces in
3241 parts of the program that you don't plan to debug.  This includes
3242 descriptions of functions and external variables, but no information
3243 about local variables and no line numbers.
3244
3245 Level 3 includes extra information, such as all the macro definitions
3246 present in the program.  Some debuggers support macro expansion when
3247 you use @option{-g3}.
3248
3249 @option{-gdwarf-2} does not accept a concatenated debug level, because
3250 GCC used to support an option @option{-gdwarf} that meant to generate
3251 debug information in version 1 of the DWARF format (which is very
3252 different from version 2), and it would have been too confusing.  That
3253 debug format is long obsolete, but the option cannot be changed now.
3254 Instead use an additional @option{-g@var{level}} option to change the
3255 debug level for DWARF2.
3256
3257 @item -feliminate-dwarf2-dups
3258 @opindex feliminate-dwarf2-dups
3259 Compress DWARF2 debugging information by eliminating duplicated
3260 information about each symbol.  This option only makes sense when
3261 generating DWARF2 debugging information with @option{-gdwarf-2}.
3262
3263 @cindex @command{prof}
3264 @item -p
3265 @opindex p
3266 Generate extra code to write profile information suitable for the
3267 analysis program @command{prof}.  You must use this option when compiling
3268 the source files you want data about, and you must also use it when
3269 linking.
3270
3271 @cindex @command{gprof}
3272 @item -pg
3273 @opindex pg
3274 Generate extra code to write profile information suitable for the
3275 analysis program @command{gprof}.  You must use this option when compiling
3276 the source files you want data about, and you must also use it when
3277 linking.
3278
3279 @item -Q
3280 @opindex Q
3281 Makes the compiler print out each function name as it is compiled, and
3282 print some statistics about each pass when it finishes.
3283
3284 @item -ftime-report
3285 @opindex ftime-report
3286 Makes the compiler print some statistics about the time consumed by each
3287 pass when it finishes.
3288
3289 @item -fmem-report
3290 @opindex fmem-report
3291 Makes the compiler print some statistics about permanent memory
3292 allocation when it finishes.
3293
3294 @item -fprofile-arcs
3295 @opindex fprofile-arcs
3296 Add code so that program flow @dfn{arcs} are instrumented.  During
3297 execution the program records how many times each branch and call is
3298 executed and how many times it is taken or returns.  When the compiled
3299 program exits it saves this data to a file called
3300 @file{@var{auxname}.gcda} for each source file. The data may be used for
3301 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3302 test coverage analysis (@option{-ftest-coverage}). Each object file's
3303 @var{auxname} is generated from the name of the output file, if
3304 explicitly specified and it is not the final executable, otherwise it is
3305 the basename of the source file. In both cases any suffix is removed
3306 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3307 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3308
3309 @itemize
3310
3311 @item
3312 Compile the source files with @option{-fprofile-arcs} plus optimization
3313 and code generation options. For test coverage analysis, use the
3314 additional @option{-ftest-coverage} option. You do not need to profile
3315 every source file in a program.
3316
3317 @item
3318 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3319 (the latter implies the former).
3320
3321 @item
3322 Run the program on a representative workload to generate the arc profile
3323 information. This may be repeated any number of times. You can run
3324 concurrent instances of your program, and provided that the file system
3325 supports locking, the data files will be correctly updated. Also
3326 @code{fork} calls are detected and correctly handled (double counting
3327 will not happen).
3328
3329 @item
3330 For profile-directed optimizations, compile the source files again with
3331 the same optimization and code generation options plus
3332 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3333 Control Optimization}).
3334
3335 @item
3336 For test coverage analysis, use @command{gcov} to produce human readable
3337 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3338 @command{gcov} documentation for further information.
3339
3340 @end itemize
3341
3342 With @option{-fprofile-arcs}, for each function of your program GCC
3343 creates a program flow graph, then finds a spanning tree for the graph.
3344 Only arcs that are not on the spanning tree have to be instrumented: the
3345 compiler adds code to count the number of times that these arcs are
3346 executed.  When an arc is the only exit or only entrance to a block, the
3347 instrumentation code can be added to the block; otherwise, a new basic
3348 block must be created to hold the instrumentation code.
3349
3350 @item -ftree-based-profiling
3351 @opindex ftree-based-profiling
3352 This option is used in addition to @option{-fprofile-arcs} or
3353 @option{-fbranch-probabilities} to control whether those optimizations
3354 are performed on a tree-based or rtl-based internal representation.
3355 If you use this option when compiling with @option{-fprofile-arcs},
3356 you must also use it when compiling later with @option{-fbranch-probabilities}.
3357 Currently the tree-based optimization is in an early stage of
3358 development, and this option is recommended only for those people
3359 working on improving it.
3360
3361 @need 2000
3362 @item -ftest-coverage
3363 @opindex ftest-coverage
3364 Produce a notes file that the @command{gcov} code-coverage utility
3365 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3366 show program coverage. Each source file's note file is called
3367 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3368 above for a description of @var{auxname} and instructions on how to
3369 generate test coverage data. Coverage data will match the source files
3370 more closely, if you do not optimize.
3371
3372 @item -d@var{letters}
3373 @item -fdump-rtl-@var{pass}
3374 @opindex d
3375 Says to make debugging dumps during compilation at times specified by
3376 @var{letters}.    This is used for debugging the RTL-based passes of the
3377 compiler.  The file names for most of the dumps are made by appending a
3378 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3379 from the name of the output file, if explicitly specified and it is not
3380 an executable, otherwise it is the basename of the source file.
3381
3382 Most debug dumps can be enabled either passing a letter to the @option{-d}
3383 option, or with a long @option{-fdump-rtl} switch; here are the possible
3384 letters for use in @var{letters} and @var{pass}, and their meanings:
3385
3386 @table @gcctabopt
3387 @item -dA
3388 @opindex dA
3389 Annotate the assembler output with miscellaneous debugging information.
3390
3391 @item -db
3392 @itemx -fdump-rtl-bp
3393 @opindex db
3394 @opindex fdump-rtl-bp
3395 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3396
3397 @item -dB
3398 @itemx -fdump-rtl-bbro
3399 @opindex dB
3400 @opindex fdump-rtl-bbro
3401 Dump after block reordering, to @file{@var{file}.30.bbro}.
3402
3403 @item -dc
3404 @itemx -fdump-rtl-combine
3405 @opindex dc
3406 @opindex fdump-rtl-combine
3407 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3408
3409 @item -dC
3410 @itemx -fdump-rtl-ce1
3411 @itemx -fdump-rtl-ce2
3412 @opindex dC
3413 @opindex fdump-rtl-ce1
3414 @opindex fdump-rtl-ce2
3415 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3416 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3417 and @option{-fdump-rtl-ce2} enable dumping after the second if
3418 conversion, to the file @file{@var{file}.18.ce2}.
3419
3420 @item -dd
3421 @itemx -fdump-rtl-btl
3422 @itemx -fdump-rtl-dbr
3423 @opindex dd
3424 @opindex fdump-rtl-btl
3425 @opindex fdump-rtl-dbr
3426 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3427 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3428 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3429 scheduling, to @file{@var{file}.36.dbr}.
3430
3431 @item -dD
3432 @opindex dD
3433 Dump all macro definitions, at the end of preprocessing, in addition to
3434 normal output.
3435
3436 @item -dE
3437 @itemx -fdump-rtl-ce3
3438 @opindex dE
3439 @opindex fdump-rtl-ce3
3440 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3441
3442 @item -df
3443 @itemx -fdump-rtl-cfg
3444 @itemx -fdump-rtl-life
3445 @opindex df
3446 @opindex fdump-rtl-cfg
3447 @opindex fdump-rtl-life
3448 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3449 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3450 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3451 to @file{@var{file}.16.life}.
3452
3453 @item -dg
3454 @itemx -fdump-rtl-greg
3455 @opindex dg
3456 @opindex fdump-rtl-greg
3457 Dump after global register allocation, to @file{@var{file}.23.greg}.
3458
3459 @item -dG
3460 @itemx -fdump-rtl-gcse
3461 @itemx -fdump-rtl-bypass
3462 @opindex dG
3463 @opindex fdump-rtl-gcse
3464 @opindex fdump-rtl-bypass
3465 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3466 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3467 enable dumping after jump bypassing and control flow optimizations, to
3468 @file{@var{file}.07.bypass}.
3469
3470 @item -dh
3471 @itemx -fdump-rtl-eh
3472 @opindex dh
3473 @opindex fdump-rtl-eh
3474 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3475
3476 @item -di
3477 @itemx -fdump-rtl-sibling
3478 @opindex di
3479 @opindex fdump-rtl-sibling
3480 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3481
3482 @item -dj
3483 @itemx -fdump-rtl-jump
3484 @opindex dj
3485 @opindex fdump-rtl-jump
3486 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3487
3488 @item -dk
3489 @itemx -fdump-rtl-stack
3490 @opindex dk
3491 @opindex fdump-rtl-stack
3492 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3493
3494 @item -dl
3495 @itemx -fdump-rtl-lreg
3496 @opindex dl
3497 @opindex fdump-rtl-lreg
3498 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3499
3500 @item -dL
3501 @itemx -fdump-rtl-loop
3502 @itemx -fdump-rtl-loop2
3503 @opindex dL
3504 @opindex fdump-rtl-loop
3505 @opindex fdump-rtl-loop2
3506 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3507 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3508 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3509 @file{@var{file}.13.loop2}.
3510
3511 @item -dm
3512 @itemx -fdump-rtl-sms
3513 @opindex dm
3514 @opindex fdump-rtl-sms
3515 Dump after modulo scheduling, to @file{@var{file}.20.sms}. 
3516
3517 @item -dM
3518 @itemx -fdump-rtl-mach
3519 @opindex dM
3520 @opindex fdump-rtl-mach
3521 Dump after performing the machine dependent reorganization pass, to
3522 @file{@var{file}.35.mach}.
3523
3524 @item -dn
3525 @itemx -fdump-rtl-rnreg
3526 @opindex dn
3527 @opindex fdump-rtl-rnreg
3528 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3529
3530 @item -dN
3531 @itemx -fdump-rtl-regmove
3532 @opindex dN
3533 @opindex fdump-rtl-regmove
3534 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3535
3536 @item -do
3537 @itemx -fdump-rtl-postreload
3538 @opindex do
3539 @opindex fdump-rtl-postreload
3540 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3541
3542 @item -dr
3543 @itemx -fdump-rtl-expand
3544 @opindex dr
3545 @opindex fdump-rtl-expand
3546 Dump after RTL generation, to @file{@var{file}.00.expand}.
3547
3548 @item -dR
3549 @itemx -fdump-rtl-sched2
3550 @opindex dR
3551 @opindex fdump-rtl-sched2
3552 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3553
3554 @item -ds
3555 @itemx -fdump-rtl-cse
3556 @opindex ds
3557 @opindex fdump-rtl-cse
3558 Dump after CSE (including the jump optimization that sometimes follows
3559 CSE), to @file{@var{file}.04.cse}.
3560
3561 @item -dS
3562 @itemx -fdump-rtl-sched
3563 @opindex dS
3564 @opindex fdump-rtl-sched
3565 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3566
3567 @item -dt
3568 @itemx -fdump-rtl-cse2
3569 @opindex dt
3570 @opindex fdump-rtl-cse2
3571 Dump after the second CSE pass (including the jump optimization that
3572 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3573
3574 @item -dT
3575 @itemx -fdump-rtl-tracer
3576 @opindex dT
3577 @opindex fdump-rtl-tracer
3578 Dump after running tracer, to @file{@var{file}.12.tracer}.
3579
3580 @item -dV
3581 @itemx -fdump-rtl-vpt
3582 @itemx -fdump-rtl-vartrack
3583 @opindex dV
3584 @opindex fdump-rtl-vpt
3585 @opindex fdump-rtl-vartrack
3586 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3587 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3588 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3589 to @file{@var{file}.34.vartrack}.
3590
3591 @item -dw
3592 @itemx -fdump-rtl-flow2
3593 @opindex dw
3594 @opindex fdump-rtl-flow2
3595 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3596
3597 @item -dz
3598 @itemx -fdump-rtl-peephole2
3599 @opindex dz
3600 @opindex fdump-rtl-peephole2
3601 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3602
3603 @item -dZ
3604 @itemx -fdump-rtl-web
3605 @opindex dZ
3606 @opindex fdump-rtl-web
3607 Dump after live range splitting, to @file{@var{file}.14.web}.
3608
3609 @item -da
3610 @itemx -fdump-rtl-all
3611 @opindex da
3612 @opindex fdump-rtl-all
3613 Produce all the dumps listed above.
3614
3615 @item -dH
3616 @opindex dH
3617 Produce a core dump whenever an error occurs.
3618
3619 @item -dm
3620 @opindex dm
3621 Print statistics on memory usage, at the end of the run, to
3622 standard error.
3623
3624 @item -dp
3625 @opindex dp
3626 Annotate the assembler output with a comment indicating which
3627 pattern and alternative was used.  The length of each instruction is
3628 also printed.
3629
3630 @item -dP
3631 @opindex dP
3632 Dump the RTL in the assembler output as a comment before each instruction.
3633 Also turns on @option{-dp} annotation.
3634
3635 @item -dv
3636 @opindex dv
3637 For each of the other indicated dump files (either with @option{-d} or
3638 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3639 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3640
3641 @item -dx
3642 @opindex dx
3643 Just generate RTL for a function instead of compiling it.  Usually used
3644 with @samp{r} (@option{-fdump-rtl-expand}).
3645
3646 @item -dy
3647 @opindex dy
3648 Dump debugging information during parsing, to standard error.
3649 @end table
3650
3651 @item -fdump-unnumbered
3652 @opindex fdump-unnumbered
3653 When doing debugging dumps (see @option{-d} option above), suppress instruction
3654 numbers and line number note output.  This makes it more feasible to
3655 use diff on debugging dumps for compiler invocations with different
3656 options, in particular with and without @option{-g}.
3657
3658 @item -fdump-translation-unit @r{(C and C++ only)}
3659 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3660 @opindex fdump-translation-unit
3661 Dump a representation of the tree structure for the entire translation
3662 unit to a file.  The file name is made by appending @file{.tu} to the
3663 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3664 controls the details of the dump as described for the
3665 @option{-fdump-tree} options.
3666
3667 @item -fdump-class-hierarchy @r{(C++ only)}
3668 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3669 @opindex fdump-class-hierarchy
3670 Dump a representation of each class's hierarchy and virtual function
3671 table layout to a file.  The file name is made by appending @file{.class}
3672 to the source file name.  If the @samp{-@var{options}} form is used,
3673 @var{options} controls the details of the dump as described for the
3674 @option{-fdump-tree} options.
3675
3676 @item -fdump-ipa-@var{switch}
3677 @opindex fdump-ipa
3678 Control the dumping at various stages of inter-procedural analysis
3679 language tree to a file.  The file name is generated by appending a switch
3680 specific suffix to the source file name. The following dumps are possible:
3681
3682 @table @samp
3683 @item all
3684 Enables all inter-procedural analysis dumps; currently the only produced
3685 dump is the @samp{cgraph} dump.
3686
3687 @item cgraph
3688 Dumps information about call-graph optimization, unused function removal,
3689 and inlining decisions.
3690 @end table
3691
3692 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3693 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3694 @opindex fdump-tree
3695 Control the dumping at various stages of processing the intermediate
3696 language tree to a file.  The file name is generated by appending a switch
3697 specific suffix to the source file name.  If the @samp{-@var{options}}
3698 form is used, @var{options} is a list of @samp{-} separated options that
3699 control the details of the dump. Not all options are applicable to all
3700 dumps, those which are not meaningful will be ignored. The following
3701 options are available
3702
3703 @table @samp
3704 @item address
3705 Print the address of each node.  Usually this is not meaningful as it
3706 changes according to the environment and source file. Its primary use
3707 is for tying up a dump file with a debug environment.
3708 @item slim
3709 Inhibit dumping of members of a scope or body of a function merely
3710 because that scope has been reached.  Only dump such items when they
3711 are directly reachable by some other path.  When dumping pretty-printed
3712 trees, this option inhibits dumping the bodies of control structures.
3713 @item raw
3714 Print a raw representation of the tree.  By default, trees are
3715 pretty-printed into a C-like representation.
3716 @item details
3717 Enable more detailed dumps (not honored by every dump option).
3718 @item stats
3719 Enable dumping various statistics about the pass (not honored by every dump
3720 option).
3721 @item blocks
3722 Enable showing basic block boundaries (disabled in raw dumps).
3723 @item vops
3724 Enable showing virtual operands for every statement.
3725 @item lineno
3726 Enable showing line numbers for statements.
3727 @item uid
3728 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3729 @item all
3730 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3731 @end table
3732
3733 The following tree dumps are possible:
3734 @table @samp
3735
3736 @item original
3737 Dump before any tree based optimization, to @file{@var{file}.original}.
3738
3739 @item optimized
3740 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3741
3742 @item inlined
3743 Dump after function inlining, to @file{@var{file}.inlined}.
3744
3745 @item gimple
3746 @opindex fdump-tree-gimple
3747 Dump each function before and after the gimplification pass to a file.  The
3748 file name is made by appending @file{.gimple} to the source file name.
3749
3750 @item cfg
3751 @opindex fdump-tree-cfg
3752 Dump the control flow graph of each function to a file.  The file name is
3753 made by appending @file{.cfg} to the source file name.
3754
3755 @item vcg
3756 @opindex fdump-tree-vcg
3757 Dump the control flow graph of each function to a file in VCG format.  The
3758 file name is made by appending @file{.vcg} to the source file name.  Note
3759 that if the file contains more than one function, the generated file cannot
3760 be used directly by VCG.  You will need to cut and paste each function's
3761 graph into its own separate file first.
3762
3763 @item ch
3764 @opindex fdump-tree-ch
3765 Dump each function after copying loop headers.  The file name is made by
3766 appending @file{.ch} to the source file name.
3767
3768 @item ssa
3769 @opindex fdump-tree-ssa
3770 Dump SSA related information to a file.  The file name is made by appending
3771 @file{.ssa} to the source file name.
3772
3773 @item alias
3774 @opindex fdump-tree-alias
3775 Dump aliasing information for each function.  The file name is made by
3776 appending @file{.alias} to the source file name.
3777
3778 @item ccp
3779 @opindex fdump-tree-ccp
3780 Dump each function after CCP.  The file name is made by appending
3781 @file{.ccp} to the source file name.
3782
3783 @item pre
3784 @opindex fdump-tree-pre
3785 Dump trees after partial redundancy elimination.  The file name is made
3786 by appending @file{.pre} to the source file name.
3787
3788 @item fre
3789 @opindex fdump-tree-fre
3790 Dump trees after full redundancy elimination.  The file name is made
3791 by appending @file{.fre} to the source file name.
3792
3793 @item dce
3794 @opindex fdump-tree-dce
3795 Dump each function after dead code elimination.  The file name is made by
3796 appending @file{.dce} to the source file name.
3797
3798 @item mudflap
3799 @opindex fdump-tree-mudflap
3800 Dump each function after adding mudflap instrumentation.  The file name is
3801 made by appending @file{.mudflap} to the source file name.
3802
3803 @item sra
3804 @opindex fdump-tree-sra
3805 Dump each function after performing scalar replacement of aggregates.  The
3806 file name is made by appending @file{.sra} to the source file name.
3807
3808 @item dom
3809 @opindex fdump-tree-dom
3810 Dump each function after applying dominator tree optimizations.  The file
3811 name is made by appending @file{.dom} to the source file name.
3812
3813 @item dse
3814 @opindex fdump-tree-dse
3815 Dump each function after applying dead store elimination.  The file
3816 name is made by appending @file{.dse} to the source file name.
3817
3818 @item phiopt
3819 @opindex fdump-tree-phiopt
3820 Dump each function after optimizing PHI nodes into straightline code.  The file
3821 name is made by appending @file{.phiopt} to the source file name.
3822
3823 @item forwprop
3824 @opindex fdump-tree-forwprop
3825 Dump each function after forward propagating single use variables.  The file
3826 name is made by appending @file{.forwprop} to the source file name.
3827
3828 @item copyrename
3829 @opindex fdump-tree-copyrename
3830 Dump each function after applying the copy rename optimization.  The file
3831 name is made by appending @file{.copyrename} to the source file name.
3832
3833 @item nrv
3834 @opindex fdump-tree-nrv
3835 Dump each function after applying the named return value optimization on
3836 generic trees.  The file name is made by appending @file{.nrv} to the source
3837 file name.
3838
3839 @item vect
3840 @opindex fdump-tree-vect
3841 Dump each function after applying vectorization of loops.  The file name is 
3842 made by appending @file{.vect} to the source file name.
3843
3844 @item all
3845 @opindex fdump-tree-all
3846 Enable all the available tree dumps with the flags provided in this option.
3847 @end table
3848
3849 @item -frandom-seed=@var{string}
3850 @opindex frandom-string
3851 This option provides a seed that GCC uses when it would otherwise use
3852 random numbers.  It is used to generate certain symbol names
3853 that have to be different in every compiled file. It is also used to
3854 place unique stamps in coverage data files and the object files that
3855 produce them. You can use the @option{-frandom-seed} option to produce
3856 reproducibly identical object files.
3857
3858 The @var{string} should be different for every file you compile.
3859
3860 @item -fsched-verbose=@var{n}
3861 @opindex fsched-verbose
3862 On targets that use instruction scheduling, this option controls the
3863 amount of debugging output the scheduler prints.  This information is
3864 written to standard error, unless @option{-dS} or @option{-dR} is
3865 specified, in which case it is output to the usual dump
3866 listing file, @file{.sched} or @file{.sched2} respectively.  However
3867 for @var{n} greater than nine, the output is always printed to standard
3868 error.
3869
3870 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3871 same information as @option{-dRS}.  For @var{n} greater than one, it
3872 also output basic block probabilities, detailed ready list information
3873 and unit/insn info.  For @var{n} greater than two, it includes RTL
3874 at abort point, control-flow and regions info.  And for @var{n} over
3875 four, @option{-fsched-verbose} also includes dependence info.
3876
3877 @item -save-temps
3878 @opindex save-temps
3879 Store the usual ``temporary'' intermediate files permanently; place them
3880 in the current directory and name them based on the source file.  Thus,
3881 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3882 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3883 preprocessed @file{foo.i} output file even though the compiler now
3884 normally uses an integrated preprocessor.
3885
3886 @item -time
3887 @opindex time
3888 Report the CPU time taken by each subprocess in the compilation
3889 sequence.  For C source files, this is the compiler proper and assembler
3890 (plus the linker if linking is done).  The output looks like this:
3891
3892 @smallexample
3893 # cc1 0.12 0.01
3894 # as 0.00 0.01
3895 @end smallexample
3896
3897 The first number on each line is the ``user time,'' that is time spent
3898 executing the program itself.  The second number is ``system time,''
3899 time spent executing operating system routines on behalf of the program.
3900 Both numbers are in seconds.
3901
3902 @item -fvar-tracking
3903 @opindex fvar-tracking
3904 Run variable tracking pass. It computes where variables are stored at each
3905 position in code. Better debugging information is then generated
3906 (if the debugging information format supports this information).
3907
3908 It is enabled by default when compiling with optimization (@option{-Os},
3909 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3910 the debug info format supports it.
3911
3912 @item -print-file-name=@var{library}
3913 @opindex print-file-name
3914 Print the full absolute name of the library file @var{library} that
3915 would be used when linking---and don't do anything else.  With this
3916 option, GCC does not compile or link anything; it just prints the
3917 file name.
3918
3919 @item -print-multi-directory
3920 @opindex print-multi-directory
3921 Print the directory name corresponding to the multilib selected by any
3922 other switches present in the command line.  This directory is supposed
3923 to exist in @env{GCC_EXEC_PREFIX}.
3924
3925 @item -print-multi-lib
3926 @opindex print-multi-lib
3927 Print the mapping from multilib directory names to compiler switches
3928 that enable them.  The directory name is separated from the switches by
3929 @samp{;}, and each switch starts with an @samp{@@} instead of the
3930 @samp{-}, without spaces between multiple switches.  This is supposed to
3931 ease shell-processing.
3932
3933 @item -print-prog-name=@var{program}
3934 @opindex print-prog-name
3935 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3936
3937 @item -print-libgcc-file-name
3938 @opindex print-libgcc-file-name
3939 Same as @option{-print-file-name=libgcc.a}.
3940
3941 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3942 but you do want to link with @file{libgcc.a}.  You can do
3943
3944 @smallexample
3945 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3946 @end smallexample
3947
3948 @item -print-search-dirs
3949 @opindex print-search-dirs
3950 Print the name of the configured installation directory and a list of
3951 program and library directories @command{gcc} will search---and don't do anything else.
3952
3953 This is useful when @command{gcc} prints the error message
3954 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3955 To resolve this you either need to put @file{cpp0} and the other compiler
3956 components where @command{gcc} expects to find them, or you can set the environment
3957 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3958 Don't forget the trailing '/'.
3959 @xref{Environment Variables}.
3960
3961 @item -dumpmachine
3962 @opindex dumpmachine
3963 Print the compiler's target machine (for example,
3964 @samp{i686-pc-linux-gnu})---and don't do anything else.
3965
3966 @item -dumpversion
3967 @opindex dumpversion
3968 Print the compiler version (for example, @samp{3.0})---and don't do
3969 anything else.
3970
3971 @item -dumpspecs
3972 @opindex dumpspecs
3973 Print the compiler's built-in specs---and don't do anything else.  (This
3974 is used when GCC itself is being built.)  @xref{Spec Files}.
3975
3976 @item -feliminate-unused-debug-types
3977 @opindex feliminate-unused-debug-types
3978 Normally, when producing DWARF2 output, GCC will emit debugging
3979 information for all types declared in a compilation
3980 unit, regardless of whether or not they are actually used
3981 in that compilation unit.  Sometimes this is useful, such as
3982 if, in the debugger, you want to cast a value to a type that is
3983 not actually used in your program (but is declared).  More often,
3984 however, this results in a significant amount of wasted space.
3985 With this option, GCC will avoid producing debug symbol output
3986 for types that are nowhere used in the source file being compiled.
3987 @end table
3988
3989 @node Optimize Options
3990 @section Options That Control Optimization
3991 @cindex optimize options
3992 @cindex options, optimization
3993
3994 These options control various sorts of optimizations.
3995
3996 Without any optimization option, the compiler's goal is to reduce the
3997 cost of compilation and to make debugging produce the expected
3998 results.  Statements are independent: if you stop the program with a
3999 breakpoint between statements, you can then assign a new value to any
4000 variable or change the program counter to any other statement in the
4001 function and get exactly the results you would expect from the source
4002 code.
4003
4004 Turning on optimization flags makes the compiler attempt to improve
4005 the performance and/or code size at the expense of compilation time
4006 and possibly the ability to debug the program.
4007
4008 The compiler performs optimization based on the knowledge it has of
4009 the program.  Optimization levels @option{-O2} and above, in
4010 particular, enable @emph{unit-at-a-time} mode, which allows the
4011 compiler to consider information gained from later functions in
4012 the file when compiling a function.  Compiling multiple files at
4013 once to a single output file in @emph{unit-at-a-time} mode allows
4014 the compiler to use information gained from all of the files when
4015 compiling each of them.
4016
4017 Not all optimizations are controlled directly by a flag.  Only
4018 optimizations that have a flag are listed.
4019
4020 @table @gcctabopt
4021 @item -O
4022 @itemx -O1
4023 @opindex O
4024 @opindex O1
4025 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4026 more memory for a large function.
4027
4028 With @option{-O}, the compiler tries to reduce code size and execution
4029 time, without performing any optimizations that take a great deal of
4030 compilation time.
4031
4032 @option{-O} turns on the following optimization flags:
4033 @gccoptlist{-fdefer-pop @gol
4034 -fmerge-constants @gol
4035 -fthread-jumps @gol
4036 -floop-optimize @gol
4037 -fif-conversion @gol
4038 -fif-conversion2 @gol
4039 -fdelayed-branch @gol
4040 -fguess-branch-probability @gol
4041 -fcprop-registers}
4042
4043 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4044 where doing so does not interfere with debugging.
4045
4046 @item -O2
4047 @opindex O2
4048 Optimize even more.  GCC performs nearly all supported optimizations
4049 that do not involve a space-speed tradeoff.  The compiler does not
4050 perform loop unrolling or function inlining when you specify @option{-O2}.
4051 As compared to @option{-O}, this option increases both compilation time
4052 and the performance of the generated code.
4053
4054 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4055 also turns on the following optimization flags:
4056 @gccoptlist{-fforce-mem @gol
4057 -foptimize-sibling-calls @gol
4058 -fstrength-reduce @gol
4059 -fcse-follow-jumps  -fcse-skip-blocks @gol
4060 -frerun-cse-after-loop  -frerun-loop-opt @gol
4061 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
4062 -fdelete-null-pointer-checks @gol
4063 -fexpensive-optimizations @gol
4064 -fregmove @gol
4065 -fschedule-insns  -fschedule-insns2 @gol
4066 -fsched-interblock  -fsched-spec @gol
4067 -fcaller-saves @gol
4068 -fpeephole2 @gol
4069 -freorder-blocks  -freorder-functions @gol
4070 -fstrict-aliasing @gol
4071 -funit-at-a-time @gol
4072 -falign-functions  -falign-jumps @gol
4073 -falign-loops  -falign-labels @gol
4074 -fcrossjumping}
4075
4076 Please note the warning under @option{-fgcse} about
4077 invoking @option{-O2} on programs that use computed gotos.
4078
4079 @item -O3
4080 @opindex O3
4081 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4082 @option{-O2} and also turns on the @option{-finline-functions},
4083 @option{-fweb} and @option{-fgcse-after-reload} options.
4084
4085 @item -O0
4086 @opindex O0
4087 Do not optimize.  This is the default.
4088
4089 @item -Os
4090 @opindex Os
4091 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4092 do not typically increase code size.  It also performs further
4093 optimizations designed to reduce code size.
4094
4095 @option{-Os} disables the following optimization flags:
4096 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4097 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4098
4099 If you use multiple @option{-O} options, with or without level numbers,
4100 the last such option is the one that is effective.
4101 @end table
4102
4103 Options of the form @option{-f@var{flag}} specify machine-independent
4104 flags.  Most flags have both positive and negative forms; the negative
4105 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4106 below, only one of the forms is listed---the one you typically will
4107 use.  You can figure out the other form by either removing @samp{no-}
4108 or adding it.
4109
4110 The following options control specific optimizations.  They are either
4111 activated by @option{-O} options or are related to ones that are.  You
4112 can use the following flags in the rare cases when ``fine-tuning'' of
4113 optimizations to be performed is desired.
4114
4115 @table @gcctabopt
4116 @item -fno-default-inline
4117 @opindex fno-default-inline
4118 Do not make member functions inline by default merely because they are
4119 defined inside the class scope (C++ only).  Otherwise, when you specify
4120 @w{@option{-O}}, member functions defined inside class scope are compiled
4121 inline by default; i.e., you don't need to add @samp{inline} in front of
4122 the member function name.
4123
4124 @item -fno-defer-pop
4125 @opindex fno-defer-pop
4126 Always pop the arguments to each function call as soon as that function
4127 returns.  For machines which must pop arguments after a function call,
4128 the compiler normally lets arguments accumulate on the stack for several
4129 function calls and pops them all at once.
4130
4131 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4132
4133 @item -fforce-mem
4134 @opindex fforce-mem
4135 Force memory operands to be copied into registers before doing
4136 arithmetic on them.  This produces better code by making all memory
4137 references potential common subexpressions.  When they are not common
4138 subexpressions, instruction combination should eliminate the separate
4139 register-load.
4140
4141 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4142
4143 @item -fforce-addr
4144 @opindex fforce-addr
4145 Force memory address constants to be copied into registers before
4146 doing arithmetic on them.  This may produce better code just as
4147 @option{-fforce-mem} may.
4148
4149 @item -fomit-frame-pointer
4150 @opindex fomit-frame-pointer
4151 Don't keep the frame pointer in a register for functions that
4152 don't need one.  This avoids the instructions to save, set up and
4153 restore frame pointers; it also makes an extra register available
4154 in many functions.  @strong{It also makes debugging impossible on
4155 some machines.}
4156
4157 On some machines, such as the VAX, this flag has no effect, because
4158 the standard calling sequence automatically handles the frame pointer
4159 and nothing is saved by pretending it doesn't exist.  The
4160 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4161 whether a target machine supports this flag.  @xref{Registers,,Register
4162 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4163
4164 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4165
4166 @item -foptimize-sibling-calls
4167 @opindex foptimize-sibling-calls
4168 Optimize sibling and tail recursive calls.
4169
4170 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4171
4172 @item -fno-inline
4173 @opindex fno-inline
4174 Don't pay attention to the @code{inline} keyword.  Normally this option
4175 is used to keep the compiler from expanding any functions inline.
4176 Note that if you are not optimizing, no functions can be expanded inline.
4177
4178 @item -finline-functions
4179 @opindex finline-functions
4180 Integrate all simple functions into their callers.  The compiler
4181 heuristically decides which functions are simple enough to be worth
4182 integrating in this way.
4183
4184 If all calls to a given function are integrated, and the function is
4185 declared @code{static}, then the function is normally not output as
4186 assembler code in its own right.
4187
4188 Enabled at level @option{-O3}.
4189
4190 @item -finline-limit=@var{n}
4191 @opindex finline-limit
4192 By default, GCC limits the size of functions that can be inlined.  This flag
4193 allows the control of this limit for functions that are explicitly marked as
4194 inline (i.e., marked with the inline keyword or defined within the class
4195 definition in c++).  @var{n} is the size of functions that can be inlined in
4196 number of pseudo instructions (not counting parameter handling).  The default
4197 value of @var{n} is 600.
4198 Increasing this value can result in more inlined code at
4199 the cost of compilation time and memory consumption.  Decreasing usually makes
4200 the compilation faster and less code will be inlined (which presumably
4201 means slower programs).  This option is particularly useful for programs that
4202 use inlining heavily such as those based on recursive templates with C++.
4203
4204 Inlining is actually controlled by a number of parameters, which may be
4205 specified individually by using @option{--param @var{name}=@var{value}}.
4206 The @option{-finline-limit=@var{n}} option sets some of these parameters
4207 as follows:
4208
4209 @table @gcctabopt
4210  @item max-inline-insns-single
4211   is set to @var{n}/2.
4212  @item max-inline-insns-auto
4213   is set to @var{n}/2.
4214  @item min-inline-insns
4215   is set to 130 or @var{n}/4, whichever is smaller.
4216  @item max-inline-insns-rtl
4217   is set to @var{n}.
4218 @end table
4219
4220 See below for a documentation of the individual
4221 parameters controlling inlining.
4222
4223 @emph{Note:} pseudo instruction represents, in this particular context, an
4224 abstract measurement of function's size.  In no way, it represents a count
4225 of assembly instructions and as such its exact meaning might change from one
4226 release to an another.
4227
4228 @item -fkeep-inline-functions
4229 @opindex fkeep-inline-functions
4230 In C, emit @code{static} functions that are declared @code{inline}
4231 into the object file, even if the function has been inlined into all
4232 of its callers.  This switch does not affect functions using the
4233 @code{extern inline} extension in GNU C.  In C++, emit any and all
4234 inline functions into the object file.
4235
4236 @item -fkeep-static-consts
4237 @opindex fkeep-static-consts
4238 Emit variables declared @code{static const} when optimization isn't turned
4239 on, even if the variables aren't referenced.
4240
4241 GCC enables this option by default.  If you want to force the compiler to
4242 check if the variable was referenced, regardless of whether or not
4243 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4244
4245 @item -fmerge-constants
4246 Attempt to merge identical constants (string constants and floating point
4247 constants) across compilation units.
4248
4249 This option is the default for optimized compilation if the assembler and
4250 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4251 behavior.
4252
4253 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4254
4255 @item -fmerge-all-constants
4256 Attempt to merge identical constants and identical variables.
4257
4258 This option implies @option{-fmerge-constants}.  In addition to
4259 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4260 arrays or initialized constant variables with integral or floating point
4261 types.  Languages like C or C++ require each non-automatic variable to
4262 have distinct location, so using this option will result in non-conforming
4263 behavior.
4264
4265 @item -fmodulo-sched
4266 @opindex fmodulo-sched
4267 Perform swing modulo scheduling immediately before the first scheduling
4268 pass.  This pass looks at innermost loops and reorders their
4269 instructions by overlapping different iterations.
4270
4271 @item -fnew-ra
4272 @opindex fnew-ra
4273 Use a graph coloring register allocator.  Currently this option is meant
4274 only for testing.  Users should not specify this option, since it is not
4275 yet ready for production use.
4276
4277 @item -fno-branch-count-reg
4278 @opindex fno-branch-count-reg
4279 Do not use ``decrement and branch'' instructions on a count register,
4280 but instead generate a sequence of instructions that decrement a
4281 register, compare it against zero, then branch based upon the result.
4282 This option is only meaningful on architectures that support such
4283 instructions, which include x86, PowerPC, IA-64 and S/390.
4284
4285 The default is @option{-fbranch-count-reg}, enabled when
4286 @option{-fstrength-reduce} is enabled.
4287
4288 @item -fno-function-cse
4289 @opindex fno-function-cse
4290 Do not put function addresses in registers; make each instruction that
4291 calls a constant function contain the function's address explicitly.
4292
4293 This option results in less efficient code, but some strange hacks
4294 that alter the assembler output may be confused by the optimizations
4295 performed when this option is not used.
4296
4297 The default is @option{-ffunction-cse}
4298
4299 @item -fno-zero-initialized-in-bss
4300 @opindex fno-zero-initialized-in-bss
4301 If the target supports a BSS section, GCC by default puts variables that
4302 are initialized to zero into BSS@.  This can save space in the resulting
4303 code.
4304
4305 This option turns off this behavior because some programs explicitly
4306 rely on variables going to the data section.  E.g., so that the
4307 resulting executable can find the beginning of that section and/or make
4308 assumptions based on that.
4309
4310 The default is @option{-fzero-initialized-in-bss}.
4311
4312 @item -fbounds-check
4313 @opindex fbounds-check
4314 For front-ends that support it, generate additional code to check that
4315 indices used to access arrays are within the declared range.  This is
4316 currently only supported by the Java and Fortran front-ends, where
4317 this option defaults to true and false respectively.
4318
4319 @item -fmudflap -fmudflapth -fmudflapir
4320 @opindex fmudflap
4321 @opindex fmudflapth
4322 @opindex fmudflapir
4323 @cindex bounds checking
4324 @cindex mudflap
4325 For front-ends that support it (C and C++), instrument all risky
4326 pointer/array dereferencing operations, some standard library
4327 string/heap functions, and some other associated constructs with
4328 range/validity tests.  Modules so instrumented should be immune to
4329 buffer overflows, invalid heap use, and some other classes of C/C++
4330 programming errors.  The instrumentation relies on a separate runtime
4331 library (@file{libmudflap}), which will be linked into a program if
4332 @option{-fmudflap} is given at link time.  Run-time behavior of the
4333 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4334 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4335 for its options.
4336
4337 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4338 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4339 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4340 instrumentation should ignore pointer reads.  This produces less
4341 instrumentation (and therefore faster execution) and still provides
4342 some protection against outright memory corrupting writes, but allows
4343 erroneously read data to propagate within a program.
4344
4345 @item -fstrength-reduce
4346 @opindex fstrength-reduce
4347 Perform the optimizations of loop strength reduction and
4348 elimination of iteration variables.
4349
4350 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4351
4352 @item -fthread-jumps
4353 @opindex fthread-jumps
4354 Perform optimizations where we check to see if a jump branches to a
4355 location where another comparison subsumed by the first is found.  If
4356 so, the first branch is redirected to either the destination of the
4357 second branch or a point immediately following it, depending on whether
4358 the condition is known to be true or false.
4359
4360 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4361
4362 @item -fcse-follow-jumps
4363 @opindex fcse-follow-jumps
4364 In common subexpression elimination, scan through jump instructions
4365 when the target of the jump is not reached by any other path.  For
4366 example, when CSE encounters an @code{if} statement with an
4367 @code{else} clause, CSE will follow the jump when the condition
4368 tested is false.
4369
4370 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4371
4372 @item -fcse-skip-blocks
4373 @opindex fcse-skip-blocks
4374 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4375 follow jumps which conditionally skip over blocks.  When CSE
4376 encounters a simple @code{if} statement with no else clause,
4377 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4378 body of the @code{if}.
4379
4380 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4381
4382 @item -frerun-cse-after-loop
4383 @opindex frerun-cse-after-loop
4384 Re-run common subexpression elimination after loop optimizations has been
4385 performed.
4386
4387 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4388
4389 @item -frerun-loop-opt
4390 @opindex frerun-loop-opt
4391 Run the loop optimizer twice.
4392
4393 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4394
4395 @item -fgcse
4396 @opindex fgcse
4397 Perform a global common subexpression elimination pass.
4398 This pass also performs global constant and copy propagation.
4399
4400 @emph{Note:} When compiling a program using computed gotos, a GCC
4401 extension, you may get better runtime performance if you disable
4402 the global common subexpression elimination pass by adding
4403 @option{-fno-gcse} to the command line.
4404
4405 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4406
4407 @item -fgcse-lm
4408 @opindex fgcse-lm
4409 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4410 attempt to move loads which are only killed by stores into themselves.  This
4411 allows a loop containing a load/store sequence to be changed to a load outside
4412 the loop, and a copy/store within the loop.
4413
4414 Enabled by default when gcse is enabled.
4415
4416 @item -fgcse-sm
4417 @opindex fgcse-sm
4418 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4419 global common subexpression elimination.  This pass will attempt to move
4420 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4421 loops containing a load/store sequence can be changed to a load before
4422 the loop and a store after the loop.
4423
4424 Enabled by default when gcse is enabled.
4425
4426 @item -fgcse-las
4427 @opindex fgcse-las
4428 When @option{-fgcse-las} is enabled, the global common subexpression
4429 elimination pass eliminates redundant loads that come after stores to the
4430 same memory location (both partial and full redundancies).
4431
4432 Enabled by default when gcse is enabled.
4433
4434 @item -fgcse-after-reload
4435 @opindex fgcse-after-reload
4436 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4437 pass is performed after reload. The purpose of this pass is to cleanup
4438 redundant spilling.
4439
4440 @item -floop-optimize
4441 @opindex floop-optimize
4442 Perform loop optimizations: move constant expressions out of loops, simplify
4443 exit test conditions and optionally do strength-reduction as well.
4444
4445 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4446
4447 @item -floop-optimize2
4448 @opindex floop-optimize2
4449 Perform loop optimizations using the new loop optimizer.  The optimizations
4450 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4451 by separate flags.
4452
4453 @item -fcrossjumping
4454 @opindex crossjumping
4455 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4456 resulting code may or may not perform better than without cross-jumping.
4457
4458 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4459
4460 @item -fif-conversion
4461 @opindex if-conversion
4462 Attempt to transform conditional jumps into branch-less equivalents.  This
4463 include use of conditional moves, min, max, set flags and abs instructions, and
4464 some tricks doable by standard arithmetics.  The use of conditional execution
4465 on chips where it is available is controlled by @code{if-conversion2}.
4466
4467 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4468
4469 @item -fif-conversion2
4470 @opindex if-conversion2
4471 Use conditional execution (where available) to transform conditional jumps into
4472 branch-less equivalents.
4473
4474 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4475
4476 @item -fdelete-null-pointer-checks
4477 @opindex fdelete-null-pointer-checks
4478 Use global dataflow analysis to identify and eliminate useless checks
4479 for null pointers.  The compiler assumes that dereferencing a null
4480 pointer would have halted the program.  If a pointer is checked after
4481 it has already been dereferenced, it cannot be null.
4482
4483 In some environments, this assumption is not true, and programs can
4484 safely dereference null pointers.  Use
4485 @option{-fno-delete-null-pointer-checks} to disable this optimization
4486 for programs which depend on that behavior.
4487
4488 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4489
4490 @item -fexpensive-optimizations
4491 @opindex fexpensive-optimizations
4492 Perform a number of minor optimizations that are relatively expensive.
4493
4494 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4495
4496 @item -foptimize-register-move
4497 @itemx -fregmove
4498 @opindex foptimize-register-move
4499 @opindex fregmove
4500 Attempt to reassign register numbers in move instructions and as
4501 operands of other simple instructions in order to maximize the amount of
4502 register tying.  This is especially helpful on machines with two-operand
4503 instructions.
4504
4505 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4506 optimization.
4507
4508 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4509
4510 @item -fdelayed-branch
4511 @opindex fdelayed-branch
4512 If supported for the target machine, attempt to reorder instructions
4513 to exploit instruction slots available after delayed branch
4514 instructions.
4515
4516 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4517
4518 @item -fschedule-insns
4519 @opindex fschedule-insns
4520 If supported for the target machine, attempt to reorder instructions to
4521 eliminate execution stalls due to required data being unavailable.  This
4522 helps machines that have slow floating point or memory load instructions
4523 by allowing other instructions to be issued until the result of the load
4524 or floating point instruction is required.
4525
4526 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4527
4528 @item -fschedule-insns2
4529 @opindex fschedule-insns2
4530 Similar to @option{-fschedule-insns}, but requests an additional pass of
4531 instruction scheduling after register allocation has been done.  This is
4532 especially useful on machines with a relatively small number of
4533 registers and where memory load instructions take more than one cycle.
4534
4535 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4536
4537 @item -fno-sched-interblock
4538 @opindex fno-sched-interblock
4539 Don't schedule instructions across basic blocks.  This is normally
4540 enabled by default when scheduling before register allocation, i.e.@:
4541 with @option{-fschedule-insns} or at @option{-O2} or higher.
4542
4543 @item -fno-sched-spec
4544 @opindex fno-sched-spec
4545 Don't allow speculative motion of non-load instructions.  This is normally
4546 enabled by default when scheduling before register allocation, i.e.@:
4547 with @option{-fschedule-insns} or at @option{-O2} or higher.
4548
4549 @item -fsched-spec-load
4550 @opindex fsched-spec-load
4551 Allow speculative motion of some load instructions.  This only makes
4552 sense when scheduling before register allocation, i.e.@: with
4553 @option{-fschedule-insns} or at @option{-O2} or higher.
4554
4555 @item -fsched-spec-load-dangerous
4556 @opindex fsched-spec-load-dangerous
4557 Allow speculative motion of more load instructions.  This only makes
4558 sense when scheduling before register allocation, i.e.@: with
4559 @option{-fschedule-insns} or at @option{-O2} or higher.
4560
4561 @item -fsched-stalled-insns=@var{n}
4562 @opindex fsched-stalled-insns
4563 Define how many insns (if any) can be moved prematurely from the queue
4564 of stalled insns into the ready list, during the second scheduling pass.
4565
4566 @item -fsched-stalled-insns-dep=@var{n}
4567 @opindex fsched-stalled-insns-dep
4568 Define how many insn groups (cycles) will be examined for a dependency
4569 on a stalled insn that is candidate for premature removal from the queue
4570 of stalled insns.  Has an effect only during the second scheduling pass,
4571 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4572
4573 @item -fsched2-use-superblocks
4574 @opindex fsched2-use-superblocks
4575 When scheduling after register allocation, do use superblock scheduling
4576 algorithm.  Superblock scheduling allows motion across basic block boundaries
4577 resulting on faster schedules.  This option is experimental, as not all machine
4578 descriptions used by GCC model the CPU closely enough to avoid unreliable
4579 results from the algorithm.
4580
4581 This only makes sense when scheduling after register allocation, i.e.@: with
4582 @option{-fschedule-insns2} or at @option{-O2} or higher.
4583
4584 @item -fsched2-use-traces
4585 @opindex fsched2-use-traces
4586 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4587 allocation and additionally perform code duplication in order to increase the
4588 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4589 trace formation.
4590
4591 This mode should produce faster but significantly longer programs.  Also
4592 without @option{-fbranch-probabilities} the traces constructed may not
4593 match the reality and hurt the performance.  This only makes
4594 sense when scheduling after register allocation, i.e.@: with
4595 @option{-fschedule-insns2} or at @option{-O2} or higher.
4596
4597 @item -freschedule-modulo-scheduled-loops
4598 @opindex fscheduling-in-modulo-scheduled-loops
4599 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4600 we may want to prevent the later scheduling passes from changing its schedule, we use this
4601 option to control that.
4602
4603 @item -fcaller-saves
4604 @opindex fcaller-saves
4605 Enable values to be allocated in registers that will be clobbered by
4606 function calls, by emitting extra instructions to save and restore the
4607 registers around such calls.  Such allocation is done only when it
4608 seems to result in better code than would otherwise be produced.
4609
4610 This option is always enabled by default on certain machines, usually
4611 those which have no call-preserved registers to use instead.
4612
4613 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4614
4615 @item -ftree-pre
4616 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4617 enabled by default at @option{-O} and higher.
4618
4619 @item -ftree-fre
4620 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4621 between FRE and PRE is that FRE only considers expressions
4622 that are computed on all paths leading to the redundant computation.
4623 This analysis faster than PRE, though it exposes fewer redundancies.
4624 This flag is enabled by default at @option{-O} and higher.
4625
4626 @item -ftree-ccp
4627 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4628 is enabled by default at @option{-O} and higher.
4629
4630 @item -ftree-dce
4631 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4632 default at @option{-O} and higher.
4633
4634 @item -ftree-dominator-opts
4635 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4636 default at @option{-O} and higher.
4637
4638 @item -ftree-ch
4639 Perform loop header copying on trees.  This is beneficial since it increases
4640 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4641 is enabled by default at @option{-O} and higher.  It is not enabled
4642 for @option{-Os}, since it usually increases code size.
4643
4644 @item -ftree-loop-optimize
4645 Perform loop optimizations on trees.  This flag is enabled by default
4646 at @option{-O} and higher.
4647
4648 @item -ftree-loop-linear
4649 Perform linear loop transformations on tree. This flag can improve cache 
4650 performance and allow further loop optimizations to take place.
4651
4652 @item -ftree-lim
4653 Perform loop invariant motion on trees.  This pass moves only invartiants that
4654 would be hard to handle on rtl level (function calls, operations that expand to
4655 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4656 operands of conditions that are invariant out of the loop, so that we can use
4657 just trivial invariantness analysis in loop unswitching.  The pass also includes
4658 store motion.
4659
4660 @item -fivcanon
4661 Create a canonical counter for number of iterations in the loop for that
4662 determining number of iterations requires complicated analysis.  Later
4663 optimizations then may determine the number easily.  Useful especially
4664 in connection with unrolling.
4665
4666 @item -fivopts
4667 Perform induction variable optimizations (strength reduction, induction
4668 variable merging and induction variable elimination) on trees.
4669
4670 @item -ftree-sra
4671 Perform scalar replacement of aggregates.  This pass replaces structure
4672 references with scalars to prevent committing structures to memory too
4673 early.  This flag is enabled by default at @option{-O} and higher.
4674
4675 @item -ftree-copyrename
4676 Perform copy renaming on trees.  This pass attempts to rename compiler
4677 temporaries to other variables at copy locations, usually resulting in
4678 variable names which more closely resemble the original variables.  This flag
4679 is enabled by default at @option{-O} and higher.
4680
4681 @item -ftree-ter
4682 Perform temporary expression replacement during the SSA->normal phase.  Single
4683 use/single def temporaries are replaced at their use location with their
4684 defining expression.  This results in non-GIMPLE code, but gives the expanders
4685 much more complex trees to work on resulting in better RTL generation.  This is
4686 enabled by default at @option{-O} and higher.
4687
4688 @item -ftree-lrs
4689 Perform live range splitting during the SSA->normal phase.  Distinct live
4690 ranges of a variable are split into unique variables, allowing for better
4691 optimization later.  This is enabled by default at @option{-O} and higher.
4692
4693 @item -ftree-vectorize
4694 Perform loop vectorization on trees.
4695
4696 @item -ftracer
4697 @opindex ftracer
4698 Perform tail duplication to enlarge superblock size. This transformation
4699 simplifies the control flow of the function allowing other optimizations to do
4700 better job.
4701
4702 @item -funroll-loops
4703 @opindex funroll-loops
4704 Unroll loops whose number of iterations can be determined at compile
4705 time or upon entry to the loop.  @option{-funroll-loops} implies both
4706 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4707 option makes code larger, and may or may not make it run faster.
4708
4709 @item -funroll-all-loops
4710 @opindex funroll-all-loops
4711 Unroll all loops, even if their number of iterations is uncertain when
4712 the loop is entered.  This usually makes programs run more slowly.
4713 @option{-funroll-all-loops} implies the same options as
4714 @option{-funroll-loops},
4715
4716 @item -fsplit-ivs-in-unroller
4717 @opindex -fsplit-ivs-in-unroller
4718 Enables expressing of values of induction variables in later iterations
4719 of the unrolled loop using the value in the first iteration.  This breaks
4720 long dependency chains, thus improving efficiency of the scheduling passes
4721 (for best results, @option{-fweb} should be used as well).
4722
4723 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4724 same effect. However in cases the loop body is more complicated than
4725 a single basic block, this is not reliable.  It also does not work at all
4726 on some of the architectures due to restrictions in the CSE pass.
4727
4728 This optimization is enabled by default.
4729
4730 @item -fprefetch-loop-arrays
4731 @opindex fprefetch-loop-arrays
4732 If supported by the target machine, generate instructions to prefetch
4733 memory to improve the performance of loops that access large arrays.
4734
4735 These options may generate better or worse code; results are highly
4736 dependent on the structure of loops within the source code.
4737
4738 @item -fno-peephole
4739 @itemx -fno-peephole2
4740 @opindex fno-peephole
4741 @opindex fno-peephole2
4742 Disable any machine-specific peephole optimizations.  The difference
4743 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4744 are implemented in the compiler; some targets use one, some use the
4745 other, a few use both.
4746
4747 @option{-fpeephole} is enabled by default.
4748 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4749
4750 @item -fno-guess-branch-probability
4751 @opindex fno-guess-branch-probability
4752 Do not guess branch probabilities using a randomized model.
4753
4754 Sometimes GCC will opt to use a randomized model to guess branch
4755 probabilities, when none are available from either profiling feedback
4756 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4757 different runs of the compiler on the same program may produce different
4758 object code.
4759
4760 In a hard real-time system, people don't want different runs of the
4761 compiler to produce code that has different behavior; minimizing
4762 non-determinism is of paramount import.  This switch allows users to
4763 reduce non-determinism, possibly at the expense of inferior
4764 optimization.
4765
4766 The default is @option{-fguess-branch-probability} at levels
4767 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4768
4769 @item -freorder-blocks
4770 @opindex freorder-blocks
4771 Reorder basic blocks in the compiled function in order to reduce number of
4772 taken branches and improve code locality.
4773
4774 Enabled at levels @option{-O2}, @option{-O3}.
4775
4776 @item -freorder-blocks-and-partition
4777 @opindex freorder-blocks-and-partition
4778 In addition to reordering basic blocks in the compiled function, in order
4779 to reduce number of taken branches, partitions hot and cold basic blocks
4780 into separate sections of the assembly and .o files, to improve
4781 paging and cache locality performance.
4782
4783 This optimization is automatically turned off in the presence of
4784 exception handling, for linkonce sections, for functions with a user-defined
4785 section attribute and on any architecture that does not support named
4786 sections.
4787
4788 @item -freorder-functions
4789 @opindex freorder-functions
4790 Reorder basic blocks in the compiled function in order to reduce number of
4791 taken branches and improve code locality. This is implemented by using special
4792 subsections @code{.text.hot} for most frequently executed functions and
4793 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4794 the linker so object file format must support named sections and linker must
4795 place them in a reasonable way.
4796
4797 Also profile feedback must be available in to make this option effective.  See
4798 @option{-fprofile-arcs} for details.
4799
4800 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4801
4802 @item -fstrict-aliasing
4803 @opindex fstrict-aliasing
4804 Allows the compiler to assume the strictest aliasing rules applicable to
4805 the language being compiled.  For C (and C++), this activates
4806 optimizations based on the type of expressions.  In particular, an
4807 object of one type is assumed never to reside at the same address as an
4808 object of a different type, unless the types are almost the same.  For
4809 example, an @code{unsigned int} can alias an @code{int}, but not a
4810 @code{void*} or a @code{double}.  A character type may alias any other
4811 type.
4812
4813 Pay special attention to code like this:
4814 @smallexample
4815 union a_union @{
4816   int i;
4817   double d;
4818 @};
4819
4820 int f() @{
4821   a_union t;
4822   t.d = 3.0;
4823   return t.i;
4824 @}
4825 @end smallexample
4826 The practice of reading from a different union member than the one most
4827 recently written to (called ``type-punning'') is common.  Even with
4828 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4829 is accessed through the union type.  So, the code above will work as
4830 expected.  However, this code might not:
4831 @smallexample
4832 int f() @{
4833   a_union t;
4834   int* ip;
4835   t.d = 3.0;
4836   ip = &t.i;
4837   return *ip;
4838 @}
4839 @end smallexample
4840
4841 Every language that wishes to perform language-specific alias analysis
4842 should define a function that computes, given an @code{tree}
4843 node, an alias set for the node.  Nodes in different alias sets are not
4844 allowed to alias.  For an example, see the C front-end function
4845 @code{c_get_alias_set}.
4846
4847 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4848
4849 @item -falign-functions
4850 @itemx -falign-functions=@var{n}
4851 @opindex falign-functions
4852 Align the start of functions to the next power-of-two greater than
4853 @var{n}, skipping up to @var{n} bytes.  For instance,
4854 @option{-falign-functions=32} aligns functions to the next 32-byte
4855 boundary, but @option{-falign-functions=24} would align to the next
4856 32-byte boundary only if this can be done by skipping 23 bytes or less.
4857
4858 @option{-fno-align-functions} and @option{-falign-functions=1} are
4859 equivalent and mean that functions will not be aligned.
4860
4861 Some assemblers only support this flag when @var{n} is a power of two;
4862 in that case, it is rounded up.
4863
4864 If @var{n} is not specified or is zero, use a machine-dependent default.
4865
4866 Enabled at levels @option{-O2}, @option{-O3}.
4867
4868 @item -falign-labels
4869 @itemx -falign-labels=@var{n}
4870 @opindex falign-labels
4871 Align all branch targets to a power-of-two boundary, skipping up to
4872 @var{n} bytes like @option{-falign-functions}.  This option can easily
4873 make code slower, because it must insert dummy operations for when the
4874 branch target is reached in the usual flow of the code.
4875
4876 @option{-fno-align-labels} and @option{-falign-labels=1} are
4877 equivalent and mean that labels will not be aligned.
4878
4879 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4880 are greater than this value, then their values are used instead.
4881
4882 If @var{n} is not specified or is zero, use a machine-dependent default
4883 which is very likely to be @samp{1}, meaning no alignment.
4884
4885 Enabled at levels @option{-O2}, @option{-O3}.
4886
4887 @item -falign-loops
4888 @itemx -falign-loops=@var{n}
4889 @opindex falign-loops
4890 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4891 like @option{-falign-functions}.  The hope is that the loop will be
4892 executed many times, which will make up for any execution of the dummy
4893 operations.
4894
4895 @option{-fno-align-loops} and @option{-falign-loops=1} are
4896 equivalent and mean that loops will not be aligned.
4897
4898 If @var{n} is not specified or is zero, use a machine-dependent default.
4899
4900 Enabled at levels @option{-O2}, @option{-O3}.
4901
4902 @item -falign-jumps
4903 @itemx -falign-jumps=@var{n}
4904 @opindex falign-jumps
4905 Align branch targets to a power-of-two boundary, for branch targets
4906 where the targets can only be reached by jumping, skipping up to @var{n}
4907 bytes like @option{-falign-functions}.  In this case, no dummy operations
4908 need be executed.
4909
4910 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4911 equivalent and mean that loops will not be aligned.
4912
4913 If @var{n} is not specified or is zero, use a machine-dependent default.
4914
4915 Enabled at levels @option{-O2}, @option{-O3}.
4916
4917 @item -funit-at-a-time
4918 @opindex funit-at-a-time
4919 Parse the whole compilation unit before starting to produce code.
4920 This allows some extra optimizations to take place but consumes
4921 more memory (in general).  There are some compatibility issues
4922 with @emph{unit-at-at-time} mode:
4923 @itemize @bullet
4924 @item
4925 enabling @emph{unit-at-a-time} mode may change the order
4926 in which functions, variables, and top-level @code{asm} statements
4927 are emitted, and will likely break code relying on some particular
4928 ordering.  The majority of such top-level @code{asm} statements,
4929 though, can be replaced by @code{section} attributes.
4930
4931 @item
4932 @emph{unit-at-a-time} mode removes unreferenced static variables
4933 and functions are removed.  This may result in undefined references
4934 when an @code{asm} statement refers directly to variables or functions
4935 that are otherwise unused.  In that case either the variable/function
4936 shall be listed as an operand of the @code{asm} statement operand or,
4937 in the case of top-level @code{asm} statements the attribute @code{used}
4938 shall be used on the declaration.
4939
4940 @item
4941 Static functions now can use non-standard passing conventions that
4942 may break @code{asm} statements calling functions directly. Again,
4943 attribute @code{used} will prevent this behavior.
4944 @end itemize
4945
4946 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4947 but this scheme may not be supported by future releases of GCC.
4948
4949 Enabled at levels @option{-O2}, @option{-O3}.
4950
4951 @item -fweb
4952 @opindex fweb
4953 Constructs webs as commonly used for register allocation purposes and assign
4954 each web individual pseudo register.  This allows the register allocation pass
4955 to operate on pseudos directly, but also strengthens several other optimization
4956 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4957 however, make debugging impossible, since variables will no longer stay in a
4958 ``home register''.
4959
4960 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4961 on targets where the default format for debugging information supports
4962 variable tracking.
4963
4964 @item -fno-cprop-registers
4965 @opindex fno-cprop-registers
4966 After register allocation and post-register allocation instruction splitting,
4967 we perform a copy-propagation pass to try to reduce scheduling dependencies
4968 and occasionally eliminate the copy.
4969
4970 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4971
4972 @item -fprofile-generate
4973 @opindex fprofile-generate
4974
4975 Enable options usually used for instrumenting application to produce
4976 profile useful for later recompilation with profile feedback based
4977 optimization.  You must use @option{-fprofile-generate} both when
4978 compiling and when linking your program.
4979
4980 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4981
4982 @item -fprofile-use
4983 @opindex fprofile-use
4984 Enable profile feedback directed optimizations, and optimizations
4985 generally profitable only with profile feedback available.
4986
4987 The following options are enabled: @code{-fbranch-probabilities},
4988 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4989
4990 @end table
4991
4992 The following options control compiler behavior regarding floating
4993 point arithmetic.  These options trade off between speed and
4994 correctness.  All must be specifically enabled.
4995
4996 @table @gcctabopt
4997 @item -ffloat-store
4998 @opindex ffloat-store
4999 Do not store floating point variables in registers, and inhibit other
5000 options that might change whether a floating point value is taken from a
5001 register or memory.
5002
5003 @cindex floating point precision
5004 This option prevents undesirable excess precision on machines such as
5005 the 68000 where the floating registers (of the 68881) keep more
5006 precision than a @code{double} is supposed to have.  Similarly for the
5007 x86 architecture.  For most programs, the excess precision does only
5008 good, but a few programs rely on the precise definition of IEEE floating
5009 point.  Use @option{-ffloat-store} for such programs, after modifying
5010 them to store all pertinent intermediate computations into variables.
5011
5012 @item -ffast-math
5013 @opindex ffast-math
5014 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5015 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5016 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5017
5018 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5019
5020 This option should never be turned on by any @option{-O} option since
5021 it can result in incorrect output for programs which depend on
5022 an exact implementation of IEEE or ISO rules/specifications for
5023 math functions.
5024
5025 @item -fno-math-errno
5026 @opindex fno-math-errno
5027 Do not set ERRNO after calling math functions that are executed
5028 with a single instruction, e.g., sqrt.  A program that relies on
5029 IEEE exceptions for math error handling may want to use this flag
5030 for speed while maintaining IEEE arithmetic compatibility.
5031
5032 This option should never be turned on by any @option{-O} option since
5033 it can result in incorrect output for programs which depend on
5034 an exact implementation of IEEE or ISO rules/specifications for
5035 math functions.
5036
5037 The default is @option{-fmath-errno}.
5038
5039 @item -funsafe-math-optimizations
5040 @opindex funsafe-math-optimizations
5041 Allow optimizations for floating-point arithmetic that (a) assume
5042 that arguments and results are valid and (b) may violate IEEE or
5043 ANSI standards.  When used at link-time, it may include libraries
5044 or startup files that change the default FPU control word or other
5045 similar optimizations.
5046
5047 This option should never be turned on by any @option{-O} option since
5048 it can result in incorrect output for programs which depend on
5049 an exact implementation of IEEE or ISO rules/specifications for
5050 math functions.
5051
5052 The default is @option{-fno-unsafe-math-optimizations}.
5053
5054 @item -ffinite-math-only
5055 @opindex ffinite-math-only
5056 Allow optimizations for floating-point arithmetic that assume
5057 that arguments and results are not NaNs or +-Infs.
5058
5059 This option should never be turned on by any @option{-O} option since
5060 it can result in incorrect output for programs which depend on
5061 an exact implementation of IEEE or ISO rules/specifications.
5062
5063 The default is @option{-fno-finite-math-only}.
5064
5065 @item -fno-trapping-math
5066 @opindex fno-trapping-math
5067 Compile code assuming that floating-point operations cannot generate
5068 user-visible traps.  These traps include division by zero, overflow,
5069 underflow, inexact result and invalid operation.  This option implies
5070 @option{-fno-signaling-nans}.  Setting this option may allow faster
5071 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5072
5073 This option should never be turned on by any @option{-O} option since
5074 it can result in incorrect output for programs which depend on
5075 an exact implementation of IEEE or ISO rules/specifications for
5076 math functions.
5077
5078 The default is @option{-ftrapping-math}.
5079
5080 @item -frounding-math
5081 @opindex frounding-math
5082 Disable transformations and optimizations that assume default floating
5083 point rounding behavior.  This is round-to-zero for all floating point
5084 to integer conversions, and round-to-nearest for all other arithmetic
5085 truncations.  This option should be specified for programs that change
5086 the FP rounding mode dynamically, or that may be executed with a
5087 non-default rounding mode.  This option disables constant folding of
5088 floating point expressions at compile-time (which may be affected by
5089 rounding mode) and arithmetic transformations that are unsafe in the
5090 presence of sign-dependent rounding modes.
5091
5092 The default is @option{-fno-rounding-math}.
5093
5094 This option is experimental and does not currently guarantee to
5095 disable all GCC optimizations that are affected by rounding mode.
5096 Future versions of GCC may provide finer control of this setting
5097 using C99's @code{FENV_ACCESS} pragma.  This command line option
5098 will be used to specify the default state for @code{FENV_ACCESS}.
5099
5100 @item -fsignaling-nans
5101 @opindex fsignaling-nans
5102 Compile code assuming that IEEE signaling NaNs may generate user-visible
5103 traps during floating-point operations.  Setting this option disables
5104 optimizations that may change the number of exceptions visible with
5105 signaling NaNs.  This option implies @option{-ftrapping-math}.
5106
5107 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5108 be defined.
5109
5110 The default is @option{-fno-signaling-nans}.
5111
5112 This option is experimental and does not currently guarantee to
5113 disable all GCC optimizations that affect signaling NaN behavior.
5114
5115 @item -fsingle-precision-constant
5116 @opindex fsingle-precision-constant
5117 Treat floating point constant as single precision constant instead of
5118 implicitly converting it to double precision constant.
5119
5120
5121 @end table
5122
5123 The following options control optimizations that may improve
5124 performance, but are not enabled by any @option{-O} options.  This
5125 section includes experimental options that may produce broken code.
5126
5127 @table @gcctabopt
5128 @item -fbranch-probabilities
5129 @opindex fbranch-probabilities
5130 After running a program compiled with @option{-fprofile-arcs}
5131 (@pxref{Debugging Options,, Options for Debugging Your Program or
5132 @command{gcc}}), you can compile it a second time using
5133 @option{-fbranch-probabilities}, to improve optimizations based on
5134 the number of times each branch was taken.  When the program
5135 compiled with @option{-fprofile-arcs} exits it saves arc execution
5136 counts to a file called @file{@var{sourcename}.gcda} for each source
5137 file  The information in this data file is very dependent on the
5138 structure of the generated code, so you must use the same source code
5139 and the same optimization options for both compilations.
5140
5141 With @option{-fbranch-probabilities}, GCC puts a
5142 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5143 These can be used to improve optimization.  Currently, they are only
5144 used in one place: in @file{reorg.c}, instead of guessing which path a
5145 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5146 exactly determine which path is taken more often.
5147
5148 @item -fprofile-values
5149 @opindex fprofile-values
5150 If combined with @option{-fprofile-arcs}, it adds code so that some
5151 data about values of expressions in the program is gathered.
5152
5153 With @option{-fbranch-probabilities}, it reads back the data gathered
5154 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5155 notes to instructions for their later usage in optimizations.
5156
5157 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5158
5159 @item -fvpt
5160 @opindex fvpt
5161 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5162 a code to gather information about values of expressions.
5163
5164 With @option{-fbranch-probabilities}, it reads back the data gathered
5165 and actually performs the optimizations based on them.
5166 Currently the optimizations include specialization of division operation
5167 using the knowledge about the value of the denominator.
5168
5169 @item -fspeculative-prefetching
5170 @opindex fspeculative-prefetching
5171 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5172 a code to gather information about addresses of memory references in the
5173 program.
5174
5175 With @option{-fbranch-probabilities}, it reads back the data gathered
5176 and issues prefetch instructions according to them.  In addition to the opportunities
5177 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5178 memory access patterns -- for example accesses to the data stored in linked
5179 list whose elements are usually allocated sequentially.
5180
5181 In order to prevent issuing double prefetches, usage of
5182 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5183
5184 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5185
5186 @item -frename-registers
5187 @opindex frename-registers
5188 Attempt to avoid false dependencies in scheduled code by making use
5189 of registers left over after register allocation.  This optimization
5190 will most benefit processors with lots of registers.  Depending on the
5191 debug information format adopted by the target, however, it can
5192 make debugging impossible, since variables will no longer stay in
5193 a ``home register''.
5194
5195 Not enabled by default at any level because it has known bugs.
5196
5197 @item -fnew-ra
5198 @opindex fnew-ra
5199 Use a graph coloring register allocator.  Currently this option is meant
5200 for testing, so we are interested to hear about miscompilations with
5201 @option{-fnew-ra}.
5202
5203 @item -ftracer
5204 @opindex ftracer
5205 Perform tail duplication to enlarge superblock size. This transformation
5206 simplifies the control flow of the function allowing other optimizations to do
5207 better job.
5208
5209 Enabled with @option{-fprofile-use}.
5210
5211 @item -funroll-loops
5212 @opindex funroll-loops
5213 Unroll loops whose number of iterations can be determined at compile time or
5214 upon entry to the loop.  @option{-funroll-loops} implies
5215 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5216 (i.e.@: complete removal of loops with small constant number of iterations).
5217 This option makes code larger, and may or may not make it run faster.
5218
5219 Enabled with @option{-fprofile-use}.
5220
5221 @item -funroll-all-loops
5222 @opindex funroll-all-loops
5223 Unroll all loops, even if their number of iterations is uncertain when
5224 the loop is entered.  This usually makes programs run more slowly.
5225 @option{-funroll-all-loops} implies the same options as
5226 @option{-funroll-loops}.
5227
5228 @item -fpeel-loops
5229 @opindex fpeel-loops
5230 Peels the loops for that there is enough information that they do not
5231 roll much (from profile feedback).  It also turns on complete loop peeling
5232 (i.e.@: complete removal of loops with small constant number of iterations).
5233
5234 Enabled with @option{-fprofile-use}.
5235
5236 @item -fmove-loop-invariants
5237 @opindex fmove-loop-invariants
5238 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5239 at level @option{-O1}
5240
5241 @item -funswitch-loops
5242 @opindex funswitch-loops
5243 Move branches with loop invariant conditions out of the loop, with duplicates
5244 of the loop on both branches (modified according to result of the condition).
5245
5246 @item -fprefetch-loop-arrays
5247 @opindex fprefetch-loop-arrays
5248 If supported by the target machine, generate instructions to prefetch
5249 memory to improve the performance of loops that access large arrays.
5250
5251 Disabled at level @option{-Os}.
5252
5253 @item -ffunction-sections
5254 @itemx -fdata-sections
5255 @opindex ffunction-sections
5256 @opindex fdata-sections
5257 Place each function or data item into its own section in the output
5258 file if the target supports arbitrary sections.  The name of the
5259 function or the name of the data item determines the section's name
5260 in the output file.
5261
5262 Use these options on systems where the linker can perform optimizations
5263 to improve locality of reference in the instruction space.  Most systems
5264 using the ELF object format and SPARC processors running Solaris 2 have
5265 linkers with such optimizations.  AIX may have these optimizations in
5266 the future.
5267
5268 Only use these options when there are significant benefits from doing
5269 so.  When you specify these options, the assembler and linker will
5270 create larger object and executable files and will also be slower.
5271 You will not be able to use @code{gprof} on all systems if you
5272 specify this option and you may have problems with debugging if
5273 you specify both this option and @option{-g}.
5274
5275 @item -fbranch-target-load-optimize
5276 @opindex fbranch-target-load-optimize
5277 Perform branch target register load optimization before prologue / epilogue
5278 threading.
5279 The use of target registers can typically be exposed only during reload,
5280 thus hoisting loads out of loops and doing inter-block scheduling needs
5281 a separate optimization pass.
5282
5283 @item -fbranch-target-load-optimize2
5284 @opindex fbranch-target-load-optimize2
5285 Perform branch target register load optimization after prologue / epilogue
5286 threading.
5287
5288 @item -fbtr-bb-exclusive
5289 @opindex fbtr-bb-exclusive
5290 When performing branch target register load optimization, don't reuse
5291 branch target registers in within any basic block.
5292
5293 @item --param @var{name}=@var{value}
5294 @opindex param
5295 In some places, GCC uses various constants to control the amount of
5296 optimization that is done.  For example, GCC will not inline functions
5297 that contain more that a certain number of instructions.  You can
5298 control some of these constants on the command-line using the
5299 @option{--param} option.
5300
5301 The names of specific parameters, and the meaning of the values, are
5302 tied to the internals of the compiler, and are subject to change
5303 without notice in future releases.
5304
5305 In each case, the @var{value} is an integer.  The allowable choices for
5306 @var{name} are given in the following table:
5307
5308 @table @gcctabopt
5309 @item max-crossjump-edges
5310 The maximum number of incoming edges to consider for crossjumping.
5311 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5312 the number of edges incoming to each block.  Increasing values mean
5313 more aggressive optimization, making the compile time increase with
5314 probably small improvement in executable size.
5315
5316 @item min-crossjump-insns
5317 The minimum number of instructions which must be matched at the end
5318 of two blocks before crossjumping will be performed on them.  This
5319 value is ignored in the case where all instructions in the block being
5320 crossjumped from are matched.  The default value is 5.
5321
5322 @item max-delay-slot-insn-search
5323 The maximum number of instructions to consider when looking for an
5324 instruction to fill a delay slot.  If more than this arbitrary number of
5325 instructions is searched, the time savings from filling the delay slot
5326 will be minimal so stop searching.  Increasing values mean more
5327 aggressive optimization, making the compile time increase with probably
5328 small improvement in executable run time.
5329
5330 @item max-delay-slot-live-search
5331 When trying to fill delay slots, the maximum number of instructions to
5332 consider when searching for a block with valid live register
5333 information.  Increasing this arbitrarily chosen value means more
5334 aggressive optimization, increasing the compile time.  This parameter
5335 should be removed when the delay slot code is rewritten to maintain the
5336 control-flow graph.
5337
5338 @item max-gcse-memory
5339 The approximate maximum amount of memory that will be allocated in
5340 order to perform the global common subexpression elimination
5341 optimization.  If more memory than specified is required, the
5342 optimization will not be done.
5343
5344 @item max-gcse-passes
5345 The maximum number of passes of GCSE to run.  The default is 1.
5346
5347 @item max-pending-list-length
5348 The maximum number of pending dependencies scheduling will allow
5349 before flushing the current state and starting over.  Large functions
5350 with few branches or calls can create excessively large lists which
5351 needlessly consume memory and resources.
5352
5353 @item max-inline-insns-single
5354 Several parameters control the tree inliner used in gcc.
5355 This number sets the maximum number of instructions (counted in GCC's
5356 internal representation) in a single function that the tree inliner
5357 will consider for inlining.  This only affects functions declared
5358 inline and methods implemented in a class declaration (C++).
5359 The default value is 500.
5360
5361 @item max-inline-insns-auto
5362 When you use @option{-finline-functions} (included in @option{-O3}),
5363 a lot of functions that would otherwise not be considered for inlining
5364 by the compiler will be investigated.  To those functions, a different
5365 (more restrictive) limit compared to functions declared inline can
5366 be applied.
5367 The default value is 120.
5368
5369 @item large-function-insns
5370 The limit specifying really large functions.  For functions greater than this
5371 limit inlining is constrained by @option{--param large-function-growth}.
5372 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5373 algorithms used by the backend.
5374 This parameter is ignored when @option{-funit-at-a-time} is not used.
5375 The default value is 3000.
5376
5377 @item large-function-growth
5378 Specifies maximal growth of large function caused by inlining in percents.
5379 This parameter is ignored when @option{-funit-at-a-time} is not used.
5380 The default value is 200.
5381
5382 @item inline-unit-growth
5383 Specifies maximal overall growth of the compilation unit caused by inlining.
5384 This parameter is ignored when @option{-funit-at-a-time} is not used.
5385 The default value is 150.
5386
5387 @item max-inline-insns-recursive
5388 @itemx max-inline-insns-recursive-auto
5389 Specifies maximum number of instructions out-of-line copy of self recursive inline
5390 function can grow into by performing recursive inlining.
5391
5392 For functions declared inline @option{--param max-inline-insns-recursive} is
5393 taken into acount.  For function not declared inline, recursive inlining
5394 happens only when @option{-finline-functions} (included in @option{-O3}) is
5395 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5396 default value is 500.
5397
5398 @item max-inline-recursive-depth
5399 @itemx max-inline-recursive-depth-auto
5400 Specifies maximum recursion depth used by the recursive inlining.
5401
5402 For functions declared inline @option{--param max-inline-recursive-depth} is
5403 taken into acount.  For function not declared inline, recursive inlining
5404 happens only when @option{-finline-functions} (included in @option{-O3}) is
5405 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5406 default value is 500.
5407
5408 @item max-inline-insns-rtl
5409 For languages that use the RTL inliner (this happens at a later stage
5410 than tree inlining), you can set the maximum allowable size (counted
5411 in RTL instructions) for the RTL inliner with this parameter.
5412 The default value is 600.
5413
5414 @item max-unrolled-insns
5415 The maximum number of instructions that a loop should have if that loop
5416 is unrolled, and if the loop is unrolled, it determines how many times
5417 the loop code is unrolled.
5418
5419 @item max-average-unrolled-insns
5420 The maximum number of instructions biased by probabilities of their execution
5421 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5422 it determines how many times the loop code is unrolled.
5423
5424 @item max-unroll-times
5425 The maximum number of unrollings of a single loop.
5426
5427 @item max-peeled-insns
5428 The maximum number of instructions that a loop should have if that loop
5429 is peeled, and if the loop is peeled, it determines how many times
5430 the loop code is peeled.
5431
5432 @item max-peel-times
5433 The maximum number of peelings of a single loop.
5434
5435 @item max-completely-peeled-insns
5436 The maximum number of insns of a completely peeled loop.
5437
5438 @item max-completely-peel-times
5439 The maximum number of iterations of a loop to be suitable for complete peeling.
5440
5441 @item max-unswitch-insns
5442 The maximum number of insns of an unswitched loop.
5443
5444 @item max-unswitch-level
5445 The maximum number of branches unswitched in a single loop.
5446
5447 @item lim-expensive
5448 The minimum cost of an expensive expression in the loop invariant motion.
5449
5450 @item iv-consider-all-candidates-bound
5451 Bound on number of candidates for induction variables below that
5452 all candidates are considered for each use in induction variable
5453 optimizations.  Only the most relevant candidates are considered
5454 if there are more candidates, to avoid quadratic time complexity.
5455
5456 @item iv-max-considered-uses
5457 The induction variable optimizations give up on loops that contain more
5458 induction variable uses.
5459
5460 @item max-iterations-to-track
5461
5462 The maximum number of iterations of a loop the brute force algorithm
5463 for analysis of # of iterations of the loop tries to evaluate.
5464
5465 @item hot-bb-count-fraction
5466 Select fraction of the maximal count of repetitions of basic block in program
5467 given basic block needs to have to be considered hot.
5468
5469 @item hot-bb-frequency-fraction
5470 Select fraction of the maximal frequency of executions of basic block in
5471 function given basic block needs to have to be considered hot
5472
5473 @item tracer-dynamic-coverage
5474 @itemx tracer-dynamic-coverage-feedback
5475
5476 This value is used to limit superblock formation once the given percentage of
5477 executed instructions is covered.  This limits unnecessary code size
5478 expansion.
5479
5480 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5481 feedback is available.  The real profiles (as opposed to statically estimated
5482 ones) are much less balanced allowing the threshold to be larger value.
5483
5484 @item tracer-max-code-growth
5485 Stop tail duplication once code growth has reached given percentage.  This is
5486 rather hokey argument, as most of the duplicates will be eliminated later in
5487 cross jumping, so it may be set to much higher values than is the desired code
5488 growth.
5489
5490 @item tracer-min-branch-ratio
5491
5492 Stop reverse growth when the reverse probability of best edge is less than this
5493 threshold (in percent).
5494
5495 @item tracer-min-branch-ratio
5496 @itemx tracer-min-branch-ratio-feedback
5497
5498 Stop forward growth if the best edge do have probability lower than this
5499 threshold.
5500
5501 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5502 compilation for profile feedback and one for compilation without.  The value
5503 for compilation with profile feedback needs to be more conservative (higher) in
5504 order to make tracer effective.
5505
5506 @item max-cse-path-length
5507
5508 Maximum number of basic blocks on path that cse considers.  The default is 10.
5509
5510 @item global-var-threshold
5511
5512 Counts the number of function calls (N) and the number of
5513 call-clobbered variables (V).  If NxV is larger than this limit, a
5514 single artificial variable will be created to represent all the
5515 call-clobbered variables at function call sites.  This artificial
5516 variable will then be made to alias every call-clobbered variable.
5517 (done as int * size_t on the host machine; beware overflow).
5518
5519 @item max-aliased-vops
5520
5521 Maximum number of virtual operands allowed to represent aliases
5522 before triggering the alias grouping heuristic.  Alias grouping
5523 reduces compile times and memory consumption needed for aliasing at
5524 the expense of precision loss in alias information.
5525
5526 @item ggc-min-expand
5527
5528 GCC uses a garbage collector to manage its own memory allocation.  This
5529 parameter specifies the minimum percentage by which the garbage
5530 collector's heap should be allowed to expand between collections.
5531 Tuning this may improve compilation speed; it has no effect on code
5532 generation.
5533
5534 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5535 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5536 the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS.  If
5537 GCC is not able to calculate RAM on a particular platform, the lower
5538 bound of 30% is used.  Setting this parameter and
5539 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5540 every opportunity.  This is extremely slow, but can be useful for
5541 debugging.
5542
5543 @item ggc-min-heapsize
5544
5545 Minimum size of the garbage collector's heap before it begins bothering
5546 to collect garbage.  The first collection occurs after the heap expands
5547 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5548 tuning this may improve compilation speed, and has no effect on code
5549 generation.
5550
5551 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5552 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5553 with a lower bound of 4096 (four megabytes) and an upper bound of
5554 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5555 particular platform, the lower bound is used.  Setting this parameter
5556 very large effectively disables garbage collection.  Setting this
5557 parameter and @option{ggc-min-expand} to zero causes a full collection
5558 to occur at every opportunity.
5559
5560 @item max-reload-search-insns
5561 The maximum number of instruction reload should look backward for equivalent
5562 register.  Increasing values mean more aggressive optimization, making the
5563 compile time increase with probably slightly better performance.  The default
5564 value is 100.
5565
5566 @item max-cselib-memory-location
5567 The maximum number of memory locations cselib should take into acount.
5568 Increasing values mean more aggressive optimization, making the compile time
5569 increase with probably slightly better performance.  The default value is 500.
5570
5571 @item reorder-blocks-duplicate
5572 @itemx reorder-blocks-duplicate-feedback
5573
5574 Used by basic block reordering pass to decide whether to use unconditional
5575 branch or duplicate the code on its destination.  Code is duplicated when its
5576 estimated size is smaller than this value multiplied by the estimated size of
5577 unconditional jump in the hot spots of the program.
5578
5579 The @option{reorder-block-duplicate-feedback} is used only when profile
5580 feedback is available and may be set to higher values than
5581 @option{reorder-block-duplicate} since information about the hot spots is more
5582 accurate.
5583
5584 @item max-sched-region-blocks
5585 The maximum number of blocks in a region to be considered for
5586 interblock scheduling.  The default value is 10.
5587
5588 @item max-sched-region-insns
5589 The maximum number of insns in a region to be considered for
5590 interblock scheduling.  The default value is 100.
5591
5592 @item integer-share-limit
5593 Small integer constants can use a shared data structure, reducing the
5594 compiler's memory usage and increasing its speed.  This sets the maximum
5595 value of a shared integer constant's.  The default value is 256.
5596
5597 @end table
5598 @end table
5599
5600 @node Preprocessor Options
5601 @section Options Controlling the Preprocessor
5602 @cindex preprocessor options
5603 @cindex options, preprocessor
5604
5605 These options control the C preprocessor, which is run on each C source
5606 file before actual compilation.
5607
5608 If you use the @option{-E} option, nothing is done except preprocessing.
5609 Some of these options make sense only together with @option{-E} because
5610 they cause the preprocessor output to be unsuitable for actual
5611 compilation.
5612
5613 @table @gcctabopt
5614 @opindex Wp
5615 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5616 and pass @var{option} directly through to the preprocessor.  If
5617 @var{option} contains commas, it is split into multiple options at the
5618 commas.  However, many options are modified, translated or interpreted
5619 by the compiler driver before being passed to the preprocessor, and
5620 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5621 interface is undocumented and subject to change, so whenever possible
5622 you should avoid using @option{-Wp} and let the driver handle the
5623 options instead.
5624
5625 @item -Xpreprocessor @var{option}
5626 @opindex preprocessor
5627 Pass @var{option} as an option to the preprocessor.  You can use this to
5628 supply system-specific preprocessor options which GCC does not know how to
5629 recognize.
5630
5631 If you want to pass an option that takes an argument, you must use
5632 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5633 @end table
5634
5635 @include cppopts.texi
5636
5637 @node Assembler Options
5638 @section Passing Options to the Assembler
5639
5640 @c prevent bad page break with this line
5641 You can pass options to the assembler.
5642
5643 @table @gcctabopt
5644 @item -Wa,@var{option}
5645 @opindex Wa
5646 Pass @var{option} as an option to the assembler.  If @var{option}
5647 contains commas, it is split into multiple options at the commas.
5648
5649 @item -Xassembler @var{option}
5650 @opindex Xassembler
5651 Pass @var{option} as an option to the assembler.  You can use this to
5652 supply system-specific assembler options which GCC does not know how to
5653 recognize.
5654
5655 If you want to pass an option that takes an argument, you must use
5656 @option{-Xassembler} twice, once for the option and once for the argument.
5657
5658 @end table
5659
5660 @node Link Options
5661 @section Options for Linking
5662 @cindex link options
5663 @cindex options, linking
5664
5665 These options come into play when the compiler links object files into
5666 an executable output file.  They are meaningless if the compiler is
5667 not doing a link step.
5668
5669 @table @gcctabopt
5670 @cindex file names
5671 @item @var{object-file-name}
5672 A file name that does not end in a special recognized suffix is
5673 considered to name an object file or library.  (Object files are
5674 distinguished from libraries by the linker according to the file
5675 contents.)  If linking is done, these object files are used as input
5676 to the linker.
5677
5678 @item -c
5679 @itemx -S
5680 @itemx -E
5681 @opindex c
5682 @opindex S
5683 @opindex E
5684 If any of these options is used, then the linker is not run, and
5685 object file names should not be used as arguments.  @xref{Overall
5686 Options}.
5687
5688 @cindex Libraries
5689 @item -l@var{library}
5690 @itemx -l @var{library}
5691 @opindex l
5692 Search the library named @var{library} when linking.  (The second
5693 alternative with the library as a separate argument is only for
5694 POSIX compliance and is not recommended.)
5695
5696 It makes a difference where in the command you write this option; the
5697 linker searches and processes libraries and object files in the order they
5698 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5699 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5700 to functions in @samp{z}, those functions may not be loaded.
5701
5702 The linker searches a standard list of directories for the library,
5703 which is actually a file named @file{lib@var{library}.a}.  The linker
5704 then uses this file as if it had been specified precisely by name.
5705
5706 The directories searched include several standard system directories
5707 plus any that you specify with @option{-L}.
5708
5709 Normally the files found this way are library files---archive files
5710 whose members are object files.  The linker handles an archive file by
5711 scanning through it for members which define symbols that have so far
5712 been referenced but not defined.  But if the file that is found is an
5713 ordinary object file, it is linked in the usual fashion.  The only
5714 difference between using an @option{-l} option and specifying a file name
5715 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5716 and searches several directories.
5717
5718 @item -lobjc
5719 @opindex lobjc
5720 You need this special case of the @option{-l} option in order to
5721 link an Objective-C or Objective-C++ program.
5722
5723 @item -nostartfiles
5724 @opindex nostartfiles
5725 Do not use the standard system startup files when linking.
5726 The standard system libraries are used normally, unless @option{-nostdlib}
5727 or @option{-nodefaultlibs} is used.
5728
5729 @item -nodefaultlibs
5730 @opindex nodefaultlibs
5731 Do not use the standard system libraries when linking.
5732 Only the libraries you specify will be passed to the linker.
5733 The standard startup files are used normally, unless @option{-nostartfiles}
5734 is used.  The compiler may generate calls to @code{memcmp},
5735 @code{memset}, @code{memcpy} and @code{memmove}.
5736 These entries are usually resolved by entries in
5737 libc.  These entry points should be supplied through some other
5738 mechanism when this option is specified.
5739
5740 @item -nostdlib
5741 @opindex nostdlib
5742 Do not use the standard system startup files or libraries when linking.
5743 No startup files and only the libraries you specify will be passed to
5744 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5745 @code{memcpy} and @code{memmove}.
5746 These entries are usually resolved by entries in
5747 libc.  These entry points should be supplied through some other
5748 mechanism when this option is specified.
5749
5750 @cindex @option{-lgcc}, use with @option{-nostdlib}
5751 @cindex @option{-nostdlib} and unresolved references
5752 @cindex unresolved references and @option{-nostdlib}
5753 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5754 @cindex @option{-nodefaultlibs} and unresolved references
5755 @cindex unresolved references and @option{-nodefaultlibs}
5756 One of the standard libraries bypassed by @option{-nostdlib} and
5757 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5758 that GCC uses to overcome shortcomings of particular machines, or special
5759 needs for some languages.
5760 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5761 Collection (GCC) Internals},
5762 for more discussion of @file{libgcc.a}.)
5763 In most cases, you need @file{libgcc.a} even when you want to avoid
5764 other standard libraries.  In other words, when you specify @option{-nostdlib}
5765 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5766 This ensures that you have no unresolved references to internal GCC
5767 library subroutines.  (For example, @samp{__main}, used to ensure C++
5768 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5769 GNU Compiler Collection (GCC) Internals}.)
5770
5771 @item -pie
5772 @opindex pie
5773 Produce a position independent executable on targets which support it.
5774 For predictable results, you must also specify the same set of options
5775 that were used to generate code (@option{-fpie}, @option{-fPIE},
5776 or model suboptions) when you specify this option.
5777
5778 @item -s
5779 @opindex s
5780 Remove all symbol table and relocation information from the executable.
5781
5782 @item -static
5783 @opindex static
5784 On systems that support dynamic linking, this prevents linking with the shared
5785 libraries.  On other systems, this option has no effect.
5786
5787 @item -shared
5788 @opindex shared
5789 Produce a shared object which can then be linked with other objects to
5790 form an executable.  Not all systems support this option.  For predictable
5791 results, you must also specify the same set of options that were used to
5792 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5793 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5794 needs to build supplementary stub code for constructors to work.  On
5795 multi-libbed systems, @samp{gcc -shared} must select the correct support
5796 libraries to link against.  Failing to supply the correct flags may lead
5797 to subtle defects.  Supplying them in cases where they are not necessary
5798 is innocuous.}
5799
5800 @item -shared-libgcc
5801 @itemx -static-libgcc
5802 @opindex shared-libgcc
5803 @opindex static-libgcc
5804 On systems that provide @file{libgcc} as a shared library, these options
5805 force the use of either the shared or static version respectively.
5806 If no shared version of @file{libgcc} was built when the compiler was
5807 configured, these options have no effect.
5808
5809 There are several situations in which an application should use the
5810 shared @file{libgcc} instead of the static version.  The most common
5811 of these is when the application wishes to throw and catch exceptions
5812 across different shared libraries.  In that case, each of the libraries
5813 as well as the application itself should use the shared @file{libgcc}.
5814
5815 Therefore, the G++ and GCJ drivers automatically add
5816 @option{-shared-libgcc} whenever you build a shared library or a main
5817 executable, because C++ and Java programs typically use exceptions, so
5818 this is the right thing to do.
5819
5820 If, instead, you use the GCC driver to create shared libraries, you may
5821 find that they will not always be linked with the shared @file{libgcc}.
5822 If GCC finds, at its configuration time, that you have a non-GNU linker
5823 or a GNU linker that does not support option @option{--eh-frame-hdr},
5824 it will link the shared version of @file{libgcc} into shared libraries
5825 by default.  Otherwise, it will take advantage of the linker and optimize
5826 away the linking with the shared version of @file{libgcc}, linking with
5827 the static version of libgcc by default.  This allows exceptions to
5828 propagate through such shared libraries, without incurring relocation
5829 costs at library load time.
5830
5831 However, if a library or main executable is supposed to throw or catch
5832 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5833 for the languages used in the program, or using the option
5834 @option{-shared-libgcc}, such that it is linked with the shared
5835 @file{libgcc}.
5836
5837 @item -symbolic
5838 @opindex symbolic
5839 Bind references to global symbols when building a shared object.  Warn
5840 about any unresolved references (unless overridden by the link editor
5841 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5842 this option.
5843
5844 @item -Xlinker @var{option}
5845 @opindex Xlinker
5846 Pass @var{option} as an option to the linker.  You can use this to
5847 supply system-specific linker options which GCC does not know how to
5848 recognize.
5849
5850 If you want to pass an option that takes an argument, you must use
5851 @option{-Xlinker} twice, once for the option and once for the argument.
5852 For example, to pass @option{-assert definitions}, you must write
5853 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5854 @option{-Xlinker "-assert definitions"}, because this passes the entire
5855 string as a single argument, which is not what the linker expects.
5856
5857 @item -Wl,@var{option}
5858 @opindex Wl
5859 Pass @var{option} as an option to the linker.  If @var{option} contains
5860 commas, it is split into multiple options at the commas.
5861
5862 @item -u @var{symbol}
5863 @opindex u
5864 Pretend the symbol @var{symbol} is undefined, to force linking of
5865 library modules to define it.  You can use @option{-u} multiple times with
5866 different symbols to force loading of additional library modules.
5867 @end table
5868
5869 @node Directory Options
5870 @section Options for Directory Search
5871 @cindex directory options
5872 @cindex options, directory search
5873 @cindex search path
5874
5875 These options specify directories to search for header files, for
5876 libraries and for parts of the compiler:
5877
5878 @table @gcctabopt
5879 @item -I@var{dir}
5880 @opindex I
5881 Add the directory @var{dir} to the head of the list of directories to be
5882 searched for header files.  This can be used to override a system header
5883 file, substituting your own version, since these directories are
5884 searched before the system header file directories.  However, you should
5885 not use this option to add directories that contain vendor-supplied
5886 system header files (use @option{-isystem} for that).  If you use more than
5887 one @option{-I} option, the directories are scanned in left-to-right
5888 order; the standard system directories come after.
5889
5890 If a standard system include directory, or a directory specified with
5891 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5892 option will be ignored.  The directory will still be searched but as a
5893 system directory at its normal position in the system include chain.
5894 This is to ensure that GCC's procedure to fix buggy system headers and
5895 the ordering for the include_next directive are not inadvertently changed.
5896 If you really need to change the search order for system directories,
5897 use the @option{-nostdinc} and/or @option{-isystem} options.
5898
5899 @item -iquote@var{dir}
5900 @opindex iquote
5901 Add the directory @var{dir} to the head of the list of directories to
5902 be searched for header files only for the case of @samp{#include
5903 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5904 otherwise just like @option{-I}.
5905
5906 @item -L@var{dir}
5907 @opindex L
5908 Add directory @var{dir} to the list of directories to be searched
5909 for @option{-l}.
5910
5911 @item -B@var{prefix}
5912 @opindex B
5913 This option specifies where to find the executables, libraries,
5914 include files, and data files of the compiler itself.
5915
5916 The compiler driver program runs one or more of the subprograms
5917 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5918 @var{prefix} as a prefix for each program it tries to run, both with and
5919 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5920
5921 For each subprogram to be run, the compiler driver first tries the
5922 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5923 was not specified, the driver tries two standard prefixes, which are
5924 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5925 those results in a file name that is found, the unmodified program
5926 name is searched for using the directories specified in your
5927 @env{PATH} environment variable.
5928
5929 The compiler will check to see if the path provided by the @option{-B}
5930 refers to a directory, and if necessary it will add a directory
5931 separator character at the end of the path.
5932
5933 @option{-B} prefixes that effectively specify directory names also apply
5934 to libraries in the linker, because the compiler translates these
5935 options into @option{-L} options for the linker.  They also apply to
5936 includes files in the preprocessor, because the compiler translates these
5937 options into @option{-isystem} options for the preprocessor.  In this case,
5938 the compiler appends @samp{include} to the prefix.
5939
5940 The run-time support file @file{libgcc.a} can also be searched for using
5941 the @option{-B} prefix, if needed.  If it is not found there, the two
5942 standard prefixes above are tried, and that is all.  The file is left
5943 out of the link if it is not found by those means.
5944
5945 Another way to specify a prefix much like the @option{-B} prefix is to use
5946 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5947 Variables}.
5948
5949 As a special kludge, if the path provided by @option{-B} is
5950 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5951 9, then it will be replaced by @file{[dir/]include}.  This is to help
5952 with boot-strapping the compiler.
5953
5954 @item -specs=@var{file}
5955 @opindex specs
5956 Process @var{file} after the compiler reads in the standard @file{specs}
5957 file, in order to override the defaults that the @file{gcc} driver
5958 program uses when determining what switches to pass to @file{cc1},
5959 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5960 @option{-specs=@var{file}} can be specified on the command line, and they
5961 are processed in order, from left to right.
5962
5963 @item -I-
5964 @opindex I-
5965 This option has been deprecated.  Please use @option{-iquote} instead for
5966 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5967 Any directories you specify with @option{-I} options before the @option{-I-}
5968 option are searched only for the case of @samp{#include "@var{file}"};
5969 they are not searched for @samp{#include <@var{file}>}.
5970
5971 If additional directories are specified with @option{-I} options after
5972 the @option{-I-}, these directories are searched for all @samp{#include}
5973 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5974 this way.)
5975
5976 In addition, the @option{-I-} option inhibits the use of the current
5977 directory (where the current input file came from) as the first search
5978 directory for @samp{#include "@var{file}"}.  There is no way to
5979 override this effect of @option{-I-}.  With @option{-I.} you can specify
5980 searching the directory which was current when the compiler was
5981 invoked.  That is not exactly the same as what the preprocessor does
5982 by default, but it is often satisfactory.
5983
5984 @option{-I-} does not inhibit the use of the standard system directories
5985 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5986 independent.
5987 @end table
5988
5989 @c man end
5990
5991 @node Spec Files
5992 @section Specifying subprocesses and the switches to pass to them
5993 @cindex Spec Files
5994
5995 @command{gcc} is a driver program.  It performs its job by invoking a
5996 sequence of other programs to do the work of compiling, assembling and
5997 linking.  GCC interprets its command-line parameters and uses these to
5998 deduce which programs it should invoke, and which command-line options
5999 it ought to place on their command lines.  This behavior is controlled
6000 by @dfn{spec strings}.  In most cases there is one spec string for each
6001 program that GCC can invoke, but a few programs have multiple spec
6002 strings to control their behavior.  The spec strings built into GCC can
6003 be overridden by using the @option{-specs=} command-line switch to specify
6004 a spec file.
6005
6006 @dfn{Spec files} are plaintext files that are used to construct spec
6007 strings.  They consist of a sequence of directives separated by blank
6008 lines.  The type of directive is determined by the first non-whitespace
6009 character on the line and it can be one of the following:
6010
6011 @table @code
6012 @item %@var{command}
6013 Issues a @var{command} to the spec file processor.  The commands that can
6014 appear here are:
6015
6016 @table @code
6017 @item %include <@var{file}>
6018 @cindex %include
6019 Search for @var{file} and insert its text at the current point in the
6020 specs file.
6021
6022 @item %include_noerr <@var{file}>
6023 @cindex %include_noerr
6024 Just like @samp{%include}, but do not generate an error message if the include
6025 file cannot be found.
6026
6027 @item %rename @var{old_name} @var{new_name}
6028 @cindex %rename
6029 Rename the spec string @var{old_name} to @var{new_name}.
6030
6031 @end table
6032
6033 @item *[@var{spec_name}]:
6034 This tells the compiler to create, override or delete the named spec
6035 string.  All lines after this directive up to the next directive or
6036 blank line are considered to be the text for the spec string.  If this
6037 results in an empty string then the spec will be deleted.  (Or, if the
6038 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6039 does not currently exist a new spec will be created.  If the spec does
6040 exist then its contents will be overridden by the text of this
6041 directive, unless the first character of that text is the @samp{+}
6042 character, in which case the text will be appended to the spec.
6043
6044 @item [@var{suffix}]:
6045 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6046 and up to the next directive or blank line are considered to make up the
6047 spec string for the indicated suffix.  When the compiler encounters an
6048 input file with the named suffix, it will processes the spec string in
6049 order to work out how to compile that file.  For example:
6050
6051 @smallexample
6052 .ZZ:
6053 z-compile -input %i
6054 @end smallexample
6055
6056 This says that any input file whose name ends in @samp{.ZZ} should be
6057 passed to the program @samp{z-compile}, which should be invoked with the
6058 command-line switch @option{-input} and with the result of performing the
6059 @samp{%i} substitution.  (See below.)
6060
6061 As an alternative to providing a spec string, the text that follows a
6062 suffix directive can be one of the following:
6063
6064 @table @code
6065 @item @@@var{language}
6066 This says that the suffix is an alias for a known @var{language}.  This is
6067 similar to using the @option{-x} command-line switch to GCC to specify a
6068 language explicitly.  For example:
6069
6070 @smallexample
6071 .ZZ:
6072 @@c++
6073 @end smallexample
6074
6075 Says that .ZZ files are, in fact, C++ source files.
6076
6077 @item #@var{name}
6078 This causes an error messages saying:
6079
6080 @smallexample
6081 @var{name} compiler not installed on this system.
6082 @end smallexample
6083 @end table
6084
6085 GCC already has an extensive list of suffixes built into it.
6086 This directive will add an entry to the end of the list of suffixes, but
6087 since the list is searched from the end backwards, it is effectively
6088 possible to override earlier entries using this technique.
6089
6090 @end table
6091
6092 GCC has the following spec strings built into it.  Spec files can
6093 override these strings or create their own.  Note that individual
6094 targets can also add their own spec strings to this list.
6095
6096 @smallexample
6097 asm          Options to pass to the assembler
6098 asm_final    Options to pass to the assembler post-processor
6099 cpp          Options to pass to the C preprocessor
6100 cc1          Options to pass to the C compiler
6101 cc1plus      Options to pass to the C++ compiler
6102 endfile      Object files to include at the end of the link
6103 link         Options to pass to the linker
6104 lib          Libraries to include on the command line to the linker
6105 libgcc       Decides which GCC support library to pass to the linker
6106 linker       Sets the name of the linker
6107 predefines   Defines to be passed to the C preprocessor
6108 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6109              by default
6110 startfile    Object files to include at the start of the link
6111 @end smallexample
6112
6113 Here is a small example of a spec file:
6114
6115 @smallexample
6116 %rename lib                 old_lib
6117
6118 *lib:
6119 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6120 @end smallexample
6121
6122 This example renames the spec called @samp{lib} to @samp{old_lib} and
6123 then overrides the previous definition of @samp{lib} with a new one.
6124 The new definition adds in some extra command-line options before
6125 including the text of the old definition.
6126
6127 @dfn{Spec strings} are a list of command-line options to be passed to their
6128 corresponding program.  In addition, the spec strings can contain
6129 @samp{%}-prefixed sequences to substitute variable text or to
6130 conditionally insert text into the command line.  Using these constructs
6131 it is possible to generate quite complex command lines.
6132
6133 Here is a table of all defined @samp{%}-sequences for spec
6134 strings.  Note that spaces are not generated automatically around the
6135 results of expanding these sequences.  Therefore you can concatenate them
6136 together or combine them with constant text in a single argument.
6137
6138 @table @code
6139 @item %%
6140 Substitute one @samp{%} into the program name or argument.
6141
6142 @item %i
6143 Substitute the name of the input file being processed.
6144
6145 @item %b
6146 Substitute the basename of the input file being processed.
6147 This is the substring up to (and not including) the last period
6148 and not including the directory.
6149
6150 @item %B
6151 This is the same as @samp{%b}, but include the file suffix (text after
6152 the last period).
6153
6154 @item %d
6155 Marks the argument containing or following the @samp{%d} as a
6156 temporary file name, so that that file will be deleted if GCC exits
6157 successfully.  Unlike @samp{%g}, this contributes no text to the
6158 argument.
6159
6160 @item %g@var{suffix}
6161 Substitute a file name that has suffix @var{suffix} and is chosen
6162 once per compilation, and mark the argument in the same way as
6163 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6164 name is now chosen in a way that is hard to predict even when previously
6165 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6166 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6167 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6168 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6169 was simply substituted with a file name chosen once per compilation,
6170 without regard to any appended suffix (which was therefore treated
6171 just like ordinary text), making such attacks more likely to succeed.
6172
6173 @item %u@var{suffix}
6174 Like @samp{%g}, but generates a new temporary file name even if
6175 @samp{%u@var{suffix}} was already seen.
6176
6177 @item %U@var{suffix}
6178 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6179 new one if there is no such last file name.  In the absence of any
6180 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6181 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6182 would involve the generation of two distinct file names, one
6183 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6184 simply substituted with a file name chosen for the previous @samp{%u},
6185 without regard to any appended suffix.
6186
6187 @item %j@var{suffix}
6188 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6189 writable, and if save-temps is off; otherwise, substitute the name
6190 of a temporary file, just like @samp{%u}.  This temporary file is not
6191 meant for communication between processes, but rather as a junk
6192 disposal mechanism.
6193
6194 @item %|@var{suffix}
6195 @itemx %m@var{suffix}
6196 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6197 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6198 all.  These are the two most common ways to instruct a program that it
6199 should read from standard input or write to standard output.  If you
6200 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6201 construct: see for example @file{f/lang-specs.h}.
6202
6203 @item %.@var{SUFFIX}
6204 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6205 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6206 terminated by the next space or %.
6207
6208 @item %w
6209 Marks the argument containing or following the @samp{%w} as the
6210 designated output file of this compilation.  This puts the argument
6211 into the sequence of arguments that @samp{%o} will substitute later.
6212
6213 @item %o
6214 Substitutes the names of all the output files, with spaces
6215 automatically placed around them.  You should write spaces
6216 around the @samp{%o} as well or the results are undefined.
6217 @samp{%o} is for use in the specs for running the linker.
6218 Input files whose names have no recognized suffix are not compiled
6219 at all, but they are included among the output files, so they will
6220 be linked.
6221
6222 @item %O
6223 Substitutes the suffix for object files.  Note that this is
6224 handled specially when it immediately follows @samp{%g, %u, or %U},
6225 because of the need for those to form complete file names.  The
6226 handling is such that @samp{%O} is treated exactly as if it had already
6227 been substituted, except that @samp{%g, %u, and %U} do not currently
6228 support additional @var{suffix} characters following @samp{%O} as they would
6229 following, for example, @samp{.o}.
6230
6231 @item %p
6232 Substitutes the standard macro predefinitions for the
6233 current target machine.  Use this when running @code{cpp}.
6234
6235 @item %P
6236 Like @samp{%p}, but puts @samp{__} before and after the name of each
6237 predefined macro, except for macros that start with @samp{__} or with
6238 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6239 C@.
6240
6241 @item %I
6242 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6243 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6244 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6245 as necessary.
6246
6247 @item %s
6248 Current argument is the name of a library or startup file of some sort.
6249 Search for that file in a standard list of directories and substitute
6250 the full name found.
6251
6252 @item %e@var{str}
6253 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6254 Use this when inconsistent options are detected.
6255
6256 @item %(@var{name})
6257 Substitute the contents of spec string @var{name} at this point.
6258
6259 @item %[@var{name}]
6260 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6261
6262 @item %x@{@var{option}@}
6263 Accumulate an option for @samp{%X}.
6264
6265 @item %X
6266 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6267 spec string.
6268
6269 @item %Y
6270 Output the accumulated assembler options specified by @option{-Wa}.
6271
6272 @item %Z
6273 Output the accumulated preprocessor options specified by @option{-Wp}.
6274
6275 @item %a
6276 Process the @code{asm} spec.  This is used to compute the
6277 switches to be passed to the assembler.
6278
6279 @item %A
6280 Process the @code{asm_final} spec.  This is a spec string for
6281 passing switches to an assembler post-processor, if such a program is
6282 needed.
6283
6284 @item %l
6285 Process the @code{link} spec.  This is the spec for computing the
6286 command line passed to the linker.  Typically it will make use of the
6287 @samp{%L %G %S %D and %E} sequences.
6288
6289 @item %D
6290 Dump out a @option{-L} option for each directory that GCC believes might
6291 contain startup files.  If the target supports multilibs then the
6292 current multilib directory will be prepended to each of these paths.
6293
6294 @item %M
6295 Output the multilib directory with directory separators replaced with
6296 @samp{_}.  If multilib directories are not set, or the multilib directory is
6297 @file{.} then this option emits nothing.
6298
6299 @item %L
6300 Process the @code{lib} spec.  This is a spec string for deciding which
6301 libraries should be included on the command line to the linker.
6302
6303 @item %G
6304 Process the @code{libgcc} spec.  This is a spec string for deciding
6305 which GCC support library should be included on the command line to the linker.
6306
6307 @item %S
6308 Process the @code{startfile} spec.  This is a spec for deciding which
6309 object files should be the first ones passed to the linker.  Typically
6310 this might be a file named @file{crt0.o}.
6311
6312 @item %E
6313 Process the @code{endfile} spec.  This is a spec string that specifies
6314 the last object files that will be passed to the linker.
6315
6316 @item %C
6317 Process the @code{cpp} spec.  This is used to construct the arguments
6318 to be passed to the C preprocessor.
6319
6320 @item %1
6321 Process the @code{cc1} spec.  This is used to construct the options to be
6322 passed to the actual C compiler (@samp{cc1}).
6323
6324 @item %2
6325 Process the @code{cc1plus} spec.  This is used to construct the options to be
6326 passed to the actual C++ compiler (@samp{cc1plus}).
6327
6328 @item %*
6329 Substitute the variable part of a matched option.  See below.
6330 Note that each comma in the substituted string is replaced by
6331 a single space.
6332
6333 @item %<@code{S}
6334 Remove all occurrences of @code{-S} from the command line.  Note---this
6335 command is position dependent.  @samp{%} commands in the spec string
6336 before this one will see @code{-S}, @samp{%} commands in the spec string
6337 after this one will not.
6338
6339 @item %:@var{function}(@var{args})
6340 Call the named function @var{function}, passing it @var{args}.
6341 @var{args} is first processed as a nested spec string, then split
6342 into an argument vector in the usual fashion.  The function returns
6343 a string which is processed as if it had appeared literally as part
6344 of the current spec.
6345
6346 The following built-in spec functions are provided:
6347
6348 @table @code
6349 @item @code{if-exists}
6350 The @code{if-exists} spec function takes one argument, an absolute
6351 pathname to a file.  If the file exists, @code{if-exists} returns the
6352 pathname.  Here is a small example of its usage:
6353
6354 @smallexample
6355 *startfile:
6356 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6357 @end smallexample
6358
6359 @item @code{if-exists-else}
6360 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6361 spec function, except that it takes two arguments.  The first argument is
6362 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6363 returns the pathname.  If it does not exist, it returns the second argument.
6364 This way, @code{if-exists-else} can be used to select one file or another,
6365 based on the existence of the first.  Here is a small example of its usage:
6366
6367 @smallexample
6368 *startfile:
6369 crt0%O%s %:if-exists(crti%O%s) \
6370 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6371 @end smallexample
6372
6373 @item @code{replace-outfile}
6374 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6375 first argument in the outfiles array and replaces it with the second argument.  Here
6376 is a small example of its usage:
6377
6378 @smallexample
6379 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6380 @end smallexample
6381
6382 @end table
6383
6384 @item %@{@code{S}@}
6385 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6386 If that switch was not specified, this substitutes nothing.  Note that
6387 the leading dash is omitted when specifying this option, and it is
6388 automatically inserted if the substitution is performed.  Thus the spec
6389 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6390 and would output the command line option @option{-foo}.
6391
6392 @item %W@{@code{S}@}
6393 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6394 deleted on failure.
6395
6396 @item %@{@code{S}*@}
6397 Substitutes all the switches specified to GCC whose names start
6398 with @code{-S}, but which also take an argument.  This is used for
6399 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6400 GCC considers @option{-o foo} as being
6401 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6402 text, including the space.  Thus two arguments would be generated.
6403
6404 @item %@{@code{S}*&@code{T}*@}
6405 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6406 (the order of @code{S} and @code{T} in the spec is not significant).
6407 There can be any number of ampersand-separated variables; for each the
6408 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6409
6410 @item %@{@code{S}:@code{X}@}
6411 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6412
6413 @item %@{!@code{S}:@code{X}@}
6414 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6415
6416 @item %@{@code{S}*:@code{X}@}
6417 Substitutes @code{X} if one or more switches whose names start with
6418 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6419 once, no matter how many such switches appeared.  However, if @code{%*}
6420 appears somewhere in @code{X}, then @code{X} will be substituted once
6421 for each matching switch, with the @code{%*} replaced by the part of
6422 that switch that matched the @code{*}.
6423
6424 @item %@{.@code{S}:@code{X}@}
6425 Substitutes @code{X}, if processing a file with suffix @code{S}.
6426
6427 @item %@{!.@code{S}:@code{X}@}
6428 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6429
6430 @item %@{@code{S}|@code{P}:@code{X}@}
6431 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6432 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6433 although they have a stronger binding than the @samp{|}.  If @code{%*}
6434 appears in @code{X}, all of the alternatives must be starred, and only
6435 the first matching alternative is substituted.
6436
6437 For example, a spec string like this:
6438
6439 @smallexample
6440 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6441 @end smallexample
6442
6443 will output the following command-line options from the following input
6444 command-line options:
6445
6446 @smallexample
6447 fred.c        -foo -baz
6448 jim.d         -bar -boggle
6449 -d fred.c     -foo -baz -boggle
6450 -d jim.d      -bar -baz -boggle
6451 @end smallexample
6452
6453 @item %@{S:X; T:Y; :D@}
6454
6455 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6456 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6457 be as many clauses as you need.  This may be combined with @code{.},
6458 @code{!}, @code{|}, and @code{*} as needed.
6459
6460
6461 @end table
6462
6463 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6464 construct may contain other nested @samp{%} constructs or spaces, or
6465 even newlines.  They are processed as usual, as described above.
6466 Trailing white space in @code{X} is ignored.  White space may also
6467 appear anywhere on the left side of the colon in these constructs,
6468 except between @code{.} or @code{*} and the corresponding word.
6469
6470 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6471 handled specifically in these constructs.  If another value of
6472 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6473 @option{-W} switch is found later in the command line, the earlier
6474 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6475 just one letter, which passes all matching options.
6476
6477 The character @samp{|} at the beginning of the predicate text is used to
6478 indicate that a command should be piped to the following command, but
6479 only if @option{-pipe} is specified.
6480
6481 It is built into GCC which switches take arguments and which do not.
6482 (You might think it would be useful to generalize this to allow each
6483 compiler's spec to say which switches take arguments.  But this cannot
6484 be done in a consistent fashion.  GCC cannot even decide which input
6485 files have been specified without knowing which switches take arguments,
6486 and it must know which input files to compile in order to tell which
6487 compilers to run).
6488
6489 GCC also knows implicitly that arguments starting in @option{-l} are to be
6490 treated as compiler output files, and passed to the linker in their
6491 proper position among the other output files.
6492
6493 @c man begin OPTIONS
6494
6495 @node Target Options
6496 @section Specifying Target Machine and Compiler Version
6497 @cindex target options
6498 @cindex cross compiling
6499 @cindex specifying machine version
6500 @cindex specifying compiler version and target machine
6501 @cindex compiler version, specifying
6502 @cindex target machine, specifying
6503
6504 The usual way to run GCC is to run the executable called @file{gcc}, or
6505 @file{<machine>-gcc} when cross-compiling, or
6506 @file{<machine>-gcc-<version>} to run a version other than the one that
6507 was installed last.  Sometimes this is inconvenient, so GCC provides
6508 options that will switch to another cross-compiler or version.
6509
6510 @table @gcctabopt
6511 @item -b @var{machine}
6512 @opindex b
6513 The argument @var{machine} specifies the target machine for compilation.
6514
6515 The value to use for @var{machine} is the same as was specified as the
6516 machine type when configuring GCC as a cross-compiler.  For
6517 example, if a cross-compiler was configured with @samp{configure
6518 i386v}, meaning to compile for an 80386 running System V, then you
6519 would specify @option{-b i386v} to run that cross compiler.
6520
6521 @item -V @var{version}
6522 @opindex V
6523 The argument @var{version} specifies which version of GCC to run.
6524 This is useful when multiple versions are installed.  For example,
6525 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6526 @end table
6527
6528 The @option{-V} and @option{-b} options work by running the
6529 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6530 use them if you can just run that directly.
6531
6532 @node Submodel Options
6533 @section Hardware Models and Configurations
6534 @cindex submodel options
6535 @cindex specifying hardware config
6536 @cindex hardware models and configurations, specifying
6537 @cindex machine dependent options
6538
6539 Earlier we discussed the standard option @option{-b} which chooses among
6540 different installed compilers for completely different target
6541 machines, such as VAX vs.@: 68000 vs.@: 80386.
6542
6543 In addition, each of these target machine types can have its own
6544 special options, starting with @samp{-m}, to choose among various
6545 hardware models or configurations---for example, 68010 vs 68020,
6546 floating coprocessor or none.  A single installed version of the
6547 compiler can compile for any model or configuration, according to the
6548 options specified.
6549
6550 Some configurations of the compiler also support additional special
6551 options, usually for compatibility with other compilers on the same
6552 platform.
6553
6554 These options are defined by the macro @code{TARGET_SWITCHES} in the
6555 machine description.  The default for the options is also defined by
6556 that macro, which enables you to change the defaults.
6557
6558 @c This list is ordered alphanumerically by subsection name.
6559 @c It should be the same order and spelling as these options are listed
6560 @c in Machine Dependent Options
6561
6562 @menu
6563 * ARC Options::
6564 * ARM Options::
6565 * AVR Options::
6566 * CRIS Options::
6567 * Darwin Options::
6568 * DEC Alpha Options::
6569 * DEC Alpha/VMS Options::
6570 * FRV Options::
6571 * H8/300 Options::
6572 * HPPA Options::
6573 * i386 and x86-64 Options::
6574 * IA-64 Options::
6575 * M32R/D Options::
6576 * M680x0 Options::
6577 * M68hc1x Options::
6578 * MCore Options::
6579 * MIPS Options::
6580 * MMIX Options::
6581 * MN10300 Options::
6582 * NS32K Options::
6583 * PDP-11 Options::
6584 * PowerPC Options::
6585 * RS/6000 and PowerPC Options::
6586 * S/390 and zSeries Options::
6587 * SH Options::
6588 * SPARC Options::
6589 * System V Options::
6590 * TMS320C3x/C4x Options::
6591 * V850 Options::
6592 * VAX Options::
6593 * x86-64 Options::
6594 * Xstormy16 Options::
6595 * Xtensa Options::
6596 * zSeries Options::
6597 @end menu
6598
6599 @node ARC Options
6600 @subsection ARC Options
6601 @cindex ARC Options
6602
6603 These options are defined for ARC implementations:
6604
6605 @table @gcctabopt
6606 @item -EL
6607 @opindex EL
6608 Compile code for little endian mode.  This is the default.
6609
6610 @item -EB
6611 @opindex EB
6612 Compile code for big endian mode.
6613
6614 @item -mmangle-cpu
6615 @opindex mmangle-cpu
6616 Prepend the name of the cpu to all public symbol names.
6617 In multiple-processor systems, there are many ARC variants with different
6618 instruction and register set characteristics.  This flag prevents code
6619 compiled for one cpu to be linked with code compiled for another.
6620 No facility exists for handling variants that are ``almost identical''.
6621 This is an all or nothing option.
6622
6623 @item -mcpu=@var{cpu}
6624 @opindex mcpu
6625 Compile code for ARC variant @var{cpu}.
6626 Which variants are supported depend on the configuration.
6627 All variants support @option{-mcpu=base}, this is the default.
6628
6629 @item -mtext=@var{text-section}
6630 @itemx -mdata=@var{data-section}
6631 @itemx -mrodata=@var{readonly-data-section}
6632 @opindex mtext
6633 @opindex mdata
6634 @opindex mrodata
6635 Put functions, data, and readonly data in @var{text-section},
6636 @var{data-section}, and @var{readonly-data-section} respectively
6637 by default.  This can be overridden with the @code{section} attribute.
6638 @xref{Variable Attributes}.
6639
6640 @end table
6641
6642 @node ARM Options
6643 @subsection ARM Options
6644 @cindex ARM options
6645
6646 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6647 architectures:
6648
6649 @table @gcctabopt
6650 @item -mabi=@var{name}
6651 @opindex mabi
6652 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6653 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6654
6655 @item -mapcs-frame
6656 @opindex mapcs-frame
6657 Generate a stack frame that is compliant with the ARM Procedure Call
6658 Standard for all functions, even if this is not strictly necessary for
6659 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6660 with this option will cause the stack frames not to be generated for
6661 leaf functions.  The default is @option{-mno-apcs-frame}.
6662
6663 @item -mapcs
6664 @opindex mapcs
6665 This is a synonym for @option{-mapcs-frame}.
6666
6667 @ignore
6668 @c not currently implemented
6669 @item -mapcs-stack-check
6670 @opindex mapcs-stack-check
6671 Generate code to check the amount of stack space available upon entry to
6672 every function (that actually uses some stack space).  If there is
6673 insufficient space available then either the function
6674 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6675 called, depending upon the amount of stack space required.  The run time
6676 system is required to provide these functions.  The default is
6677 @option{-mno-apcs-stack-check}, since this produces smaller code.
6678
6679 @c not currently implemented
6680 @item -mapcs-float
6681 @opindex mapcs-float
6682 Pass floating point arguments using the float point registers.  This is
6683 one of the variants of the APCS@.  This option is recommended if the
6684 target hardware has a floating point unit or if a lot of floating point
6685 arithmetic is going to be performed by the code.  The default is
6686 @option{-mno-apcs-float}, since integer only code is slightly increased in
6687 size if @option{-mapcs-float} is used.
6688
6689 @c not currently implemented
6690 @item -mapcs-reentrant
6691 @opindex mapcs-reentrant
6692 Generate reentrant, position independent code.  The default is
6693 @option{-mno-apcs-reentrant}.
6694 @end ignore
6695
6696 @item -mthumb-interwork
6697 @opindex mthumb-interwork
6698 Generate code which supports calling between the ARM and Thumb
6699 instruction sets.  Without this option the two instruction sets cannot
6700 be reliably used inside one program.  The default is
6701 @option{-mno-thumb-interwork}, since slightly larger code is generated
6702 when @option{-mthumb-interwork} is specified.
6703
6704 @item -mno-sched-prolog
6705 @opindex mno-sched-prolog
6706 Prevent the reordering of instructions in the function prolog, or the
6707 merging of those instruction with the instructions in the function's
6708 body.  This means that all functions will start with a recognizable set
6709 of instructions (or in fact one of a choice from a small set of
6710 different function prologues), and this information can be used to
6711 locate the start if functions inside an executable piece of code.  The
6712 default is @option{-msched-prolog}.
6713
6714 @item -mhard-float
6715 @opindex mhard-float
6716 Generate output containing floating point instructions.  This is the
6717 default.
6718
6719 @item -msoft-float
6720 @opindex msoft-float
6721 Generate output containing library calls for floating point.
6722 @strong{Warning:} the requisite libraries are not available for all ARM
6723 targets.  Normally the facilities of the machine's usual C compiler are
6724 used, but this cannot be done directly in cross-compilation.  You must make
6725 your own arrangements to provide suitable library functions for
6726 cross-compilation.
6727
6728 @option{-msoft-float} changes the calling convention in the output file;
6729 therefore, it is only useful if you compile @emph{all} of a program with
6730 this option.  In particular, you need to compile @file{libgcc.a}, the
6731 library that comes with GCC, with @option{-msoft-float} in order for
6732 this to work.
6733
6734 @item -mfloat-abi=@var{name}
6735 @opindex mfloat-abi
6736 Specifies which ABI to use for floating point values.  Permissible values
6737 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6738
6739 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6740 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6741 of floating point instructions, but still uses the soft-float calling
6742 conventions.
6743
6744 @item -mlittle-endian
6745 @opindex mlittle-endian
6746 Generate code for a processor running in little-endian mode.  This is
6747 the default for all standard configurations.
6748
6749 @item -mbig-endian
6750 @opindex mbig-endian
6751 Generate code for a processor running in big-endian mode; the default is
6752 to compile code for a little-endian processor.
6753
6754 @item -mwords-little-endian
6755 @opindex mwords-little-endian
6756 This option only applies when generating code for big-endian processors.
6757 Generate code for a little-endian word order but a big-endian byte
6758 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6759 option should only be used if you require compatibility with code for
6760 big-endian ARM processors generated by versions of the compiler prior to
6761 2.8.
6762
6763 @item -mcpu=@var{name}
6764 @opindex mcpu
6765 This specifies the name of the target ARM processor.  GCC uses this name
6766 to determine what kind of instructions it can emit when generating
6767 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6768 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6769 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6770 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6771 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6772 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6773 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6774 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6775 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6776 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6777 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6778 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6779 @samp{arm1136j-s}, @samp{arm1136jf-s} ,@samp{xscale}, @samp{iwmmxt},
6780 @samp{ep9312}.
6781
6782 @itemx -mtune=@var{name}
6783 @opindex mtune
6784 This option is very similar to the @option{-mcpu=} option, except that
6785 instead of specifying the actual target processor type, and hence
6786 restricting which instructions can be used, it specifies that GCC should
6787 tune the performance of the code as if the target were of the type
6788 specified in this option, but still choosing the instructions that it
6789 will generate based on the cpu specified by a @option{-mcpu=} option.
6790 For some ARM implementations better performance can be obtained by using
6791 this option.
6792
6793 @item -march=@var{name}
6794 @opindex march
6795 This specifies the name of the target ARM architecture.  GCC uses this
6796 name to determine what kind of instructions it can emit when generating
6797 assembly code.  This option can be used in conjunction with or instead
6798 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6799 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6800 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6801 @samp{iwmmxt}, @samp{ep9312}.
6802
6803 @item -mfpu=@var{name}
6804 @itemx -mfpe=@var{number}
6805 @itemx -mfp=@var{number}
6806 @opindex mfpu
6807 @opindex mfpe
6808 @opindex mfp
6809 This specifies what floating point hardware (or hardware emulation) is
6810 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6811 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6812 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6813 with older versions of GCC@.
6814
6815 If @option{-msoft-float} is specified this specifies the format of
6816 floating point values.
6817
6818 @item -mstructure-size-boundary=@var{n}
6819 @opindex mstructure-size-boundary
6820 The size of all structures and unions will be rounded up to a multiple
6821 of the number of bits set by this option.  Permissible values are 8, 32
6822 and 64.  The default value varies for different toolchains.  For the COFF
6823 targeted toolchain the default value is 8.  A value of 64 is only allowed
6824 if the underlying ABI supports it.
6825
6826 Specifying the larger number can produce faster, more efficient code, but
6827 can also increase the size of the program.  Different values are potentially
6828 incompatible.  Code compiled with one value cannot necessarily expect to
6829 work with code or libraries compiled with another value, if they exchange
6830 information using structures or unions.
6831
6832 @item -mabort-on-noreturn
6833 @opindex mabort-on-noreturn
6834 Generate a call to the function @code{abort} at the end of a
6835 @code{noreturn} function.  It will be executed if the function tries to
6836 return.
6837
6838 @item -mlong-calls
6839 @itemx -mno-long-calls
6840 @opindex mlong-calls
6841 @opindex mno-long-calls
6842 Tells the compiler to perform function calls by first loading the
6843 address of the function into a register and then performing a subroutine
6844 call on this register.  This switch is needed if the target function
6845 will lie outside of the 64 megabyte addressing range of the offset based
6846 version of subroutine call instruction.
6847
6848 Even if this switch is enabled, not all function calls will be turned
6849 into long calls.  The heuristic is that static functions, functions
6850 which have the @samp{short-call} attribute, functions that are inside
6851 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6852 definitions have already been compiled within the current compilation
6853 unit, will not be turned into long calls.  The exception to this rule is
6854 that weak function definitions, functions with the @samp{long-call}
6855 attribute or the @samp{section} attribute, and functions that are within
6856 the scope of a @samp{#pragma long_calls} directive, will always be
6857 turned into long calls.
6858
6859 This feature is not enabled by default.  Specifying
6860 @option{-mno-long-calls} will restore the default behavior, as will
6861 placing the function calls within the scope of a @samp{#pragma
6862 long_calls_off} directive.  Note these switches have no effect on how
6863 the compiler generates code to handle function calls via function
6864 pointers.
6865
6866 @item -mnop-fun-dllimport
6867 @opindex mnop-fun-dllimport
6868 Disable support for the @code{dllimport} attribute.
6869
6870 @item -msingle-pic-base
6871 @opindex msingle-pic-base
6872 Treat the register used for PIC addressing as read-only, rather than
6873 loading it in the prologue for each function.  The run-time system is
6874 responsible for initializing this register with an appropriate value
6875 before execution begins.
6876
6877 @item -mpic-register=@var{reg}
6878 @opindex mpic-register
6879 Specify the register to be used for PIC addressing.  The default is R10
6880 unless stack-checking is enabled, when R9 is used.
6881
6882 @item -mcirrus-fix-invalid-insns
6883 @opindex mcirrus-fix-invalid-insns
6884 @opindex mno-cirrus-fix-invalid-insns
6885 Insert NOPs into the instruction stream to in order to work around
6886 problems with invalid Maverick instruction combinations.  This option
6887 is only valid if the @option{-mcpu=ep9312} option has been used to
6888 enable generation of instructions for the Cirrus Maverick floating
6889 point co-processor.  This option is not enabled by default, since the
6890 problem is only present in older Maverick implementations.  The default
6891 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6892 switch.
6893
6894 @item -mpoke-function-name
6895 @opindex mpoke-function-name
6896 Write the name of each function into the text section, directly
6897 preceding the function prologue.  The generated code is similar to this:
6898
6899 @smallexample
6900      t0
6901          .ascii "arm_poke_function_name", 0
6902          .align
6903      t1
6904          .word 0xff000000 + (t1 - t0)
6905      arm_poke_function_name
6906          mov     ip, sp
6907          stmfd   sp!, @{fp, ip, lr, pc@}
6908          sub     fp, ip, #4
6909 @end smallexample
6910
6911 When performing a stack backtrace, code can inspect the value of
6912 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6913 location @code{pc - 12} and the top 8 bits are set, then we know that
6914 there is a function name embedded immediately preceding this location
6915 and has length @code{((pc[-3]) & 0xff000000)}.
6916
6917 @item -mthumb
6918 @opindex mthumb
6919 Generate code for the 16-bit Thumb instruction set.  The default is to
6920 use the 32-bit ARM instruction set.
6921
6922 @item -mtpcs-frame
6923 @opindex mtpcs-frame
6924 Generate a stack frame that is compliant with the Thumb Procedure Call
6925 Standard for all non-leaf functions.  (A leaf function is one that does
6926 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6927
6928 @item -mtpcs-leaf-frame
6929 @opindex mtpcs-leaf-frame
6930 Generate a stack frame that is compliant with the Thumb Procedure Call
6931 Standard for all leaf functions.  (A leaf function is one that does
6932 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6933
6934 @item -mcallee-super-interworking
6935 @opindex mcallee-super-interworking
6936 Gives all externally visible functions in the file being compiled an ARM
6937 instruction set header which switches to Thumb mode before executing the
6938 rest of the function.  This allows these functions to be called from
6939 non-interworking code.
6940
6941 @item -mcaller-super-interworking
6942 @opindex mcaller-super-interworking
6943 Allows calls via function pointers (including virtual functions) to
6944 execute correctly regardless of whether the target code has been
6945 compiled for interworking or not.  There is a small overhead in the cost
6946 of executing a function pointer if this option is enabled.
6947
6948 @end table
6949
6950 @node AVR Options
6951 @subsection AVR Options
6952 @cindex AVR Options
6953
6954 These options are defined for AVR implementations:
6955
6956 @table @gcctabopt
6957 @item -mmcu=@var{mcu}
6958 @opindex mmcu
6959 Specify ATMEL AVR instruction set or MCU type.
6960
6961 Instruction set avr1 is for the minimal AVR core, not supported by the C
6962 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6963 attiny11, attiny12, attiny15, attiny28).
6964
6965 Instruction set avr2 (default) is for the classic AVR core with up to
6966 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6967 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6968 at90c8534, at90s8535).
6969
6970 Instruction set avr3 is for the classic AVR core with up to 128K program
6971 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6972
6973 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6974 memory space (MCU types: atmega8, atmega83, atmega85).
6975
6976 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6977 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6978 atmega64, atmega128, at43usb355, at94k).
6979
6980 @item -msize
6981 @opindex msize
6982 Output instruction sizes to the asm file.
6983
6984 @item -minit-stack=@var{N}
6985 @opindex minit-stack
6986 Specify the initial stack address, which may be a symbol or numeric value,
6987 @samp{__stack} is the default.
6988
6989 @item -mno-interrupts
6990 @opindex mno-interrupts
6991 Generated code is not compatible with hardware interrupts.
6992 Code size will be smaller.
6993
6994 @item -mcall-prologues
6995 @opindex mcall-prologues
6996 Functions prologues/epilogues expanded as call to appropriate
6997 subroutines.  Code size will be smaller.
6998
6999 @item -mno-tablejump
7000 @opindex mno-tablejump
7001 Do not generate tablejump insns which sometimes increase code size.
7002
7003 @item -mtiny-stack
7004 @opindex mtiny-stack
7005 Change only the low 8 bits of the stack pointer.
7006
7007 @item -mint8
7008 @opindex mint8
7009 Assume int to be 8 bit integer. This affects the sizes of all types: A
7010 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7011 and long long will be 4 bytes. Please note that this option does not
7012 comply to the C standards, but it will provide you with smaller code
7013 size.
7014 @end table
7015
7016 @node CRIS Options
7017 @subsection CRIS Options
7018 @cindex CRIS Options
7019
7020 These options are defined specifically for the CRIS ports.
7021
7022 @table @gcctabopt
7023 @item -march=@var{architecture-type}
7024 @itemx -mcpu=@var{architecture-type}
7025 @opindex march
7026 @opindex mcpu
7027 Generate code for the specified architecture.  The choices for
7028 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7029 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
7030 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7031 @samp{v10}.
7032
7033 @item -mtune=@var{architecture-type}
7034 @opindex mtune
7035 Tune to @var{architecture-type} everything applicable about the generated
7036 code, except for the ABI and the set of available instructions.  The
7037 choices for @var{architecture-type} are the same as for
7038 @option{-march=@var{architecture-type}}.
7039
7040 @item -mmax-stack-frame=@var{n}
7041 @opindex mmax-stack-frame
7042 Warn when the stack frame of a function exceeds @var{n} bytes.
7043
7044 @item -melinux-stacksize=@var{n}
7045 @opindex melinux-stacksize
7046 Only available with the @samp{cris-axis-aout} target.  Arranges for
7047 indications in the program to the kernel loader that the stack of the
7048 program should be set to @var{n} bytes.
7049
7050 @item -metrax4
7051 @itemx -metrax100
7052 @opindex metrax4
7053 @opindex metrax100
7054 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7055 @option{-march=v3} and @option{-march=v8} respectively.
7056
7057 @item -mmul-bug-workaround
7058 @itemx -mno-mul-bug-workaround
7059 @opindex mmul-bug-workaround
7060 @opindex mno-mul-bug-workaround
7061 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7062 models where it applies.  This option is active by default.
7063
7064 @item -mpdebug
7065 @opindex mpdebug
7066 Enable CRIS-specific verbose debug-related information in the assembly
7067 code.  This option also has the effect to turn off the @samp{#NO_APP}
7068 formatted-code indicator to the assembler at the beginning of the
7069 assembly file.
7070
7071 @item -mcc-init
7072 @opindex mcc-init
7073 Do not use condition-code results from previous instruction; always emit
7074 compare and test instructions before use of condition codes.
7075
7076 @item -mno-side-effects
7077 @opindex mno-side-effects
7078 Do not emit instructions with side-effects in addressing modes other than
7079 post-increment.
7080
7081 @item -mstack-align
7082 @itemx -mno-stack-align
7083 @itemx -mdata-align
7084 @itemx -mno-data-align
7085 @itemx -mconst-align
7086 @itemx -mno-const-align
7087 @opindex mstack-align
7088 @opindex mno-stack-align
7089 @opindex mdata-align
7090 @opindex mno-data-align
7091 @opindex mconst-align
7092 @opindex mno-const-align
7093 These options (no-options) arranges (eliminate arrangements) for the
7094 stack-frame, individual data and constants to be aligned for the maximum
7095 single data access size for the chosen CPU model.  The default is to
7096 arrange for 32-bit alignment.  ABI details such as structure layout are
7097 not affected by these options.
7098
7099 @item -m32-bit
7100 @itemx -m16-bit
7101 @itemx -m8-bit
7102 @opindex m32-bit
7103 @opindex m16-bit
7104 @opindex m8-bit
7105 Similar to the stack- data- and const-align options above, these options
7106 arrange for stack-frame, writable data and constants to all be 32-bit,
7107 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7108
7109 @item -mno-prologue-epilogue
7110 @itemx -mprologue-epilogue
7111 @opindex mno-prologue-epilogue
7112 @opindex mprologue-epilogue
7113 With @option{-mno-prologue-epilogue}, the normal function prologue and
7114 epilogue that sets up the stack-frame are omitted and no return
7115 instructions or return sequences are generated in the code.  Use this
7116 option only together with visual inspection of the compiled code: no
7117 warnings or errors are generated when call-saved registers must be saved,
7118 or storage for local variable needs to be allocated.
7119
7120 @item -mno-gotplt
7121 @itemx -mgotplt
7122 @opindex mno-gotplt
7123 @opindex mgotplt
7124 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7125 instruction sequences that load addresses for functions from the PLT part
7126 of the GOT rather than (traditional on other architectures) calls to the
7127 PLT.  The default is @option{-mgotplt}.
7128
7129 @item -maout
7130 @opindex maout
7131 Legacy no-op option only recognized with the cris-axis-aout target.
7132
7133 @item -melf
7134 @opindex melf
7135 Legacy no-op option only recognized with the cris-axis-elf and
7136 cris-axis-linux-gnu targets.
7137
7138 @item -melinux
7139 @opindex melinux
7140 Only recognized with the cris-axis-aout target, where it selects a
7141 GNU/linux-like multilib, include files and instruction set for
7142 @option{-march=v8}.
7143
7144 @item -mlinux
7145 @opindex mlinux
7146 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7147
7148 @item -sim
7149 @opindex sim
7150 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7151 to link with input-output functions from a simulator library.  Code,
7152 initialized data and zero-initialized data are allocated consecutively.
7153
7154 @item -sim2
7155 @opindex sim2
7156 Like @option{-sim}, but pass linker options to locate initialized data at
7157 0x40000000 and zero-initialized data at 0x80000000.
7158 @end table
7159
7160 @node Darwin Options
7161 @subsection Darwin Options
7162 @cindex Darwin options
7163
7164 These options are defined for all architectures running the Darwin operating
7165 system.  They are useful for compatibility with other Mac OS compilers.
7166
7167 @table @gcctabopt
7168 @item -F@var{dir}
7169 @opindex F
7170 Add the framework directory @var{dir} to the head of the list of
7171 directories to be searched for header files.  These directories are
7172 interleaved with those specified by @option{-I} options and are
7173 scanned in a left-to-right order.
7174
7175 A framework directory is a directory with frameworks in it.  A
7176 framework is a directory with a @samp{"Headers"} and/or
7177 @samp{"PrivateHeaders"} directory contained directly in it that ends
7178 in @samp{".framework"}.  The name of a framework is the name of this
7179 directory excluding the @samp{".framework"}.  Headers associated with
7180 the framework are found in one of those two directories, with
7181 @samp{"Headers"} being searched first.  A subframework is a framework
7182 directory that is in a framework's @samp{"Frameworks"} directory.
7183 Includes of subframework headers can only appear in a header of a
7184 framework that contains the subframework, or in a sibling subframework
7185 header.  Two subframeworks are siblings if they occur in the same
7186 framework.  A subframework should not have the same name as a
7187 framework, a warning will be issued if this is violated.  Currently a
7188 subframework cannot have subframeworks, in the future, the mechanism
7189 may be extended to support this.  The standard frameworks can be found
7190 in @samp{"/System/Library/Frameworks"} and
7191 @samp{"/Library/Frameworks"}.  An example include looks like
7192 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7193 the name of the framework and header.h is found in the
7194 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7195
7196 @item -gused
7197 @opindex -gused
7198 Emit debugging information for symbols that are used. For STABS
7199 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7200 This is by default ON.
7201
7202 @item -gfull
7203 @opindex -gfull
7204 Emit debugging information for all symbols and types.
7205
7206 @item -mone-byte-bool
7207 @opindex -mone-byte-bool
7208 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7209 By default @samp{sizeof(bool)} is @samp{4} when compiling for 
7210 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7211 option has no effect on x86.
7212
7213 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7214 to generate code that is not binary compatible with code generated
7215 without that switch.  Using this switch may require recompiling all
7216 other modules in a program, including system libraries.  Use this 
7217 switch to conform to a non-default data model.
7218
7219 @item -mfix-and-continue
7220 @itemx -ffix-and-continue
7221 @itemx -findirect-data
7222 @opindex mfix-and-continue
7223 @opindex ffix-and-continue
7224 @opindex findirect-data
7225 Generate code suitable for fast turn around development.  Needed to
7226 enable gdb to dynamically load @code{.o} files into already running
7227 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7228 are provided for backwards compatibility.
7229
7230 @item -all_load
7231 @opindex all_load
7232 Loads all members of static archive libraries.
7233 See man ld(1) for more information.
7234
7235 @item -arch_errors_fatal
7236 @opindex arch_errors_fatal
7237 Cause the errors having to do with files that have the wrong architecture
7238 to be fatal.
7239
7240 @item -bind_at_load
7241 @opindex bind_at_load
7242 Causes the output file to be marked such that the dynamic linker will
7243 bind all undefined references when the file is loaded or launched.
7244
7245 @item -bundle
7246 @opindex bundle
7247 Produce a Mach-o bundle format file.
7248 See man ld(1) for more information.
7249
7250 @item -bundle_loader @var{executable}
7251 @opindex bundle_loader
7252 This specifies the @var{executable} that will be loading the build
7253 output file being linked. See man ld(1) for more information.
7254
7255 @item -allowable_client  @var{client_name}
7256 @itemx -arch_only
7257
7258 @itemx -client_name
7259 @itemx -compatibility_version
7260 @itemx -current_version
7261 @itemx -dead_strip
7262 @itemx -dependency-file
7263 @itemx -dylib_file
7264 @itemx -dylinker_install_name
7265 @itemx -dynamic
7266 @itemx -dynamiclib
7267 @itemx -exported_symbols_list
7268 @itemx -filelist
7269 @itemx -flat_namespace
7270 @itemx -force_cpusubtype_ALL
7271 @itemx -force_flat_namespace
7272 @itemx -headerpad_max_install_names
7273 @itemx -image_base
7274 @itemx -init
7275 @itemx -install_name
7276 @itemx -keep_private_externs
7277 @itemx -multi_module
7278 @itemx -multiply_defined
7279 @itemx -multiply_defined_unused
7280 @itemx -noall_load
7281 @itemx -no_dead_strip_inits_and_terms
7282 @itemx -nofixprebinding
7283 @itemx -nomultidefs
7284 @itemx -noprebind
7285 @itemx -noseglinkedit
7286 @itemx -pagezero_size
7287 @itemx -prebind
7288 @itemx -prebind_all_twolevel_modules
7289 @itemx -private_bundle
7290 @itemx -read_only_relocs
7291 @itemx -sectalign
7292 @itemx -sectobjectsymbols
7293 @itemx -whyload
7294 @itemx -seg1addr
7295 @itemx -sectcreate
7296 @itemx -sectobjectsymbols
7297 @itemx -sectorder
7298 @itemx -segaddr
7299 @itemx -segs_read_only_addr
7300 @itemx -segs_read_write_addr
7301 @itemx -seg_addr_table
7302 @itemx -seg_addr_table_filename
7303 @itemx -seglinkedit
7304 @itemx -segprot
7305 @itemx -segs_read_only_addr
7306 @itemx -segs_read_write_addr
7307 @itemx -single_module
7308 @itemx -static
7309 @itemx -sub_library
7310 @itemx -sub_umbrella
7311 @itemx -twolevel_namespace
7312 @itemx -umbrella
7313 @itemx -undefined
7314 @itemx -unexported_symbols_list
7315 @itemx -weak_reference_mismatches
7316 @itemx -whatsloaded
7317
7318 @opindex allowable_client
7319 @opindex arch_only
7320 @opindex client_name
7321 @opindex compatibility_version
7322 @opindex current_version
7323 @opindex dead_strip
7324 @opindex dependency-file
7325 @opindex dylib_file
7326 @opindex dylinker_install_name
7327 @opindex dynamic
7328 @opindex dynamiclib
7329 @opindex exported_symbols_list
7330 @opindex filelist
7331 @opindex flat_namespace
7332 @opindex force_cpusubtype_ALL
7333 @opindex force_flat_namespace
7334 @opindex headerpad_max_install_names
7335 @opindex image_base
7336 @opindex init
7337 @opindex install_name
7338 @opindex keep_private_externs
7339 @opindex multi_module
7340 @opindex multiply_defined
7341 @opindex multiply_defined_unused
7342 @opindex noall_load
7343 @opindex no_dead_strip_inits_and_terms
7344 @opindex nofixprebinding
7345 @opindex nomultidefs
7346 @opindex noprebind
7347 @opindex noseglinkedit
7348 @opindex pagezero_size
7349 @opindex prebind
7350 @opindex prebind_all_twolevel_modules
7351 @opindex private_bundle
7352 @opindex read_only_relocs
7353 @opindex sectalign
7354 @opindex sectobjectsymbols
7355 @opindex whyload
7356 @opindex seg1addr
7357 @opindex sectcreate
7358 @opindex sectobjectsymbols
7359 @opindex sectorder
7360 @opindex segaddr
7361 @opindex segs_read_only_addr
7362 @opindex segs_read_write_addr
7363 @opindex seg_addr_table
7364 @opindex seg_addr_table_filename
7365 @opindex seglinkedit
7366 @opindex segprot
7367 @opindex segs_read_only_addr
7368 @opindex segs_read_write_addr
7369 @opindex single_module
7370 @opindex static
7371 @opindex sub_library
7372 @opindex sub_umbrella
7373 @opindex twolevel_namespace
7374 @opindex umbrella
7375 @opindex undefined
7376 @opindex unexported_symbols_list
7377 @opindex weak_reference_mismatches
7378 @opindex whatsloaded
7379
7380 These options are available for Darwin linker. Darwin linker man page
7381 describes them in detail.
7382 @end table
7383
7384 @node DEC Alpha Options
7385 @subsection DEC Alpha Options
7386
7387 These @samp{-m} options are defined for the DEC Alpha implementations:
7388
7389 @table @gcctabopt
7390 @item -mno-soft-float
7391 @itemx -msoft-float
7392 @opindex mno-soft-float
7393 @opindex msoft-float
7394 Use (do not use) the hardware floating-point instructions for
7395 floating-point operations.  When @option{-msoft-float} is specified,
7396 functions in @file{libgcc.a} will be used to perform floating-point
7397 operations.  Unless they are replaced by routines that emulate the
7398 floating-point operations, or compiled in such a way as to call such
7399 emulations routines, these routines will issue floating-point
7400 operations.   If you are compiling for an Alpha without floating-point
7401 operations, you must ensure that the library is built so as not to call
7402 them.
7403
7404 Note that Alpha implementations without floating-point operations are
7405 required to have floating-point registers.
7406
7407 @item -mfp-reg
7408 @itemx -mno-fp-regs
7409 @opindex mfp-reg
7410 @opindex mno-fp-regs
7411 Generate code that uses (does not use) the floating-point register set.
7412 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7413 register set is not used, floating point operands are passed in integer
7414 registers as if they were integers and floating-point results are passed
7415 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7416 so any function with a floating-point argument or return value called by code
7417 compiled with @option{-mno-fp-regs} must also be compiled with that
7418 option.
7419
7420 A typical use of this option is building a kernel that does not use,
7421 and hence need not save and restore, any floating-point registers.
7422
7423 @item -mieee
7424 @opindex mieee
7425 The Alpha architecture implements floating-point hardware optimized for
7426 maximum performance.  It is mostly compliant with the IEEE floating
7427 point standard.  However, for full compliance, software assistance is
7428 required.  This option generates code fully IEEE compliant code
7429 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7430 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7431 defined during compilation.  The resulting code is less efficient but is
7432 able to correctly support denormalized numbers and exceptional IEEE
7433 values such as not-a-number and plus/minus infinity.  Other Alpha
7434 compilers call this option @option{-ieee_with_no_inexact}.
7435
7436 @item -mieee-with-inexact
7437 @opindex mieee-with-inexact
7438 This is like @option{-mieee} except the generated code also maintains
7439 the IEEE @var{inexact-flag}.  Turning on this option causes the
7440 generated code to implement fully-compliant IEEE math.  In addition to
7441 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7442 macro.  On some Alpha implementations the resulting code may execute
7443 significantly slower than the code generated by default.  Since there is
7444 very little code that depends on the @var{inexact-flag}, you should
7445 normally not specify this option.  Other Alpha compilers call this
7446 option @option{-ieee_with_inexact}.
7447
7448 @item -mfp-trap-mode=@var{trap-mode}
7449 @opindex mfp-trap-mode
7450 This option controls what floating-point related traps are enabled.
7451 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7452 The trap mode can be set to one of four values:
7453
7454 @table @samp
7455 @item n
7456 This is the default (normal) setting.  The only traps that are enabled
7457 are the ones that cannot be disabled in software (e.g., division by zero
7458 trap).
7459
7460 @item u
7461 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7462 as well.
7463
7464 @item su
7465 Like @samp{su}, but the instructions are marked to be safe for software
7466 completion (see Alpha architecture manual for details).
7467
7468 @item sui
7469 Like @samp{su}, but inexact traps are enabled as well.
7470 @end table
7471
7472 @item -mfp-rounding-mode=@var{rounding-mode}
7473 @opindex mfp-rounding-mode
7474 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7475 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7476 of:
7477
7478 @table @samp
7479 @item n
7480 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7481 the nearest machine number or towards the even machine number in case
7482 of a tie.
7483
7484 @item m
7485 Round towards minus infinity.
7486
7487 @item c
7488 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7489
7490 @item d
7491 Dynamic rounding mode.  A field in the floating point control register
7492 (@var{fpcr}, see Alpha architecture reference manual) controls the
7493 rounding mode in effect.  The C library initializes this register for
7494 rounding towards plus infinity.  Thus, unless your program modifies the
7495 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7496 @end table
7497
7498 @item -mtrap-precision=@var{trap-precision}
7499 @opindex mtrap-precision
7500 In the Alpha architecture, floating point traps are imprecise.  This
7501 means without software assistance it is impossible to recover from a
7502 floating trap and program execution normally needs to be terminated.
7503 GCC can generate code that can assist operating system trap handlers
7504 in determining the exact location that caused a floating point trap.
7505 Depending on the requirements of an application, different levels of
7506 precisions can be selected:
7507
7508 @table @samp
7509 @item p
7510 Program precision.  This option is the default and means a trap handler
7511 can only identify which program caused a floating point exception.
7512
7513 @item f
7514 Function precision.  The trap handler can determine the function that
7515 caused a floating point exception.
7516
7517 @item i
7518 Instruction precision.  The trap handler can determine the exact
7519 instruction that caused a floating point exception.
7520 @end table
7521
7522 Other Alpha compilers provide the equivalent options called
7523 @option{-scope_safe} and @option{-resumption_safe}.
7524
7525 @item -mieee-conformant
7526 @opindex mieee-conformant
7527 This option marks the generated code as IEEE conformant.  You must not
7528 use this option unless you also specify @option{-mtrap-precision=i} and either
7529 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7530 is to emit the line @samp{.eflag 48} in the function prologue of the
7531 generated assembly file.  Under DEC Unix, this has the effect that
7532 IEEE-conformant math library routines will be linked in.
7533
7534 @item -mbuild-constants
7535 @opindex mbuild-constants
7536 Normally GCC examines a 32- or 64-bit integer constant to
7537 see if it can construct it from smaller constants in two or three
7538 instructions.  If it cannot, it will output the constant as a literal and
7539 generate code to load it from the data segment at runtime.
7540
7541 Use this option to require GCC to construct @emph{all} integer constants
7542 using code, even if it takes more instructions (the maximum is six).
7543
7544 You would typically use this option to build a shared library dynamic
7545 loader.  Itself a shared library, it must relocate itself in memory
7546 before it can find the variables and constants in its own data segment.
7547
7548 @item -malpha-as
7549 @itemx -mgas
7550 @opindex malpha-as
7551 @opindex mgas
7552 Select whether to generate code to be assembled by the vendor-supplied
7553 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7554
7555 @item -mbwx
7556 @itemx -mno-bwx
7557 @itemx -mcix
7558 @itemx -mno-cix
7559 @itemx -mfix
7560 @itemx -mno-fix
7561 @itemx -mmax
7562 @itemx -mno-max
7563 @opindex mbwx
7564 @opindex mno-bwx
7565 @opindex mcix
7566 @opindex mno-cix
7567 @opindex mfix
7568 @opindex mno-fix
7569 @opindex mmax
7570 @opindex mno-max
7571 Indicate whether GCC should generate code to use the optional BWX,
7572 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7573 sets supported by the CPU type specified via @option{-mcpu=} option or that
7574 of the CPU on which GCC was built if none was specified.
7575
7576 @item -mfloat-vax
7577 @itemx -mfloat-ieee
7578 @opindex mfloat-vax
7579 @opindex mfloat-ieee
7580 Generate code that uses (does not use) VAX F and G floating point
7581 arithmetic instead of IEEE single and double precision.
7582
7583 @item -mexplicit-relocs
7584 @itemx -mno-explicit-relocs
7585 @opindex mexplicit-relocs
7586 @opindex mno-explicit-relocs
7587 Older Alpha assemblers provided no way to generate symbol relocations
7588 except via assembler macros.  Use of these macros does not allow
7589 optimal instruction scheduling.  GNU binutils as of version 2.12
7590 supports a new syntax that allows the compiler to explicitly mark
7591 which relocations should apply to which instructions.  This option
7592 is mostly useful for debugging, as GCC detects the capabilities of
7593 the assembler when it is built and sets the default accordingly.
7594
7595 @item -msmall-data
7596 @itemx -mlarge-data
7597 @opindex msmall-data
7598 @opindex mlarge-data
7599 When @option{-mexplicit-relocs} is in effect, static data is
7600 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7601 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7602 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7603 16-bit relocations off of the @code{$gp} register.  This limits the
7604 size of the small data area to 64KB, but allows the variables to be
7605 directly accessed via a single instruction.
7606
7607 The default is @option{-mlarge-data}.  With this option the data area
7608 is limited to just below 2GB.  Programs that require more than 2GB of
7609 data must use @code{malloc} or @code{mmap} to allocate the data in the
7610 heap instead of in the program's data segment.
7611
7612 When generating code for shared libraries, @option{-fpic} implies
7613 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7614
7615 @item -msmall-text
7616 @itemx -mlarge-text
7617 @opindex msmall-text
7618 @opindex mlarge-text
7619 When @option{-msmall-text} is used, the compiler assumes that the
7620 code of the entire program (or shared library) fits in 4MB, and is
7621 thus reachable with a branch instruction.  When @option{-msmall-data}
7622 is used, the compiler can assume that all local symbols share the
7623 same @code{$gp} value, and thus reduce the number of instructions
7624 required for a function call from 4 to 1.
7625
7626 The default is @option{-mlarge-text}.
7627
7628 @item -mcpu=@var{cpu_type}
7629 @opindex mcpu
7630 Set the instruction set and instruction scheduling parameters for
7631 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7632 style name or the corresponding chip number.  GCC supports scheduling
7633 parameters for the EV4, EV5 and EV6 family of processors and will
7634 choose the default values for the instruction set from the processor
7635 you specify.  If you do not specify a processor type, GCC will default
7636 to the processor on which the compiler was built.
7637
7638 Supported values for @var{cpu_type} are
7639
7640 @table @samp
7641 @item ev4
7642 @itemx ev45
7643 @itemx 21064
7644 Schedules as an EV4 and has no instruction set extensions.
7645
7646 @item ev5
7647 @itemx 21164
7648 Schedules as an EV5 and has no instruction set extensions.
7649
7650 @item ev56
7651 @itemx 21164a
7652 Schedules as an EV5 and supports the BWX extension.
7653
7654 @item pca56
7655 @itemx 21164pc
7656 @itemx 21164PC
7657 Schedules as an EV5 and supports the BWX and MAX extensions.
7658
7659 @item ev6
7660 @itemx 21264
7661 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7662
7663 @item ev67
7664 @itemx 21264a
7665 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7666 @end table
7667
7668 @item -mtune=@var{cpu_type}
7669 @opindex mtune
7670 Set only the instruction scheduling parameters for machine type
7671 @var{cpu_type}.  The instruction set is not changed.
7672
7673 @item -mmemory-latency=@var{time}
7674 @opindex mmemory-latency
7675 Sets the latency the scheduler should assume for typical memory
7676 references as seen by the application.  This number is highly
7677 dependent on the memory access patterns used by the application
7678 and the size of the external cache on the machine.
7679
7680 Valid options for @var{time} are
7681
7682 @table @samp
7683 @item @var{number}
7684 A decimal number representing clock cycles.
7685
7686 @item L1
7687 @itemx L2
7688 @itemx L3
7689 @itemx main
7690 The compiler contains estimates of the number of clock cycles for
7691 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7692 (also called Dcache, Scache, and Bcache), as well as to main memory.
7693 Note that L3 is only valid for EV5.
7694
7695 @end table
7696 @end table
7697
7698 @node DEC Alpha/VMS Options
7699 @subsection DEC Alpha/VMS Options
7700
7701 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7702
7703 @table @gcctabopt
7704 @item -mvms-return-codes
7705 @opindex mvms-return-codes
7706 Return VMS condition codes from main.  The default is to return POSIX
7707 style condition (e.g.@ error) codes.
7708 @end table
7709
7710 @node FRV Options
7711 @subsection FRV Options
7712 @cindex FRV Options
7713
7714 @table @gcctabopt
7715 @item -mgpr-32
7716 @opindex mgpr-32
7717
7718 Only use the first 32 general purpose registers.
7719
7720 @item -mgpr-64
7721 @opindex mgpr-64
7722
7723 Use all 64 general purpose registers.
7724
7725 @item -mfpr-32
7726 @opindex mfpr-32
7727
7728 Use only the first 32 floating point registers.
7729
7730 @item -mfpr-64
7731 @opindex mfpr-64
7732
7733 Use all 64 floating point registers
7734
7735 @item -mhard-float
7736 @opindex mhard-float
7737
7738 Use hardware instructions for floating point operations.
7739
7740 @item -msoft-float
7741 @opindex msoft-float
7742
7743 Use library routines for floating point operations.
7744
7745 @item -malloc-cc
7746 @opindex malloc-cc
7747
7748 Dynamically allocate condition code registers.
7749
7750 @item -mfixed-cc
7751 @opindex mfixed-cc
7752
7753 Do not try to dynamically allocate condition code registers, only
7754 use @code{icc0} and @code{fcc0}.
7755
7756 @item -mdword
7757 @opindex mdword
7758
7759 Change ABI to use double word insns.
7760
7761 @item -mno-dword
7762 @opindex mno-dword
7763
7764 Do not use double word instructions.
7765
7766 @item -mdouble
7767 @opindex mdouble
7768
7769 Use floating point double instructions.
7770
7771 @item -mno-double
7772 @opindex mno-double
7773
7774 Do not use floating point double instructions.
7775
7776 @item -mmedia
7777 @opindex mmedia
7778
7779 Use media instructions.
7780
7781 @item -mno-media
7782 @opindex mno-media
7783
7784 Do not use media instructions.
7785
7786 @item -mmuladd
7787 @opindex mmuladd
7788
7789 Use multiply and add/subtract instructions.
7790
7791 @item -mno-muladd
7792 @opindex mno-muladd
7793
7794 Do not use multiply and add/subtract instructions.
7795
7796 @item -mfdpic
7797 @opindex mfdpic
7798
7799 Select the FDPIC ABI, that uses function descriptors to represent
7800 pointers to functions.  Without any PIC/PIE-related options, it
7801 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7802 assumes GOT entries and small data are within a 12-bit range from the
7803 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7804 are computed with 32 bits.
7805
7806 @item -minline-plt
7807 @opindex minline-plt
7808
7809 Enable inlining of PLT entries in function calls to functions that are
7810 not known to bind locally.  It has no effect without @option{-mfdpic}.
7811 It's enabled by default if optimizing for speed and compiling for
7812 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7813 optimization option such as @option{-O3} or above is present in the
7814 command line.
7815
7816 @item -mgprel-ro
7817 @opindex mgprel-ro
7818
7819 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7820 that is known to be in read-only sections.  It's enabled by default,
7821 except for @option{-fpic} or @option{-fpie}: even though it may help
7822 make the global offset table smaller, it trades 1 instruction for 4.
7823 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7824 one of which may be shared by multiple symbols, and it avoids the need
7825 for a GOT entry for the referenced symbol, so it's more likely to be a
7826 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7827
7828 @item -multilib-library-pic
7829 @opindex multilib-library-pic
7830
7831 Link with the (library, not FD) pic libraries.  It's implied by
7832 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7833 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7834 it explicitly.
7835
7836 @item -mlinked-fp
7837 @opindex mlinked-fp
7838
7839 Follow the EABI requirement of always creating a frame pointer whenever
7840 a stack frame is allocated.  This option is enabled by default and can
7841 be disabled with @option{-mno-linked-fp}.
7842
7843 @item -mlong-calls
7844 @opindex mlong-calls
7845
7846 Use indirect addressing to call functions outside the current
7847 compilation unit.  This allows the functions to be placed anywhere
7848 within the 32-bit address space.
7849
7850 @item -malign-labels
7851 @opindex malign-labels
7852
7853 Try to align labels to an 8-byte boundary by inserting nops into the
7854 previous packet.  This option only has an effect when VLIW packing
7855 is enabled.  It doesn't create new packets; it merely adds nops to
7856 existing ones.
7857
7858 @item -mlibrary-pic
7859 @opindex mlibrary-pic
7860
7861 Generate position-independent EABI code.
7862
7863 @item -macc-4
7864 @opindex macc-4
7865
7866 Use only the first four media accumulator registers.
7867
7868 @item -macc-8
7869 @opindex macc-8
7870
7871 Use all eight media accumulator registers.
7872
7873 @item -mpack
7874 @opindex mpack
7875
7876 Pack VLIW instructions.
7877
7878 @item -mno-pack
7879 @opindex mno-pack
7880
7881 Do not pack VLIW instructions.
7882
7883 @item -mno-eflags
7884 @opindex mno-eflags
7885
7886 Do not mark ABI switches in e_flags.
7887
7888 @item -mcond-move
7889 @opindex mcond-move
7890
7891 Enable the use of conditional-move instructions (default).
7892
7893 This switch is mainly for debugging the compiler and will likely be removed
7894 in a future version.
7895
7896 @item -mno-cond-move
7897 @opindex mno-cond-move
7898
7899 Disable the use of conditional-move instructions.
7900
7901 This switch is mainly for debugging the compiler and will likely be removed
7902 in a future version.
7903
7904 @item -mscc
7905 @opindex mscc
7906
7907 Enable the use of conditional set instructions (default).
7908
7909 This switch is mainly for debugging the compiler and will likely be removed
7910 in a future version.
7911
7912 @item -mno-scc
7913 @opindex mno-scc
7914
7915 Disable the use of conditional set instructions.
7916
7917 This switch is mainly for debugging the compiler and will likely be removed
7918 in a future version.
7919
7920 @item -mcond-exec
7921 @opindex mcond-exec
7922
7923 Enable the use of conditional execution (default).
7924
7925 This switch is mainly for debugging the compiler and will likely be removed
7926 in a future version.
7927
7928 @item -mno-cond-exec
7929 @opindex mno-cond-exec
7930
7931 Disable the use of conditional execution.
7932
7933 This switch is mainly for debugging the compiler and will likely be removed
7934 in a future version.
7935
7936 @item -mvliw-branch
7937 @opindex mvliw-branch
7938
7939 Run a pass to pack branches into VLIW instructions (default).
7940
7941 This switch is mainly for debugging the compiler and will likely be removed
7942 in a future version.
7943
7944 @item -mno-vliw-branch
7945 @opindex mno-vliw-branch
7946
7947 Do not run a pass to pack branches into VLIW instructions.
7948
7949 This switch is mainly for debugging the compiler and will likely be removed
7950 in a future version.
7951
7952 @item -mmulti-cond-exec
7953 @opindex mmulti-cond-exec
7954
7955 Enable optimization of @code{&&} and @code{||} in conditional execution
7956 (default).
7957
7958 This switch is mainly for debugging the compiler and will likely be removed
7959 in a future version.
7960
7961 @item -mno-multi-cond-exec
7962 @opindex mno-multi-cond-exec
7963
7964 Disable optimization of @code{&&} and @code{||} in conditional execution.
7965
7966 This switch is mainly for debugging the compiler and will likely be removed
7967 in a future version.
7968
7969 @item -mnested-cond-exec
7970 @opindex mnested-cond-exec
7971
7972 Enable nested conditional execution optimizations (default).
7973
7974 This switch is mainly for debugging the compiler and will likely be removed
7975 in a future version.
7976
7977 @item -mno-nested-cond-exec
7978 @opindex mno-nested-cond-exec
7979
7980 Disable nested conditional execution optimizations.
7981
7982 This switch is mainly for debugging the compiler and will likely be removed
7983 in a future version.
7984
7985 @item -mtomcat-stats
7986 @opindex mtomcat-stats
7987
7988 Cause gas to print out tomcat statistics.
7989
7990 @item -mcpu=@var{cpu}
7991 @opindex mcpu
7992
7993 Select the processor type for which to generate code.  Possible values are
7994 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
7995 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
7996
7997 @end table
7998
7999 @node H8/300 Options
8000 @subsection H8/300 Options
8001
8002 These @samp{-m} options are defined for the H8/300 implementations:
8003
8004 @table @gcctabopt
8005 @item -mrelax
8006 @opindex mrelax
8007 Shorten some address references at link time, when possible; uses the
8008 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8009 ld, Using ld}, for a fuller description.
8010
8011 @item -mh
8012 @opindex mh
8013 Generate code for the H8/300H@.
8014
8015 @item -ms
8016 @opindex ms
8017 Generate code for the H8S@.
8018
8019 @item -mn
8020 @opindex mn
8021 Generate code for the H8S and H8/300H in the normal mode.  This switch
8022 must be used either with @option{-mh} or @option{-ms}.
8023
8024 @item -ms2600
8025 @opindex ms2600
8026 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8027
8028 @item -mint32
8029 @opindex mint32
8030 Make @code{int} data 32 bits by default.
8031
8032 @item -malign-300
8033 @opindex malign-300
8034 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8035 The default for the H8/300H and H8S is to align longs and floats on 4
8036 byte boundaries.
8037 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8038 This option has no effect on the H8/300.
8039 @end table
8040
8041 @node HPPA Options
8042 @subsection HPPA Options
8043 @cindex HPPA Options
8044
8045 These @samp{-m} options are defined for the HPPA family of computers:
8046
8047 @table @gcctabopt
8048 @item -march=@var{architecture-type}
8049 @opindex march
8050 Generate code for the specified architecture.  The choices for
8051 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8052 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8053 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8054 architecture option for your machine.  Code compiled for lower numbered
8055 architectures will run on higher numbered architectures, but not the
8056 other way around.
8057
8058 @item -mpa-risc-1-0
8059 @itemx -mpa-risc-1-1
8060 @itemx -mpa-risc-2-0
8061 @opindex mpa-risc-1-0
8062 @opindex mpa-risc-1-1
8063 @opindex mpa-risc-2-0
8064 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8065
8066 @item -mbig-switch
8067 @opindex mbig-switch
8068 Generate code suitable for big switch tables.  Use this option only if
8069 the assembler/linker complain about out of range branches within a switch
8070 table.
8071
8072 @item -mjump-in-delay
8073 @opindex mjump-in-delay
8074 Fill delay slots of function calls with unconditional jump instructions
8075 by modifying the return pointer for the function call to be the target
8076 of the conditional jump.
8077
8078 @item -mdisable-fpregs
8079 @opindex mdisable-fpregs
8080 Prevent floating point registers from being used in any manner.  This is
8081 necessary for compiling kernels which perform lazy context switching of
8082 floating point registers.  If you use this option and attempt to perform
8083 floating point operations, the compiler will abort.
8084
8085 @item -mdisable-indexing
8086 @opindex mdisable-indexing
8087 Prevent the compiler from using indexing address modes.  This avoids some
8088 rather obscure problems when compiling MIG generated code under MACH@.
8089
8090 @item -mno-space-regs
8091 @opindex mno-space-regs
8092 Generate code that assumes the target has no space registers.  This allows
8093 GCC to generate faster indirect calls and use unscaled index address modes.
8094
8095 Such code is suitable for level 0 PA systems and kernels.
8096
8097 @item -mfast-indirect-calls
8098 @opindex mfast-indirect-calls
8099 Generate code that assumes calls never cross space boundaries.  This
8100 allows GCC to emit code which performs faster indirect calls.
8101
8102 This option will not work in the presence of shared libraries or nested
8103 functions.
8104
8105 @item -mfixed-range=@var{register-range}
8106 @opindex mfixed-range
8107 Generate code treating the given register range as fixed registers.
8108 A fixed register is one that the register allocator can not use.  This is
8109 useful when compiling kernel code.  A register range is specified as
8110 two registers separated by a dash.  Multiple register ranges can be
8111 specified separated by a comma.
8112
8113 @item -mlong-load-store
8114 @opindex mlong-load-store
8115 Generate 3-instruction load and store sequences as sometimes required by
8116 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8117 the HP compilers.
8118
8119 @item -mportable-runtime
8120 @opindex mportable-runtime
8121 Use the portable calling conventions proposed by HP for ELF systems.
8122
8123 @item -mgas
8124 @opindex mgas
8125 Enable the use of assembler directives only GAS understands.
8126
8127 @item -mschedule=@var{cpu-type}
8128 @opindex mschedule
8129 Schedule code according to the constraints for the machine type
8130 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8131 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8132 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8133 proper scheduling option for your machine.  The default scheduling is
8134 @samp{8000}.
8135
8136 @item -mlinker-opt
8137 @opindex mlinker-opt
8138 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8139 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8140 linkers in which they give bogus error messages when linking some programs.
8141
8142 @item -msoft-float
8143 @opindex msoft-float
8144 Generate output containing library calls for floating point.
8145 @strong{Warning:} the requisite libraries are not available for all HPPA
8146 targets.  Normally the facilities of the machine's usual C compiler are
8147 used, but this cannot be done directly in cross-compilation.  You must make
8148 your own arrangements to provide suitable library functions for
8149 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8150 does provide software floating point support.
8151
8152 @option{-msoft-float} changes the calling convention in the output file;
8153 therefore, it is only useful if you compile @emph{all} of a program with
8154 this option.  In particular, you need to compile @file{libgcc.a}, the
8155 library that comes with GCC, with @option{-msoft-float} in order for
8156 this to work.
8157
8158 @item -msio
8159 @opindex msio
8160 Generate the predefine, @code{_SIO}, for server IO.  The default is
8161 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8162 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8163 options are available under HP-UX and HI-UX.
8164
8165 @item -mgnu-ld
8166 @opindex gnu-ld
8167 Use GNU ld specific options.  This passes @option{-shared} to ld when
8168 building a shared library.  It is the default when GCC is configured,
8169 explicitly or implicitly, with the GNU linker.  This option does not
8170 have any affect on which ld is called, it only changes what parameters
8171 are passed to that ld.  The ld that is called is determined by the
8172 @option{--with-ld} configure option, GCC's program search path, and
8173 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8174 using @samp{which `gcc -print-prog-name=ld`}.
8175
8176 @item -mhp-ld
8177 @opindex hp-ld
8178 Use HP ld specific options.  This passes @option{-b} to ld when building
8179 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8180 links.  It is the default when GCC is configured, explicitly or
8181 implicitly, with the HP linker.  This option does not have any affect on
8182 which ld is called, it only changes what parameters are passed to that
8183 ld.  The ld that is called is determined by the @option{--with-ld}
8184 configure option, GCC's program search path, and finally by the user's
8185 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8186 `gcc -print-prog-name=ld`}.
8187
8188 @item -mlong-calls
8189 @opindex mno-long-calls
8190 Generate code that uses long call sequences.  This ensures that a call
8191 is always able to reach linker generated stubs.  The default is to generate
8192 long calls only when the distance from the call site to the beginning
8193 of the function or translation unit, as the case may be, exceeds a
8194 predefined limit set by the branch type being used.  The limits for
8195 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8196 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8197 240,000 bytes.
8198
8199 Distances are measured from the beginning of functions when using the
8200 @option{-ffunction-sections} option, or when using the @option{-mgas}
8201 and @option{-mno-portable-runtime} options together under HP-UX with
8202 the SOM linker.
8203
8204 It is normally not desirable to use this option as it will degrade
8205 performance.  However, it may be useful in large applications,
8206 particularly when partial linking is used to build the application.
8207
8208 The types of long calls used depends on the capabilities of the
8209 assembler and linker, and the type of code being generated.  The
8210 impact on systems that support long absolute calls, and long pic
8211 symbol-difference or pc-relative calls should be relatively small.
8212 However, an indirect call is used on 32-bit ELF systems in pic code
8213 and it is quite long.
8214
8215 @item -munix=@var{unix-std}
8216 @opindex march
8217 Generate compiler predefines and select a startfile for the specified
8218 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8219 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8220 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8221 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8222 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8223 and later.
8224
8225 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8226 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8227 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8228 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8229 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8230 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8231
8232 It is @emph{important} to note that this option changes the interfaces
8233 for various library routines.  It also affects the operational behavior
8234 of the C library.  Thus, @emph{extreme} care is needed in using this
8235 option.
8236
8237 Library code that is intended to operate with more than one UNIX
8238 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8239 as appropriate.  Most GNU software doesn't provide this capability.
8240
8241 @item -nolibdld
8242 @opindex nolibdld
8243 Suppress the generation of link options to search libdld.sl when the
8244 @option{-static} option is specified on HP-UX 10 and later.
8245
8246 @item -static
8247 @opindex static
8248 The HP-UX implementation of setlocale in libc has a dependency on
8249 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8250 when the @option{-static} option is specified, special link options
8251 are needed to resolve this dependency.
8252
8253 On HP-UX 10 and later, the GCC driver adds the necessary options to
8254 link with libdld.sl when the @option{-static} option is specified.
8255 This causes the resulting binary to be dynamic.  On the 64-bit port,
8256 the linkers generate dynamic binaries by default in any case.  The
8257 @option{-nolibdld} option can be used to prevent the GCC driver from
8258 adding these link options.
8259
8260 @item -threads
8261 @opindex threads
8262 Add support for multithreading with the @dfn{dce thread} library
8263 under HP-UX.  This option sets flags for both the preprocessor and
8264 linker.
8265 @end table
8266
8267 @node i386 and x86-64 Options
8268 @subsection Intel 386 and AMD x86-64 Options
8269 @cindex i386 Options
8270 @cindex x86-64 Options
8271 @cindex Intel 386 Options
8272 @cindex AMD x86-64 Options
8273
8274 These @samp{-m} options are defined for the i386 and x86-64 family of
8275 computers:
8276
8277 @table @gcctabopt
8278 @item -mtune=@var{cpu-type}
8279 @opindex mtune
8280 Tune to @var{cpu-type} everything applicable about the generated code, except
8281 for the ABI and the set of available instructions.  The choices for
8282 @var{cpu-type} are:
8283 @table @emph
8284 @item i386
8285 Original Intel's i386 CPU.
8286 @item i486
8287 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8288 @item i586, pentium
8289 Intel Pentium CPU with no MMX support.
8290 @item pentium-mmx
8291 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8292 @item i686, pentiumpro
8293 Intel PentiumPro CPU.
8294 @item pentium2
8295 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8296 @item pentium3, pentium3m
8297 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8298 support.
8299 @item pentium-m
8300 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8301 support.  Used by Centrino notebooks.
8302 @item pentium4, pentium4m
8303 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8304 @item prescott
8305 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8306 set support.
8307 @item nocona
8308 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8309 SSE2 and SSE3 instruction set support.
8310 @item k6
8311 AMD K6 CPU with MMX instruction set support.
8312 @item k6-2, k6-3
8313 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8314 @item athlon, athlon-tbird
8315 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8316 support.
8317 @item athlon-4, athlon-xp, athlon-mp
8318 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8319 instruction set support.
8320 @item k8, opteron, athlon64, athlon-fx
8321 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8322 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8323 @item winchip-c6
8324 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8325 set support.
8326 @item winchip2
8327 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8328 instruction set support.
8329 @item c3
8330 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8331 implemented for this chip.)
8332 @item c3-2
8333 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8334 implemented for this chip.)
8335 @end table
8336
8337 While picking a specific @var{cpu-type} will schedule things appropriately
8338 for that particular chip, the compiler will not generate any code that
8339 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8340 being used.
8341
8342 @item -march=@var{cpu-type}
8343 @opindex march
8344 Generate instructions for the machine type @var{cpu-type}.  The choices
8345 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8346 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8347
8348 @item -mcpu=@var{cpu-type}
8349 @opindex mcpu
8350 A deprecated synonym for @option{-mtune}.
8351
8352 @item -m386
8353 @itemx -m486
8354 @itemx -mpentium
8355 @itemx -mpentiumpro
8356 @opindex m386
8357 @opindex m486
8358 @opindex mpentium
8359 @opindex mpentiumpro
8360 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8361 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8362 These synonyms are deprecated.
8363
8364 @item -mfpmath=@var{unit}
8365 @opindex march
8366 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8367 for @var{unit} are:
8368
8369 @table @samp
8370 @item 387
8371 Use the standard 387 floating point coprocessor present majority of chips and
8372 emulated otherwise.  Code compiled with this option will run almost everywhere.
8373 The temporary results are computed in 80bit precision instead of precision
8374 specified by the type resulting in slightly different results compared to most
8375 of other chips. See @option{-ffloat-store} for more detailed description.
8376
8377 This is the default choice for i386 compiler.
8378
8379 @item sse
8380 Use scalar floating point instructions present in the SSE instruction set.
8381 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8382 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8383 instruction set supports only single precision arithmetics, thus the double and
8384 extended precision arithmetics is still done using 387.  Later version, present
8385 only in Pentium4 and the future AMD x86-64 chips supports double precision
8386 arithmetics too.
8387
8388 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8389 @option{-msse2} switches to enable SSE extensions and make this option
8390 effective.  For x86-64 compiler, these extensions are enabled by default.
8391
8392 The resulting code should be considerably faster in the majority of cases and avoid
8393 the numerical instability problems of 387 code, but may break some existing
8394 code that expects temporaries to be 80bit.
8395
8396 This is the default choice for the x86-64 compiler.
8397
8398 @item sse,387
8399 Attempt to utilize both instruction sets at once.  This effectively double the
8400 amount of available registers and on chips with separate execution units for
8401 387 and SSE the execution resources too.  Use this option with care, as it is
8402 still experimental, because the GCC register allocator does not model separate
8403 functional units well resulting in instable performance.
8404 @end table
8405
8406 @item -masm=@var{dialect}
8407 @opindex masm=@var{dialect}
8408 Output asm instructions using selected @var{dialect}. Supported choices are
8409 @samp{intel} or @samp{att} (the default one).
8410
8411 @item -mieee-fp
8412 @itemx -mno-ieee-fp
8413 @opindex mieee-fp
8414 @opindex mno-ieee-fp
8415 Control whether or not the compiler uses IEEE floating point
8416 comparisons.  These handle correctly the case where the result of a
8417 comparison is unordered.
8418
8419 @item -msoft-float
8420 @opindex msoft-float
8421 Generate output containing library calls for floating point.
8422 @strong{Warning:} the requisite libraries are not part of GCC@.
8423 Normally the facilities of the machine's usual C compiler are used, but
8424 this can't be done directly in cross-compilation.  You must make your
8425 own arrangements to provide suitable library functions for
8426 cross-compilation.
8427
8428 On machines where a function returns floating point results in the 80387
8429 register stack, some floating point opcodes may be emitted even if
8430 @option{-msoft-float} is used.
8431
8432 @item -mno-fp-ret-in-387
8433 @opindex mno-fp-ret-in-387
8434 Do not use the FPU registers for return values of functions.
8435
8436 The usual calling convention has functions return values of types
8437 @code{float} and @code{double} in an FPU register, even if there
8438 is no FPU@.  The idea is that the operating system should emulate
8439 an FPU@.
8440
8441 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8442 in ordinary CPU registers instead.
8443
8444 @item -mno-fancy-math-387
8445 @opindex mno-fancy-math-387
8446 Some 387 emulators do not support the @code{sin}, @code{cos} and
8447 @code{sqrt} instructions for the 387.  Specify this option to avoid
8448 generating those instructions.  This option is the default on FreeBSD,
8449 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8450 indicates that the target cpu will always have an FPU and so the
8451 instruction will not need emulation.  As of revision 2.6.1, these
8452 instructions are not generated unless you also use the
8453 @option{-funsafe-math-optimizations} switch.
8454
8455 @item -malign-double
8456 @itemx -mno-align-double
8457 @opindex malign-double
8458 @opindex mno-align-double
8459 Control whether GCC aligns @code{double}, @code{long double}, and
8460 @code{long long} variables on a two word boundary or a one word
8461 boundary.  Aligning @code{double} variables on a two word boundary will
8462 produce code that runs somewhat faster on a @samp{Pentium} at the
8463 expense of more memory.
8464
8465 @strong{Warning:} if you use the @option{-malign-double} switch,
8466 structures containing the above types will be aligned differently than
8467 the published application binary interface specifications for the 386
8468 and will not be binary compatible with structures in code compiled
8469 without that switch.
8470
8471 @item -m96bit-long-double
8472 @itemx -m128bit-long-double
8473 @opindex m96bit-long-double
8474 @opindex m128bit-long-double
8475 These switches control the size of @code{long double} type. The i386
8476 application binary interface specifies the size to be 96 bits,
8477 so @option{-m96bit-long-double} is the default in 32 bit mode.
8478
8479 Modern architectures (Pentium and newer) would prefer @code{long double}
8480 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8481 conforming to the ABI, this would not be possible.  So specifying a
8482 @option{-m128bit-long-double} will align @code{long double}
8483 to a 16 byte boundary by padding the @code{long double} with an additional
8484 32 bit zero.
8485
8486 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8487 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8488
8489 Notice that neither of these options enable any extra precision over the x87
8490 standard of 80 bits for a @code{long double}.
8491
8492 @strong{Warning:} if you override the default value for your target ABI, the
8493 structures and arrays containing @code{long double} variables will change
8494 their size as well as function calling convention for function taking
8495 @code{long double} will be modified.  Hence they will not be binary
8496 compatible with arrays or structures in code compiled without that switch.
8497
8498
8499 @item -msvr3-shlib
8500 @itemx -mno-svr3-shlib
8501 @opindex msvr3-shlib
8502 @opindex mno-svr3-shlib
8503 Control whether GCC places uninitialized local variables into the
8504 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8505 into @code{bss}.  These options are meaningful only on System V Release 3.
8506
8507 @item -mrtd
8508 @opindex mrtd
8509 Use a different function-calling convention, in which functions that
8510 take a fixed number of arguments return with the @code{ret} @var{num}
8511 instruction, which pops their arguments while returning.  This saves one
8512 instruction in the caller since there is no need to pop the arguments
8513 there.
8514
8515 You can specify that an individual function is called with this calling
8516 sequence with the function attribute @samp{stdcall}.  You can also
8517 override the @option{-mrtd} option by using the function attribute
8518 @samp{cdecl}.  @xref{Function Attributes}.
8519
8520 @strong{Warning:} this calling convention is incompatible with the one
8521 normally used on Unix, so you cannot use it if you need to call
8522 libraries compiled with the Unix compiler.
8523
8524 Also, you must provide function prototypes for all functions that
8525 take variable numbers of arguments (including @code{printf});
8526 otherwise incorrect code will be generated for calls to those
8527 functions.
8528
8529 In addition, seriously incorrect code will result if you call a
8530 function with too many arguments.  (Normally, extra arguments are
8531 harmlessly ignored.)
8532
8533 @item -mregparm=@var{num}
8534 @opindex mregparm
8535 Control how many registers are used to pass integer arguments.  By
8536 default, no registers are used to pass arguments, and at most 3
8537 registers can be used.  You can control this behavior for a specific
8538 function by using the function attribute @samp{regparm}.
8539 @xref{Function Attributes}.
8540
8541 @strong{Warning:} if you use this switch, and
8542 @var{num} is nonzero, then you must build all modules with the same
8543 value, including any libraries.  This includes the system libraries and
8544 startup modules.
8545
8546 @item -mpreferred-stack-boundary=@var{num}
8547 @opindex mpreferred-stack-boundary
8548 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8549 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8550 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8551 size (@option{-Os}), in which case the default is the minimum correct
8552 alignment (4 bytes for x86, and 8 bytes for x86-64).
8553
8554 On Pentium and PentiumPro, @code{double} and @code{long double} values
8555 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8556 suffer significant run time performance penalties.  On Pentium III, the
8557 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8558 penalties if it is not 16 byte aligned.
8559
8560 To ensure proper alignment of this values on the stack, the stack boundary
8561 must be as aligned as that required by any value stored on the stack.
8562 Further, every function must be generated such that it keeps the stack
8563 aligned.  Thus calling a function compiled with a higher preferred
8564 stack boundary from a function compiled with a lower preferred stack
8565 boundary will most likely misalign the stack.  It is recommended that
8566 libraries that use callbacks always use the default setting.
8567
8568 This extra alignment does consume extra stack space, and generally
8569 increases code size.  Code that is sensitive to stack space usage, such
8570 as embedded systems and operating system kernels, may want to reduce the
8571 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8572
8573 @item -mmmx
8574 @itemx -mno-mmx
8575 @item -msse
8576 @itemx -mno-sse
8577 @item -msse2
8578 @itemx -mno-sse2
8579 @item -msse3
8580 @itemx -mno-sse3
8581 @item -m3dnow
8582 @itemx -mno-3dnow
8583 @opindex mmmx
8584 @opindex mno-mmx
8585 @opindex msse
8586 @opindex mno-sse
8587 @opindex m3dnow
8588 @opindex mno-3dnow
8589 These switches enable or disable the use of built-in functions that allow
8590 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8591 instruction set.
8592
8593 @xref{X86 Built-in Functions}, for details of the functions enabled
8594 and disabled by these switches.
8595
8596 To have SSE/SSE2 instructions generated automatically from floating-point
8597 code, see @option{-mfpmath=sse}.
8598
8599 @item -mpush-args
8600 @itemx -mno-push-args
8601 @opindex mpush-args
8602 @opindex mno-push-args
8603 Use PUSH operations to store outgoing parameters.  This method is shorter
8604 and usually equally fast as method using SUB/MOV operations and is enabled
8605 by default.  In some cases disabling it may improve performance because of
8606 improved scheduling and reduced dependencies.
8607
8608 @item -maccumulate-outgoing-args
8609 @opindex maccumulate-outgoing-args
8610 If enabled, the maximum amount of space required for outgoing arguments will be
8611 computed in the function prologue.  This is faster on most modern CPUs
8612 because of reduced dependencies, improved scheduling and reduced stack usage
8613 when preferred stack boundary is not equal to 2.  The drawback is a notable
8614 increase in code size.  This switch implies @option{-mno-push-args}.
8615
8616 @item -mthreads
8617 @opindex mthreads
8618 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8619 on thread-safe exception handling must compile and link all code with the
8620 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8621 @option{-D_MT}; when linking, it links in a special thread helper library
8622 @option{-lmingwthrd} which cleans up per thread exception handling data.
8623
8624 @item -mno-align-stringops
8625 @opindex mno-align-stringops
8626 Do not align destination of inlined string operations.  This switch reduces
8627 code size and improves performance in case the destination is already aligned,
8628 but GCC doesn't know about it.
8629
8630 @item -minline-all-stringops
8631 @opindex minline-all-stringops
8632 By default GCC inlines string operations only when destination is known to be
8633 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8634 size, but may improve performance of code that depends on fast memcpy, strlen
8635 and memset for short lengths.
8636
8637 @item -momit-leaf-frame-pointer
8638 @opindex momit-leaf-frame-pointer
8639 Don't keep the frame pointer in a register for leaf functions.  This
8640 avoids the instructions to save, set up and restore frame pointers and
8641 makes an extra register available in leaf functions.  The option
8642 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8643 which might make debugging harder.
8644
8645 @item -mtls-direct-seg-refs
8646 @itemx -mno-tls-direct-seg-refs
8647 @opindex mtls-direct-seg-refs
8648 Controls whether TLS variables may be accessed with offsets from the
8649 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8650 or whether the thread base pointer must be added.  Whether or not this
8651 is legal depends on the operating system, and whether it maps the
8652 segment to cover the entire TLS area.
8653
8654 For systems that use GNU libc, the default is on.
8655 @end table
8656
8657 These @samp{-m} switches are supported in addition to the above
8658 on AMD x86-64 processors in 64-bit environments.
8659
8660 @table @gcctabopt
8661 @item -m32
8662 @itemx -m64
8663 @opindex m32
8664 @opindex m64
8665 Generate code for a 32-bit or 64-bit environment.
8666 The 32-bit environment sets int, long and pointer to 32 bits and
8667 generates code that runs on any i386 system.
8668 The 64-bit environment sets int to 32 bits and long and pointer
8669 to 64 bits and generates code for AMD's x86-64 architecture.
8670
8671 @item -mno-red-zone
8672 @opindex no-red-zone
8673 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8674 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8675 stack pointer that will not be modified by signal or interrupt handlers
8676 and therefore can be used for temporary data without adjusting the stack
8677 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8678
8679 @item -mcmodel=small
8680 @opindex mcmodel=small
8681 Generate code for the small code model: the program and its symbols must
8682 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8683 Programs can be statically or dynamically linked.  This is the default
8684 code model.
8685
8686 @item -mcmodel=kernel
8687 @opindex mcmodel=kernel
8688 Generate code for the kernel code model.  The kernel runs in the
8689 negative 2 GB of the address space.
8690 This model has to be used for Linux kernel code.
8691
8692 @item -mcmodel=medium
8693 @opindex mcmodel=medium
8694 Generate code for the medium model: The program is linked in the lower 2
8695 GB of the address space but symbols can be located anywhere in the
8696 address space.  Programs can be statically or dynamically linked, but
8697 building of shared libraries are not supported with the medium model.
8698
8699 @item -mcmodel=large
8700 @opindex mcmodel=large
8701 Generate code for the large model: This model makes no assumptions
8702 about addresses and sizes of sections.  Currently GCC does not implement
8703 this model.
8704 @end table
8705
8706 @node IA-64 Options
8707 @subsection IA-64 Options
8708 @cindex IA-64 Options
8709
8710 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8711
8712 @table @gcctabopt
8713 @item -mbig-endian
8714 @opindex mbig-endian
8715 Generate code for a big endian target.  This is the default for HP-UX@.
8716
8717 @item -mlittle-endian
8718 @opindex mlittle-endian
8719 Generate code for a little endian target.  This is the default for AIX5
8720 and GNU/Linux.
8721
8722 @item -mgnu-as
8723 @itemx -mno-gnu-as
8724 @opindex mgnu-as
8725 @opindex mno-gnu-as
8726 Generate (or don't) code for the GNU assembler.  This is the default.
8727 @c Also, this is the default if the configure option @option{--with-gnu-as}
8728 @c is used.
8729
8730 @item -mgnu-ld
8731 @itemx -mno-gnu-ld
8732 @opindex mgnu-ld
8733 @opindex mno-gnu-ld
8734 Generate (or don't) code for the GNU linker.  This is the default.
8735 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8736 @c is used.
8737
8738 @item -mno-pic
8739 @opindex mno-pic
8740 Generate code that does not use a global pointer register.  The result
8741 is not position independent code, and violates the IA-64 ABI@.
8742
8743 @item -mvolatile-asm-stop
8744 @itemx -mno-volatile-asm-stop
8745 @opindex mvolatile-asm-stop
8746 @opindex mno-volatile-asm-stop
8747 Generate (or don't) a stop bit immediately before and after volatile asm
8748 statements.
8749
8750 @item -mb-step
8751 @opindex mb-step
8752 Generate code that works around Itanium B step errata.
8753
8754 @item -mregister-names
8755 @itemx -mno-register-names
8756 @opindex mregister-names
8757 @opindex mno-register-names
8758 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8759 the stacked registers.  This may make assembler output more readable.
8760
8761 @item -mno-sdata
8762 @itemx -msdata
8763 @opindex mno-sdata
8764 @opindex msdata
8765 Disable (or enable) optimizations that use the small data section.  This may
8766 be useful for working around optimizer bugs.
8767
8768 @item -mconstant-gp
8769 @opindex mconstant-gp
8770 Generate code that uses a single constant global pointer value.  This is
8771 useful when compiling kernel code.
8772
8773 @item -mauto-pic
8774 @opindex mauto-pic
8775 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8776 This is useful when compiling firmware code.
8777
8778 @item -minline-float-divide-min-latency
8779 @opindex minline-float-divide-min-latency
8780 Generate code for inline divides of floating point values
8781 using the minimum latency algorithm.
8782
8783 @item -minline-float-divide-max-throughput
8784 @opindex minline-float-divide-max-throughput
8785 Generate code for inline divides of floating point values
8786 using the maximum throughput algorithm.
8787
8788 @item -minline-int-divide-min-latency
8789 @opindex minline-int-divide-min-latency
8790 Generate code for inline divides of integer values
8791 using the minimum latency algorithm.
8792
8793 @item -minline-int-divide-max-throughput
8794 @opindex minline-int-divide-max-throughput
8795 Generate code for inline divides of integer values
8796 using the maximum throughput algorithm.
8797
8798 @item -mno-dwarf2-asm
8799 @itemx -mdwarf2-asm
8800 @opindex mno-dwarf2-asm
8801 @opindex mdwarf2-asm
8802 Don't (or do) generate assembler code for the DWARF2 line number debugging
8803 info.  This may be useful when not using the GNU assembler.
8804
8805 @item -mfixed-range=@var{register-range}
8806 @opindex mfixed-range
8807 Generate code treating the given register range as fixed registers.
8808 A fixed register is one that the register allocator can not use.  This is
8809 useful when compiling kernel code.  A register range is specified as
8810 two registers separated by a dash.  Multiple register ranges can be
8811 specified separated by a comma.
8812
8813 @item -mearly-stop-bits
8814 @itemx -mno-early-stop-bits
8815 @opindex mearly-stop-bits
8816 @opindex mno-early-stop-bits
8817 Allow stop bits to be placed earlier than immediately preceding the
8818 instruction that triggered the stop bit.  This can improve instruction
8819 scheduling, but does not always do so.
8820 @end table
8821
8822 @node M32R/D Options
8823 @subsection M32R/D Options
8824 @cindex M32R/D options
8825
8826 These @option{-m} options are defined for Renesas M32R/D architectures:
8827
8828 @table @gcctabopt
8829 @item -m32r2
8830 @opindex m32r2
8831 Generate code for the M32R/2@.
8832
8833 @item -m32rx
8834 @opindex m32rx
8835 Generate code for the M32R/X@.
8836
8837 @item -m32r
8838 @opindex m32r
8839 Generate code for the M32R@.  This is the default.
8840
8841 @item -mmodel=small
8842 @opindex mmodel=small
8843 Assume all objects live in the lower 16MB of memory (so that their addresses
8844 can be loaded with the @code{ld24} instruction), and assume all subroutines
8845 are reachable with the @code{bl} instruction.
8846 This is the default.
8847
8848 The addressability of a particular object can be set with the
8849 @code{model} attribute.
8850
8851 @item -mmodel=medium
8852 @opindex mmodel=medium
8853 Assume objects may be anywhere in the 32-bit address space (the compiler
8854 will generate @code{seth/add3} instructions to load their addresses), and
8855 assume all subroutines are reachable with the @code{bl} instruction.
8856
8857 @item -mmodel=large
8858 @opindex mmodel=large
8859 Assume objects may be anywhere in the 32-bit address space (the compiler
8860 will generate @code{seth/add3} instructions to load their addresses), and
8861 assume subroutines may not be reachable with the @code{bl} instruction
8862 (the compiler will generate the much slower @code{seth/add3/jl}
8863 instruction sequence).
8864
8865 @item -msdata=none
8866 @opindex msdata=none
8867 Disable use of the small data area.  Variables will be put into
8868 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8869 @code{section} attribute has been specified).
8870 This is the default.
8871
8872 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8873 Objects may be explicitly put in the small data area with the
8874 @code{section} attribute using one of these sections.
8875
8876 @item -msdata=sdata
8877 @opindex msdata=sdata
8878 Put small global and static data in the small data area, but do not
8879 generate special code to reference them.
8880
8881 @item -msdata=use
8882 @opindex msdata=use
8883 Put small global and static data in the small data area, and generate
8884 special instructions to reference them.
8885
8886 @item -G @var{num}
8887 @opindex G
8888 @cindex smaller data references
8889 Put global and static objects less than or equal to @var{num} bytes
8890 into the small data or bss sections instead of the normal data or bss
8891 sections.  The default value of @var{num} is 8.
8892 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8893 for this option to have any effect.
8894
8895 All modules should be compiled with the same @option{-G @var{num}} value.
8896 Compiling with different values of @var{num} may or may not work; if it
8897 doesn't the linker will give an error message---incorrect code will not be
8898 generated.
8899
8900 @item -mdebug
8901 @opindex mdebug
8902 Makes the M32R specific code in the compiler display some statistics
8903 that might help in debugging programs.
8904
8905 @item -malign-loops
8906 @opindex malign-loops
8907 Align all loops to a 32-byte boundary.
8908
8909 @item -mno-align-loops
8910 @opindex mno-align-loops
8911 Do not enforce a 32-byte alignment for loops.  This is the default.
8912
8913 @item -missue-rate=@var{number}
8914 @opindex missue-rate=@var{number}
8915 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8916 or 2.
8917
8918 @item -mbranch-cost=@var{number}
8919 @opindex mbranch-cost=@var{number}
8920 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8921 preferred over conditional code, if it is 2, then the opposite will
8922 apply.
8923
8924 @item -mflush-trap=@var{number}
8925 @opindex mflush-trap=@var{number}
8926 Specifies the trap number to use to flush the cache.  The default is
8927 12.  Valid numbers are between 0 and 15 inclusive.
8928
8929 @item -mno-flush-trap
8930 @opindex mno-flush-trap
8931 Specifies that the cache cannot be flushed by using a trap.
8932
8933 @item -mflush-func=@var{name}
8934 @opindex mflush-func=@var{name}
8935 Specifies the name of the operating system function to call to flush
8936 the cache.  The default is @emph{_flush_cache}, but a function call
8937 will only be used if a trap is not available.
8938
8939 @item -mno-flush-func
8940 @opindex mno-flush-func
8941 Indicates that there is no OS function for flushing the cache.
8942
8943 @end table
8944
8945 @node M680x0 Options
8946 @subsection M680x0 Options
8947 @cindex M680x0 options
8948
8949 These are the @samp{-m} options defined for the 68000 series.  The default
8950 values for these options depends on which style of 68000 was selected when
8951 the compiler was configured; the defaults for the most common choices are
8952 given below.
8953
8954 @table @gcctabopt
8955 @item -m68000
8956 @itemx -mc68000
8957 @opindex m68000
8958 @opindex mc68000
8959 Generate output for a 68000.  This is the default
8960 when the compiler is configured for 68000-based systems.
8961
8962 Use this option for microcontrollers with a 68000 or EC000 core,
8963 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8964
8965 @item -m68020
8966 @itemx -mc68020
8967 @opindex m68020
8968 @opindex mc68020
8969 Generate output for a 68020.  This is the default
8970 when the compiler is configured for 68020-based systems.
8971
8972 @item -m68881
8973 @opindex m68881
8974 Generate output containing 68881 instructions for floating point.
8975 This is the default for most 68020 systems unless @option{--nfp} was
8976 specified when the compiler was configured.
8977
8978 @item -m68030
8979 @opindex m68030
8980 Generate output for a 68030.  This is the default when the compiler is
8981 configured for 68030-based systems.
8982
8983 @item -m68040
8984 @opindex m68040
8985 Generate output for a 68040.  This is the default when the compiler is
8986 configured for 68040-based systems.
8987
8988 This option inhibits the use of 68881/68882 instructions that have to be
8989 emulated by software on the 68040.  Use this option if your 68040 does not
8990 have code to emulate those instructions.
8991
8992 @item -m68060
8993 @opindex m68060
8994 Generate output for a 68060.  This is the default when the compiler is
8995 configured for 68060-based systems.
8996
8997 This option inhibits the use of 68020 and 68881/68882 instructions that
8998 have to be emulated by software on the 68060.  Use this option if your 68060
8999 does not have code to emulate those instructions.
9000
9001 @item -mcpu32
9002 @opindex mcpu32
9003 Generate output for a CPU32.  This is the default
9004 when the compiler is configured for CPU32-based systems.
9005
9006 Use this option for microcontrollers with a
9007 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9008 68336, 68340, 68341, 68349 and 68360.
9009
9010 @item -m5200
9011 @opindex m5200
9012 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9013 when the compiler is configured for 520X-based systems.
9014
9015 Use this option for microcontroller with a 5200 core, including
9016 the MCF5202, MCF5203, MCF5204 and MCF5202.
9017
9018
9019 @item -m68020-40
9020 @opindex m68020-40
9021 Generate output for a 68040, without using any of the new instructions.
9022 This results in code which can run relatively efficiently on either a
9023 68020/68881 or a 68030 or a 68040.  The generated code does use the
9024 68881 instructions that are emulated on the 68040.
9025
9026 @item -m68020-60
9027 @opindex m68020-60
9028 Generate output for a 68060, without using any of the new instructions.
9029 This results in code which can run relatively efficiently on either a
9030 68020/68881 or a 68030 or a 68040.  The generated code does use the
9031 68881 instructions that are emulated on the 68060.
9032
9033 @item -msoft-float
9034 @opindex msoft-float
9035 Generate output containing library calls for floating point.
9036 @strong{Warning:} the requisite libraries are not available for all m68k
9037 targets.  Normally the facilities of the machine's usual C compiler are
9038 used, but this can't be done directly in cross-compilation.  You must
9039 make your own arrangements to provide suitable library functions for
9040 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9041 @samp{m68k-*-coff} do provide software floating point support.
9042
9043 @item -mshort
9044 @opindex mshort
9045 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9046 Additionally, parameters passed on the stack are also aligned to a
9047 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9048
9049 @item -mnobitfield
9050 @opindex mnobitfield
9051 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9052 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9053
9054 @item -mbitfield
9055 @opindex mbitfield
9056 Do use the bit-field instructions.  The @option{-m68020} option implies
9057 @option{-mbitfield}.  This is the default if you use a configuration
9058 designed for a 68020.
9059
9060 @item -mrtd
9061 @opindex mrtd
9062 Use a different function-calling convention, in which functions
9063 that take a fixed number of arguments return with the @code{rtd}
9064 instruction, which pops their arguments while returning.  This
9065 saves one instruction in the caller since there is no need to pop
9066 the arguments there.
9067
9068 This calling convention is incompatible with the one normally
9069 used on Unix, so you cannot use it if you need to call libraries
9070 compiled with the Unix compiler.
9071
9072 Also, you must provide function prototypes for all functions that
9073 take variable numbers of arguments (including @code{printf});
9074 otherwise incorrect code will be generated for calls to those
9075 functions.
9076
9077 In addition, seriously incorrect code will result if you call a
9078 function with too many arguments.  (Normally, extra arguments are
9079 harmlessly ignored.)
9080
9081 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9082 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9083
9084 @item -malign-int
9085 @itemx -mno-align-int
9086 @opindex malign-int
9087 @opindex mno-align-int
9088 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9089 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9090 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9091 Aligning variables on 32-bit boundaries produces code that runs somewhat
9092 faster on processors with 32-bit busses at the expense of more memory.
9093
9094 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9095 align structures containing the above types  differently than
9096 most published application binary interface specifications for the m68k.
9097
9098 @item -mpcrel
9099 @opindex mpcrel
9100 Use the pc-relative addressing mode of the 68000 directly, instead of
9101 using a global offset table.  At present, this option implies @option{-fpic},
9102 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9103 not presently supported with @option{-mpcrel}, though this could be supported for
9104 68020 and higher processors.
9105
9106 @item -mno-strict-align
9107 @itemx -mstrict-align
9108 @opindex mno-strict-align
9109 @opindex mstrict-align
9110 Do not (do) assume that unaligned memory references will be handled by
9111 the system.
9112
9113 @item -msep-data
9114 Generate code that allows the data segment to be located in a different
9115 area of memory from the text segment.  This allows for execute in place in
9116 an environment without virtual memory management.  This option implies
9117 @option{-fPIC}.
9118
9119 @item -mno-sep-data
9120 Generate code that assumes that the data segment follows the text segment.
9121 This is the default.
9122
9123 @item -mid-shared-library
9124 Generate code that supports shared libraries via the library ID method.
9125 This allows for execute in place and shared libraries in an environment
9126 without virtual memory management.  This option implies @option{-fPIC}.
9127
9128 @item -mno-id-shared-library
9129 Generate code that doesn't assume ID based shared libraries are being used.
9130 This is the default.
9131
9132 @item -mshared-library-id=n
9133 Specified the identification number of the ID based shared library being
9134 compiled.  Specifying a value of 0 will generate more compact code, specifying
9135 other values will force the allocation of that number to the current
9136 library but is no more space or time efficient than omitting this option.
9137
9138 @end table
9139
9140 @node M68hc1x Options
9141 @subsection M68hc1x Options
9142 @cindex M68hc1x options
9143
9144 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9145 microcontrollers.  The default values for these options depends on
9146 which style of microcontroller was selected when the compiler was configured;
9147 the defaults for the most common choices are given below.
9148
9149 @table @gcctabopt
9150 @item -m6811
9151 @itemx -m68hc11
9152 @opindex m6811
9153 @opindex m68hc11
9154 Generate output for a 68HC11.  This is the default
9155 when the compiler is configured for 68HC11-based systems.
9156
9157 @item -m6812
9158 @itemx -m68hc12
9159 @opindex m6812
9160 @opindex m68hc12
9161 Generate output for a 68HC12.  This is the default
9162 when the compiler is configured for 68HC12-based systems.
9163
9164 @item -m68S12
9165 @itemx -m68hcs12
9166 @opindex m68S12
9167 @opindex m68hcs12
9168 Generate output for a 68HCS12.
9169
9170 @item -mauto-incdec
9171 @opindex mauto-incdec
9172 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9173 addressing modes.
9174
9175 @item -minmax
9176 @itemx -nominmax
9177 @opindex minmax
9178 @opindex mnominmax
9179 Enable the use of 68HC12 min and max instructions.
9180
9181 @item -mlong-calls
9182 @itemx -mno-long-calls
9183 @opindex mlong-calls
9184 @opindex mno-long-calls
9185 Treat all calls as being far away (near).  If calls are assumed to be
9186 far away, the compiler will use the @code{call} instruction to
9187 call a function and the @code{rtc} instruction for returning.
9188
9189 @item -mshort
9190 @opindex mshort
9191 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9192
9193 @item -msoft-reg-count=@var{count}
9194 @opindex msoft-reg-count
9195 Specify the number of pseudo-soft registers which are used for the
9196 code generation.  The maximum number is 32.  Using more pseudo-soft
9197 register may or may not result in better code depending on the program.
9198 The default is 4 for 68HC11 and 2 for 68HC12.
9199
9200 @end table
9201
9202 @node MCore Options
9203 @subsection MCore Options
9204 @cindex MCore options
9205
9206 These are the @samp{-m} options defined for the Motorola M*Core
9207 processors.
9208
9209 @table @gcctabopt
9210
9211 @item -mhardlit
9212 @itemx -mno-hardlit
9213 @opindex mhardlit
9214 @opindex mno-hardlit
9215 Inline constants into the code stream if it can be done in two
9216 instructions or less.
9217
9218 @item -mdiv
9219 @itemx -mno-div
9220 @opindex mdiv
9221 @opindex mno-div
9222 Use the divide instruction.  (Enabled by default).
9223
9224 @item -mrelax-immediate
9225 @itemx -mno-relax-immediate
9226 @opindex mrelax-immediate
9227 @opindex mno-relax-immediate
9228 Allow arbitrary sized immediates in bit operations.
9229
9230 @item -mwide-bitfields
9231 @itemx -mno-wide-bitfields
9232 @opindex mwide-bitfields
9233 @opindex mno-wide-bitfields
9234 Always treat bit-fields as int-sized.
9235
9236 @item -m4byte-functions
9237 @itemx -mno-4byte-functions
9238 @opindex m4byte-functions
9239 @opindex mno-4byte-functions
9240 Force all functions to be aligned to a four byte boundary.
9241
9242 @item -mcallgraph-data
9243 @itemx -mno-callgraph-data
9244 @opindex mcallgraph-data
9245 @opindex mno-callgraph-data
9246 Emit callgraph information.
9247
9248 @item -mslow-bytes
9249 @itemx -mno-slow-bytes
9250 @opindex mslow-bytes
9251 @opindex mno-slow-bytes
9252 Prefer word access when reading byte quantities.
9253
9254 @item -mlittle-endian
9255 @itemx -mbig-endian
9256 @opindex mlittle-endian
9257 @opindex mbig-endian
9258 Generate code for a little endian target.
9259
9260 @item -m210
9261 @itemx -m340
9262 @opindex m210
9263 @opindex m340
9264 Generate code for the 210 processor.
9265 @end table
9266
9267 @node MIPS Options
9268 @subsection MIPS Options
9269 @cindex MIPS options
9270
9271 @table @gcctabopt
9272
9273 @item -EB
9274 @opindex EB
9275 Generate big-endian code.
9276
9277 @item -EL
9278 @opindex EL
9279 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9280 configurations.
9281
9282 @item -march=@var{arch}
9283 @opindex march
9284 Generate code that will run on @var{arch}, which can be the name of a
9285 generic MIPS ISA, or the name of a particular processor.
9286 The ISA names are:
9287 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9288 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9289 The processor names are:
9290 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9291 @samp{m4k},
9292 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9293 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9294 @samp{rm9000},
9295 @samp{orion},
9296 @samp{sb1},
9297 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9298 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9299 The special value @samp{from-abi} selects the
9300 most compatible architecture for the selected ABI (that is,
9301 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9302
9303 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9304 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9305 @samp{vr} may be written @samp{r}.
9306
9307 GCC defines two macros based on the value of this option.  The first
9308 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9309 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9310 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9311 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9312 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9313
9314 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9315 above.  In other words, it will have the full prefix and will not
9316 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9317 the macro names the resolved architecture (either @samp{"mips1"} or
9318 @samp{"mips3"}).  It names the default architecture when no
9319 @option{-march} option is given.
9320
9321 @item -mtune=@var{arch}
9322 @opindex mtune
9323 Optimize for @var{arch}.  Among other things, this option controls
9324 the way instructions are scheduled, and the perceived cost of arithmetic
9325 operations.  The list of @var{arch} values is the same as for
9326 @option{-march}.
9327
9328 When this option is not used, GCC will optimize for the processor
9329 specified by @option{-march}.  By using @option{-march} and
9330 @option{-mtune} together, it is possible to generate code that will
9331 run on a family of processors, but optimize the code for one
9332 particular member of that family.
9333
9334 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9335 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9336 @samp{-march} ones described above.
9337
9338 @item -mips1
9339 @opindex mips1
9340 Equivalent to @samp{-march=mips1}.
9341
9342 @item -mips2
9343 @opindex mips2
9344 Equivalent to @samp{-march=mips2}.
9345
9346 @item -mips3
9347 @opindex mips3
9348 Equivalent to @samp{-march=mips3}.
9349
9350 @item -mips4
9351 @opindex mips4
9352 Equivalent to @samp{-march=mips4}.
9353
9354 @item -mips32
9355 @opindex mips32
9356 Equivalent to @samp{-march=mips32}.
9357
9358 @item -mips32r2
9359 @opindex mips32r2
9360 Equivalent to @samp{-march=mips32r2}.
9361
9362 @item -mips64
9363 @opindex mips64
9364 Equivalent to @samp{-march=mips64}.
9365
9366 @item -mips16
9367 @itemx -mno-mips16
9368 @opindex mips16
9369 @opindex mno-mips16
9370 Use (do not use) the MIPS16 ISA.
9371
9372 @item -mabi=32
9373 @itemx -mabi=o64
9374 @itemx -mabi=n32
9375 @itemx -mabi=64
9376 @itemx -mabi=eabi
9377 @opindex mabi=32
9378 @opindex mabi=o64
9379 @opindex mabi=n32
9380 @opindex mabi=64
9381 @opindex mabi=eabi
9382 Generate code for the given ABI@.
9383
9384 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9385 generates 64-bit code when you select a 64-bit architecture, but you
9386 can use @option{-mgp32} to get 32-bit code instead.
9387
9388 For information about the O64 ABI, see
9389 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9390
9391 @item -mabicalls
9392 @itemx -mno-abicalls
9393 @opindex mabicalls
9394 @opindex mno-abicalls
9395 Generate (do not generate) SVR4-style position-independent code.
9396 @option{-mabicalls} is the default for SVR4-based systems.
9397
9398 @item -mxgot
9399 @itemx -mno-xgot
9400 @opindex mxgot
9401 @opindex mno-xgot
9402 Lift (do not lift) the usual restrictions on the size of the global
9403 offset table.
9404
9405 GCC normally uses a single instruction to load values from the GOT.
9406 While this is relatively efficient, it will only work if the GOT
9407 is smaller than about 64k.  Anything larger will cause the linker
9408 to report an error such as:
9409
9410 @cindex relocation truncated to fit (MIPS)
9411 @smallexample
9412 relocation truncated to fit: R_MIPS_GOT16 foobar
9413 @end smallexample
9414
9415 If this happens, you should recompile your code with @option{-mxgot}.
9416 It should then work with very large GOTs, although it will also be
9417 less efficient, since it will take three instructions to fetch the
9418 value of a global symbol.
9419
9420 Note that some linkers can create multiple GOTs.  If you have such a
9421 linker, you should only need to use @option{-mxgot} when a single object
9422 file accesses more than 64k's worth of GOT entries.  Very few do.
9423
9424 These options have no effect unless GCC is generating position
9425 independent code.
9426
9427 @item -mgp32
9428 @opindex mgp32
9429 Assume that general-purpose registers are 32 bits wide.
9430
9431 @item -mgp64
9432 @opindex mgp64
9433 Assume that general-purpose registers are 64 bits wide.
9434
9435 @item -mfp32
9436 @opindex mfp32
9437 Assume that floating-point registers are 32 bits wide.
9438
9439 @item -mfp64
9440 @opindex mfp64
9441 Assume that floating-point registers are 64 bits wide.
9442
9443 @item -mhard-float
9444 @opindex mhard-float
9445 Use floating-point coprocessor instructions.
9446
9447 @item -msoft-float
9448 @opindex msoft-float
9449 Do not use floating-point coprocessor instructions.  Implement
9450 floating-point calculations using library calls instead.
9451
9452 @item -msingle-float
9453 @opindex msingle-float
9454 Assume that the floating-point coprocessor only supports single-precision
9455 operations.
9456
9457 @itemx -mdouble-float
9458 @opindex mdouble-float
9459 Assume that the floating-point coprocessor supports double-precision
9460 operations.  This is the default.
9461
9462 @itemx -mpaired-single
9463 @itemx -mno-paired-single
9464 @opindex mpaired-single
9465 @opindex mno-paired-single
9466 Use (do not use) the paired single instructions.
9467
9468 @itemx -mips3d
9469 @itemx -mno-mips3d
9470 @opindex mips3d
9471 @opindex mno-mips3d
9472 Use (do not use) the MIPS-3D ASE.  The option @option{-mips3d} implies
9473 @option{-mpaired-single}.
9474
9475 @item -mint64
9476 @opindex mint64
9477 Force @code{int} and @code{long} types to be 64 bits wide.  See
9478 @option{-mlong32} for an explanation of the default and the way
9479 that the pointer size is determined.
9480
9481 @item -mlong64
9482 @opindex mlong64
9483 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9484 an explanation of the default and the way that the pointer size is
9485 determined.
9486
9487 @item -mlong32
9488 @opindex mlong32
9489 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9490
9491 The default size of @code{int}s, @code{long}s and pointers depends on
9492 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9493 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9494 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9495 or the same size as integer registers, whichever is smaller.
9496
9497 @item -G @var{num}
9498 @opindex G
9499 @cindex smaller data references (MIPS)
9500 @cindex gp-relative references (MIPS)
9501 Put global and static items less than or equal to @var{num} bytes into
9502 the small data or bss section instead of the normal data or bss section.
9503 This allows the data to be accessed using a single instruction.
9504
9505 All modules should be compiled with the same @option{-G @var{num}}
9506 value.
9507
9508 @item -membedded-data
9509 @itemx -mno-embedded-data
9510 @opindex membedded-data
9511 @opindex mno-embedded-data
9512 Allocate variables to the read-only data section first if possible, then
9513 next in the small data section if possible, otherwise in data.  This gives
9514 slightly slower code than the default, but reduces the amount of RAM required
9515 when executing, and thus may be preferred for some embedded systems.
9516
9517 @item -muninit-const-in-rodata
9518 @itemx -mno-uninit-const-in-rodata
9519 @opindex muninit-const-in-rodata
9520 @opindex mno-uninit-const-in-rodata
9521 Put uninitialized @code{const} variables in the read-only data section.
9522 This option is only meaningful in conjunction with @option{-membedded-data}.
9523
9524 @item -msplit-addresses
9525 @itemx -mno-split-addresses
9526 @opindex msplit-addresses
9527 @opindex mno-split-addresses
9528 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9529 relocation operators.  This option has been superceded by
9530 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9531
9532 @item -mexplicit-relocs
9533 @itemx -mno-explicit-relocs
9534 @opindex mexplicit-relocs
9535 @opindex mno-explicit-relocs
9536 Use (do not use) assembler relocation operators when dealing with symbolic
9537 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9538 is to use assembler macros instead.
9539
9540 @option{-mexplicit-relocs} is the default if GCC was configured
9541 to use an assembler that supports relocation operators.
9542
9543 @item -mcheck-zero-division
9544 @itemx -mno-check-zero-division
9545 @opindex mcheck-zero-division
9546 @opindex mno-check-zero-division
9547 Trap (do not trap) on integer division by zero.  The default is
9548 @option{-mcheck-zero-division}.
9549
9550 @item -mdivide-traps
9551 @itemx -mdivide-breaks
9552 @opindex mdivide-traps
9553 @opindex mdivide-breaks
9554 MIPS systems check for division by zero by generating either a
9555 conditional trap or a break instruction.  Using traps results in
9556 smaller code, but is only supported on MIPS II and later.  Also, some
9557 versions of the Linux kernel have a bug that prevents trap from
9558 generating the proper signal (SIGFPE).  Use @option{-mdivide-traps} to
9559 allow conditional traps on architectures that support them and
9560 @option{-mdivide-breaks} to force the use of breaks.
9561
9562 The default is usually @option{-mdivide-traps}, but this can be
9563 overridden at configure time using @option{--with-divide=breaks}.
9564 Divide-by-zero checks can be completely disabled using
9565 @option{-mno-check-zero-division}.
9566
9567 @item -mmemcpy
9568 @itemx -mno-memcpy
9569 @opindex mmemcpy
9570 @opindex mno-memcpy
9571 Force (do not force) the use of @code{memcpy()} for non-trivial block
9572 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9573 most constant-sized copies.
9574
9575 @item -mlong-calls
9576 @itemx -mno-long-calls
9577 @opindex mlong-calls
9578 @opindex mno-long-calls
9579 Disable (do not disable) use of the @code{jal} instruction.  Calling
9580 functions using @code{jal} is more efficient but requires the caller
9581 and callee to be in the same 256 megabyte segment.
9582
9583 This option has no effect on abicalls code.  The default is
9584 @option{-mno-long-calls}.
9585
9586 @item -mmad
9587 @itemx -mno-mad
9588 @opindex mmad
9589 @opindex mno-mad
9590 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9591 instructions, as provided by the R4650 ISA.
9592
9593 @item -mfused-madd
9594 @itemx -mno-fused-madd
9595 @opindex mfused-madd
9596 @opindex mno-fused-madd
9597 Enable (disable) use of the floating point multiply-accumulate
9598 instructions, when they are available.  The default is
9599 @option{-mfused-madd}.
9600
9601 When multiply-accumulate instructions are used, the intermediate
9602 product is calculated to infinite precision and is not subject to
9603 the FCSR Flush to Zero bit.  This may be undesirable in some
9604 circumstances.
9605
9606 @item -nocpp
9607 @opindex nocpp
9608 Tell the MIPS assembler to not run its preprocessor over user
9609 assembler files (with a @samp{.s} suffix) when assembling them.
9610
9611 @item -mfix-r4000
9612 @itemx -mno-fix-r4000
9613 @opindex mfix-r4000
9614 @opindex mno-fix-r4000
9615 Work around certain R4000 CPU errata:
9616 @itemize @minus
9617 @item
9618 A double-word or a variable shift may give an incorrect result if executed
9619 immediately after starting an integer division.
9620 @item
9621 A double-word or a variable shift may give an incorrect result if executed
9622 while an integer multiplication is in progress.
9623 @item
9624 An integer division may give an incorrect result if started in a delay slot
9625 of a taken branch or a jump.
9626 @end itemize
9627
9628 @item -mfix-r4400
9629 @itemx -mno-fix-r4400
9630 @opindex mfix-r4400
9631 @opindex mno-fix-r4400
9632 Work around certain R4400 CPU errata:
9633 @itemize @minus
9634 @item
9635 A double-word or a variable shift may give an incorrect result if executed
9636 immediately after starting an integer division.
9637 @end itemize
9638
9639 @item -mfix-vr4120
9640 @itemx -mno-fix-vr4120
9641 @opindex mfix-vr4120
9642 Work around certain VR4120 errata:
9643 @itemize @minus
9644 @item
9645 @code{dmultu} does not always produce the correct result.
9646 @item
9647 @code{div} and @code{ddiv} do not always produce the correct result if one
9648 of the operands is negative.
9649 @end itemize
9650 The workarounds for the division errata rely on special functions in
9651 @file{libgcc.a}.  At present, these functions are only provided by
9652 the @code{mips64vr*-elf} configurations.
9653
9654 Other VR4120 errata require a nop to be inserted between certain pairs of
9655 instructions.  These errata are handled by the assembler, not by GCC itself.
9656
9657 @item -mfix-sb1
9658 @itemx -mno-fix-sb1
9659 @opindex mfix-sb1
9660 Work around certain SB-1 CPU core errata.
9661 (This flag currently works around the SB-1 revision 2
9662 ``F1'' and ``F2'' floating point errata.)
9663
9664 @item -mflush-func=@var{func}
9665 @itemx -mno-flush-func
9666 @opindex mflush-func
9667 Specifies the function to call to flush the I and D caches, or to not
9668 call any such function.  If called, the function must take the same
9669 arguments as the common @code{_flush_func()}, that is, the address of the
9670 memory range for which the cache is being flushed, the size of the
9671 memory range, and the number 3 (to flush both caches).  The default
9672 depends on the target GCC was configured for, but commonly is either
9673 @samp{_flush_func} or @samp{__cpu_flush}.
9674
9675 @item -mbranch-likely
9676 @itemx -mno-branch-likely
9677 @opindex mbranch-likely
9678 @opindex mno-branch-likely
9679 Enable or disable use of Branch Likely instructions, regardless of the
9680 default for the selected architecture.  By default, Branch Likely
9681 instructions may be generated if they are supported by the selected
9682 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9683 and processors which implement those architectures; for those, Branch
9684 Likely instructions will not be generated by default because the MIPS32
9685 and MIPS64 architectures specifically deprecate their use.
9686
9687 @item -mfp-exceptions
9688 @itemx -mno-fp-exceptions
9689 @opindex mfp-exceptions
9690 Specifies whether FP exceptions are enabled.  This affects how we schedule
9691 FP instructions for some processors.  The default is that FP exceptions are
9692 enabled.
9693
9694 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9695 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9696 FP pipe.
9697
9698 @item -mvr4130-align
9699 @itemx -mno-vr4130-align
9700 @opindex mvr4130-align
9701 The VR4130 pipeline is two-way superscalar, but can only issue two
9702 instructions together if the first one is 8-byte aligned.  When this
9703 option is enabled, GCC will align pairs of instructions that it
9704 thinks should execute in parallel.
9705
9706 This option only has an effect when optimizing for the VR4130.
9707 It normally makes code faster, but at the expense of making it bigger.
9708 It is enabled by default at optimization level @option{-O3}.
9709 @end table
9710
9711 @node MMIX Options
9712 @subsection MMIX Options
9713 @cindex MMIX Options
9714
9715 These options are defined for the MMIX:
9716
9717 @table @gcctabopt
9718 @item -mlibfuncs
9719 @itemx -mno-libfuncs
9720 @opindex mlibfuncs
9721 @opindex mno-libfuncs
9722 Specify that intrinsic library functions are being compiled, passing all
9723 values in registers, no matter the size.
9724
9725 @item -mepsilon
9726 @itemx -mno-epsilon
9727 @opindex mepsilon
9728 @opindex mno-epsilon
9729 Generate floating-point comparison instructions that compare with respect
9730 to the @code{rE} epsilon register.
9731
9732 @item -mabi=mmixware
9733 @itemx -mabi=gnu
9734 @opindex mabi-mmixware
9735 @opindex mabi=gnu
9736 Generate code that passes function parameters and return values that (in
9737 the called function) are seen as registers @code{$0} and up, as opposed to
9738 the GNU ABI which uses global registers @code{$231} and up.
9739
9740 @item -mzero-extend
9741 @itemx -mno-zero-extend
9742 @opindex mzero-extend
9743 @opindex mno-zero-extend
9744 When reading data from memory in sizes shorter than 64 bits, use (do not
9745 use) zero-extending load instructions by default, rather than
9746 sign-extending ones.
9747
9748 @item -mknuthdiv
9749 @itemx -mno-knuthdiv
9750 @opindex mknuthdiv
9751 @opindex mno-knuthdiv
9752 Make the result of a division yielding a remainder have the same sign as
9753 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9754 remainder follows the sign of the dividend.  Both methods are
9755 arithmetically valid, the latter being almost exclusively used.
9756
9757 @item -mtoplevel-symbols
9758 @itemx -mno-toplevel-symbols
9759 @opindex mtoplevel-symbols
9760 @opindex mno-toplevel-symbols
9761 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9762 code can be used with the @code{PREFIX} assembly directive.
9763
9764 @item -melf
9765 @opindex melf
9766 Generate an executable in the ELF format, rather than the default
9767 @samp{mmo} format used by the @command{mmix} simulator.
9768
9769 @item -mbranch-predict
9770 @itemx -mno-branch-predict
9771 @opindex mbranch-predict
9772 @opindex mno-branch-predict
9773 Use (do not use) the probable-branch instructions, when static branch
9774 prediction indicates a probable branch.
9775
9776 @item -mbase-addresses
9777 @itemx -mno-base-addresses
9778 @opindex mbase-addresses
9779 @opindex mno-base-addresses
9780 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9781 base address automatically generates a request (handled by the assembler
9782 and the linker) for a constant to be set up in a global register.  The
9783 register is used for one or more base address requests within the range 0
9784 to 255 from the value held in the register.  The generally leads to short
9785 and fast code, but the number of different data items that can be
9786 addressed is limited.  This means that a program that uses lots of static
9787 data may require @option{-mno-base-addresses}.
9788
9789 @item -msingle-exit
9790 @itemx -mno-single-exit
9791 @opindex msingle-exit
9792 @opindex mno-single-exit
9793 Force (do not force) generated code to have a single exit point in each
9794 function.
9795 @end table
9796
9797 @node MN10300 Options
9798 @subsection MN10300 Options
9799 @cindex MN10300 options
9800
9801 These @option{-m} options are defined for Matsushita MN10300 architectures:
9802
9803 @table @gcctabopt
9804 @item -mmult-bug
9805 @opindex mmult-bug
9806 Generate code to avoid bugs in the multiply instructions for the MN10300
9807 processors.  This is the default.
9808
9809 @item -mno-mult-bug
9810 @opindex mno-mult-bug
9811 Do not generate code to avoid bugs in the multiply instructions for the
9812 MN10300 processors.
9813
9814 @item -mam33
9815 @opindex mam33
9816 Generate code which uses features specific to the AM33 processor.
9817
9818 @item -mno-am33
9819 @opindex mno-am33
9820 Do not generate code which uses features specific to the AM33 processor.  This
9821 is the default.
9822
9823 @item -mno-crt0
9824 @opindex mno-crt0
9825 Do not link in the C run-time initialization object file.
9826
9827 @item -mrelax
9828 @opindex mrelax
9829 Indicate to the linker that it should perform a relaxation optimization pass
9830 to shorten branches, calls and absolute memory addresses.  This option only
9831 has an effect when used on the command line for the final link step.
9832
9833 This option makes symbolic debugging impossible.
9834 @end table
9835
9836 @node NS32K Options
9837 @subsection NS32K Options
9838 @cindex NS32K options
9839
9840 These are the @samp{-m} options defined for the 32000 series.  The default
9841 values for these options depends on which style of 32000 was selected when
9842 the compiler was configured; the defaults for the most common choices are
9843 given below.
9844
9845 @table @gcctabopt
9846 @item -m32032
9847 @itemx -m32032
9848 @opindex m32032
9849 @opindex m32032
9850 Generate output for a 32032.  This is the default
9851 when the compiler is configured for 32032 and 32016 based systems.
9852
9853 @item -m32332
9854 @itemx -m32332
9855 @opindex m32332
9856 @opindex m32332
9857 Generate output for a 32332.  This is the default
9858 when the compiler is configured for 32332-based systems.
9859
9860 @item -m32532
9861 @itemx -m32532
9862 @opindex m32532
9863 @opindex m32532
9864 Generate output for a 32532.  This is the default
9865 when the compiler is configured for 32532-based systems.
9866
9867 @item -m32081
9868 @opindex m32081
9869 Generate output containing 32081 instructions for floating point.
9870 This is the default for all systems.
9871
9872 @item -m32381
9873 @opindex m32381
9874 Generate output containing 32381 instructions for floating point.  This
9875 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9876 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9877
9878 @item -mmulti-add
9879 @opindex mmulti-add
9880 Try and generate multiply-add floating point instructions @code{polyF}
9881 and @code{dotF}.  This option is only available if the @option{-m32381}
9882 option is in effect.  Using these instructions requires changes to
9883 register allocation which generally has a negative impact on
9884 performance.  This option should only be enabled when compiling code
9885 particularly likely to make heavy use of multiply-add instructions.
9886
9887 @item -mnomulti-add
9888 @opindex mnomulti-add
9889 Do not try and generate multiply-add floating point instructions
9890 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9891
9892 @item -msoft-float
9893 @opindex msoft-float
9894 Generate output containing library calls for floating point.
9895 @strong{Warning:} the requisite libraries may not be available.
9896
9897 @item -mieee-compare
9898 @itemx -mno-ieee-compare
9899 @opindex mieee-compare
9900 @opindex mno-ieee-compare
9901 Control whether or not the compiler uses IEEE floating point
9902 comparisons.  These handle correctly the case where the result of a
9903 comparison is unordered.
9904 @strong{Warning:} the requisite kernel support may not be available.
9905
9906 @item -mnobitfield
9907 @opindex mnobitfield
9908 Do not use the bit-field instructions.  On some machines it is faster to
9909 use shifting and masking operations.  This is the default for the pc532.
9910
9911 @item -mbitfield
9912 @opindex mbitfield
9913 Do use the bit-field instructions.  This is the default for all platforms
9914 except the pc532.
9915
9916 @item -mrtd
9917 @opindex mrtd
9918 Use a different function-calling convention, in which functions
9919 that take a fixed number of arguments return pop their
9920 arguments on return with the @code{ret} instruction.
9921
9922 This calling convention is incompatible with the one normally
9923 used on Unix, so you cannot use it if you need to call libraries
9924 compiled with the Unix compiler.
9925
9926 Also, you must provide function prototypes for all functions that
9927 take variable numbers of arguments (including @code{printf});
9928 otherwise incorrect code will be generated for calls to those
9929 functions.
9930
9931 In addition, seriously incorrect code will result if you call a
9932 function with too many arguments.  (Normally, extra arguments are
9933 harmlessly ignored.)
9934
9935 This option takes its name from the 680x0 @code{rtd} instruction.
9936
9937
9938 @item -mregparam
9939 @opindex mregparam
9940 Use a different function-calling convention where the first two arguments
9941 are passed in registers.
9942
9943 This calling convention is incompatible with the one normally
9944 used on Unix, so you cannot use it if you need to call libraries
9945 compiled with the Unix compiler.
9946
9947 @item -mnoregparam
9948 @opindex mnoregparam
9949 Do not pass any arguments in registers.  This is the default for all
9950 targets.
9951
9952 @item -msb
9953 @opindex msb
9954 It is OK to use the sb as an index register which is always loaded with
9955 zero.  This is the default for the pc532-netbsd target.
9956
9957 @item -mnosb
9958 @opindex mnosb
9959 The sb register is not available for use or has not been initialized to
9960 zero by the run time system.  This is the default for all targets except
9961 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9962 @option{-fpic} is set.
9963
9964 @item -mhimem
9965 @opindex mhimem
9966 Many ns32000 series addressing modes use displacements of up to 512MB@.
9967 If an address is above 512MB then displacements from zero can not be used.
9968 This option causes code to be generated which can be loaded above 512MB@.
9969 This may be useful for operating systems or ROM code.
9970
9971 @item -mnohimem
9972 @opindex mnohimem
9973 Assume code will be loaded in the first 512MB of virtual address space.
9974 This is the default for all platforms.
9975
9976 @end table
9977
9978 @node PDP-11 Options
9979 @subsection PDP-11 Options
9980 @cindex PDP-11 Options
9981
9982 These options are defined for the PDP-11:
9983
9984 @table @gcctabopt
9985 @item -mfpu
9986 @opindex mfpu
9987 Use hardware FPP floating point.  This is the default.  (FIS floating
9988 point on the PDP-11/40 is not supported.)
9989
9990 @item -msoft-float
9991 @opindex msoft-float
9992 Do not use hardware floating point.
9993
9994 @item -mac0
9995 @opindex mac0
9996 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9997
9998 @item -mno-ac0
9999 @opindex mno-ac0
10000 Return floating-point results in memory.  This is the default.
10001
10002 @item -m40
10003 @opindex m40
10004 Generate code for a PDP-11/40.
10005
10006 @item -m45
10007 @opindex m45
10008 Generate code for a PDP-11/45.  This is the default.
10009
10010 @item -m10
10011 @opindex m10
10012 Generate code for a PDP-11/10.
10013
10014 @item -mbcopy-builtin
10015 @opindex bcopy-builtin
10016 Use inline @code{movmemhi} patterns for copying memory.  This is the
10017 default.
10018
10019 @item -mbcopy
10020 @opindex mbcopy
10021 Do not use inline @code{movmemhi} patterns for copying memory.
10022
10023 @item -mint16
10024 @itemx -mno-int32
10025 @opindex mint16
10026 @opindex mno-int32
10027 Use 16-bit @code{int}.  This is the default.
10028
10029 @item -mint32
10030 @itemx -mno-int16
10031 @opindex mint32
10032 @opindex mno-int16
10033 Use 32-bit @code{int}.
10034
10035 @item -mfloat64
10036 @itemx -mno-float32
10037 @opindex mfloat64
10038 @opindex mno-float32
10039 Use 64-bit @code{float}.  This is the default.
10040
10041 @item -mfloat32
10042 @itemx -mno-float64
10043 @opindex mfloat32
10044 @opindex mno-float64
10045 Use 32-bit @code{float}.
10046
10047 @item -mabshi
10048 @opindex mabshi
10049 Use @code{abshi2} pattern.  This is the default.
10050
10051 @item -mno-abshi
10052 @opindex mno-abshi
10053 Do not use @code{abshi2} pattern.
10054
10055 @item -mbranch-expensive
10056 @opindex mbranch-expensive
10057 Pretend that branches are expensive.  This is for experimenting with
10058 code generation only.
10059
10060 @item -mbranch-cheap
10061 @opindex mbranch-cheap
10062 Do not pretend that branches are expensive.  This is the default.
10063
10064 @item -msplit
10065 @opindex msplit
10066 Generate code for a system with split I&D.
10067
10068 @item -mno-split
10069 @opindex mno-split
10070 Generate code for a system without split I&D.  This is the default.
10071
10072 @item -munix-asm
10073 @opindex munix-asm
10074 Use Unix assembler syntax.  This is the default when configured for
10075 @samp{pdp11-*-bsd}.
10076
10077 @item -mdec-asm
10078 @opindex mdec-asm
10079 Use DEC assembler syntax.  This is the default when configured for any
10080 PDP-11 target other than @samp{pdp11-*-bsd}.
10081 @end table
10082
10083 @node PowerPC Options
10084 @subsection PowerPC Options
10085 @cindex PowerPC options
10086
10087 These are listed under @xref{RS/6000 and PowerPC Options}.
10088
10089 @node RS/6000 and PowerPC Options
10090 @subsection IBM RS/6000 and PowerPC Options
10091 @cindex RS/6000 and PowerPC Options
10092 @cindex IBM RS/6000 and PowerPC Options
10093
10094 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10095 @table @gcctabopt
10096 @item -mpower
10097 @itemx -mno-power
10098 @itemx -mpower2
10099 @itemx -mno-power2
10100 @itemx -mpowerpc
10101 @itemx -mno-powerpc
10102 @itemx -mpowerpc-gpopt
10103 @itemx -mno-powerpc-gpopt
10104 @itemx -mpowerpc-gfxopt
10105 @itemx -mno-powerpc-gfxopt
10106 @itemx -mpowerpc64
10107 @itemx -mno-powerpc64
10108 @opindex mpower
10109 @opindex mno-power
10110 @opindex mpower2
10111 @opindex mno-power2
10112 @opindex mpowerpc
10113 @opindex mno-powerpc
10114 @opindex mpowerpc-gpopt
10115 @opindex mno-powerpc-gpopt
10116 @opindex mpowerpc-gfxopt
10117 @opindex mno-powerpc-gfxopt
10118 @opindex mpowerpc64
10119 @opindex mno-powerpc64
10120 GCC supports two related instruction set architectures for the
10121 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10122 instructions supported by the @samp{rios} chip set used in the original
10123 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10124 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10125 the IBM 4xx microprocessors.
10126
10127 Neither architecture is a subset of the other.  However there is a
10128 large common subset of instructions supported by both.  An MQ
10129 register is included in processors supporting the POWER architecture.
10130
10131 You use these options to specify which instructions are available on the
10132 processor you are using.  The default value of these options is
10133 determined when configuring GCC@.  Specifying the
10134 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10135 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10136 rather than the options listed above.
10137
10138 The @option{-mpower} option allows GCC to generate instructions that
10139 are found only in the POWER architecture and to use the MQ register.
10140 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10141 to generate instructions that are present in the POWER2 architecture but
10142 not the original POWER architecture.
10143
10144 The @option{-mpowerpc} option allows GCC to generate instructions that
10145 are found only in the 32-bit subset of the PowerPC architecture.
10146 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10147 GCC to use the optional PowerPC architecture instructions in the
10148 General Purpose group, including floating-point square root.  Specifying
10149 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10150 use the optional PowerPC architecture instructions in the Graphics
10151 group, including floating-point select.
10152
10153 The @option{-mpowerpc64} option allows GCC to generate the additional
10154 64-bit instructions that are found in the full PowerPC64 architecture
10155 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10156 @option{-mno-powerpc64}.
10157
10158 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10159 will use only the instructions in the common subset of both
10160 architectures plus some special AIX common-mode calls, and will not use
10161 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10162 permits GCC to use any instruction from either architecture and to
10163 allow use of the MQ register; specify this for the Motorola MPC601.
10164
10165 @item -mnew-mnemonics
10166 @itemx -mold-mnemonics
10167 @opindex mnew-mnemonics
10168 @opindex mold-mnemonics
10169 Select which mnemonics to use in the generated assembler code.  With
10170 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10171 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10172 assembler mnemonics defined for the POWER architecture.  Instructions
10173 defined in only one architecture have only one mnemonic; GCC uses that
10174 mnemonic irrespective of which of these options is specified.
10175
10176 GCC defaults to the mnemonics appropriate for the architecture in
10177 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10178 value of these option.  Unless you are building a cross-compiler, you
10179 should normally not specify either @option{-mnew-mnemonics} or
10180 @option{-mold-mnemonics}, but should instead accept the default.
10181
10182 @item -mcpu=@var{cpu_type}
10183 @opindex mcpu
10184 Set architecture type, register usage, choice of mnemonics, and
10185 instruction scheduling parameters for machine type @var{cpu_type}.
10186 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10187 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10188 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10189 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10190 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10191 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10192 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10193 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10194 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10195
10196 @option{-mcpu=common} selects a completely generic processor.  Code
10197 generated under this option will run on any POWER or PowerPC processor.
10198 GCC will use only the instructions in the common subset of both
10199 architectures, and will not use the MQ register.  GCC assumes a generic
10200 processor model for scheduling purposes.
10201
10202 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10203 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10204 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10205 types, with an appropriate, generic processor model assumed for
10206 scheduling purposes.
10207
10208 The other options specify a specific processor.  Code generated under
10209 those options will run best on that processor, and may not run at all on
10210 others.
10211
10212 The @option{-mcpu} options automatically enable or disable the
10213 following options: @option{-maltivec}, @option{-mhard-float},
10214 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10215 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10216 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10217 @option{-mstring}.  The particular options set for any particular CPU
10218 will vary between compiler versions, depending on what setting seems
10219 to produce optimal code for that CPU; it doesn't necessarily reflect
10220 the actual hardware's capabilities.  If you wish to set an individual
10221 option to a particular value, you may specify it after the
10222 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10223
10224 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10225 not enabled or disabled by the @option{-mcpu} option at present, since
10226 AIX does not have full support for these options.  You may still
10227 enable or disable them individually if you're sure it'll work in your
10228 environment.
10229
10230 @item -mtune=@var{cpu_type}
10231 @opindex mtune
10232 Set the instruction scheduling parameters for machine type
10233 @var{cpu_type}, but do not set the architecture type, register usage, or
10234 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10235 values for @var{cpu_type} are used for @option{-mtune} as for
10236 @option{-mcpu}.  If both are specified, the code generated will use the
10237 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10238 scheduling parameters set by @option{-mtune}.
10239
10240 @item -maltivec
10241 @itemx -mno-altivec
10242 @opindex maltivec
10243 @opindex mno-altivec
10244 These switches enable or disable the use of built-in functions that
10245 allow access to the AltiVec instruction set.  You may also need to set
10246 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10247 enhancements.
10248
10249 @item -mabi=spe
10250 @opindex mabi=spe
10251 Extend the current ABI with SPE ABI extensions.  This does not change
10252 the default ABI, instead it adds the SPE ABI extensions to the current
10253 ABI@.
10254
10255 @item -mabi=no-spe
10256 @opindex mabi=no-spe
10257 Disable Booke SPE ABI extensions for the current ABI.
10258
10259 @item -misel=@var{yes/no}
10260 @itemx -misel
10261 @opindex misel
10262 This switch enables or disables the generation of ISEL instructions.
10263
10264 @item -mspe=@var{yes/no}
10265 @itemx -mspe
10266 @opindex mspe
10267 This switch enables or disables the generation of SPE simd
10268 instructions.
10269
10270 @item -mfloat-gprs=@var{yes/no}
10271 @itemx -mfloat-gprs
10272 @opindex mfloat-gprs
10273 This switch enables or disables the generation of floating point
10274 operations on the general purpose registers for architectures that
10275 support it.  This option is currently only available on the MPC8540.
10276
10277 @item -m32
10278 @itemx -m64
10279 @opindex m32
10280 @opindex m64
10281 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10282 targets (including GNU/Linux).  The 32-bit environment sets int, long
10283 and pointer to 32 bits and generates code that runs on any PowerPC
10284 variant.  The 64-bit environment sets int to 32 bits and long and
10285 pointer to 64 bits, and generates code for PowerPC64, as for
10286 @option{-mpowerpc64}.
10287
10288 @item -mfull-toc
10289 @itemx -mno-fp-in-toc
10290 @itemx -mno-sum-in-toc
10291 @itemx -mminimal-toc
10292 @opindex mfull-toc
10293 @opindex mno-fp-in-toc
10294 @opindex mno-sum-in-toc
10295 @opindex mminimal-toc
10296 Modify generation of the TOC (Table Of Contents), which is created for
10297 every executable file.  The @option{-mfull-toc} option is selected by
10298 default.  In that case, GCC will allocate at least one TOC entry for
10299 each unique non-automatic variable reference in your program.  GCC
10300 will also place floating-point constants in the TOC@.  However, only
10301 16,384 entries are available in the TOC@.
10302
10303 If you receive a linker error message that saying you have overflowed
10304 the available TOC space, you can reduce the amount of TOC space used
10305 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10306 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10307 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10308 generate code to calculate the sum of an address and a constant at
10309 run-time instead of putting that sum into the TOC@.  You may specify one
10310 or both of these options.  Each causes GCC to produce very slightly
10311 slower and larger code at the expense of conserving TOC space.
10312
10313 If you still run out of space in the TOC even when you specify both of
10314 these options, specify @option{-mminimal-toc} instead.  This option causes
10315 GCC to make only one TOC entry for every file.  When you specify this
10316 option, GCC will produce code that is slower and larger but which
10317 uses extremely little TOC space.  You may wish to use this option
10318 only on files that contain less frequently executed code.
10319
10320 @item -maix64
10321 @itemx -maix32
10322 @opindex maix64
10323 @opindex maix32
10324 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10325 @code{long} type, and the infrastructure needed to support them.
10326 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10327 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10328 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10329
10330 @item -mxl-call
10331 @itemx -mno-xl-call
10332 @opindex mxl-call
10333 @opindex mno-xl-call
10334 On AIX, pass floating-point arguments to prototyped functions beyond the
10335 register save area (RSA) on the stack in addition to argument FPRs.  The
10336 AIX calling convention was extended but not initially documented to
10337 handle an obscure K&R C case of calling a function that takes the
10338 address of its arguments with fewer arguments than declared.  AIX XL
10339 compilers access floating point arguments which do not fit in the
10340 RSA from the stack when a subroutine is compiled without
10341 optimization.  Because always storing floating-point arguments on the
10342 stack is inefficient and rarely needed, this option is not enabled by
10343 default and only is necessary when calling subroutines compiled by AIX
10344 XL compilers without optimization.
10345
10346 @item -mpe
10347 @opindex mpe
10348 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10349 application written to use message passing with special startup code to
10350 enable the application to run.  The system must have PE installed in the
10351 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10352 must be overridden with the @option{-specs=} option to specify the
10353 appropriate directory location.  The Parallel Environment does not
10354 support threads, so the @option{-mpe} option and the @option{-pthread}
10355 option are incompatible.
10356
10357 @item -malign-natural
10358 @itemx -malign-power
10359 @opindex malign-natural
10360 @opindex malign-power
10361 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10362 @option{-malign-natural} overrides the ABI-defined alignment of larger
10363 types, such as floating-point doubles, on their natural size-based boundary.
10364 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10365 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
10366
10367 @item -msoft-float
10368 @itemx -mhard-float
10369 @opindex msoft-float
10370 @opindex mhard-float
10371 Generate code that does not use (uses) the floating-point register set.
10372 Software floating point emulation is provided if you use the
10373 @option{-msoft-float} option, and pass the option to GCC when linking.
10374
10375 @item -mmultiple
10376 @itemx -mno-multiple
10377 @opindex mmultiple
10378 @opindex mno-multiple
10379 Generate code that uses (does not use) the load multiple word
10380 instructions and the store multiple word instructions.  These
10381 instructions are generated by default on POWER systems, and not
10382 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10383 endian PowerPC systems, since those instructions do not work when the
10384 processor is in little endian mode.  The exceptions are PPC740 and
10385 PPC750 which permit the instructions usage in little endian mode.
10386
10387 @item -mstring
10388 @itemx -mno-string
10389 @opindex mstring
10390 @opindex mno-string
10391 Generate code that uses (does not use) the load string instructions
10392 and the store string word instructions to save multiple registers and
10393 do small block moves.  These instructions are generated by default on
10394 POWER systems, and not generated on PowerPC systems.  Do not use
10395 @option{-mstring} on little endian PowerPC systems, since those
10396 instructions do not work when the processor is in little endian mode.
10397 The exceptions are PPC740 and PPC750 which permit the instructions
10398 usage in little endian mode.
10399
10400 @item -mupdate
10401 @itemx -mno-update
10402 @opindex mupdate
10403 @opindex mno-update
10404 Generate code that uses (does not use) the load or store instructions
10405 that update the base register to the address of the calculated memory
10406 location.  These instructions are generated by default.  If you use
10407 @option{-mno-update}, there is a small window between the time that the
10408 stack pointer is updated and the address of the previous frame is
10409 stored, which means code that walks the stack frame across interrupts or
10410 signals may get corrupted data.
10411
10412 @item -mfused-madd
10413 @itemx -mno-fused-madd
10414 @opindex mfused-madd
10415 @opindex mno-fused-madd
10416 Generate code that uses (does not use) the floating point multiply and
10417 accumulate instructions.  These instructions are generated by default if
10418 hardware floating is used.
10419
10420 @item -mno-bit-align
10421 @itemx -mbit-align
10422 @opindex mno-bit-align
10423 @opindex mbit-align
10424 On System V.4 and embedded PowerPC systems do not (do) force structures
10425 and unions that contain bit-fields to be aligned to the base type of the
10426 bit-field.
10427
10428 For example, by default a structure containing nothing but 8
10429 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10430 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10431 the structure would be aligned to a 1 byte boundary and be one byte in
10432 size.
10433
10434 @item -mno-strict-align
10435 @itemx -mstrict-align
10436 @opindex mno-strict-align
10437 @opindex mstrict-align
10438 On System V.4 and embedded PowerPC systems do not (do) assume that
10439 unaligned memory references will be handled by the system.
10440
10441 @item -mrelocatable
10442 @itemx -mno-relocatable
10443 @opindex mrelocatable
10444 @opindex mno-relocatable
10445 On embedded PowerPC systems generate code that allows (does not allow)
10446 the program to be relocated to a different address at runtime.  If you
10447 use @option{-mrelocatable} on any module, all objects linked together must
10448 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10449
10450 @item -mrelocatable-lib
10451 @itemx -mno-relocatable-lib
10452 @opindex mrelocatable-lib
10453 @opindex mno-relocatable-lib
10454 On embedded PowerPC systems generate code that allows (does not allow)
10455 the program to be relocated to a different address at runtime.  Modules
10456 compiled with @option{-mrelocatable-lib} can be linked with either modules
10457 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10458 with modules compiled with the @option{-mrelocatable} options.
10459
10460 @item -mno-toc
10461 @itemx -mtoc
10462 @opindex mno-toc
10463 @opindex mtoc
10464 On System V.4 and embedded PowerPC systems do not (do) assume that
10465 register 2 contains a pointer to a global area pointing to the addresses
10466 used in the program.
10467
10468 @item -mlittle
10469 @itemx -mlittle-endian
10470 @opindex mlittle
10471 @opindex mlittle-endian
10472 On System V.4 and embedded PowerPC systems compile code for the
10473 processor in little endian mode.  The @option{-mlittle-endian} option is
10474 the same as @option{-mlittle}.
10475
10476 @item -mbig
10477 @itemx -mbig-endian
10478 @opindex mbig
10479 @opindex mbig-endian
10480 On System V.4 and embedded PowerPC systems compile code for the
10481 processor in big endian mode.  The @option{-mbig-endian} option is
10482 the same as @option{-mbig}.
10483
10484 @item -mdynamic-no-pic
10485 @opindex mdynamic-no-pic
10486 On Darwin and Mac OS X systems, compile code so that it is not
10487 relocatable, but that its external references are relocatable.  The
10488 resulting code is suitable for applications, but not shared
10489 libraries.
10490
10491 @item -mprioritize-restricted-insns=@var{priority}
10492 @opindex mprioritize-restricted-insns
10493 This option controls the priority that is assigned to
10494 dispatch-slot restricted instructions during the second scheduling
10495 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10496 @var{no/highest/second-highest} priority to dispatch slot restricted
10497 instructions.
10498
10499 @item -msched-costly-dep=@var{dependence_type}
10500 @opindex msched-costly-dep
10501 This option controls which dependences are considered costly
10502 by the target during instruction scheduling.  The argument
10503 @var{dependence_type} takes one of the following values:
10504 @var{no}: no dependence is costly,
10505 @var{all}: all dependences are costly,
10506 @var{true_store_to_load}: a true dependence from store to load is costly,
10507 @var{store_to_load}: any dependence from store to load is costly,
10508 @var{number}: any dependence which latency >= @var{number} is costly.
10509
10510 @item -minsert-sched-nops=@var{scheme}
10511 @opindex minsert-sched-nops
10512 This option controls which nop insertion scheme will be used during
10513 the second scheduling pass. The argument @var{scheme} takes one of the
10514 following values:
10515 @var{no}: Don't insert nops.
10516 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10517 according to the scheduler's grouping.
10518 @var{regroup_exact}: Insert nops to force costly dependent insns into
10519 separate groups.  Insert exactly as many nops as needed to force an insn
10520 to a new group, according to the estimated processor grouping.
10521 @var{number}: Insert nops to force costly dependent insns into
10522 separate groups.  Insert @var{number} nops to force an insn to a new group.
10523
10524 @item -mcall-sysv
10525 @opindex mcall-sysv
10526 On System V.4 and embedded PowerPC systems compile code using calling
10527 conventions that adheres to the March 1995 draft of the System V
10528 Application Binary Interface, PowerPC processor supplement.  This is the
10529 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10530
10531 @item -mcall-sysv-eabi
10532 @opindex mcall-sysv-eabi
10533 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10534
10535 @item -mcall-sysv-noeabi
10536 @opindex mcall-sysv-noeabi
10537 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10538
10539 @item -mcall-solaris
10540 @opindex mcall-solaris
10541 On System V.4 and embedded PowerPC systems compile code for the Solaris
10542 operating system.
10543
10544 @item -mcall-linux
10545 @opindex mcall-linux
10546 On System V.4 and embedded PowerPC systems compile code for the
10547 Linux-based GNU system.
10548
10549 @item -mcall-gnu
10550 @opindex mcall-gnu
10551 On System V.4 and embedded PowerPC systems compile code for the
10552 Hurd-based GNU system.
10553
10554 @item -mcall-netbsd
10555 @opindex mcall-netbsd
10556 On System V.4 and embedded PowerPC systems compile code for the
10557 NetBSD operating system.
10558
10559 @item -maix-struct-return
10560 @opindex maix-struct-return
10561 Return all structures in memory (as specified by the AIX ABI)@.
10562
10563 @item -msvr4-struct-return
10564 @opindex msvr4-struct-return
10565 Return structures smaller than 8 bytes in registers (as specified by the
10566 SVR4 ABI)@.
10567
10568 @item -mabi=altivec
10569 @opindex mabi=altivec
10570 Extend the current ABI with AltiVec ABI extensions.  This does not
10571 change the default ABI, instead it adds the AltiVec ABI extensions to
10572 the current ABI@.
10573
10574 @item -mabi=no-altivec
10575 @opindex mabi=no-altivec
10576 Disable AltiVec ABI extensions for the current ABI.
10577
10578 @item -mprototype
10579 @itemx -mno-prototype
10580 @opindex mprototype
10581 @opindex mno-prototype
10582 On System V.4 and embedded PowerPC systems assume that all calls to
10583 variable argument functions are properly prototyped.  Otherwise, the
10584 compiler must insert an instruction before every non prototyped call to
10585 set or clear bit 6 of the condition code register (@var{CR}) to
10586 indicate whether floating point values were passed in the floating point
10587 registers in case the function takes a variable arguments.  With
10588 @option{-mprototype}, only calls to prototyped variable argument functions
10589 will set or clear the bit.
10590
10591 @item -msim
10592 @opindex msim
10593 On embedded PowerPC systems, assume that the startup module is called
10594 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10595 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10596 configurations.
10597
10598 @item -mmvme
10599 @opindex mmvme
10600 On embedded PowerPC systems, assume that the startup module is called
10601 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10602 @file{libc.a}.
10603
10604 @item -mads
10605 @opindex mads
10606 On embedded PowerPC systems, assume that the startup module is called
10607 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10608 @file{libc.a}.
10609
10610 @item -myellowknife
10611 @opindex myellowknife
10612 On embedded PowerPC systems, assume that the startup module is called
10613 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10614 @file{libc.a}.
10615
10616 @item -mvxworks
10617 @opindex mvxworks
10618 On System V.4 and embedded PowerPC systems, specify that you are
10619 compiling for a VxWorks system.
10620
10621 @item -mwindiss
10622 @opindex mwindiss
10623 Specify that you are compiling for the WindISS simulation environment.
10624
10625 @item -memb
10626 @opindex memb
10627 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10628 header to indicate that @samp{eabi} extended relocations are used.
10629
10630 @item -meabi
10631 @itemx -mno-eabi
10632 @opindex meabi
10633 @opindex mno-eabi
10634 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10635 Embedded Applications Binary Interface (eabi) which is a set of
10636 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10637 means that the stack is aligned to an 8 byte boundary, a function
10638 @code{__eabi} is called to from @code{main} to set up the eabi
10639 environment, and the @option{-msdata} option can use both @code{r2} and
10640 @code{r13} to point to two separate small data areas.  Selecting
10641 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10642 do not call an initialization function from @code{main}, and the
10643 @option{-msdata} option will only use @code{r13} to point to a single
10644 small data area.  The @option{-meabi} option is on by default if you
10645 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10646
10647 @item -msdata=eabi
10648 @opindex msdata=eabi
10649 On System V.4 and embedded PowerPC systems, put small initialized
10650 @code{const} global and static data in the @samp{.sdata2} section, which
10651 is pointed to by register @code{r2}.  Put small initialized
10652 non-@code{const} global and static data in the @samp{.sdata} section,
10653 which is pointed to by register @code{r13}.  Put small uninitialized
10654 global and static data in the @samp{.sbss} section, which is adjacent to
10655 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10656 incompatible with the @option{-mrelocatable} option.  The
10657 @option{-msdata=eabi} option also sets the @option{-memb} option.
10658
10659 @item -msdata=sysv
10660 @opindex msdata=sysv
10661 On System V.4 and embedded PowerPC systems, put small global and static
10662 data in the @samp{.sdata} section, which is pointed to by register
10663 @code{r13}.  Put small uninitialized global and static data in the
10664 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10665 The @option{-msdata=sysv} option is incompatible with the
10666 @option{-mrelocatable} option.
10667
10668 @item -msdata=default
10669 @itemx -msdata
10670 @opindex msdata=default
10671 @opindex msdata
10672 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10673 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10674 same as @option{-msdata=sysv}.
10675
10676 @item -msdata-data
10677 @opindex msdata-data
10678 On System V.4 and embedded PowerPC systems, put small global and static
10679 data in the @samp{.sdata} section.  Put small uninitialized global and
10680 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10681 to address small data however.  This is the default behavior unless
10682 other @option{-msdata} options are used.
10683
10684 @item -msdata=none
10685 @itemx -mno-sdata
10686 @opindex msdata=none
10687 @opindex mno-sdata
10688 On embedded PowerPC systems, put all initialized global and static data
10689 in the @samp{.data} section, and all uninitialized data in the
10690 @samp{.bss} section.
10691
10692 @item -G @var{num}
10693 @opindex G
10694 @cindex smaller data references (PowerPC)
10695 @cindex .sdata/.sdata2 references (PowerPC)
10696 On embedded PowerPC systems, put global and static items less than or
10697 equal to @var{num} bytes into the small data or bss sections instead of
10698 the normal data or bss section.  By default, @var{num} is 8.  The
10699 @option{-G @var{num}} switch is also passed to the linker.
10700 All modules should be compiled with the same @option{-G @var{num}} value.
10701
10702 @item -mregnames
10703 @itemx -mno-regnames
10704 @opindex mregnames
10705 @opindex mno-regnames
10706 On System V.4 and embedded PowerPC systems do (do not) emit register
10707 names in the assembly language output using symbolic forms.
10708
10709 @item -mlongcall
10710 @itemx -mno-longcall
10711 @opindex mlongcall
10712 @opindex mno-longcall
10713 Default to making all function calls indirectly, using a register, so
10714 that functions which reside further than 32 megabytes (33,554,432
10715 bytes) from the current location can be called.  This setting can be
10716 overridden by the @code{shortcall} function attribute, or by
10717 @code{#pragma longcall(0)}.
10718
10719 Some linkers are capable of detecting out-of-range calls and generating
10720 glue code on the fly.  On these systems, long calls are unnecessary and
10721 generate slower code.  As of this writing, the AIX linker can do this,
10722 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10723 to the GNU linker for 32-bit PowerPC systems as well.
10724
10725 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10726 callee, L42'', plus a ``branch island'' (glue code).  The two target
10727 addresses represent the callee and the ``branch island.'' The
10728 Darwin/PPC linker will prefer the first address and generate a ``bl
10729 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10730 otherwise, the linker will generate ``bl L42'' to call the ``branch
10731 island.''  The ``branch island'' is appended to the body of the
10732 calling function; it computes the full 32-bit address of the callee
10733 and jumps to it.
10734
10735 On Mach-O (Darwin) systems, this option directs the compiler emit to
10736 the glue for every direct call, and the Darwin linker decides whether
10737 to use or discard it.
10738
10739 In the future, we may cause GCC to ignore all longcall specifications
10740 when the linker is known to generate glue.
10741
10742 @item -pthread
10743 @opindex pthread
10744 Adds support for multithreading with the @dfn{pthreads} library.
10745 This option sets flags for both the preprocessor and linker.
10746
10747 @end table
10748
10749 @node S/390 and zSeries Options
10750 @subsection S/390 and zSeries Options
10751 @cindex S/390 and zSeries Options
10752
10753 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10754
10755 @table @gcctabopt
10756 @item -mhard-float
10757 @itemx -msoft-float
10758 @opindex mhard-float
10759 @opindex msoft-float
10760 Use (do not use) the hardware floating-point instructions and registers
10761 for floating-point operations.  When @option{-msoft-float} is specified,
10762 functions in @file{libgcc.a} will be used to perform floating-point
10763 operations.  When @option{-mhard-float} is specified, the compiler
10764 generates IEEE floating-point instructions.  This is the default.
10765
10766 @item -mbackchain
10767 @itemx -mno-backchain
10768 @itemx -mkernel-backchain
10769 @opindex mbackchain
10770 @opindex mno-backchain
10771 @opindex mkernel-backchain
10772 In order to provide a backchain the address of the caller's frame
10773 is stored within the callee's stack frame.
10774 A backchain may be needed to allow debugging using tools that do not understand
10775 DWARF-2 call frame information.
10776 For @option{-mno-backchain} no backchain is maintained at all which is the 
10777 default. 
10778 If one of the other options is present the backchain pointer is placed either 
10779 on top of the stack frame  (@option{-mkernel-backchain}) or on
10780 the bottom (@option{-mbackchain}).
10781 Beside the different backchain location @option{-mkernel-backchain}
10782 also changes stack frame layout breaking the ABI. This option
10783 is intended to be used for code which internally needs a backchain but has
10784 to get by with a limited stack size e.g.@: the linux kernel. 
10785 Internal unwinding code not using DWARF-2 info has to be able to locate the
10786 return address of a function. That will be eased be the fact that
10787 the return address of a function is placed two words below the backchain 
10788 pointer.
10789
10790 @item -msmall-exec
10791 @itemx -mno-small-exec
10792 @opindex msmall-exec
10793 @opindex mno-small-exec
10794 Generate (or do not generate) code using the @code{bras} instruction
10795 to do subroutine calls.
10796 This only works reliably if the total executable size does not
10797 exceed 64k.  The default is to use the @code{basr} instruction instead,
10798 which does not have this limitation.
10799
10800 @item -m64
10801 @itemx -m31
10802 @opindex m64
10803 @opindex m31
10804 When @option{-m31} is specified, generate code compliant to the
10805 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10806 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10807 particular to generate 64-bit instructions.  For the @samp{s390}
10808 targets, the default is @option{-m31}, while the @samp{s390x}
10809 targets default to @option{-m64}.
10810
10811 @item -mzarch
10812 @itemx -mesa
10813 @opindex mzarch
10814 @opindex mesa
10815 When @option{-mzarch} is specified, generate code using the
10816 instructions available on z/Architecture.
10817 When @option{-mesa} is specified, generate code using the
10818 instructions available on ESA/390. Note that @option{-mesa} is
10819 not possible with @option{-m64}.
10820 When generating code compliant to the GNU/Linux for S/390 ABI,
10821 the default is @option{-mesa}.  When generating code compliant
10822 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10823
10824 @item -mmvcle
10825 @itemx -mno-mvcle
10826 @opindex mmvcle
10827 @opindex mno-mvcle
10828 Generate (or do not generate) code using the @code{mvcle} instruction
10829 to perform block moves.  When @option{-mno-mvcle} is specified,
10830 use a @code{mvc} loop instead.  This is the default.
10831
10832 @item -mdebug
10833 @itemx -mno-debug
10834 @opindex mdebug
10835 @opindex mno-debug
10836 Print (or do not print) additional debug information when compiling.
10837 The default is to not print debug information.
10838
10839 @item -march=@var{cpu-type}
10840 @opindex march
10841 Generate code that will run on @var{cpu-type}, which is the name of a system
10842 representing a certain processor type. Possible values for
10843 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10844 When generating code using the instructions available on z/Architecture,
10845 the default is @option{-march=z900}.  Otherwise, the default is
10846 @option{-march=g5}.
10847
10848 @item -mtune=@var{cpu-type}
10849 @opindex mtune
10850 Tune to @var{cpu-type} everything applicable about the generated code,
10851 except for the ABI and the set of available instructions.
10852 The list of @var{cpu-type} values is the same as for @option{-march}.
10853 The default is the value used for @option{-march}.
10854
10855 @item -mtpf-trace
10856 @itemx -mno-tpf-trace
10857 @opindex mtpf-trace
10858 @opindex mno-tpf-trace
10859 Generate code that adds (does not add) in TPF OS specific branches to trace
10860 routines in the operating system.  This option is off by default, even
10861 when compiling for the TPF OS.
10862
10863 @item -mfused-madd
10864 @itemx -mno-fused-madd
10865 @opindex mfused-madd
10866 @opindex mno-fused-madd
10867 Generate code that uses (does not use) the floating point multiply and
10868 accumulate instructions.  These instructions are generated by default if
10869 hardware floating point is used.
10870
10871 @item -mwarn-framesize=@var{framesize}
10872 @opindex mwarn-framesize
10873 Emit a warning if the current function exceeds the given frame size.  Because
10874 this is a compile time check it doesn't need to be a real problem when the program
10875 runs.  It is intended to identify functions which most probably cause 
10876 a stack overflow.  It is useful to be used in an environment with limited stack 
10877 size e.g.@: the linux kernel.
10878
10879 @item -mwarn-dynamicstack
10880 @opindex mwarn-dynamicstack
10881 Emit a warning if the function calls alloca or uses dynamically
10882 sized arrays.  This is generally a bad idea with a limited stack size.
10883
10884 @item -mstack-guard=@var{stack-guard}
10885 @item -mstack-size=@var{stack-size}
10886 @opindex mstack-guard
10887 @opindex mstack-size
10888 These arguments always have to be used in conjunction.  If they are present the s390
10889 back end emits additional instructions in the function prologue which trigger a trap
10890 if the stack size is @var{stack-guard} bytes above the @var{stack-size} 
10891 (remember that the stack on s390 grows downward).  These options are intended to 
10892 be used to help debugging stack overflow problems.  The additionally emitted code 
10893 cause only little overhead and hence can also be used in production like systems 
10894 without greater performance degradation.  The given values have to be exact 
10895 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
10896 In order to be efficient the extra code makes the assumption that the stack starts
10897 at an address aligned to the value given by @var{stack-size}.
10898 @end table
10899
10900 @node SH Options
10901 @subsection SH Options
10902
10903 These @samp{-m} options are defined for the SH implementations:
10904
10905 @table @gcctabopt
10906 @item -m1
10907 @opindex m1
10908 Generate code for the SH1.
10909
10910 @item -m2
10911 @opindex m2
10912 Generate code for the SH2.
10913
10914 @item -m2e
10915 Generate code for the SH2e.
10916
10917 @item -m3
10918 @opindex m3
10919 Generate code for the SH3.
10920
10921 @item -m3e
10922 @opindex m3e
10923 Generate code for the SH3e.
10924
10925 @item -m4-nofpu
10926 @opindex m4-nofpu
10927 Generate code for the SH4 without a floating-point unit.
10928
10929 @item -m4-single-only
10930 @opindex m4-single-only
10931 Generate code for the SH4 with a floating-point unit that only
10932 supports single-precision arithmetic.
10933
10934 @item -m4-single
10935 @opindex m4-single
10936 Generate code for the SH4 assuming the floating-point unit is in
10937 single-precision mode by default.
10938
10939 @item -m4
10940 @opindex m4
10941 Generate code for the SH4.
10942
10943 @item -m4a-nofpu
10944 @opindex m4a-nofpu
10945 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
10946 floating-point unit is not used.
10947
10948 @item -m4a-single-only
10949 @opindex m4a-single-only
10950 Generate code for the SH4a, in such a way that no double-precision
10951 floating point operations are used.
10952
10953 @item -m4a-single
10954 @opindex m4a-single
10955 Generate code for the SH4a assuming the floating-point unit is in
10956 single-precision mode by default.
10957
10958 @item -m4a
10959 @opindex m4a
10960 Generate code for the SH4a.
10961
10962 @item -m4al
10963 @opindex m4al
10964 Same as @option{-m4a-nofpu}, except that it implicitly passes
10965 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
10966 instructions at the moment.
10967
10968 @item -mb
10969 @opindex mb
10970 Compile code for the processor in big endian mode.
10971
10972 @item -ml
10973 @opindex ml
10974 Compile code for the processor in little endian mode.
10975
10976 @item -mdalign
10977 @opindex mdalign
10978 Align doubles at 64-bit boundaries.  Note that this changes the calling
10979 conventions, and thus some functions from the standard C library will
10980 not work unless you recompile it first with @option{-mdalign}.
10981
10982 @item -mrelax
10983 @opindex mrelax
10984 Shorten some address references at link time, when possible; uses the
10985 linker option @option{-relax}.
10986
10987 @item -mbigtable
10988 @opindex mbigtable
10989 Use 32-bit offsets in @code{switch} tables.  The default is to use
10990 16-bit offsets.
10991
10992 @item -mfmovd
10993 @opindex mfmovd
10994 Enable the use of the instruction @code{fmovd}.
10995
10996 @item -mhitachi
10997 @opindex mhitachi
10998 Comply with the calling conventions defined by Renesas.
10999
11000 @item -mrenesas
11001 @opindex mhitachi
11002 Comply with the calling conventions defined by Renesas.
11003
11004 @item -mno-renesas
11005 @opindex mhitachi
11006 Comply with the calling conventions defined for GCC before the Renesas
11007 conventions were available.  This option is the default for all
11008 targets of the SH toolchain except for @samp{sh-symbianelf}.
11009
11010 @item -mnomacsave
11011 @opindex mnomacsave
11012 Mark the @code{MAC} register as call-clobbered, even if
11013 @option{-mhitachi} is given.
11014
11015 @item -mieee
11016 @opindex mieee
11017 Increase IEEE-compliance of floating-point code.
11018
11019 @item -misize
11020 @opindex misize
11021 Dump instruction size and location in the assembly code.
11022
11023 @item -mpadstruct
11024 @opindex mpadstruct
11025 This option is deprecated.  It pads structures to multiple of 4 bytes,
11026 which is incompatible with the SH ABI@.
11027
11028 @item -mspace
11029 @opindex mspace
11030 Optimize for space instead of speed.  Implied by @option{-Os}.
11031
11032 @item -mprefergot
11033 @opindex mprefergot
11034 When generating position-independent code, emit function calls using
11035 the Global Offset Table instead of the Procedure Linkage Table.
11036
11037 @item -musermode
11038 @opindex musermode
11039 Generate a library function call to invalidate instruction cache
11040 entries, after fixing up a trampoline.  This library function call
11041 doesn't assume it can write to the whole memory address space.  This
11042 is the default when the target is @code{sh-*-linux*}.
11043 @end table
11044
11045 @node SPARC Options
11046 @subsection SPARC Options
11047 @cindex SPARC options
11048
11049 These @samp{-m} options are supported on the SPARC:
11050
11051 @table @gcctabopt
11052 @item -mno-app-regs
11053 @itemx -mapp-regs
11054 @opindex mno-app-regs
11055 @opindex mapp-regs
11056 Specify @option{-mapp-regs} to generate output using the global registers
11057 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11058 is the default.
11059
11060 To be fully SVR4 ABI compliant at the cost of some performance loss,
11061 specify @option{-mno-app-regs}.  You should compile libraries and system
11062 software with this option.
11063
11064 @item -mfpu
11065 @itemx -mhard-float
11066 @opindex mfpu
11067 @opindex mhard-float
11068 Generate output containing floating point instructions.  This is the
11069 default.
11070
11071 @item -mno-fpu
11072 @itemx -msoft-float
11073 @opindex mno-fpu
11074 @opindex msoft-float
11075 Generate output containing library calls for floating point.
11076 @strong{Warning:} the requisite libraries are not available for all SPARC
11077 targets.  Normally the facilities of the machine's usual C compiler are
11078 used, but this cannot be done directly in cross-compilation.  You must make
11079 your own arrangements to provide suitable library functions for
11080 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11081 @samp{sparclite-*-*} do provide software floating point support.
11082
11083 @option{-msoft-float} changes the calling convention in the output file;
11084 therefore, it is only useful if you compile @emph{all} of a program with
11085 this option.  In particular, you need to compile @file{libgcc.a}, the
11086 library that comes with GCC, with @option{-msoft-float} in order for
11087 this to work.
11088
11089 @item -mhard-quad-float
11090 @opindex mhard-quad-float
11091 Generate output containing quad-word (long double) floating point
11092 instructions.
11093
11094 @item -msoft-quad-float
11095 @opindex msoft-quad-float
11096 Generate output containing library calls for quad-word (long double)
11097 floating point instructions.  The functions called are those specified
11098 in the SPARC ABI@.  This is the default.
11099
11100 As of this writing, there are no SPARC implementations that have hardware
11101 support for the quad-word floating point instructions.  They all invoke
11102 a trap handler for one of these instructions, and then the trap handler
11103 emulates the effect of the instruction.  Because of the trap handler overhead,
11104 this is much slower than calling the ABI library routines.  Thus the
11105 @option{-msoft-quad-float} option is the default.
11106
11107 @item -mno-unaligned-doubles
11108 @itemx -munaligned-doubles
11109 @opindex mno-unaligned-doubles
11110 @opindex munaligned-doubles
11111 Assume that doubles have 8 byte alignment.  This is the default.
11112
11113 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11114 alignment only if they are contained in another type, or if they have an
11115 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11116 Specifying this option avoids some rare compatibility problems with code
11117 generated by other compilers.  It is not the default because it results
11118 in a performance loss, especially for floating point code.
11119
11120 @item -mno-faster-structs
11121 @itemx -mfaster-structs
11122 @opindex mno-faster-structs
11123 @opindex mfaster-structs
11124 With @option{-mfaster-structs}, the compiler assumes that structures
11125 should have 8 byte alignment.  This enables the use of pairs of
11126 @code{ldd} and @code{std} instructions for copies in structure
11127 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11128 However, the use of this changed alignment directly violates the SPARC
11129 ABI@.  Thus, it's intended only for use on targets where the developer
11130 acknowledges that their resulting code will not be directly in line with
11131 the rules of the ABI@.
11132
11133 @item -mimpure-text
11134 @opindex mimpure-text
11135 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11136 the compiler to not pass @option{-z text} to the linker when linking a
11137 shared object.  Using this option, you can link position-dependent
11138 code into a shared object.
11139
11140 @option{-mimpure-text} suppresses the ``relocations remain against
11141 allocatable but non-writable sections'' linker error message.
11142 However, the necessary relocations will trigger copy-on-write, and the
11143 shared object is not actually shared across processes.  Instead of
11144 using @option{-mimpure-text}, you should compile all source code with
11145 @option{-fpic} or @option{-fPIC}.
11146
11147 This option is only available on SunOS and Solaris.
11148
11149 @item -mcpu=@var{cpu_type}
11150 @opindex mcpu
11151 Set the instruction set, register set, and instruction scheduling parameters
11152 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11153 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11154 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11155 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11156 @samp{ultrasparc3}.
11157
11158 Default instruction scheduling parameters are used for values that select
11159 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11160 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11161
11162 Here is a list of each supported architecture and their supported
11163 implementations.
11164
11165 @smallexample
11166     v7:             cypress
11167     v8:             supersparc, hypersparc
11168     sparclite:      f930, f934, sparclite86x
11169     sparclet:       tsc701
11170     v9:             ultrasparc, ultrasparc3
11171 @end smallexample
11172
11173 By default (unless configured otherwise), GCC generates code for the V7
11174 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11175 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11176 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11177 SPARCStation 1, 2, IPX etc.
11178
11179 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11180 architecture.  The only difference from V7 code is that the compiler emits
11181 the integer multiply and integer divide instructions which exist in SPARC-V8
11182 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11183 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11184 2000 series.
11185
11186 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11187 the SPARC architecture.  This adds the integer multiply, integer divide step
11188 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11189 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11190 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
11191 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11192 MB86934 chip, which is the more recent SPARClite with FPU.
11193
11194 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11195 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11196 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11197 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11198 optimizes it for the TEMIC SPARClet chip.
11199
11200 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11201 architecture.  This adds 64-bit integer and floating-point move instructions,
11202 3 additional floating-point condition code registers and conditional move
11203 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11204 optimizes it for the Sun UltraSPARC I/II chips.  With
11205 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11206 Sun UltraSPARC III chip.
11207
11208 @item -mtune=@var{cpu_type}
11209 @opindex mtune
11210 Set the instruction scheduling parameters for machine type
11211 @var{cpu_type}, but do not set the instruction set or register set that the
11212 option @option{-mcpu=@var{cpu_type}} would.
11213
11214 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11215 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11216 that select a particular cpu implementation.  Those are @samp{cypress},
11217 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11218 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11219 @samp{ultrasparc3}.
11220
11221 @item -mv8plus
11222 @itemx -mno-v8plus
11223 @opindex mv8plus
11224 @opindex mno-v8plus
11225 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
11226 difference from the V8 ABI is that the global and out registers are
11227 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11228 mode for all SPARC-V9 processors.
11229
11230 @item -mvis
11231 @itemx -mno-vis
11232 @opindex mvis
11233 @opindex mno-vis
11234 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11235 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11236 @end table
11237
11238 These @samp{-m} options are supported in addition to the above
11239 on SPARC-V9 processors in 64-bit environments:
11240
11241 @table @gcctabopt
11242 @item -mlittle-endian
11243 @opindex mlittle-endian
11244 Generate code for a processor running in little-endian mode. It is only
11245 available for a few configurations and most notably not on Solaris.
11246
11247 @item -m32
11248 @itemx -m64
11249 @opindex m32
11250 @opindex m64
11251 Generate code for a 32-bit or 64-bit environment.
11252 The 32-bit environment sets int, long and pointer to 32 bits.
11253 The 64-bit environment sets int to 32 bits and long and pointer
11254 to 64 bits.
11255
11256 @item -mcmodel=medlow
11257 @opindex mcmodel=medlow
11258 Generate code for the Medium/Low code model: 64-bit addresses, programs
11259 must be linked in the low 32 bits of memory.  Programs can be statically
11260 or dynamically linked.
11261
11262 @item -mcmodel=medmid
11263 @opindex mcmodel=medmid
11264 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11265 must be linked in the low 44 bits of memory, the text and data segments must
11266 be less than 2GB in size and the data segment must be located within 2GB of
11267 the text segment.
11268
11269 @item -mcmodel=medany
11270 @opindex mcmodel=medany
11271 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11272 may be linked anywhere in memory, the text and data segments must be less
11273 than 2GB in size and the data segment must be located within 2GB of the
11274 text segment.
11275
11276 @item -mcmodel=embmedany
11277 @opindex mcmodel=embmedany
11278 Generate code for the Medium/Anywhere code model for embedded systems:
11279 64-bit addresses, the text and data segments must be less than 2GB in
11280 size, both starting anywhere in memory (determined at link time).  The
11281 global register %g4 points to the base of the data segment.  Programs
11282 are statically linked and PIC is not supported.
11283
11284 @item -mstack-bias
11285 @itemx -mno-stack-bias
11286 @opindex mstack-bias
11287 @opindex mno-stack-bias
11288 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11289 frame pointer if present, are offset by @minus{}2047 which must be added back
11290 when making stack frame references.  This is the default in 64-bit mode.
11291 Otherwise, assume no such offset is present.
11292 @end table
11293
11294 These switches are supported in addition to the above on Solaris:
11295
11296 @table @gcctabopt
11297 @item -threads
11298 @opindex threads
11299 Add support for multithreading using the Solaris threads library.  This
11300 option sets flags for both the preprocessor and linker.  This option does
11301 not affect the thread safety of object code produced by the compiler or
11302 that of libraries supplied with it.
11303
11304 @item -pthreads
11305 @opindex pthreads
11306 Add support for multithreading using the POSIX threads library.  This
11307 option sets flags for both the preprocessor and linker.  This option does
11308 not affect the thread safety of object code produced  by the compiler or
11309 that of libraries supplied with it.
11310 @end table
11311
11312 @node System V Options
11313 @subsection Options for System V
11314
11315 These additional options are available on System V Release 4 for
11316 compatibility with other compilers on those systems:
11317
11318 @table @gcctabopt
11319 @item -G
11320 @opindex G
11321 Create a shared object.
11322 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11323
11324 @item -Qy
11325 @opindex Qy
11326 Identify the versions of each tool used by the compiler, in a
11327 @code{.ident} assembler directive in the output.
11328
11329 @item -Qn
11330 @opindex Qn
11331 Refrain from adding @code{.ident} directives to the output file (this is
11332 the default).
11333
11334 @item -YP,@var{dirs}
11335 @opindex YP
11336 Search the directories @var{dirs}, and no others, for libraries
11337 specified with @option{-l}.
11338
11339 @item -Ym,@var{dir}
11340 @opindex Ym
11341 Look in the directory @var{dir} to find the M4 preprocessor.
11342 The assembler uses this option.
11343 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11344 @c the generic assembler that comes with Solaris takes just -Ym.
11345 @end table
11346
11347 @node TMS320C3x/C4x Options
11348 @subsection TMS320C3x/C4x Options
11349 @cindex TMS320C3x/C4x Options
11350
11351 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11352
11353 @table @gcctabopt
11354
11355 @item -mcpu=@var{cpu_type}
11356 @opindex mcpu
11357 Set the instruction set, register set, and instruction scheduling
11358 parameters for machine type @var{cpu_type}.  Supported values for
11359 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11360 @samp{c44}.  The default is @samp{c40} to generate code for the
11361 TMS320C40.
11362
11363 @item -mbig-memory
11364 @itemx -mbig
11365 @itemx -msmall-memory
11366 @itemx -msmall
11367 @opindex mbig-memory
11368 @opindex mbig
11369 @opindex msmall-memory
11370 @opindex msmall
11371 Generates code for the big or small memory model.  The small memory
11372 model assumed that all data fits into one 64K word page.  At run-time
11373 the data page (DP) register must be set to point to the 64K page
11374 containing the .bss and .data program sections.  The big memory model is
11375 the default and requires reloading of the DP register for every direct
11376 memory access.
11377
11378 @item -mbk
11379 @itemx -mno-bk
11380 @opindex mbk
11381 @opindex mno-bk
11382 Allow (disallow) allocation of general integer operands into the block
11383 count register BK@.
11384
11385 @item -mdb
11386 @itemx -mno-db
11387 @opindex mdb
11388 @opindex mno-db
11389 Enable (disable) generation of code using decrement and branch,
11390 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11391 on the safe side, this is disabled for the C3x, since the maximum
11392 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11393 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11394 that it can utilize the decrement and branch instruction, but will give
11395 up if there is more than one memory reference in the loop.  Thus a loop
11396 where the loop counter is decremented can generate slightly more
11397 efficient code, in cases where the RPTB instruction cannot be utilized.
11398
11399 @item -mdp-isr-reload
11400 @itemx -mparanoid
11401 @opindex mdp-isr-reload
11402 @opindex mparanoid
11403 Force the DP register to be saved on entry to an interrupt service
11404 routine (ISR), reloaded to point to the data section, and restored on
11405 exit from the ISR@.  This should not be required unless someone has
11406 violated the small memory model by modifying the DP register, say within
11407 an object library.
11408
11409 @item -mmpyi
11410 @itemx -mno-mpyi
11411 @opindex mmpyi
11412 @opindex mno-mpyi
11413 For the C3x use the 24-bit MPYI instruction for integer multiplies
11414 instead of a library call to guarantee 32-bit results.  Note that if one
11415 of the operands is a constant, then the multiplication will be performed
11416 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11417 then squaring operations are performed inline instead of a library call.
11418
11419 @item -mfast-fix
11420 @itemx -mno-fast-fix
11421 @opindex mfast-fix
11422 @opindex mno-fast-fix
11423 The C3x/C4x FIX instruction to convert a floating point value to an
11424 integer value chooses the nearest integer less than or equal to the
11425 floating point value rather than to the nearest integer.  Thus if the
11426 floating point number is negative, the result will be incorrectly
11427 truncated an additional code is necessary to detect and correct this
11428 case.  This option can be used to disable generation of the additional
11429 code required to correct the result.
11430
11431 @item -mrptb
11432 @itemx -mno-rptb
11433 @opindex mrptb
11434 @opindex mno-rptb
11435 Enable (disable) generation of repeat block sequences using the RPTB
11436 instruction for zero overhead looping.  The RPTB construct is only used
11437 for innermost loops that do not call functions or jump across the loop
11438 boundaries.  There is no advantage having nested RPTB loops due to the
11439 overhead required to save and restore the RC, RS, and RE registers.
11440 This is enabled by default with @option{-O2}.
11441
11442 @item -mrpts=@var{count}
11443 @itemx -mno-rpts
11444 @opindex mrpts
11445 @opindex mno-rpts
11446 Enable (disable) the use of the single instruction repeat instruction
11447 RPTS@.  If a repeat block contains a single instruction, and the loop
11448 count can be guaranteed to be less than the value @var{count}, GCC will
11449 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11450 then a RPTS will be emitted even if the loop count cannot be determined
11451 at compile time.  Note that the repeated instruction following RPTS does
11452 not have to be reloaded from memory each iteration, thus freeing up the
11453 CPU buses for operands.  However, since interrupts are blocked by this
11454 instruction, it is disabled by default.
11455
11456 @item -mloop-unsigned
11457 @itemx -mno-loop-unsigned
11458 @opindex mloop-unsigned
11459 @opindex mno-loop-unsigned
11460 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11461 is @math{2^{31} + 1} since these instructions test if the iteration count is
11462 negative to terminate the loop.  If the iteration count is unsigned
11463 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11464 exceeded.  This switch allows an unsigned iteration count.
11465
11466 @item -mti
11467 @opindex mti
11468 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11469 with.  This also enforces compatibility with the API employed by the TI
11470 C3x C compiler.  For example, long doubles are passed as structures
11471 rather than in floating point registers.
11472
11473 @item -mregparm
11474 @itemx -mmemparm
11475 @opindex mregparm
11476 @opindex mmemparm
11477 Generate code that uses registers (stack) for passing arguments to functions.
11478 By default, arguments are passed in registers where possible rather
11479 than by pushing arguments on to the stack.
11480
11481 @item -mparallel-insns
11482 @itemx -mno-parallel-insns
11483 @opindex mparallel-insns
11484 @opindex mno-parallel-insns
11485 Allow the generation of parallel instructions.  This is enabled by
11486 default with @option{-O2}.
11487
11488 @item -mparallel-mpy
11489 @itemx -mno-parallel-mpy
11490 @opindex mparallel-mpy
11491 @opindex mno-parallel-mpy
11492 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11493 provided @option{-mparallel-insns} is also specified.  These instructions have
11494 tight register constraints which can pessimize the code generation
11495 of large functions.
11496
11497 @end table
11498
11499 @node V850 Options
11500 @subsection V850 Options
11501 @cindex V850 Options
11502
11503 These @samp{-m} options are defined for V850 implementations:
11504
11505 @table @gcctabopt
11506 @item -mlong-calls
11507 @itemx -mno-long-calls
11508 @opindex mlong-calls
11509 @opindex mno-long-calls
11510 Treat all calls as being far away (near).  If calls are assumed to be
11511 far away, the compiler will always load the functions address up into a
11512 register, and call indirect through the pointer.
11513
11514 @item -mno-ep
11515 @itemx -mep
11516 @opindex mno-ep
11517 @opindex mep
11518 Do not optimize (do optimize) basic blocks that use the same index
11519 pointer 4 or more times to copy pointer into the @code{ep} register, and
11520 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11521 option is on by default if you optimize.
11522
11523 @item -mno-prolog-function
11524 @itemx -mprolog-function
11525 @opindex mno-prolog-function
11526 @opindex mprolog-function
11527 Do not use (do use) external functions to save and restore registers
11528 at the prologue and epilogue of a function.  The external functions
11529 are slower, but use less code space if more than one function saves
11530 the same number of registers.  The @option{-mprolog-function} option
11531 is on by default if you optimize.
11532
11533 @item -mspace
11534 @opindex mspace
11535 Try to make the code as small as possible.  At present, this just turns
11536 on the @option{-mep} and @option{-mprolog-function} options.
11537
11538 @item -mtda=@var{n}
11539 @opindex mtda
11540 Put static or global variables whose size is @var{n} bytes or less into
11541 the tiny data area that register @code{ep} points to.  The tiny data
11542 area can hold up to 256 bytes in total (128 bytes for byte references).
11543
11544 @item -msda=@var{n}
11545 @opindex msda
11546 Put static or global variables whose size is @var{n} bytes or less into
11547 the small data area that register @code{gp} points to.  The small data
11548 area can hold up to 64 kilobytes.
11549
11550 @item -mzda=@var{n}
11551 @opindex mzda
11552 Put static or global variables whose size is @var{n} bytes or less into
11553 the first 32 kilobytes of memory.
11554
11555 @item -mv850
11556 @opindex mv850
11557 Specify that the target processor is the V850.
11558
11559 @item -mbig-switch
11560 @opindex mbig-switch
11561 Generate code suitable for big switch tables.  Use this option only if
11562 the assembler/linker complain about out of range branches within a switch
11563 table.
11564
11565 @item -mapp-regs
11566 @opindex mapp-regs
11567 This option will cause r2 and r5 to be used in the code generated by
11568 the compiler.  This setting is the default.
11569
11570 @item -mno-app-regs
11571 @opindex mno-app-regs
11572 This option will cause r2 and r5 to be treated as fixed registers.
11573
11574 @item -mv850e1
11575 @opindex mv850e1
11576 Specify that the target processor is the V850E1.  The preprocessor
11577 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11578 this option is used.
11579
11580 @item -mv850e
11581 @opindex mv850e
11582 Specify that the target processor is the V850E.  The preprocessor
11583 constant @samp{__v850e__} will be defined if this option is used.
11584
11585 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11586 are defined then a default target processor will be chosen and the
11587 relevant @samp{__v850*__} preprocessor constant will be defined.
11588
11589 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11590 defined, regardless of which processor variant is the target.
11591
11592 @item -mdisable-callt
11593 @opindex mdisable-callt
11594 This option will suppress generation of the CALLT instruction for the
11595 v850e and v850e1 flavors of the v850 architecture.  The default is
11596 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11597
11598 @end table
11599
11600 @node VAX Options
11601 @subsection VAX Options
11602 @cindex VAX options
11603
11604 These @samp{-m} options are defined for the VAX:
11605
11606 @table @gcctabopt
11607 @item -munix
11608 @opindex munix
11609 Do not output certain jump instructions (@code{aobleq} and so on)
11610 that the Unix assembler for the VAX cannot handle across long
11611 ranges.
11612
11613 @item -mgnu
11614 @opindex mgnu
11615 Do output those jump instructions, on the assumption that you
11616 will assemble with the GNU assembler.
11617
11618 @item -mg
11619 @opindex mg
11620 Output code for g-format floating point numbers instead of d-format.
11621 @end table
11622
11623 @node x86-64 Options
11624 @subsection x86-64 Options
11625 @cindex x86-64 options
11626
11627 These are listed under @xref{i386 and x86-64 Options}.
11628
11629 @node Xstormy16 Options
11630 @subsection Xstormy16 Options
11631 @cindex Xstormy16 Options
11632
11633 These options are defined for Xstormy16:
11634
11635 @table @gcctabopt
11636 @item -msim
11637 @opindex msim
11638 Choose startup files and linker script suitable for the simulator.
11639 @end table
11640
11641 @node Xtensa Options
11642 @subsection Xtensa Options
11643 @cindex Xtensa Options
11644
11645 These options are supported for Xtensa targets:
11646
11647 @table @gcctabopt
11648 @item -mconst16
11649 @itemx -mno-const16
11650 @opindex mconst16
11651 @opindex mno-const16
11652 Enable or disable use of @code{CONST16} instructions for loading
11653 constant values.  The @code{CONST16} instruction is currently not a
11654 standard option from Tensilica.  When enabled, @code{CONST16}
11655 instructions are always used in place of the standard @code{L32R}
11656 instructions.  The use of @code{CONST16} is enabled by default only if
11657 the @code{L32R} instruction is not available.
11658
11659 @item -mfused-madd
11660 @itemx -mno-fused-madd
11661 @opindex mfused-madd
11662 @opindex mno-fused-madd
11663 Enable or disable use of fused multiply/add and multiply/subtract
11664 instructions in the floating-point option.  This has no effect if the
11665 floating-point option is not also enabled.  Disabling fused multiply/add
11666 and multiply/subtract instructions forces the compiler to use separate
11667 instructions for the multiply and add/subtract operations.  This may be
11668 desirable in some cases where strict IEEE 754-compliant results are
11669 required: the fused multiply add/subtract instructions do not round the
11670 intermediate result, thereby producing results with @emph{more} bits of
11671 precision than specified by the IEEE standard.  Disabling fused multiply
11672 add/subtract instructions also ensures that the program output is not
11673 sensitive to the compiler's ability to combine multiply and add/subtract
11674 operations.
11675
11676 @item -mtext-section-literals
11677 @itemx -mno-text-section-literals
11678 @opindex mtext-section-literals
11679 @opindex mno-text-section-literals
11680 Control the treatment of literal pools.  The default is
11681 @option{-mno-text-section-literals}, which places literals in a separate
11682 section in the output file.  This allows the literal pool to be placed
11683 in a data RAM/ROM, and it also allows the linker to combine literal
11684 pools from separate object files to remove redundant literals and
11685 improve code size.  With @option{-mtext-section-literals}, the literals
11686 are interspersed in the text section in order to keep them as close as
11687 possible to their references.  This may be necessary for large assembly
11688 files.
11689
11690 @item -mtarget-align
11691 @itemx -mno-target-align
11692 @opindex mtarget-align
11693 @opindex mno-target-align
11694 When this option is enabled, GCC instructs the assembler to
11695 automatically align instructions to reduce branch penalties at the
11696 expense of some code density.  The assembler attempts to widen density
11697 instructions to align branch targets and the instructions following call
11698 instructions.  If there are not enough preceding safe density
11699 instructions to align a target, no widening will be performed.  The
11700 default is @option{-mtarget-align}.  These options do not affect the
11701 treatment of auto-aligned instructions like @code{LOOP}, which the
11702 assembler will always align, either by widening density instructions or
11703 by inserting no-op instructions.
11704
11705 @item -mlongcalls
11706 @itemx -mno-longcalls
11707 @opindex mlongcalls
11708 @opindex mno-longcalls
11709 When this option is enabled, GCC instructs the assembler to translate
11710 direct calls to indirect calls unless it can determine that the target
11711 of a direct call is in the range allowed by the call instruction.  This
11712 translation typically occurs for calls to functions in other source
11713 files.  Specifically, the assembler translates a direct @code{CALL}
11714 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11715 The default is @option{-mno-longcalls}.  This option should be used in
11716 programs where the call target can potentially be out of range.  This
11717 option is implemented in the assembler, not the compiler, so the
11718 assembly code generated by GCC will still show direct call
11719 instructions---look at the disassembled object code to see the actual
11720 instructions.  Note that the assembler will use an indirect call for
11721 every cross-file call, not just those that really will be out of range.
11722 @end table
11723
11724 @node zSeries Options
11725 @subsection zSeries Options
11726 @cindex zSeries options
11727
11728 These are listed under @xref{S/390 and zSeries Options}.
11729
11730 @node Code Gen Options
11731 @section Options for Code Generation Conventions
11732 @cindex code generation conventions
11733 @cindex options, code generation
11734 @cindex run-time options
11735
11736 These machine-independent options control the interface conventions
11737 used in code generation.
11738
11739 Most of them have both positive and negative forms; the negative form
11740 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11741 one of the forms is listed---the one which is not the default.  You
11742 can figure out the other form by either removing @samp{no-} or adding
11743 it.
11744
11745 @table @gcctabopt
11746 @item -fbounds-check
11747 @opindex fbounds-check
11748 For front-ends that support it, generate additional code to check that
11749 indices used to access arrays are within the declared range.  This is
11750 currently only supported by the Java and Fortran 77 front-ends, where
11751 this option defaults to true and false respectively.
11752
11753 @item -ftrapv
11754 @opindex ftrapv
11755 This option generates traps for signed overflow on addition, subtraction,
11756 multiplication operations.
11757
11758 @item -fwrapv
11759 @opindex fwrapv
11760 This option instructs the compiler to assume that signed arithmetic
11761 overflow of addition, subtraction and multiplication wraps around
11762 using twos-complement representation.  This flag enables some optimizations
11763 and disables other.  This option is enabled by default for the Java
11764 front-end, as required by the Java language specification.
11765
11766 @item -fexceptions
11767 @opindex fexceptions
11768 Enable exception handling.  Generates extra code needed to propagate
11769 exceptions.  For some targets, this implies GCC will generate frame
11770 unwind information for all functions, which can produce significant data
11771 size overhead, although it does not affect execution.  If you do not
11772 specify this option, GCC will enable it by default for languages like
11773 C++ which normally require exception handling, and disable it for
11774 languages like C that do not normally require it.  However, you may need
11775 to enable this option when compiling C code that needs to interoperate
11776 properly with exception handlers written in C++.  You may also wish to
11777 disable this option if you are compiling older C++ programs that don't
11778 use exception handling.
11779
11780 @item -fnon-call-exceptions
11781 @opindex fnon-call-exceptions
11782 Generate code that allows trapping instructions to throw exceptions.
11783 Note that this requires platform-specific runtime support that does
11784 not exist everywhere.  Moreover, it only allows @emph{trapping}
11785 instructions to throw exceptions, i.e.@: memory references or floating
11786 point instructions.  It does not allow exceptions to be thrown from
11787 arbitrary signal handlers such as @code{SIGALRM}.
11788
11789 @item -funwind-tables
11790 @opindex funwind-tables
11791 Similar to @option{-fexceptions}, except that it will just generate any needed
11792 static data, but will not affect the generated code in any other way.
11793 You will normally not enable this option; instead, a language processor
11794 that needs this handling would enable it on your behalf.
11795
11796 @item -fasynchronous-unwind-tables
11797 @opindex fasynchronous-unwind-tables
11798 Generate unwind table in dwarf2 format, if supported by target machine.  The
11799 table is exact at each instruction boundary, so it can be used for stack
11800 unwinding from asynchronous events (such as debugger or garbage collector).
11801
11802 @item -fpcc-struct-return
11803 @opindex fpcc-struct-return
11804 Return ``short'' @code{struct} and @code{union} values in memory like
11805 longer ones, rather than in registers.  This convention is less
11806 efficient, but it has the advantage of allowing intercallability between
11807 GCC-compiled files and files compiled with other compilers, particularly
11808 the Portable C Compiler (pcc).
11809
11810 The precise convention for returning structures in memory depends
11811 on the target configuration macros.
11812
11813 Short structures and unions are those whose size and alignment match
11814 that of some integer type.
11815
11816 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11817 switch is not binary compatible with code compiled with the
11818 @option{-freg-struct-return} switch.
11819 Use it to conform to a non-default application binary interface.
11820
11821 @item -freg-struct-return
11822 @opindex freg-struct-return
11823 Return @code{struct} and @code{union} values in registers when possible.
11824 This is more efficient for small structures than
11825 @option{-fpcc-struct-return}.
11826
11827 If you specify neither @option{-fpcc-struct-return} nor
11828 @option{-freg-struct-return}, GCC defaults to whichever convention is
11829 standard for the target.  If there is no standard convention, GCC
11830 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11831 the principal compiler.  In those cases, we can choose the standard, and
11832 we chose the more efficient register return alternative.
11833
11834 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11835 switch is not binary compatible with code compiled with the
11836 @option{-fpcc-struct-return} switch.
11837 Use it to conform to a non-default application binary interface.
11838
11839 @item -fshort-enums
11840 @opindex fshort-enums
11841 Allocate to an @code{enum} type only as many bytes as it needs for the
11842 declared range of possible values.  Specifically, the @code{enum} type
11843 will be equivalent to the smallest integer type which has enough room.
11844
11845 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11846 code that is not binary compatible with code generated without that switch.
11847 Use it to conform to a non-default application binary interface.
11848
11849 @item -fshort-double
11850 @opindex fshort-double
11851 Use the same size for @code{double} as for @code{float}.
11852
11853 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11854 code that is not binary compatible with code generated without that switch.
11855 Use it to conform to a non-default application binary interface.
11856
11857 @item -fshort-wchar
11858 @opindex fshort-wchar
11859 Override the underlying type for @samp{wchar_t} to be @samp{short
11860 unsigned int} instead of the default for the target.  This option is
11861 useful for building programs to run under WINE@.
11862
11863 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11864 code that is not binary compatible with code generated without that switch.
11865 Use it to conform to a non-default application binary interface.
11866
11867 @item -fshared-data
11868 @opindex fshared-data
11869 Requests that the data and non-@code{const} variables of this
11870 compilation be shared data rather than private data.  The distinction
11871 makes sense only on certain operating systems, where shared data is
11872 shared between processes running the same program, while private data
11873 exists in one copy per process.
11874
11875 @item -fno-common
11876 @opindex fno-common
11877 In C, allocate even uninitialized global variables in the data section of the
11878 object file, rather than generating them as common blocks.  This has the
11879 effect that if the same variable is declared (without @code{extern}) in
11880 two different compilations, you will get an error when you link them.
11881 The only reason this might be useful is if you wish to verify that the
11882 program will work on other systems which always work this way.
11883
11884 @item -fno-ident
11885 @opindex fno-ident
11886 Ignore the @samp{#ident} directive.
11887
11888 @item -finhibit-size-directive
11889 @opindex finhibit-size-directive
11890 Don't output a @code{.size} assembler directive, or anything else that
11891 would cause trouble if the function is split in the middle, and the
11892 two halves are placed at locations far apart in memory.  This option is
11893 used when compiling @file{crtstuff.c}; you should not need to use it
11894 for anything else.
11895
11896 @item -fverbose-asm
11897 @opindex fverbose-asm
11898 Put extra commentary information in the generated assembly code to
11899 make it more readable.  This option is generally only of use to those
11900 who actually need to read the generated assembly code (perhaps while
11901 debugging the compiler itself).
11902
11903 @option{-fno-verbose-asm}, the default, causes the
11904 extra information to be omitted and is useful when comparing two assembler
11905 files.
11906
11907 @item -fpic
11908 @opindex fpic
11909 @cindex global offset table
11910 @cindex PIC
11911 Generate position-independent code (PIC) suitable for use in a shared
11912 library, if supported for the target machine.  Such code accesses all
11913 constant addresses through a global offset table (GOT)@.  The dynamic
11914 loader resolves the GOT entries when the program starts (the dynamic
11915 loader is not part of GCC; it is part of the operating system).  If
11916 the GOT size for the linked executable exceeds a machine-specific
11917 maximum size, you get an error message from the linker indicating that
11918 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11919 instead.  (These maximums are 8k on the SPARC and 32k
11920 on the m68k and RS/6000.  The 386 has no such limit.)
11921
11922 Position-independent code requires special support, and therefore works
11923 only on certain machines.  For the 386, GCC supports PIC for System V
11924 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11925 position-independent.
11926
11927 @item -fPIC
11928 @opindex fPIC
11929 If supported for the target machine, emit position-independent code,
11930 suitable for dynamic linking and avoiding any limit on the size of the
11931 global offset table.  This option makes a difference on the m68k
11932 and the SPARC.
11933
11934 Position-independent code requires special support, and therefore works
11935 only on certain machines.
11936
11937 @item -fpie
11938 @itemx -fPIE
11939 @opindex fpie
11940 @opindex fPIE
11941 These options are similar to @option{-fpic} and @option{-fPIC}, but
11942 generated position independent code can be only linked into executables.
11943 Usually these options are used when @option{-pie} GCC option will be
11944 used during linking.
11945
11946 @item -ffixed-@var{reg}
11947 @opindex ffixed
11948 Treat the register named @var{reg} as a fixed register; generated code
11949 should never refer to it (except perhaps as a stack pointer, frame
11950 pointer or in some other fixed role).
11951
11952 @var{reg} must be the name of a register.  The register names accepted
11953 are machine-specific and are defined in the @code{REGISTER_NAMES}
11954 macro in the machine description macro file.
11955
11956 This flag does not have a negative form, because it specifies a
11957 three-way choice.
11958
11959 @item -fcall-used-@var{reg}
11960 @opindex fcall-used
11961 Treat the register named @var{reg} as an allocable register that is
11962 clobbered by function calls.  It may be allocated for temporaries or
11963 variables that do not live across a call.  Functions compiled this way
11964 will not save and restore the register @var{reg}.
11965
11966 It is an error to used this flag with the frame pointer or stack pointer.
11967 Use of this flag for other registers that have fixed pervasive roles in
11968 the machine's execution model will produce disastrous results.
11969
11970 This flag does not have a negative form, because it specifies a
11971 three-way choice.
11972
11973 @item -fcall-saved-@var{reg}
11974 @opindex fcall-saved
11975 Treat the register named @var{reg} as an allocable register saved by
11976 functions.  It may be allocated even for temporaries or variables that
11977 live across a call.  Functions compiled this way will save and restore
11978 the register @var{reg} if they use it.
11979
11980 It is an error to used this flag with the frame pointer or stack pointer.
11981 Use of this flag for other registers that have fixed pervasive roles in
11982 the machine's execution model will produce disastrous results.
11983
11984 A different sort of disaster will result from the use of this flag for
11985 a register in which function values may be returned.
11986
11987 This flag does not have a negative form, because it specifies a
11988 three-way choice.
11989
11990 @item -fpack-struct[=@var{n}]
11991 @opindex fpack-struct
11992 Without a value specified, pack all structure members together without
11993 holes. When a value is specified (which must be a small power of two), pack
11994 structure members according to this value, representing the maximum
11995 alignment (that is, objects with default alignment requirements larger than
11996 this will be output potentially unaligned at the next fitting location.
11997
11998 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11999 code that is not binary compatible with code generated without that switch.
12000 Additionally, it makes the code suboptimal.
12001 Use it to conform to a non-default application binary interface.
12002
12003 @item -finstrument-functions
12004 @opindex finstrument-functions
12005 Generate instrumentation calls for entry and exit to functions.  Just
12006 after function entry and just before function exit, the following
12007 profiling functions will be called with the address of the current
12008 function and its call site.  (On some platforms,
12009 @code{__builtin_return_address} does not work beyond the current
12010 function, so the call site information may not be available to the
12011 profiling functions otherwise.)
12012
12013 @smallexample
12014 void __cyg_profile_func_enter (void *this_fn,
12015                                void *call_site);
12016 void __cyg_profile_func_exit  (void *this_fn,
12017                                void *call_site);
12018 @end smallexample
12019
12020 The first argument is the address of the start of the current function,
12021 which may be looked up exactly in the symbol table.
12022
12023 This instrumentation is also done for functions expanded inline in other
12024 functions.  The profiling calls will indicate where, conceptually, the
12025 inline function is entered and exited.  This means that addressable
12026 versions of such functions must be available.  If all your uses of a
12027 function are expanded inline, this may mean an additional expansion of
12028 code size.  If you use @samp{extern inline} in your C code, an
12029 addressable version of such functions must be provided.  (This is
12030 normally the case anyways, but if you get lucky and the optimizer always
12031 expands the functions inline, you might have gotten away without
12032 providing static copies.)
12033
12034 A function may be given the attribute @code{no_instrument_function}, in
12035 which case this instrumentation will not be done.  This can be used, for
12036 example, for the profiling functions listed above, high-priority
12037 interrupt routines, and any functions from which the profiling functions
12038 cannot safely be called (perhaps signal handlers, if the profiling
12039 routines generate output or allocate memory).
12040
12041 @item -fstack-check
12042 @opindex fstack-check
12043 Generate code to verify that you do not go beyond the boundary of the
12044 stack.  You should specify this flag if you are running in an
12045 environment with multiple threads, but only rarely need to specify it in
12046 a single-threaded environment since stack overflow is automatically
12047 detected on nearly all systems if there is only one stack.
12048
12049 Note that this switch does not actually cause checking to be done; the
12050 operating system must do that.  The switch causes generation of code
12051 to ensure that the operating system sees the stack being extended.
12052
12053 @item -fstack-limit-register=@var{reg}
12054 @itemx -fstack-limit-symbol=@var{sym}
12055 @itemx -fno-stack-limit
12056 @opindex fstack-limit-register
12057 @opindex fstack-limit-symbol
12058 @opindex fno-stack-limit
12059 Generate code to ensure that the stack does not grow beyond a certain value,
12060 either the value of a register or the address of a symbol.  If the stack
12061 would grow beyond the value, a signal is raised.  For most targets,
12062 the signal is raised before the stack overruns the boundary, so
12063 it is possible to catch the signal without taking special precautions.
12064
12065 For instance, if the stack starts at absolute address @samp{0x80000000}
12066 and grows downwards, you can use the flags
12067 @option{-fstack-limit-symbol=__stack_limit} and
12068 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12069 of 128KB@.  Note that this may only work with the GNU linker.
12070
12071 @cindex aliasing of parameters
12072 @cindex parameters, aliased
12073 @item -fargument-alias
12074 @itemx -fargument-noalias
12075 @itemx -fargument-noalias-global
12076 @opindex fargument-alias
12077 @opindex fargument-noalias
12078 @opindex fargument-noalias-global
12079 Specify the possible relationships among parameters and between
12080 parameters and global data.
12081
12082 @option{-fargument-alias} specifies that arguments (parameters) may
12083 alias each other and may alias global storage.@*
12084 @option{-fargument-noalias} specifies that arguments do not alias
12085 each other, but may alias global storage.@*
12086 @option{-fargument-noalias-global} specifies that arguments do not
12087 alias each other and do not alias global storage.
12088
12089 Each language will automatically use whatever option is required by
12090 the language standard.  You should not need to use these options yourself.
12091
12092 @item -fleading-underscore
12093 @opindex fleading-underscore
12094 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12095 change the way C symbols are represented in the object file.  One use
12096 is to help link with legacy assembly code.
12097
12098 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12099 generate code that is not binary compatible with code generated without that
12100 switch.  Use it to conform to a non-default application binary interface.
12101 Not all targets provide complete support for this switch.
12102
12103 @item -ftls-model=@var{model}
12104 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12105 The @var{model} argument should be one of @code{global-dynamic},
12106 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12107
12108 The default without @option{-fpic} is @code{initial-exec}; with
12109 @option{-fpic} the default is @code{global-dynamic}.
12110
12111 @item -fvisibility=@var{default|internal|hidden|protected}
12112 @opindex fvisibility
12113 Set the default ELF image symbol visibility to the specified option - all
12114 symbols will be marked with this unless overridden within the code.
12115 Using this feature can very substantially improve linking and
12116 load times of shared object libraries, produce more optimized
12117 code, provide near-perfect API export and prevent symbol clashes.
12118 It is @strong{strongly} recommended that you use this in any shared objects
12119 you distribute.
12120      
12121 Despite the nomenclature, @code{default} always means public ie;
12122 available to be linked against from outside the shared object.
12123 @code{protected} and @code{internal} are pretty useless in real-world
12124 usage so the only other commonly used option will be @code{hidden}.
12125 The default if -fvisibility isn't specified is @code{default} ie; make every
12126 symbol public - this causes the same behavior as previous versions of
12127 GCC.
12128      
12129 A good explanation of the benefits offered by ensuring ELF
12130 symbols have the correct visibility is given by ``How To Write
12131 Shared Libraries'' by Ulrich Drepper (which can be found at
12132 @w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
12133 solution made possible by this option to marking things hidden when
12134 the default is public is to make the default hidden and mark things
12135 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12136 and @code{__attribute__ ((visibility("default")))} instead of
12137 @code{__declspec(dllexport)} you get almost identical semantics with
12138 identical syntax. This is a great boon to those working with
12139 cross-platform projects.
12140
12141 For those adding visibility support to existing code, you may find
12142 @samp{#pragma GCC visibility} of use. This works by you enclosing
12143 the declarations you wish to set visibility for with (for example)
12144 @samp{#pragma GCC visibility push(hidden)} and
12145 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
12146 times. Bear in mind that symbol visibility should be viewed @strong{as
12147 part of the API interface contract} and thus all new code should
12148 always specify visibility when it is not the default ie; declarations
12149 only for use within the local DSO should @strong{always} be marked explicitly
12150 as hidden as so to avoid PLT indirection overheads - making this
12151 abundantly clear also aids readability and self-documentation of the code.
12152 Note that due to ISO C++ specification requirements, operator new and
12153 operator delete must always be of default visibility.
12154
12155 An overview of these techniques, their benefits and how to use them
12156 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12157
12158 @end table
12159
12160 @c man end
12161
12162 @node Environment Variables
12163 @section Environment Variables Affecting GCC
12164 @cindex environment variables
12165
12166 @c man begin ENVIRONMENT
12167 This section describes several environment variables that affect how GCC
12168 operates.  Some of them work by specifying directories or prefixes to use
12169 when searching for various kinds of files.  Some are used to specify other
12170 aspects of the compilation environment.
12171
12172 Note that you can also specify places to search using options such as
12173 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12174 take precedence over places specified using environment variables, which
12175 in turn take precedence over those specified by the configuration of GCC@.
12176 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12177 GNU Compiler Collection (GCC) Internals}.
12178
12179 @table @env
12180 @item LANG
12181 @itemx LC_CTYPE
12182 @c @itemx LC_COLLATE
12183 @itemx LC_MESSAGES
12184 @c @itemx LC_MONETARY
12185 @c @itemx LC_NUMERIC
12186 @c @itemx LC_TIME
12187 @itemx LC_ALL
12188 @findex LANG
12189 @findex LC_CTYPE
12190 @c @findex LC_COLLATE
12191 @findex LC_MESSAGES
12192 @c @findex LC_MONETARY
12193 @c @findex LC_NUMERIC
12194 @c @findex LC_TIME
12195 @findex LC_ALL
12196 @cindex locale
12197 These environment variables control the way that GCC uses
12198 localization information that allow GCC to work with different
12199 national conventions.  GCC inspects the locale categories
12200 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12201 so.  These locale categories can be set to any value supported by your
12202 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12203 Kingdom encoded in UTF-8.
12204
12205 The @env{LC_CTYPE} environment variable specifies character
12206 classification.  GCC uses it to determine the character boundaries in
12207 a string; this is needed for some multibyte encodings that contain quote
12208 and escape characters that would otherwise be interpreted as a string
12209 end or escape.
12210
12211 The @env{LC_MESSAGES} environment variable specifies the language to
12212 use in diagnostic messages.
12213
12214 If the @env{LC_ALL} environment variable is set, it overrides the value
12215 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12216 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12217 environment variable.  If none of these variables are set, GCC
12218 defaults to traditional C English behavior.
12219
12220 @item TMPDIR
12221 @findex TMPDIR
12222 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12223 files.  GCC uses temporary files to hold the output of one stage of
12224 compilation which is to be used as input to the next stage: for example,
12225 the output of the preprocessor, which is the input to the compiler
12226 proper.
12227
12228 @item GCC_EXEC_PREFIX
12229 @findex GCC_EXEC_PREFIX
12230 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12231 names of the subprograms executed by the compiler.  No slash is added
12232 when this prefix is combined with the name of a subprogram, but you can
12233 specify a prefix that ends with a slash if you wish.
12234
12235 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12236 an appropriate prefix to use based on the pathname it was invoked with.
12237
12238 If GCC cannot find the subprogram using the specified prefix, it
12239 tries looking in the usual places for the subprogram.
12240
12241 The default value of @env{GCC_EXEC_PREFIX} is
12242 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12243 of @code{prefix} when you ran the @file{configure} script.
12244
12245 Other prefixes specified with @option{-B} take precedence over this prefix.
12246
12247 This prefix is also used for finding files such as @file{crt0.o} that are
12248 used for linking.
12249
12250 In addition, the prefix is used in an unusual way in finding the
12251 directories to search for header files.  For each of the standard
12252 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12253 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12254 replacing that beginning with the specified prefix to produce an
12255 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12256 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12257 These alternate directories are searched first; the standard directories
12258 come next.
12259
12260 @item COMPILER_PATH
12261 @findex COMPILER_PATH
12262 The value of @env{COMPILER_PATH} is a colon-separated list of
12263 directories, much like @env{PATH}.  GCC tries the directories thus
12264 specified when searching for subprograms, if it can't find the
12265 subprograms using @env{GCC_EXEC_PREFIX}.
12266
12267 @item LIBRARY_PATH
12268 @findex LIBRARY_PATH
12269 The value of @env{LIBRARY_PATH} is a colon-separated list of
12270 directories, much like @env{PATH}.  When configured as a native compiler,
12271 GCC tries the directories thus specified when searching for special
12272 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12273 using GCC also uses these directories when searching for ordinary
12274 libraries for the @option{-l} option (but directories specified with
12275 @option{-L} come first).
12276
12277 @item LANG
12278 @findex LANG
12279 @cindex locale definition
12280 This variable is used to pass locale information to the compiler.  One way in
12281 which this information is used is to determine the character set to be used
12282 when character literals, string literals and comments are parsed in C and C++.
12283 When the compiler is configured to allow multibyte characters,
12284 the following values for @env{LANG} are recognized:
12285
12286 @table @samp
12287 @item C-JIS
12288 Recognize JIS characters.
12289 @item C-SJIS
12290 Recognize SJIS characters.
12291 @item C-EUCJP
12292 Recognize EUCJP characters.
12293 @end table
12294
12295 If @env{LANG} is not defined, or if it has some other value, then the
12296 compiler will use mblen and mbtowc as defined by the default locale to
12297 recognize and translate multibyte characters.
12298 @end table
12299
12300 @noindent
12301 Some additional environments variables affect the behavior of the
12302 preprocessor.
12303
12304 @include cppenv.texi
12305
12306 @c man end
12307
12308 @node Precompiled Headers
12309 @section Using Precompiled Headers
12310 @cindex precompiled headers
12311 @cindex speed of compilation
12312
12313 Often large projects have many header files that are included in every
12314 source file.  The time the compiler takes to process these header files
12315 over and over again can account for nearly all of the time required to
12316 build the project.  To make builds faster, GCC allows users to
12317 `precompile' a header file; then, if builds can use the precompiled
12318 header file they will be much faster.
12319
12320 @strong{Caution:} There are a few known situations where GCC will
12321 crash when trying to use a precompiled header.  If you have trouble
12322 with a precompiled header, you should remove the precompiled header
12323 and compile without it.  In addition, please use GCC's on-line
12324 defect-tracking system to report any problems you encounter with
12325 precompiled headers.  @xref{Bugs}.
12326
12327 To create a precompiled header file, simply compile it as you would any
12328 other file, if necessary using the @option{-x} option to make the driver
12329 treat it as a C or C++ header file.  You will probably want to use a
12330 tool like @command{make} to keep the precompiled header up-to-date when
12331 the headers it contains change.
12332
12333 A precompiled header file will be searched for when @code{#include} is
12334 seen in the compilation.  As it searches for the included file
12335 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12336 compiler looks for a precompiled header in each directory just before it
12337 looks for the include file in that directory.  The name searched for is
12338 the name specified in the @code{#include} with @samp{.gch} appended.  If
12339 the precompiled header file can't be used, it is ignored.
12340
12341 For instance, if you have @code{#include "all.h"}, and you have
12342 @file{all.h.gch} in the same directory as @file{all.h}, then the
12343 precompiled header file will be used if possible, and the original
12344 header will be used otherwise.
12345
12346 Alternatively, you might decide to put the precompiled header file in a
12347 directory and use @option{-I} to ensure that directory is searched
12348 before (or instead of) the directory containing the original header.
12349 Then, if you want to check that the precompiled header file is always
12350 used, you can put a file of the same name as the original header in this
12351 directory containing an @code{#error} command.
12352
12353 This also works with @option{-include}.  So yet another way to use
12354 precompiled headers, good for projects not designed with precompiled
12355 header files in mind, is to simply take most of the header files used by
12356 a project, include them from another header file, precompile that header
12357 file, and @option{-include} the precompiled header.  If the header files
12358 have guards against multiple inclusion, they will be skipped because
12359 they've already been included (in the precompiled header).
12360
12361 If you need to precompile the same header file for different
12362 languages, targets, or compiler options, you can instead make a
12363 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12364 header in the directory, perhaps using @option{-o}.  It doesn't matter
12365 what you call the files in the directory, every precompiled header in
12366 the directory will be considered.  The first precompiled header
12367 encountered in the directory that is valid for this compilation will
12368 be used; they're searched in no particular order.
12369
12370 There are many other possibilities, limited only by your imagination,
12371 good sense, and the constraints of your build system.
12372
12373 A precompiled header file can be used only when these conditions apply:
12374
12375 @itemize
12376 @item
12377 Only one precompiled header can be used in a particular compilation.
12378
12379 @item
12380 A precompiled header can't be used once the first C token is seen.  You
12381 can have preprocessor directives before a precompiled header; you can
12382 even include a precompiled header from inside another header, so long as
12383 there are no C tokens before the @code{#include}.
12384
12385 @item
12386 The precompiled header file must be produced for the same language as
12387 the current compilation.  You can't use a C precompiled header for a C++
12388 compilation.
12389
12390 @item
12391 The precompiled header file must be produced by the same compiler
12392 version and configuration as the current compilation is using.
12393 The easiest way to guarantee this is to use the same compiler binary
12394 for creating and using precompiled headers.
12395
12396 @item
12397 Any macros defined before the precompiled header is included must
12398 either be defined in the same way as when the precompiled header was
12399 generated, or must not affect the precompiled header, which usually
12400 means that the they don't appear in the precompiled header at all.
12401
12402 The @option{-D} option is one way to define a macro before a
12403 precompiled header is included; using a @code{#define} can also do it.
12404 There are also some options that define macros implicitly, like
12405 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12406 defined this way.
12407
12408 @item If debugging information is output when using the precompiled
12409 header, using @option{-g} or similar, the same kind of debugging information
12410 must have been output when building the precompiled header.  However,
12411 a precompiled header built using @option{-g} can be used in a compilation
12412 when no debugging information is being output.
12413
12414 @item The same @option{-m} options must generally be used when building
12415 and using the precompiled header.  @xref{Submodel Options},
12416 for any cases where this rule is relaxed.
12417
12418 @item Each of the following options must be the same when building and using
12419 the precompiled header:
12420
12421 @gccoptlist{-fexceptions -funit-at-a-time}
12422
12423 @item
12424 Some other command-line options starting with @option{-f},
12425 @option{-p}, or @option{-O} must be defined in the same way as when
12426 the precompiled header was generated.  At present, it's not clear
12427 which options are safe to change and which are not; the safest choice
12428 is to use exactly the same options when generating and using the
12429 precompiled header.  The following are known to be safe:
12430
12431 @gccoptlist{-fpreprocessed -pedantic-errors}
12432
12433 @end itemize
12434
12435 For all of these except the last, the compiler will automatically
12436 ignore the precompiled header if the conditions aren't met.  If you
12437 find an option combination that doesn't work and doesn't cause the
12438 precompiled header to be ignored, please consider filing a bug report,
12439 see @ref{Bugs}.
12440
12441 If you do use differing options when generating and using the
12442 precompiled header, the actual behavior will be a mixture of the
12443 behavior for the options.  For instance, if you use @option{-g} to
12444 generate the precompiled header but not when using it, you may or may
12445 not get debugging information for routines in the precompiled header.
12446
12447 @node Running Protoize
12448 @section Running Protoize
12449
12450 The program @code{protoize} is an optional part of GCC@.  You can use
12451 it to add prototypes to a program, thus converting the program to ISO
12452 C in one respect.  The companion program @code{unprotoize} does the
12453 reverse: it removes argument types from any prototypes that are found.
12454
12455 When you run these programs, you must specify a set of source files as
12456 command line arguments.  The conversion programs start out by compiling
12457 these files to see what functions they define.  The information gathered
12458 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12459
12460 After scanning comes actual conversion.  The specified files are all
12461 eligible to be converted; any files they include (whether sources or
12462 just headers) are eligible as well.
12463
12464 But not all the eligible files are converted.  By default,
12465 @code{protoize} and @code{unprotoize} convert only source and header
12466 files in the current directory.  You can specify additional directories
12467 whose files should be converted with the @option{-d @var{directory}}
12468 option.  You can also specify particular files to exclude with the
12469 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12470 directory name matches one of the specified directory names, and its
12471 name within the directory has not been excluded.
12472
12473 Basic conversion with @code{protoize} consists of rewriting most
12474 function definitions and function declarations to specify the types of
12475 the arguments.  The only ones not rewritten are those for varargs
12476 functions.
12477
12478 @code{protoize} optionally inserts prototype declarations at the
12479 beginning of the source file, to make them available for any calls that
12480 precede the function's definition.  Or it can insert prototype
12481 declarations with block scope in the blocks where undeclared functions
12482 are called.
12483
12484 Basic conversion with @code{unprotoize} consists of rewriting most
12485 function declarations to remove any argument types, and rewriting
12486 function definitions to the old-style pre-ISO form.
12487
12488 Both conversion programs print a warning for any function declaration or
12489 definition that they can't convert.  You can suppress these warnings
12490 with @option{-q}.
12491
12492 The output from @code{protoize} or @code{unprotoize} replaces the
12493 original source file.  The original file is renamed to a name ending
12494 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12495 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12496 for DOS) file already exists, then the source file is simply discarded.
12497
12498 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12499 scan the program and collect information about the functions it uses.
12500 So neither of these programs will work until GCC is installed.
12501
12502 Here is a table of the options you can use with @code{protoize} and
12503 @code{unprotoize}.  Each option works with both programs unless
12504 otherwise stated.
12505
12506 @table @code
12507 @item -B @var{directory}
12508 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12509 usual directory (normally @file{/usr/local/lib}).  This file contains
12510 prototype information about standard system functions.  This option
12511 applies only to @code{protoize}.
12512
12513 @item -c @var{compilation-options}
12514 Use @var{compilation-options} as the options when running @command{gcc} to
12515 produce the @samp{.X} files.  The special option @option{-aux-info} is
12516 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12517
12518 Note that the compilation options must be given as a single argument to
12519 @code{protoize} or @code{unprotoize}.  If you want to specify several
12520 @command{gcc} options, you must quote the entire set of compilation options
12521 to make them a single word in the shell.
12522
12523 There are certain @command{gcc} arguments that you cannot use, because they
12524 would produce the wrong kind of output.  These include @option{-g},
12525 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12526 the @var{compilation-options}, they are ignored.
12527
12528 @item -C
12529 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12530 systems) instead of @samp{.c}.  This is convenient if you are converting
12531 a C program to C++.  This option applies only to @code{protoize}.
12532
12533 @item -g
12534 Add explicit global declarations.  This means inserting explicit
12535 declarations at the beginning of each source file for each function
12536 that is called in the file and was not declared.  These declarations
12537 precede the first function definition that contains a call to an
12538 undeclared function.  This option applies only to @code{protoize}.
12539
12540 @item -i @var{string}
12541 Indent old-style parameter declarations with the string @var{string}.
12542 This option applies only to @code{protoize}.
12543
12544 @code{unprotoize} converts prototyped function definitions to old-style
12545 function definitions, where the arguments are declared between the
12546 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12547 uses five spaces as the indentation.  If you want to indent with just
12548 one space instead, use @option{-i " "}.
12549
12550 @item -k
12551 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12552 is finished.
12553
12554 @item -l
12555 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12556 a prototype declaration for each function in each block which calls the
12557 function without any declaration.  This option applies only to
12558 @code{protoize}.
12559
12560 @item -n
12561 Make no real changes.  This mode just prints information about the conversions
12562 that would have been done without @option{-n}.
12563
12564 @item -N
12565 Make no @samp{.save} files.  The original files are simply deleted.
12566 Use this option with caution.
12567
12568 @item -p @var{program}
12569 Use the program @var{program} as the compiler.  Normally, the name
12570 @file{gcc} is used.
12571
12572 @item -q
12573 Work quietly.  Most warnings are suppressed.
12574
12575 @item -v
12576 Print the version number, just like @option{-v} for @command{gcc}.
12577 @end table
12578
12579 If you need special compiler options to compile one of your program's
12580 source files, then you should generate that file's @samp{.X} file
12581 specially, by running @command{gcc} on that source file with the
12582 appropriate options and the option @option{-aux-info}.  Then run
12583 @code{protoize} on the entire set of files.  @code{protoize} will use
12584 the existing @samp{.X} file because it is newer than the source file.
12585 For example:
12586
12587 @smallexample
12588 gcc -Dfoo=bar file1.c -aux-info file1.X
12589 protoize *.c
12590 @end smallexample
12591
12592 @noindent
12593 You need to include the special files along with the rest in the
12594 @code{protoize} command, even though their @samp{.X} files already
12595 exist, because otherwise they won't get converted.
12596
12597 @xref{Protoize Caveats}, for more information on how to use
12598 @code{protoize} successfully.