OSDN Git Service

* doc/invoke.texi: Document -mTLS.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  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 -Wno-pointer-sign}
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 -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 -fvariable-expansion-in-unroller @gol
320 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
321 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
322 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
323 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
324 --param @var{name}=@var{value}
325 -O  -O0  -O1  -O2  -O3  -Os}
326
327 @item Preprocessor Options
328 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
329 @gccoptlist{-A@var{question}=@var{answer} @gol
330 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
331 -C  -dD  -dI  -dM  -dN @gol
332 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
333 -idirafter @var{dir} @gol
334 -include @var{file}  -imacros @var{file} @gol
335 -iprefix @var{file}  -iwithprefix @var{dir} @gol
336 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
337 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
338 -P  -fworking-directory  -remap @gol
339 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
340 -Xpreprocessor @var{option}}
341
342 @item Assembler Option
343 @xref{Assembler Options,,Passing Options to the Assembler}.
344 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
345
346 @item Linker Options
347 @xref{Link Options,,Options for Linking}.
348 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
349 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
350 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
351 -Wl,@var{option}  -Xlinker @var{option} @gol
352 -u @var{symbol}}
353
354 @item Directory Options
355 @xref{Directory Options,,Options for Directory Search}.
356 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
357
358 @item Target Options
359 @c I wrote this xref this way to avoid overfull hbox. -- rms
360 @xref{Target Options}.
361 @gccoptlist{-V @var{version}  -b @var{machine}}
362
363 @item Machine Dependent Options
364 @xref{Submodel Options,,Hardware Models and Configurations}.
365 @c This list is ordered alphanumerically by subsection name.
366 @c Try and put the significant identifier (CPU or system) first,
367 @c so users have a clue at guessing where the ones they want will be.
368
369 @emph{ARC Options}
370 @gccoptlist{-EB  -EL @gol
371 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
372 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
373
374 @emph{ARM Options}
375 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
376 -mabi=@var{name} @gol
377 -mapcs-stack-check  -mno-apcs-stack-check @gol
378 -mapcs-float  -mno-apcs-float @gol
379 -mapcs-reentrant  -mno-apcs-reentrant @gol
380 -msched-prolog  -mno-sched-prolog @gol
381 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
382 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
383 -mthumb-interwork  -mno-thumb-interwork @gol
384 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
385 -mstructure-size-boundary=@var{n} @gol
386 -mabort-on-noreturn @gol
387 -mlong-calls  -mno-long-calls @gol
388 -msingle-pic-base  -mno-single-pic-base @gol
389 -mpic-register=@var{reg} @gol
390 -mnop-fun-dllimport @gol
391 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
392 -mpoke-function-name @gol
393 -mthumb  -marm @gol
394 -mtpcs-frame  -mtpcs-leaf-frame @gol
395 -mcaller-super-interworking  -mcallee-super-interworking}
396
397 @emph{AVR Options}
398 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
399 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
400
401 @emph{CRIS Options}
402 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
403 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
404 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
405 -mstack-align  -mdata-align  -mconst-align @gol
406 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
407 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
408 -mmul-bug-workaround  -mno-mul-bug-workaround}
409
410 @emph{Darwin Options}
411 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
412 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
413 -client_name  -compatibility_version  -current_version @gol
414 -dead_strip @gol
415 -dependency-file  -dylib_file  -dylinker_install_name @gol
416 -dynamic  -dynamiclib  -exported_symbols_list @gol
417 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
418 -force_flat_namespace  -headerpad_max_install_names @gol
419 -image_base  -init  -install_name  -keep_private_externs @gol
420 -multi_module  -multiply_defined  -multiply_defined_unused @gol
421 -noall_load   -no_dead_strip_inits_and_terms @gol
422 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
423 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
424 -private_bundle  -read_only_relocs  -sectalign @gol
425 -sectobjectsymbols  -whyload  -seg1addr @gol
426 -sectcreate  -sectobjectsymbols  -sectorder @gol
427 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
428 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
429 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
430 -single_module  -static  -sub_library  -sub_umbrella @gol
431 -twolevel_namespace  -umbrella  -undefined @gol
432 -unexported_symbols_list  -weak_reference_mismatches @gol
433 -whatsloaded -F -gused -gfull -mone-byte-bool}
434
435 @emph{DEC Alpha Options}
436 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
437 -mieee  -mieee-with-inexact  -mieee-conformant @gol
438 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
439 -mtrap-precision=@var{mode}  -mbuild-constants @gol
440 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
441 -mbwx  -mmax  -mfix  -mcix @gol
442 -mfloat-vax  -mfloat-ieee @gol
443 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
444 -msmall-text  -mlarge-text @gol
445 -mmemory-latency=@var{time}}
446
447 @emph{DEC Alpha/VMS Options}
448 @gccoptlist{-mvms-return-codes}
449
450 @emph{FRV Options}
451 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
452 -mhard-float  -msoft-float @gol
453 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
454 -mdouble  -mno-double @gol
455 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
456 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
457 -mlinked-fp  -mlong-calls  -malign-labels @gol
458 -mlibrary-pic  -macc-4  -macc-8 @gol
459 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
460 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
461 -mvliw-branch  -mno-vliw-branch @gol
462 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
463 -mno-nested-cond-exec  -mtomcat-stats @gol
464 -mTLS -mtls @gol
465 -mcpu=@var{cpu}}
466
467 @emph{H8/300 Options}
468 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
469
470 @emph{HPPA Options}
471 @gccoptlist{-march=@var{architecture-type} @gol
472 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
473 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
474 -mfixed-range=@var{register-range} @gol
475 -mjump-in-delay -mlinker-opt -mlong-calls @gol
476 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
477 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
478 -mno-jump-in-delay  -mno-long-load-store @gol
479 -mno-portable-runtime  -mno-soft-float @gol
480 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
481 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
482 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
483 -munix=@var{unix-std}  -nolibdld  -static  -threads}
484
485 @emph{i386 and x86-64 Options}
486 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
487 -mfpmath=@var{unit} @gol
488 -masm=@var{dialect}  -mno-fancy-math-387 @gol
489 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
490 -mno-wide-multiply  -mrtd  -malign-double @gol
491 -mpreferred-stack-boundary=@var{num} @gol
492 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
493 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
494 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
495 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
496 -mno-red-zone -mno-tls-direct-seg-refs @gol
497 -mcmodel=@var{code-model} @gol
498 -m32  -m64}
499
500 @emph{IA-64 Options}
501 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
502 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
503 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
504 -minline-float-divide-max-throughput @gol
505 -minline-int-divide-min-latency @gol
506 -minline-int-divide-max-throughput  @gol
507 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
508 -mno-dwarf2-asm -mearly-stop-bits @gol
509 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
510 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
511
512 @emph{M32R/D Options}
513 @gccoptlist{-m32r2 -m32rx -m32r @gol
514 -mdebug @gol
515 -malign-loops -mno-align-loops @gol
516 -missue-rate=@var{number} @gol
517 -mbranch-cost=@var{number} @gol
518 -mmodel=@var{code-size-model-type} @gol
519 -msdata=@var{sdata-type} @gol
520 -mno-flush-func -mflush-func=@var{name} @gol
521 -mno-flush-trap -mflush-trap=@var{number} @gol
522 -G @var{num}}
523
524 @emph{M680x0 Options}
525 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
526 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
527 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
528 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
529 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
530
531 @emph{M68hc1x Options}
532 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
533 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
534 -msoft-reg-count=@var{count}}
535
536 @emph{MCore Options}
537 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
538 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
539 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
540 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
541 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
542
543 @emph{MIPS Options}
544 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
545 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
546 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
547 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
548 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
549 -mpaired-single  -mips3d @gol
550 -mint64  -mlong64  -mlong32 @gol
551 -G@var{num}  -membedded-data  -mno-embedded-data @gol
552 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
553 -msplit-addresses  -mno-split-addresses  @gol
554 -mexplicit-relocs  -mno-explicit-relocs  @gol
555 -mcheck-zero-division  -mno-check-zero-division @gol
556 -mdivide-traps  -mdivide-breaks @gol
557 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
558 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
559 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
560 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
561 -mflush-func=@var{func}  -mno-flush-func @gol
562 -mbranch-likely  -mno-branch-likely @gol
563 -mfp-exceptions -mno-fp-exceptions @gol
564 -mvr4130-align -mno-vr4130-align}
565
566 @emph{MMIX Options}
567 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
568 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
569 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
570 -mno-base-addresses  -msingle-exit  -mno-single-exit}
571
572 @emph{MN10300 Options}
573 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
574 -mam33  -mno-am33 @gol
575 -mam33-2  -mno-am33-2 @gol
576 -mno-crt0  -mrelax}
577
578 @emph{NS32K Options}
579 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
580 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
581 -mregparam  -mnoregparam  -msb  -mnosb @gol
582 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
583
584 @emph{PDP-11 Options}
585 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
586 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
587 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
588 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
589 -mbranch-expensive  -mbranch-cheap @gol
590 -msplit  -mno-split  -munix-asm  -mdec-asm}
591
592 @emph{PowerPC Options}
593 See RS/6000 and PowerPC Options.
594
595 @emph{RS/6000 and PowerPC Options}
596 @gccoptlist{-mcpu=@var{cpu-type} @gol
597 -mtune=@var{cpu-type} @gol
598 -mpower  -mno-power  -mpower2  -mno-power2 @gol
599 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
600 -maltivec  -mno-altivec @gol
601 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
602 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
603 -mnew-mnemonics  -mold-mnemonics @gol
604 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
605 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
606 -malign-power  -malign-natural @gol
607 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
608 -mstring  -mno-string  -mupdate  -mno-update @gol
609 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
610 -mstrict-align  -mno-strict-align  -mrelocatable @gol
611 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
612 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
613 -mdynamic-no-pic @gol
614 -mprioritize-restricted-insns=@var{priority} @gol
615 -msched-costly-dep=@var{dependence_type} @gol
616 -minsert-sched-nops=@var{scheme} @gol
617 -mcall-sysv  -mcall-netbsd @gol
618 -maix-struct-return  -msvr4-struct-return @gol
619 -mabi=altivec  -mabi=no-altivec @gol
620 -mabi=spe  -mabi=no-spe @gol
621 -misel=yes  -misel=no @gol
622 -mspe=yes  -mspe=no @gol
623 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
624 -mprototype  -mno-prototype @gol
625 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
626 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
627
628 @emph{S/390 and zSeries Options}
629 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
630 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
631 -mpacked-stack  -mno-packed-stack @gol
632 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
633 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
634 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
635 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
636
637 @emph{SH Options}
638 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
639 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
640 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
641 -m5-64media  -m5-64media-nofpu @gol
642 -m5-32media  -m5-32media-nofpu @gol
643 -m5-compact  -m5-compact-nofpu @gol
644 -mb  -ml  -mdalign  -mrelax @gol
645 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
646 -mieee  -misize  -mpadstruct  -mspace @gol
647 -mprefergot  -musermode}
648
649 @emph{SPARC Options}
650 @gccoptlist{-mcpu=@var{cpu-type} @gol
651 -mtune=@var{cpu-type} @gol
652 -mcmodel=@var{code-model} @gol
653 -m32  -m64  -mapp-regs  -mno-app-regs @gol
654 -mfaster-structs  -mno-faster-structs @gol
655 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
656 -mhard-quad-float  -msoft-quad-float @gol
657 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
658 -mstack-bias  -mno-stack-bias @gol
659 -munaligned-doubles  -mno-unaligned-doubles @gol
660 -mv8plus  -mno-v8plus  -mvis  -mno-vis
661 -threads -pthreads}
662
663 @emph{System V Options}
664 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
665
666 @emph{TMS320C3x/C4x Options}
667 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
668 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
669 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
670 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
671
672 @emph{V850 Options}
673 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
674 -mprolog-function  -mno-prolog-function  -mspace @gol
675 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
676 -mapp-regs  -mno-app-regs @gol
677 -mdisable-callt  -mno-disable-callt @gol
678 -mv850e1 @gol
679 -mv850e @gol
680 -mv850  -mbig-switch}
681
682 @emph{VAX Options}
683 @gccoptlist{-mg  -mgnu  -munix}
684
685 @emph{x86-64 Options}
686 See i386 and x86-64 Options.
687
688 @emph{Xstormy16 Options}
689 @gccoptlist{-msim}
690
691 @emph{Xtensa Options}
692 @gccoptlist{-mconst16 -mno-const16 @gol
693 -mfused-madd  -mno-fused-madd @gol
694 -mtext-section-literals  -mno-text-section-literals @gol
695 -mtarget-align  -mno-target-align @gol
696 -mlongcalls  -mno-longcalls}
697
698 @emph{zSeries Options}
699 See S/390 and zSeries Options.
700
701 @item Code Generation Options
702 @xref{Code Gen Options,,Options for Code Generation Conventions}.
703 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
704 -ffixed-@var{reg}  -fexceptions @gol
705 -fnon-call-exceptions  -funwind-tables @gol
706 -fasynchronous-unwind-tables @gol
707 -finhibit-size-directive  -finstrument-functions @gol
708 -fno-common  -fno-ident @gol
709 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
710 -freg-struct-return  -fshared-data  -fshort-enums @gol
711 -fshort-double  -fshort-wchar @gol
712 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
713 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
714 -fargument-alias  -fargument-noalias @gol
715 -fargument-noalias-global  -fleading-underscore @gol
716 -ftls-model=@var{model} @gol
717 -ftrapv  -fwrapv  -fbounds-check @gol
718 -fvisibility}
719 @end table
720
721 @menu
722 * Overall Options::     Controlling the kind of output:
723                         an executable, object files, assembler files,
724                         or preprocessed source.
725 * C Dialect Options::   Controlling the variant of C language compiled.
726 * C++ Dialect Options:: Variations on C++.
727 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
728                         and Objective-C++.
729 * Language Independent Options:: Controlling how diagnostics should be
730                         formatted.
731 * Warning Options::     How picky should the compiler be?
732 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
733 * Optimize Options::    How much optimization?
734 * Preprocessor Options:: Controlling header files and macro definitions.
735                          Also, getting dependency information for Make.
736 * Assembler Options::   Passing options to the assembler.
737 * Link Options::        Specifying libraries and so on.
738 * Directory Options::   Where to find header files and libraries.
739                         Where to find the compiler executable files.
740 * Spec Files::          How to pass switches to sub-processes.
741 * Target Options::      Running a cross-compiler, or an old version of GCC.
742 @end menu
743
744 @node Overall Options
745 @section Options Controlling the Kind of Output
746
747 Compilation can involve up to four stages: preprocessing, compilation
748 proper, assembly and linking, always in that order.  GCC is capable of
749 preprocessing and compiling several files either into several
750 assembler input files, or into one assembler input file; then each
751 assembler input file produces an object file, and linking combines all
752 the object files (those newly compiled, and those specified as input)
753 into an executable file.
754
755 @cindex file name suffix
756 For any given input file, the file name suffix determines what kind of
757 compilation is done:
758
759 @table @gcctabopt
760 @item @var{file}.c
761 C source code which must be preprocessed.
762
763 @item @var{file}.i
764 C source code which should not be preprocessed.
765
766 @item @var{file}.ii
767 C++ source code which should not be preprocessed.
768
769 @item @var{file}.m
770 Objective-C source code.  Note that you must link with the @file{libobjc}
771 library to make an Objective-C program work.
772
773 @item @var{file}.mi
774 Objective-C source code which should not be preprocessed.
775
776 @item @var{file}.mm
777 @itemx @var{file}.M
778 Objective-C++ source code.  Note that you must link with the @file{libobjc}
779 library to make an Objective-C++ program work.  Note that @samp{.M} refers
780 to a literal capital M@.
781
782 @item @var{file}.mii
783 Objective-C++ source code which should not be preprocessed.
784
785 @item @var{file}.h
786 C, C++, Objective-C or Objective-C++ header file to be turned into a
787 precompiled header.
788
789 @item @var{file}.cc
790 @itemx @var{file}.cp
791 @itemx @var{file}.cxx
792 @itemx @var{file}.cpp
793 @itemx @var{file}.CPP
794 @itemx @var{file}.c++
795 @itemx @var{file}.C
796 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
797 the last two letters must both be literally @samp{x}.  Likewise,
798 @samp{.C} refers to a literal capital C@.
799
800 @item @var{file}.hh
801 @itemx @var{file}.H
802 C++ header file to be turned into a precompiled header.
803
804 @item @var{file}.f
805 @itemx @var{file}.for
806 @itemx @var{file}.FOR
807 Fortran source code which should not be preprocessed.
808
809 @item @var{file}.F
810 @itemx @var{file}.fpp
811 @itemx @var{file}.FPP
812 Fortran source code which must be preprocessed (with the traditional
813 preprocessor).
814
815 @item @var{file}.r
816 Fortran source code which must be preprocessed with a RATFOR
817 preprocessor (not included with GCC)@.
818
819 @item @var{file}.f90
820 @itemx @var{file}.f95
821 Fortran 90/95 source code which should not be preprocessed.
822
823 @c FIXME: Descriptions of Java file types.
824 @c @var{file}.java
825 @c @var{file}.class
826 @c @var{file}.zip
827 @c @var{file}.jar
828
829 @item @var{file}.ads
830 Ada source code file which contains a library unit declaration (a
831 declaration of a package, subprogram, or generic, or a generic
832 instantiation), or a library unit renaming declaration (a package,
833 generic, or subprogram renaming declaration).  Such files are also
834 called @dfn{specs}.
835
836 @itemx @var{file}.adb
837 Ada source code file containing a library unit body (a subprogram or
838 package body).  Such files are also called @dfn{bodies}.
839
840 @c GCC also knows about some suffixes for languages not yet included:
841 @c Pascal:
842 @c @var{file}.p
843 @c @var{file}.pas
844
845 @item @var{file}.s
846 Assembler code.
847
848 @item @var{file}.S
849 Assembler code which must be preprocessed.
850
851 @item @var{other}
852 An object file to be fed straight into linking.
853 Any file name with no recognized suffix is treated this way.
854 @end table
855
856 @opindex x
857 You can specify the input language explicitly with the @option{-x} option:
858
859 @table @gcctabopt
860 @item -x @var{language}
861 Specify explicitly the @var{language} for the following input files
862 (rather than letting the compiler choose a default based on the file
863 name suffix).  This option applies to all following input files until
864 the next @option{-x} option.  Possible values for @var{language} are:
865 @smallexample
866 c  c-header  c-cpp-output
867 c++  c++-header  c++-cpp-output
868 objective-c  objective-c-header  objective-c-cpp-output
869 objective-c++ objective-c++-header objective-c++-cpp-output
870 assembler  assembler-with-cpp
871 ada
872 f77  f77-cpp-input  ratfor
873 f95
874 java
875 treelang
876 @end smallexample
877
878 @item -x none
879 Turn off any specification of a language, so that subsequent files are
880 handled according to their file name suffixes (as they are if @option{-x}
881 has not been used at all).
882
883 @item -pass-exit-codes
884 @opindex pass-exit-codes
885 Normally the @command{gcc} program will exit with the code of 1 if any
886 phase of the compiler returns a non-success return code.  If you specify
887 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
888 numerically highest error produced by any phase that returned an error
889 indication.
890 @end table
891
892 If you only want some of the stages of compilation, you can use
893 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
894 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
895 @command{gcc} is to stop.  Note that some combinations (for example,
896 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
897
898 @table @gcctabopt
899 @item -c
900 @opindex c
901 Compile or assemble the source files, but do not link.  The linking
902 stage simply is not done.  The ultimate output is in the form of an
903 object file for each source file.
904
905 By default, the object file name for a source file is made by replacing
906 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
907
908 Unrecognized input files, not requiring compilation or assembly, are
909 ignored.
910
911 @item -S
912 @opindex S
913 Stop after the stage of compilation proper; do not assemble.  The output
914 is in the form of an assembler code file for each non-assembler input
915 file specified.
916
917 By default, the assembler file name for a source file is made by
918 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
919
920 Input files that don't require compilation are ignored.
921
922 @item -E
923 @opindex E
924 Stop after the preprocessing stage; do not run the compiler proper.  The
925 output is in the form of preprocessed source code, which is sent to the
926 standard output.
927
928 Input files which don't require preprocessing are ignored.
929
930 @cindex output file option
931 @item -o @var{file}
932 @opindex o
933 Place output in file @var{file}.  This applies regardless to whatever
934 sort of output is being produced, whether it be an executable file,
935 an object file, an assembler file or preprocessed C code.
936
937 If @option{-o} is not specified, the default is to put an executable
938 file in @file{a.out}, the object file for
939 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
940 assembler file in @file{@var{source}.s}, a precompiled header file in
941 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
942 standard output.
943
944 @item -v
945 @opindex v
946 Print (on standard error output) the commands executed to run the stages
947 of compilation.  Also print the version number of the compiler driver
948 program and of the preprocessor and the compiler proper.
949
950 @item -###
951 @opindex ###
952 Like @option{-v} except the commands are not executed and all command
953 arguments are quoted.  This is useful for shell scripts to capture the
954 driver-generated command lines.
955
956 @item -pipe
957 @opindex pipe
958 Use pipes rather than temporary files for communication between the
959 various stages of compilation.  This fails to work on some systems where
960 the assembler is unable to read from a pipe; but the GNU assembler has
961 no trouble.
962
963 @item -combine
964 @opindex combine
965 If you are compiling multiple source files, this option tells the driver
966 to pass all the source files to the compiler at once (for those
967 languages for which the compiler can handle this).  This will allow
968 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
969 language for which this is supported is C@.  If you pass source files for
970 multiple languages to the driver, using this option, the driver will invoke
971 the compiler(s) that support IMA once each, passing each compiler all the
972 source files appropriate for it.  For those languages that do not support
973 IMA this option will be ignored, and the compiler will be invoked once for
974 each source file in that language.  If you use this option in conjunction
975 with @option{-save-temps}, the compiler will generate multiple
976 pre-processed files
977 (one for each source file), but only one (combined) @file{.o} or
978 @file{.s} file.
979
980 @item --help
981 @opindex help
982 Print (on the standard output) a description of the command line options
983 understood by @command{gcc}.  If the @option{-v} option is also specified
984 then @option{--help} will also be passed on to the various processes
985 invoked by @command{gcc}, so that they can display the command line options
986 they accept.  If the @option{-Wextra} option is also specified then command
987 line options which have no documentation associated with them will also
988 be displayed.
989
990 @item --target-help
991 @opindex target-help
992 Print (on the standard output) a description of target specific command
993 line options for each tool.
994
995 @item --version
996 @opindex version
997 Display the version number and copyrights of the invoked GCC@.
998 @end table
999
1000 @node Invoking G++
1001 @section Compiling C++ Programs
1002
1003 @cindex suffixes for C++ source
1004 @cindex C++ source file suffixes
1005 C++ source files conventionally use one of the suffixes @samp{.C},
1006 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1007 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1008 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1009 files with these names and compiles them as C++ programs even if you
1010 call the compiler the same way as for compiling C programs (usually
1011 with the name @command{gcc}).
1012
1013 @findex g++
1014 @findex c++
1015 However, C++ programs often require class libraries as well as a
1016 compiler that understands the C++ language---and under some
1017 circumstances, you might want to compile programs or header files from
1018 standard input, or otherwise without a suffix that flags them as C++
1019 programs.  You might also like to precompile a C header file with a
1020 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1021 program that calls GCC with the default language set to C++, and
1022 automatically specifies linking against the C++ library.  On many
1023 systems, @command{g++} is also installed with the name @command{c++}.
1024
1025 @cindex invoking @command{g++}
1026 When you compile C++ programs, you may specify many of the same
1027 command-line options that you use for compiling programs in any
1028 language; or command-line options meaningful for C and related
1029 languages; or options that are meaningful only for C++ programs.
1030 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1031 explanations of options for languages related to C@.
1032 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1033 explanations of options that are meaningful only for C++ programs.
1034
1035 @node C Dialect Options
1036 @section Options Controlling C Dialect
1037 @cindex dialect options
1038 @cindex language dialect options
1039 @cindex options, dialect
1040
1041 The following options control the dialect of C (or languages derived
1042 from C, such as C++, Objective-C and Objective-C++) that the compiler
1043 accepts:
1044
1045 @table @gcctabopt
1046 @cindex ANSI support
1047 @cindex ISO support
1048 @item -ansi
1049 @opindex ansi
1050 In C mode, support all ISO C90 programs.  In C++ mode,
1051 remove GNU extensions that conflict with ISO C++.
1052
1053 This turns off certain features of GCC that are incompatible with ISO
1054 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1055 such as the @code{asm} and @code{typeof} keywords, and
1056 predefined macros such as @code{unix} and @code{vax} that identify the
1057 type of system you are using.  It also enables the undesirable and
1058 rarely used ISO trigraph feature.  For the C compiler,
1059 it disables recognition of C++ style @samp{//} comments as well as
1060 the @code{inline} keyword.
1061
1062 The alternate keywords @code{__asm__}, @code{__extension__},
1063 @code{__inline__} and @code{__typeof__} continue to work despite
1064 @option{-ansi}.  You would not want to use them in an ISO C program, of
1065 course, but it is useful to put them in header files that might be included
1066 in compilations done with @option{-ansi}.  Alternate predefined macros
1067 such as @code{__unix__} and @code{__vax__} are also available, with or
1068 without @option{-ansi}.
1069
1070 The @option{-ansi} option does not cause non-ISO programs to be
1071 rejected gratuitously.  For that, @option{-pedantic} is required in
1072 addition to @option{-ansi}.  @xref{Warning Options}.
1073
1074 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1075 option is used.  Some header files may notice this macro and refrain
1076 from declaring certain functions or defining certain macros that the
1077 ISO standard doesn't call for; this is to avoid interfering with any
1078 programs that might use these names for other things.
1079
1080 Functions which would normally be built in but do not have semantics
1081 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1082 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1083 built-in functions provided by GCC}, for details of the functions
1084 affected.
1085
1086 @item -std=
1087 @opindex std
1088 Determine the language standard.  This option is currently only
1089 supported when compiling C or C++.  A value for this option must be
1090 provided; possible values are
1091
1092 @table @samp
1093 @item c89
1094 @itemx iso9899:1990
1095 ISO C90 (same as @option{-ansi}).
1096
1097 @item iso9899:199409
1098 ISO C90 as modified in amendment 1.
1099
1100 @item c99
1101 @itemx c9x
1102 @itemx iso9899:1999
1103 @itemx iso9899:199x
1104 ISO C99.  Note that this standard is not yet fully supported; see
1105 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1106 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1107
1108 @item gnu89
1109 Default, ISO C90 plus GNU extensions (including some C99 features).
1110
1111 @item gnu99
1112 @itemx gnu9x
1113 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1114 this will become the default.  The name @samp{gnu9x} is deprecated.
1115
1116 @item c++98
1117 The 1998 ISO C++ standard plus amendments.
1118
1119 @item gnu++98
1120 The same as @option{-std=c++98} plus GNU extensions.  This is the
1121 default for C++ code.
1122 @end table
1123
1124 Even when this option is not specified, you can still use some of the
1125 features of newer standards in so far as they do not conflict with
1126 previous C standards.  For example, you may use @code{__restrict__} even
1127 when @option{-std=c99} is not specified.
1128
1129 The @option{-std} options specifying some version of ISO C have the same
1130 effects as @option{-ansi}, except that features that were not in ISO C90
1131 but are in the specified version (for example, @samp{//} comments and
1132 the @code{inline} keyword in ISO C99) are not disabled.
1133
1134 @xref{Standards,,Language Standards Supported by GCC}, for details of
1135 these standard versions.
1136
1137 @item -aux-info @var{filename}
1138 @opindex aux-info
1139 Output to the given filename prototyped declarations for all functions
1140 declared and/or defined in a translation unit, including those in header
1141 files.  This option is silently ignored in any language other than C@.
1142
1143 Besides declarations, the file indicates, in comments, the origin of
1144 each declaration (source file and line), whether the declaration was
1145 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1146 @samp{O} for old, respectively, in the first character after the line
1147 number and the colon), and whether it came from a declaration or a
1148 definition (@samp{C} or @samp{F}, respectively, in the following
1149 character).  In the case of function definitions, a K&R-style list of
1150 arguments followed by their declarations is also provided, inside
1151 comments, after the declaration.
1152
1153 @item -fno-asm
1154 @opindex fno-asm
1155 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1156 keyword, so that code can use these words as identifiers.  You can use
1157 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1158 instead.  @option{-ansi} implies @option{-fno-asm}.
1159
1160 In C++, this switch only affects the @code{typeof} keyword, since
1161 @code{asm} and @code{inline} are standard keywords.  You may want to
1162 use the @option{-fno-gnu-keywords} flag instead, which has the same
1163 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1164 switch only affects the @code{asm} and @code{typeof} keywords, since
1165 @code{inline} is a standard keyword in ISO C99.
1166
1167 @item -fno-builtin
1168 @itemx -fno-builtin-@var{function}
1169 @opindex fno-builtin
1170 @cindex built-in functions
1171 Don't recognize built-in functions that do not begin with
1172 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1173 functions provided by GCC}, for details of the functions affected,
1174 including those which are not built-in functions when @option{-ansi} or
1175 @option{-std} options for strict ISO C conformance are used because they
1176 do not have an ISO standard meaning.
1177
1178 GCC normally generates special code to handle certain built-in functions
1179 more efficiently; for instance, calls to @code{alloca} may become single
1180 instructions that adjust the stack directly, and calls to @code{memcpy}
1181 may become inline copy loops.  The resulting code is often both smaller
1182 and faster, but since the function calls no longer appear as such, you
1183 cannot set a breakpoint on those calls, nor can you change the behavior
1184 of the functions by linking with a different library.  In addition,
1185 when a function is recognized as a built-in function, GCC may use
1186 information about that function to warn about problems with calls to
1187 that function, or to generate more efficient code, even if the
1188 resulting code still contains calls to that function.  For example,
1189 warnings are given with @option{-Wformat} for bad calls to
1190 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1191 known not to modify global memory.
1192
1193 With the @option{-fno-builtin-@var{function}} option
1194 only the built-in function @var{function} is
1195 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1196 function is named this is not built-in in this version of GCC, this
1197 option is ignored.  There is no corresponding
1198 @option{-fbuiltin-@var{function}} option; if you wish to enable
1199 built-in functions selectively when using @option{-fno-builtin} or
1200 @option{-ffreestanding}, you may define macros such as:
1201
1202 @smallexample
1203 #define abs(n)          __builtin_abs ((n))
1204 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1205 @end smallexample
1206
1207 @item -fhosted
1208 @opindex fhosted
1209 @cindex hosted environment
1210
1211 Assert that compilation takes place in a hosted environment.  This implies
1212 @option{-fbuiltin}.  A hosted environment is one in which the
1213 entire standard library is available, and in which @code{main} has a return
1214 type of @code{int}.  Examples are nearly everything except a kernel.
1215 This is equivalent to @option{-fno-freestanding}.
1216
1217 @item -ffreestanding
1218 @opindex ffreestanding
1219 @cindex hosted environment
1220
1221 Assert that compilation takes place in a freestanding environment.  This
1222 implies @option{-fno-builtin}.  A freestanding environment
1223 is one in which the standard library may not exist, and program startup may
1224 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1225 This is equivalent to @option{-fno-hosted}.
1226
1227 @xref{Standards,,Language Standards Supported by GCC}, for details of
1228 freestanding and hosted environments.
1229
1230 @item -fms-extensions
1231 @opindex fms-extensions
1232 Accept some non-standard constructs used in Microsoft header files.
1233
1234 Some cases of unnamed fields in structures and unions are only
1235 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1236 fields within structs/unions}, for details.
1237
1238 @item -trigraphs
1239 @opindex trigraphs
1240 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1241 options for strict ISO C conformance) implies @option{-trigraphs}.
1242
1243 @item -no-integrated-cpp
1244 @opindex no-integrated-cpp
1245 Performs a compilation in two passes: preprocessing and compiling.  This
1246 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1247 @option{-B} option.  The user supplied compilation step can then add in
1248 an additional preprocessing step after normal preprocessing but before
1249 compiling.  The default is to use the integrated cpp (internal cpp)
1250
1251 The semantics of this option will change if "cc1", "cc1plus", and
1252 "cc1obj" are merged.
1253
1254 @cindex traditional C language
1255 @cindex C language, traditional
1256 @item -traditional
1257 @itemx -traditional-cpp
1258 @opindex traditional-cpp
1259 @opindex traditional
1260 Formerly, these options caused GCC to attempt to emulate a pre-standard
1261 C compiler.  They are now only supported with the @option{-E} switch.
1262 The preprocessor continues to support a pre-standard mode.  See the GNU
1263 CPP manual for details.
1264
1265 @item -fcond-mismatch
1266 @opindex fcond-mismatch
1267 Allow conditional expressions with mismatched types in the second and
1268 third arguments.  The value of such an expression is void.  This option
1269 is not supported for C++.
1270
1271 @item -funsigned-char
1272 @opindex funsigned-char
1273 Let the type @code{char} be unsigned, like @code{unsigned char}.
1274
1275 Each kind of machine has a default for what @code{char} should
1276 be.  It is either like @code{unsigned char} by default or like
1277 @code{signed char} by default.
1278
1279 Ideally, a portable program should always use @code{signed char} or
1280 @code{unsigned char} when it depends on the signedness of an object.
1281 But many programs have been written to use plain @code{char} and
1282 expect it to be signed, or expect it to be unsigned, depending on the
1283 machines they were written for.  This option, and its inverse, let you
1284 make such a program work with the opposite default.
1285
1286 The type @code{char} is always a distinct type from each of
1287 @code{signed char} or @code{unsigned char}, even though its behavior
1288 is always just like one of those two.
1289
1290 @item -fsigned-char
1291 @opindex fsigned-char
1292 Let the type @code{char} be signed, like @code{signed char}.
1293
1294 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1295 the negative form of @option{-funsigned-char}.  Likewise, the option
1296 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1297
1298 @item -fsigned-bitfields
1299 @itemx -funsigned-bitfields
1300 @itemx -fno-signed-bitfields
1301 @itemx -fno-unsigned-bitfields
1302 @opindex fsigned-bitfields
1303 @opindex funsigned-bitfields
1304 @opindex fno-signed-bitfields
1305 @opindex fno-unsigned-bitfields
1306 These options control whether a bit-field is signed or unsigned, when the
1307 declaration does not use either @code{signed} or @code{unsigned}.  By
1308 default, such a bit-field is signed, because this is consistent: the
1309 basic integer types such as @code{int} are signed types.
1310 @end table
1311
1312 @node C++ Dialect Options
1313 @section Options Controlling C++ Dialect
1314
1315 @cindex compiler options, C++
1316 @cindex C++ options, command line
1317 @cindex options, C++
1318 This section describes the command-line options that are only meaningful
1319 for C++ programs; but you can also use most of the GNU compiler options
1320 regardless of what language your program is in.  For example, you
1321 might compile a file @code{firstClass.C} like this:
1322
1323 @smallexample
1324 g++ -g -frepo -O -c firstClass.C
1325 @end smallexample
1326
1327 @noindent
1328 In this example, only @option{-frepo} is an option meant
1329 only for C++ programs; you can use the other options with any
1330 language supported by GCC@.
1331
1332 Here is a list of options that are @emph{only} for compiling C++ programs:
1333
1334 @table @gcctabopt
1335
1336 @item -fabi-version=@var{n}
1337 @opindex fabi-version
1338 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1339 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1340 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1341 the version that conforms most closely to the C++ ABI specification.
1342 Therefore, the ABI obtained using version 0 will change as ABI bugs
1343 are fixed.
1344
1345 The default is version 2.
1346
1347 @item -fno-access-control
1348 @opindex fno-access-control
1349 Turn off all access checking.  This switch is mainly useful for working
1350 around bugs in the access control code.
1351
1352 @item -fcheck-new
1353 @opindex fcheck-new
1354 Check that the pointer returned by @code{operator new} is non-null
1355 before attempting to modify the storage allocated.  This check is
1356 normally unnecessary because the C++ standard specifies that
1357 @code{operator new} will only return @code{0} if it is declared
1358 @samp{throw()}, in which case the compiler will always check the
1359 return value even without this option.  In all other cases, when
1360 @code{operator new} has a non-empty exception specification, memory
1361 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1362 @samp{new (nothrow)}.
1363
1364 @item -fconserve-space
1365 @opindex fconserve-space
1366 Put uninitialized or runtime-initialized global variables into the
1367 common segment, as C does.  This saves space in the executable at the
1368 cost of not diagnosing duplicate definitions.  If you compile with this
1369 flag and your program mysteriously crashes after @code{main()} has
1370 completed, you may have an object that is being destroyed twice because
1371 two definitions were merged.
1372
1373 This option is no longer useful on most targets, now that support has
1374 been added for putting variables into BSS without making them common.
1375
1376 @item -fno-const-strings
1377 @opindex fno-const-strings
1378 Give string constants type @code{char *} instead of type @code{const
1379 char *}.  By default, G++ uses type @code{const char *} as required by
1380 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1381 actually modify the value of a string constant.
1382
1383 This option might be removed in a future release of G++.  For maximum
1384 portability, you should structure your code so that it works with
1385 string constants that have type @code{const char *}.
1386
1387 @item -fno-elide-constructors
1388 @opindex fno-elide-constructors
1389 The C++ standard allows an implementation to omit creating a temporary
1390 which is only used to initialize another object of the same type.
1391 Specifying this option disables that optimization, and forces G++ to
1392 call the copy constructor in all cases.
1393
1394 @item -fno-enforce-eh-specs
1395 @opindex fno-enforce-eh-specs
1396 Don't check for violation of exception specifications at runtime.  This
1397 option violates the C++ standard, but may be useful for reducing code
1398 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1399 will still optimize based on the exception specifications.
1400
1401 @item -ffor-scope
1402 @itemx -fno-for-scope
1403 @opindex ffor-scope
1404 @opindex fno-for-scope
1405 If @option{-ffor-scope} is specified, the scope of variables declared in
1406 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1407 as specified by the C++ standard.
1408 If @option{-fno-for-scope} is specified, the scope of variables declared in
1409 a @i{for-init-statement} extends to the end of the enclosing scope,
1410 as was the case in old versions of G++, and other (traditional)
1411 implementations of C++.
1412
1413 The default if neither flag is given to follow the standard,
1414 but to allow and give a warning for old-style code that would
1415 otherwise be invalid, or have different behavior.
1416
1417 @item -fno-gnu-keywords
1418 @opindex fno-gnu-keywords
1419 Do not recognize @code{typeof} as a keyword, so that code can use this
1420 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1421 @option{-ansi} implies @option{-fno-gnu-keywords}.
1422
1423 @item -fno-implicit-templates
1424 @opindex fno-implicit-templates
1425 Never emit code for non-inline templates which are instantiated
1426 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1427 @xref{Template Instantiation}, for more information.
1428
1429 @item -fno-implicit-inline-templates
1430 @opindex fno-implicit-inline-templates
1431 Don't emit code for implicit instantiations of inline templates, either.
1432 The default is to handle inlines differently so that compiles with and
1433 without optimization will need the same set of explicit instantiations.
1434
1435 @item -fno-implement-inlines
1436 @opindex fno-implement-inlines
1437 To save space, do not emit out-of-line copies of inline functions
1438 controlled by @samp{#pragma implementation}.  This will cause linker
1439 errors if these functions are not inlined everywhere they are called.
1440
1441 @item -fms-extensions
1442 @opindex fms-extensions
1443 Disable pedantic warnings about constructs used in MFC, such as implicit
1444 int and getting a pointer to member function via non-standard syntax.
1445
1446 @item -fno-nonansi-builtins
1447 @opindex fno-nonansi-builtins
1448 Disable built-in declarations of functions that are not mandated by
1449 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1450 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1451
1452 @item -fno-operator-names
1453 @opindex fno-operator-names
1454 Do not treat the operator name keywords @code{and}, @code{bitand},
1455 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1456 synonyms as keywords.
1457
1458 @item -fno-optional-diags
1459 @opindex fno-optional-diags
1460 Disable diagnostics that the standard says a compiler does not need to
1461 issue.  Currently, the only such diagnostic issued by G++ is the one for
1462 a name having multiple meanings within a class.
1463
1464 @item -fpermissive
1465 @opindex fpermissive
1466 Downgrade some diagnostics about nonconformant code from errors to
1467 warnings.  Thus, using @option{-fpermissive} will allow some
1468 nonconforming code to compile.
1469
1470 @item -frepo
1471 @opindex frepo
1472 Enable automatic template instantiation at link time.  This option also
1473 implies @option{-fno-implicit-templates}.  @xref{Template
1474 Instantiation}, for more information.
1475
1476 @item -fno-rtti
1477 @opindex fno-rtti
1478 Disable generation of information about every class with virtual
1479 functions for use by the C++ runtime type identification features
1480 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1481 of the language, you can save some space by using this flag.  Note that
1482 exception handling uses the same information, but it will generate it as
1483 needed.
1484
1485 @item -fstats
1486 @opindex fstats
1487 Emit statistics about front-end processing at the end of the compilation.
1488 This information is generally only useful to the G++ development team.
1489
1490 @item -ftemplate-depth-@var{n}
1491 @opindex ftemplate-depth
1492 Set the maximum instantiation depth for template classes to @var{n}.
1493 A limit on the template instantiation depth is needed to detect
1494 endless recursions during template class instantiation.  ANSI/ISO C++
1495 conforming programs must not rely on a maximum depth greater than 17.
1496
1497 @item -fno-threadsafe-statics
1498 @opindex fno-threadsafe-statics
1499 Do not emit the extra code to use the routines specified in the C++
1500 ABI for thread-safe initialization of local statics.  You can use this
1501 option to reduce code size slightly in code that doesn't need to be
1502 thread-safe.
1503
1504 @item -fuse-cxa-atexit
1505 @opindex fuse-cxa-atexit
1506 Register destructors for objects with static storage duration with the
1507 @code{__cxa_atexit} function rather than the @code{atexit} function.
1508 This option is required for fully standards-compliant handling of static
1509 destructors, but will only work if your C library supports
1510 @code{__cxa_atexit}.
1511
1512 @item -fvisibility-inlines-hidden
1513 @opindex fvisibility-inlines-hidden
1514 Causes all inlined methods to be marked with
1515 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1516 appear in the export table of a DSO and do not require a PLT indirection
1517 when used within the DSO@.  Enabling this option can have a dramatic effect
1518 on load and link times of a DSO as it massively reduces the size of the
1519 dynamic export table when the library makes heavy use of templates.  While
1520 it can cause bloating through duplication of code within each DSO where
1521 it is used, often the wastage is less than the considerable space occupied
1522 by a long symbol name in the export table which is typical when using
1523 templates and namespaces.  For even more savings, combine with the
1524 @option{-fvisibility=hidden} switch.
1525
1526 @item -fno-weak
1527 @opindex fno-weak
1528 Do not use weak symbol support, even if it is provided by the linker.
1529 By default, G++ will use weak symbols if they are available.  This
1530 option exists only for testing, and should not be used by end-users;
1531 it will result in inferior code and has no benefits.  This option may
1532 be removed in a future release of G++.
1533
1534 @item -nostdinc++
1535 @opindex nostdinc++
1536 Do not search for header files in the standard directories specific to
1537 C++, but do still search the other standard directories.  (This option
1538 is used when building the C++ library.)
1539 @end table
1540
1541 In addition, these optimization, warning, and code generation options
1542 have meanings only for C++ programs:
1543
1544 @table @gcctabopt
1545 @item -fno-default-inline
1546 @opindex fno-default-inline
1547 Do not assume @samp{inline} for functions defined inside a class scope.
1548 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1549 functions will have linkage like inline functions; they just won't be
1550 inlined by default.
1551
1552 @item -Wabi @r{(C++ only)}
1553 @opindex Wabi
1554 Warn when G++ generates code that is probably not compatible with the
1555 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1556 all such cases, there are probably some cases that are not warned about,
1557 even though G++ is generating incompatible code.  There may also be
1558 cases where warnings are emitted even though the code that is generated
1559 will be compatible.
1560
1561 You should rewrite your code to avoid these warnings if you are
1562 concerned about the fact that code generated by G++ may not be binary
1563 compatible with code generated by other compilers.
1564
1565 The known incompatibilities at this point include:
1566
1567 @itemize @bullet
1568
1569 @item
1570 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1571 pack data into the same byte as a base class.  For example:
1572
1573 @smallexample
1574 struct A @{ virtual void f(); int f1 : 1; @};
1575 struct B : public A @{ int f2 : 1; @};
1576 @end smallexample
1577
1578 @noindent
1579 In this case, G++ will place @code{B::f2} into the same byte
1580 as@code{A::f1}; other compilers will not.  You can avoid this problem
1581 by explicitly padding @code{A} so that its size is a multiple of the
1582 byte size on your platform; that will cause G++ and other compilers to
1583 layout @code{B} identically.
1584
1585 @item
1586 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1587 tail padding when laying out virtual bases.  For example:
1588
1589 @smallexample
1590 struct A @{ virtual void f(); char c1; @};
1591 struct B @{ B(); char c2; @};
1592 struct C : public A, public virtual B @{@};
1593 @end smallexample
1594
1595 @noindent
1596 In this case, G++ will not place @code{B} into the tail-padding for
1597 @code{A}; other compilers will.  You can avoid this problem by
1598 explicitly padding @code{A} so that its size is a multiple of its
1599 alignment (ignoring virtual base classes); that will cause G++ and other
1600 compilers to layout @code{C} identically.
1601
1602 @item
1603 Incorrect handling of bit-fields with declared widths greater than that
1604 of their underlying types, when the bit-fields appear in a union.  For
1605 example:
1606
1607 @smallexample
1608 union U @{ int i : 4096; @};
1609 @end smallexample
1610
1611 @noindent
1612 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1613 union too small by the number of bits in an @code{int}.
1614
1615 @item
1616 Empty classes can be placed at incorrect offsets.  For example:
1617
1618 @smallexample
1619 struct A @{@};
1620
1621 struct B @{
1622   A a;
1623   virtual void f ();
1624 @};
1625
1626 struct C : public B, public A @{@};
1627 @end smallexample
1628
1629 @noindent
1630 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1631 it should be placed at offset zero.  G++ mistakenly believes that the
1632 @code{A} data member of @code{B} is already at offset zero.
1633
1634 @item
1635 Names of template functions whose types involve @code{typename} or
1636 template template parameters can be mangled incorrectly.
1637
1638 @smallexample
1639 template <typename Q>
1640 void f(typename Q::X) @{@}
1641
1642 template <template <typename> class Q>
1643 void f(typename Q<int>::X) @{@}
1644 @end smallexample
1645
1646 @noindent
1647 Instantiations of these templates may be mangled incorrectly.
1648
1649 @end itemize
1650
1651 @item -Wctor-dtor-privacy @r{(C++ only)}
1652 @opindex Wctor-dtor-privacy
1653 Warn when a class seems unusable because all the constructors or
1654 destructors in that class are private, and it has neither friends nor
1655 public static member functions.
1656
1657 @item -Wnon-virtual-dtor @r{(C++ only)}
1658 @opindex Wnon-virtual-dtor
1659 Warn when a class appears to be polymorphic, thereby requiring a virtual
1660 destructor, yet it declares a non-virtual one.
1661 This warning is enabled by @option{-Wall}.
1662
1663 @item -Wreorder @r{(C++ only)}
1664 @opindex Wreorder
1665 @cindex reordering, warning
1666 @cindex warning for reordering of member initializers
1667 Warn when the order of member initializers given in the code does not
1668 match the order in which they must be executed.  For instance:
1669
1670 @smallexample
1671 struct A @{
1672   int i;
1673   int j;
1674   A(): j (0), i (1) @{ @}
1675 @};
1676 @end smallexample
1677
1678 The compiler will rearrange the member initializers for @samp{i}
1679 and @samp{j} to match the declaration order of the members, emitting
1680 a warning to that effect.  This warning is enabled by @option{-Wall}.
1681 @end table
1682
1683 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1684
1685 @table @gcctabopt
1686 @item -Weffc++ @r{(C++ only)}
1687 @opindex Weffc++
1688 Warn about violations of the following style guidelines from Scott Meyers'
1689 @cite{Effective C++} book:
1690
1691 @itemize @bullet
1692 @item
1693 Item 11:  Define a copy constructor and an assignment operator for classes
1694 with dynamically allocated memory.
1695
1696 @item
1697 Item 12:  Prefer initialization to assignment in constructors.
1698
1699 @item
1700 Item 14:  Make destructors virtual in base classes.
1701
1702 @item
1703 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1704
1705 @item
1706 Item 23:  Don't try to return a reference when you must return an object.
1707
1708 @end itemize
1709
1710 Also warn about violations of the following style guidelines from
1711 Scott Meyers' @cite{More Effective C++} book:
1712
1713 @itemize @bullet
1714 @item
1715 Item 6:  Distinguish between prefix and postfix forms of increment and
1716 decrement operators.
1717
1718 @item
1719 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1720
1721 @end itemize
1722
1723 When selecting this option, be aware that the standard library
1724 headers do not obey all of these guidelines; use @samp{grep -v}
1725 to filter out those warnings.
1726
1727 @item -Wno-deprecated @r{(C++ only)}
1728 @opindex Wno-deprecated
1729 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1730
1731 @item -Wno-non-template-friend @r{(C++ only)}
1732 @opindex Wno-non-template-friend
1733 Disable warnings when non-templatized friend functions are declared
1734 within a template.  Since the advent of explicit template specification
1735 support in G++, if the name of the friend is an unqualified-id (i.e.,
1736 @samp{friend foo(int)}), the C++ language specification demands that the
1737 friend declare or define an ordinary, nontemplate function.  (Section
1738 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1739 could be interpreted as a particular specialization of a templatized
1740 function.  Because this non-conforming behavior is no longer the default
1741 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1742 check existing code for potential trouble spots and is on by default.
1743 This new compiler behavior can be turned off with
1744 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1745 but disables the helpful warning.
1746
1747 @item -Wold-style-cast @r{(C++ only)}
1748 @opindex Wold-style-cast
1749 Warn if an old-style (C-style) cast to a non-void type is used within
1750 a C++ program.  The new-style casts (@samp{static_cast},
1751 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1752 unintended effects and much easier to search for.
1753
1754 @item -Woverloaded-virtual @r{(C++ only)}
1755 @opindex Woverloaded-virtual
1756 @cindex overloaded virtual fn, warning
1757 @cindex warning for overloaded virtual fn
1758 Warn when a function declaration hides virtual functions from a
1759 base class.  For example, in:
1760
1761 @smallexample
1762 struct A @{
1763   virtual void f();
1764 @};
1765
1766 struct B: public A @{
1767   void f(int);
1768 @};
1769 @end smallexample
1770
1771 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1772 like:
1773
1774 @smallexample
1775 B* b;
1776 b->f();
1777 @end smallexample
1778
1779 will fail to compile.
1780
1781 @item -Wno-pmf-conversions @r{(C++ only)}
1782 @opindex Wno-pmf-conversions
1783 Disable the diagnostic for converting a bound pointer to member function
1784 to a plain pointer.
1785
1786 @item -Wsign-promo @r{(C++ only)}
1787 @opindex Wsign-promo
1788 Warn when overload resolution chooses a promotion from unsigned or
1789 enumerated type to a signed type, over a conversion to an unsigned type of
1790 the same size.  Previous versions of G++ would try to preserve
1791 unsignedness, but the standard mandates the current behavior.
1792
1793 @item -Wsynth @r{(C++ only)}
1794 @opindex Wsynth
1795 @cindex warning for synthesized methods
1796 @cindex synthesized methods, warning
1797 Warn when G++'s synthesis behavior does not match that of cfront.  For
1798 instance:
1799
1800 @smallexample
1801 struct A @{
1802   operator int ();
1803   A& operator = (int);
1804 @};
1805
1806 main ()
1807 @{
1808   A a,b;
1809   a = b;
1810 @}
1811 @end smallexample
1812
1813 In this example, G++ will synthesize a default @samp{A& operator =
1814 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1815 @end table
1816
1817 @node Objective-C and Objective-C++ Dialect Options
1818 @section Options Controlling Objective-C and Objective-C++ Dialects
1819
1820 @cindex compiler options, Objective-C and Objective-C++
1821 @cindex Objective-C and Objective-C++ options, command line
1822 @cindex options, Objective-C and Objective-C++
1823 (NOTE: This manual does not describe the Objective-C and Objective-C++
1824 languages themselves.  See @xref{Standards,,Language Standards
1825 Supported by GCC}, for references.)
1826
1827 This section describes the command-line options that are only meaningful
1828 for Objective-C and Objective-C++ programs, but you can also use most of
1829 the language-independent GNU compiler options.
1830 For example, you might compile a file @code{some_class.m} like this:
1831
1832 @smallexample
1833 gcc -g -fgnu-runtime -O -c some_class.m
1834 @end smallexample
1835
1836 @noindent
1837 In this example, @option{-fgnu-runtime} is an option meant only for
1838 Objective-C and Objective-C++ programs; you can use the other options with
1839 any language supported by GCC@.
1840
1841 Note that since Objective-C is an extension of the C language, Objective-C
1842 compilations may also use options specific to the C front-end (e.g.,
1843 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1844 C++-specific options (e.g., @option{-Wabi}).
1845
1846 Here is a list of options that are @emph{only} for compiling Objective-C
1847 and Objective-C++ programs:
1848
1849 @table @gcctabopt
1850 @item -fconstant-string-class=@var{class-name}
1851 @opindex fconstant-string-class
1852 Use @var{class-name} as the name of the class to instantiate for each
1853 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1854 class name is @code{NXConstantString} if the GNU runtime is being used, and
1855 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1856 @option{-fconstant-cfstrings} option, if also present, will override the
1857 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1858 to be laid out as constant CoreFoundation strings.
1859
1860 @item -fgnu-runtime
1861 @opindex fgnu-runtime
1862 Generate object code compatible with the standard GNU Objective-C
1863 runtime.  This is the default for most types of systems.
1864
1865 @item -fnext-runtime
1866 @opindex fnext-runtime
1867 Generate output compatible with the NeXT runtime.  This is the default
1868 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1869 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1870 used.
1871
1872 @item -fno-nil-receivers
1873 @opindex fno-nil-receivers
1874 Assume that all Objective-C message dispatches (e.g.,
1875 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1876 is not @code{nil}.  This allows for more efficient entry points in the runtime
1877 to be used.  Currently, this option is only available in conjunction with
1878 the NeXT runtime on Mac OS X 10.3 and later.
1879
1880 @item -fobjc-exceptions
1881 @opindex fobjc-exceptions
1882 Enable syntactic support for structured exception handling in Objective-C,
1883 similar to what is offered by C++ and Java.  Currently, this option is only
1884 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1885
1886 @smallexample
1887   @@try @{
1888     @dots{}
1889        @@throw expr;
1890     @dots{}
1891   @}
1892   @@catch (AnObjCClass *exc) @{
1893     @dots{}
1894       @@throw expr;
1895     @dots{}
1896       @@throw;
1897     @dots{}
1898   @}
1899   @@catch (AnotherClass *exc) @{
1900     @dots{}
1901   @}
1902   @@catch (id allOthers) @{
1903     @dots{}
1904   @}
1905   @@finally @{
1906     @dots{}
1907       @@throw expr;
1908     @dots{}
1909   @}
1910 @end smallexample
1911
1912 The @code{@@throw} statement may appear anywhere in an Objective-C or
1913 Objective-C++ program; when used inside of a @code{@@catch} block, the
1914 @code{@@throw} may appear without an argument (as shown above), in which case
1915 the object caught by the @code{@@catch} will be rethrown.
1916
1917 Note that only (pointers to) Objective-C objects may be thrown and
1918 caught using this scheme.  When an object is thrown, it will be caught
1919 by the nearest @code{@@catch} clause capable of handling objects of that type,
1920 analogously to how @code{catch} blocks work in C++ and Java.  A
1921 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1922 any and all Objective-C exceptions not caught by previous @code{@@catch}
1923 clauses (if any).
1924
1925 The @code{@@finally} clause, if present, will be executed upon exit from the
1926 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1927 regardless of whether any exceptions are thrown, caught or rethrown
1928 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1929 of the @code{finally} clause in Java.
1930
1931 There are several caveats to using the new exception mechanism:
1932
1933 @itemize @bullet
1934 @item
1935 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1936 idioms provided by the @code{NSException} class, the new
1937 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1938 systems, due to additional functionality needed in the (NeXT) Objective-C
1939 runtime.
1940
1941 @item
1942 As mentioned above, the new exceptions do not support handling
1943 types other than Objective-C objects.   Furthermore, when used from
1944 Objective-C++, the Objective-C exception model does not interoperate with C++
1945 exceptions at this time.  This means you cannot @code{@@throw} an exception
1946 from Objective-C and @code{catch} it in C++, or vice versa
1947 (i.e., @code{throw @dots{} @@catch}).
1948 @end itemize
1949
1950 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1951 blocks for thread-safe execution:
1952
1953 @smallexample
1954   @@synchronized (ObjCClass *guard) @{
1955     @dots{}
1956   @}
1957 @end smallexample
1958
1959 Upon entering the @code{@@synchronized} block, a thread of execution shall
1960 first check whether a lock has been placed on the corresponding @code{guard}
1961 object by another thread.  If it has, the current thread shall wait until
1962 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1963 the current thread will place its own lock on it, execute the code contained in
1964 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1965 making @code{guard} available to other threads).
1966
1967 Unlike Java, Objective-C does not allow for entire methods to be marked
1968 @code{@@synchronized}.  Note that throwing exceptions out of
1969 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1970 to be unlocked properly.
1971
1972 @item -freplace-objc-classes
1973 @opindex freplace-objc-classes
1974 Emit a special marker instructing @command{ld(1)} not to statically link in
1975 the resulting object file, and allow @command{dyld(1)} to load it in at
1976 run time instead.  This is used in conjunction with the Fix-and-Continue
1977 debugging mode, where the object file in question may be recompiled and
1978 dynamically reloaded in the course of program execution, without the need
1979 to restart the program itself.  Currently, Fix-and-Continue functionality
1980 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1981 and later.
1982
1983 @item -fzero-link
1984 @opindex fzero-link
1985 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1986 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1987 compile time) with static class references that get initialized at load time,
1988 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1989 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1990 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1991 for individual class implementations to be modified during program execution.
1992
1993 @item -gen-decls
1994 @opindex gen-decls
1995 Dump interface declarations for all classes seen in the source file to a
1996 file named @file{@var{sourcename}.decl}.
1997
1998 @item -Wno-protocol
1999 @opindex Wno-protocol
2000 If a class is declared to implement a protocol, a warning is issued for
2001 every method in the protocol that is not implemented by the class.  The
2002 default behavior is to issue a warning for every method not explicitly
2003 implemented in the class, even if a method implementation is inherited
2004 from the superclass.  If you use the @option{-Wno-protocol} option, then
2005 methods inherited from the superclass are considered to be implemented,
2006 and no warning is issued for them.
2007
2008 @item -Wselector
2009 @opindex Wselector
2010 Warn if multiple methods of different types for the same selector are
2011 found during compilation.  The check is performed on the list of methods
2012 in the final stage of compilation.  Additionally, a check is performed
2013 for each selector appearing in a @code{@@selector(@dots{})}
2014 expression, and a corresponding method for that selector has been found
2015 during compilation.  Because these checks scan the method table only at
2016 the end of compilation, these warnings are not produced if the final
2017 stage of compilation is not reached, for example because an error is
2018 found during compilation, or because the @option{-fsyntax-only} option is
2019 being used.
2020
2021 @item -Wundeclared-selector
2022 @opindex Wundeclared-selector
2023 Warn if a @code{@@selector(@dots{})} expression referring to an
2024 undeclared selector is found.  A selector is considered undeclared if no
2025 method with that name has been declared before the
2026 @code{@@selector(@dots{})} expression, either explicitly in an
2027 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2028 an @code{@@implementation} section.  This option always performs its
2029 checks as soon as a @code{@@selector(@dots{})} expression is found,
2030 while @option{-Wselector} only performs its checks in the final stage of
2031 compilation.  This also enforces the coding style convention
2032 that methods and selectors must be declared before being used.
2033
2034 @item -print-objc-runtime-info
2035 @opindex print-objc-runtime-info
2036 Generate C header describing the largest structure that is passed by
2037 value, if any.
2038
2039 @end table
2040
2041 @node Language Independent Options
2042 @section Options to Control Diagnostic Messages Formatting
2043 @cindex options to control diagnostics formatting
2044 @cindex diagnostic messages
2045 @cindex message formatting
2046
2047 Traditionally, diagnostic messages have been formatted irrespective of
2048 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2049 below can be used to control the diagnostic messages formatting
2050 algorithm, e.g.@: how many characters per line, how often source location
2051 information should be reported.  Right now, only the C++ front end can
2052 honor these options.  However it is expected, in the near future, that
2053 the remaining front ends would be able to digest them correctly.
2054
2055 @table @gcctabopt
2056 @item -fmessage-length=@var{n}
2057 @opindex fmessage-length
2058 Try to format error messages so that they fit on lines of about @var{n}
2059 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2060 the front ends supported by GCC@.  If @var{n} is zero, then no
2061 line-wrapping will be done; each error message will appear on a single
2062 line.
2063
2064 @opindex fdiagnostics-show-location
2065 @item -fdiagnostics-show-location=once
2066 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2067 reporter to emit @emph{once} source location information; that is, in
2068 case the message is too long to fit on a single physical line and has to
2069 be wrapped, the source location won't be emitted (as prefix) again,
2070 over and over, in subsequent continuation lines.  This is the default
2071 behavior.
2072
2073 @item -fdiagnostics-show-location=every-line
2074 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2075 messages reporter to emit the same source location information (as
2076 prefix) for physical lines that result from the process of breaking
2077 a message which is too long to fit on a single line.
2078
2079 @end table
2080
2081 @node Warning Options
2082 @section Options to Request or Suppress Warnings
2083 @cindex options to control warnings
2084 @cindex warning messages
2085 @cindex messages, warning
2086 @cindex suppressing warnings
2087
2088 Warnings are diagnostic messages that report constructions which
2089 are not inherently erroneous but which are risky or suggest there
2090 may have been an error.
2091
2092 You can request many specific warnings with options beginning @samp{-W},
2093 for example @option{-Wimplicit} to request warnings on implicit
2094 declarations.  Each of these specific warning options also has a
2095 negative form beginning @samp{-Wno-} to turn off warnings;
2096 for example, @option{-Wno-implicit}.  This manual lists only one of the
2097 two forms, whichever is not the default.
2098
2099 The following options control the amount and kinds of warnings produced
2100 by GCC; for further, language-specific options also refer to
2101 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2102 Options}.
2103
2104 @table @gcctabopt
2105 @cindex syntax checking
2106 @item -fsyntax-only
2107 @opindex fsyntax-only
2108 Check the code for syntax errors, but don't do anything beyond that.
2109
2110 @item -pedantic
2111 @opindex pedantic
2112 Issue all the warnings demanded by strict ISO C and ISO C++;
2113 reject all programs that use forbidden extensions, and some other
2114 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2115 version of the ISO C standard specified by any @option{-std} option used.
2116
2117 Valid ISO C and ISO C++ programs should compile properly with or without
2118 this option (though a rare few will require @option{-ansi} or a
2119 @option{-std} option specifying the required version of ISO C)@.  However,
2120 without this option, certain GNU extensions and traditional C and C++
2121 features are supported as well.  With this option, they are rejected.
2122
2123 @option{-pedantic} does not cause warning messages for use of the
2124 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2125 warnings are also disabled in the expression that follows
2126 @code{__extension__}.  However, only system header files should use
2127 these escape routes; application programs should avoid them.
2128 @xref{Alternate Keywords}.
2129
2130 Some users try to use @option{-pedantic} to check programs for strict ISO
2131 C conformance.  They soon find that it does not do quite what they want:
2132 it finds some non-ISO practices, but not all---only those for which
2133 ISO C @emph{requires} a diagnostic, and some others for which
2134 diagnostics have been added.
2135
2136 A feature to report any failure to conform to ISO C might be useful in
2137 some instances, but would require considerable additional work and would
2138 be quite different from @option{-pedantic}.  We don't have plans to
2139 support such a feature in the near future.
2140
2141 Where the standard specified with @option{-std} represents a GNU
2142 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2143 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2144 extended dialect is based.  Warnings from @option{-pedantic} are given
2145 where they are required by the base standard.  (It would not make sense
2146 for such warnings to be given only for features not in the specified GNU
2147 C dialect, since by definition the GNU dialects of C include all
2148 features the compiler supports with the given option, and there would be
2149 nothing to warn about.)
2150
2151 @item -pedantic-errors
2152 @opindex pedantic-errors
2153 Like @option{-pedantic}, except that errors are produced rather than
2154 warnings.
2155
2156 @item -w
2157 @opindex w
2158 Inhibit all warning messages.
2159
2160 @item -Wno-import
2161 @opindex Wno-import
2162 Inhibit warning messages about the use of @samp{#import}.
2163
2164 @item -Wchar-subscripts
2165 @opindex Wchar-subscripts
2166 Warn if an array subscript has type @code{char}.  This is a common cause
2167 of error, as programmers often forget that this type is signed on some
2168 machines.
2169
2170 @item -Wcomment
2171 @opindex Wcomment
2172 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2173 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2174
2175 @item -Wfatal-errors
2176 @opindex Wfatal-errors
2177 This option causes the compiler to abort compilation on the first error
2178 occurred rather than trying to keep going and printing further error
2179 messages.
2180
2181 @item -Wformat
2182 @opindex Wformat
2183 @opindex ffreestanding
2184 @opindex fno-builtin
2185 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2186 the arguments supplied have types appropriate to the format string
2187 specified, and that the conversions specified in the format string make
2188 sense.  This includes standard functions, and others specified by format
2189 attributes (@pxref{Function Attributes}), in the @code{printf},
2190 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2191 not in the C standard) families (or other target-specific families).
2192 Which functions are checked without format attributes having been
2193 specified depends on the standard version selected, and such checks of
2194 functions without the attribute specified are disabled by
2195 @option{-ffreestanding} or @option{-fno-builtin}.
2196
2197 The formats are checked against the format features supported by GNU
2198 libc version 2.2.  These include all ISO C90 and C99 features, as well
2199 as features from the Single Unix Specification and some BSD and GNU
2200 extensions.  Other library implementations may not support all these
2201 features; GCC does not support warning about features that go beyond a
2202 particular library's limitations.  However, if @option{-pedantic} is used
2203 with @option{-Wformat}, warnings will be given about format features not
2204 in the selected standard version (but not for @code{strfmon} formats,
2205 since those are not in any version of the C standard).  @xref{C Dialect
2206 Options,,Options Controlling C Dialect}.
2207
2208 Since @option{-Wformat} also checks for null format arguments for
2209 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2210
2211 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2212 aspects of format checking, the options @option{-Wformat-y2k},
2213 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2214 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2215 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2216
2217 @item -Wformat-y2k
2218 @opindex Wformat-y2k
2219 If @option{-Wformat} is specified, also warn about @code{strftime}
2220 formats which may yield only a two-digit year.
2221
2222 @item -Wno-format-extra-args
2223 @opindex Wno-format-extra-args
2224 If @option{-Wformat} is specified, do not warn about excess arguments to a
2225 @code{printf} or @code{scanf} format function.  The C standard specifies
2226 that such arguments are ignored.
2227
2228 Where the unused arguments lie between used arguments that are
2229 specified with @samp{$} operand number specifications, normally
2230 warnings are still given, since the implementation could not know what
2231 type to pass to @code{va_arg} to skip the unused arguments.  However,
2232 in the case of @code{scanf} formats, this option will suppress the
2233 warning if the unused arguments are all pointers, since the Single
2234 Unix Specification says that such unused arguments are allowed.
2235
2236 @item -Wno-format-zero-length
2237 @opindex Wno-format-zero-length
2238 If @option{-Wformat} is specified, do not warn about zero-length formats.
2239 The C standard specifies that zero-length formats are allowed.
2240
2241 @item -Wformat-nonliteral
2242 @opindex Wformat-nonliteral
2243 If @option{-Wformat} is specified, also warn if the format string is not a
2244 string literal and so cannot be checked, unless the format function
2245 takes its format arguments as a @code{va_list}.
2246
2247 @item -Wformat-security
2248 @opindex Wformat-security
2249 If @option{-Wformat} is specified, also warn about uses of format
2250 functions that represent possible security problems.  At present, this
2251 warns about calls to @code{printf} and @code{scanf} functions where the
2252 format string is not a string literal and there are no format arguments,
2253 as in @code{printf (foo);}.  This may be a security hole if the format
2254 string came from untrusted input and contains @samp{%n}.  (This is
2255 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2256 in future warnings may be added to @option{-Wformat-security} that are not
2257 included in @option{-Wformat-nonliteral}.)
2258
2259 @item -Wformat=2
2260 @opindex Wformat=2
2261 Enable @option{-Wformat} plus format checks not included in
2262 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2263 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2264
2265 @item -Wnonnull
2266 @opindex Wnonnull
2267 Warn about passing a null pointer for arguments marked as
2268 requiring a non-null value by the @code{nonnull} function attribute.
2269
2270 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2271 can be disabled with the @option{-Wno-nonnull} option.
2272
2273 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2274 @opindex Winit-self
2275 Warn about uninitialized variables which are initialized with themselves.
2276 Note this option can only be used with the @option{-Wuninitialized} option,
2277 which in turn only works with @option{-O1} and above.
2278
2279 For example, GCC will warn about @code{i} being uninitialized in the
2280 following snippet only when @option{-Winit-self} has been specified:
2281 @smallexample
2282 @group
2283 int f()
2284 @{
2285   int i = i;
2286   return i;
2287 @}
2288 @end group
2289 @end smallexample
2290
2291 @item -Wimplicit-int
2292 @opindex Wimplicit-int
2293 Warn when a declaration does not specify a type.
2294
2295 @item -Wimplicit-function-declaration
2296 @itemx -Werror-implicit-function-declaration
2297 @opindex Wimplicit-function-declaration
2298 @opindex Werror-implicit-function-declaration
2299 Give a warning (or error) whenever a function is used before being
2300 declared.  The form @option{-Wno-error-implicit-function-declaration}
2301 is not supported.
2302
2303 @item -Wimplicit
2304 @opindex Wimplicit
2305 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2306
2307 @item -Wmain
2308 @opindex Wmain
2309 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2310 function with external linkage, returning int, taking either zero
2311 arguments, two, or three arguments of appropriate types.
2312
2313 @item -Wmissing-braces
2314 @opindex Wmissing-braces
2315 Warn if an aggregate or union initializer is not fully bracketed.  In
2316 the following example, the initializer for @samp{a} is not fully
2317 bracketed, but that for @samp{b} is fully bracketed.
2318
2319 @smallexample
2320 int a[2][2] = @{ 0, 1, 2, 3 @};
2321 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2322 @end smallexample
2323
2324 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2325 @opindex Wmissing-include-dirs
2326 Warn if a user-supplied include directory does not exist.
2327
2328 @item -Wparentheses
2329 @opindex Wparentheses
2330 Warn if parentheses are omitted in certain contexts, such
2331 as when there is an assignment in a context where a truth value
2332 is expected, or when operators are nested whose precedence people
2333 often get confused about.  Only the warning for an assignment used as
2334 a truth value is supported when compiling C++; the other warnings are
2335 only supported when compiling C@.
2336
2337 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2338 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2339 interpretation from that of ordinary mathematical notation.
2340
2341 Also warn about constructions where there may be confusion to which
2342 @code{if} statement an @code{else} branch belongs.  Here is an example of
2343 such a case:
2344
2345 @smallexample
2346 @group
2347 @{
2348   if (a)
2349     if (b)
2350       foo ();
2351   else
2352     bar ();
2353 @}
2354 @end group
2355 @end smallexample
2356
2357 In C, every @code{else} branch belongs to the innermost possible @code{if}
2358 statement, which in this example is @code{if (b)}.  This is often not
2359 what the programmer expected, as illustrated in the above example by
2360 indentation the programmer chose.  When there is the potential for this
2361 confusion, GCC will issue a warning when this flag is specified.
2362 To eliminate the warning, add explicit braces around the innermost
2363 @code{if} statement so there is no way the @code{else} could belong to
2364 the enclosing @code{if}.  The resulting code would look like this:
2365
2366 @smallexample
2367 @group
2368 @{
2369   if (a)
2370     @{
2371       if (b)
2372         foo ();
2373       else
2374         bar ();
2375     @}
2376 @}
2377 @end group
2378 @end smallexample
2379
2380 @item -Wsequence-point
2381 @opindex Wsequence-point
2382 Warn about code that may have undefined semantics because of violations
2383 of sequence point rules in the C standard.
2384
2385 The C standard defines the order in which expressions in a C program are
2386 evaluated in terms of @dfn{sequence points}, which represent a partial
2387 ordering between the execution of parts of the program: those executed
2388 before the sequence point, and those executed after it.  These occur
2389 after the evaluation of a full expression (one which is not part of a
2390 larger expression), after the evaluation of the first operand of a
2391 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2392 function is called (but after the evaluation of its arguments and the
2393 expression denoting the called function), and in certain other places.
2394 Other than as expressed by the sequence point rules, the order of
2395 evaluation of subexpressions of an expression is not specified.  All
2396 these rules describe only a partial order rather than a total order,
2397 since, for example, if two functions are called within one expression
2398 with no sequence point between them, the order in which the functions
2399 are called is not specified.  However, the standards committee have
2400 ruled that function calls do not overlap.
2401
2402 It is not specified when between sequence points modifications to the
2403 values of objects take effect.  Programs whose behavior depends on this
2404 have undefined behavior; the C standard specifies that ``Between the
2405 previous and next sequence point an object shall have its stored value
2406 modified at most once by the evaluation of an expression.  Furthermore,
2407 the prior value shall be read only to determine the value to be
2408 stored.''.  If a program breaks these rules, the results on any
2409 particular implementation are entirely unpredictable.
2410
2411 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2412 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2413 diagnosed by this option, and it may give an occasional false positive
2414 result, but in general it has been found fairly effective at detecting
2415 this sort of problem in programs.
2416
2417 The present implementation of this option only works for C programs.  A
2418 future implementation may also work for C++ programs.
2419
2420 The C standard is worded confusingly, therefore there is some debate
2421 over the precise meaning of the sequence point rules in subtle cases.
2422 Links to discussions of the problem, including proposed formal
2423 definitions, may be found on the GCC readings page, at
2424 @w{@uref{http://gcc.gnu.org/readings.html}}.
2425
2426 @item -Wreturn-type
2427 @opindex Wreturn-type
2428 Warn whenever a function is defined with a return-type that defaults to
2429 @code{int}.  Also warn about any @code{return} statement with no
2430 return-value in a function whose return-type is not @code{void}.
2431
2432 For C, also warn if the return type of a function has a type qualifier
2433 such as @code{const}.  Such a type qualifier has no effect, since the
2434 value returned by a function is not an lvalue.  ISO C prohibits
2435 qualified @code{void} return types on function definitions, so such
2436 return types always receive a warning even without this option.
2437
2438 For C++, a function without return type always produces a diagnostic
2439 message, even when @option{-Wno-return-type} is specified.  The only
2440 exceptions are @samp{main} and functions defined in system headers.
2441
2442 @item -Wswitch
2443 @opindex Wswitch
2444 Warn whenever a @code{switch} statement has an index of enumerated type
2445 and lacks a @code{case} for one or more of the named codes of that
2446 enumeration.  (The presence of a @code{default} label prevents this
2447 warning.)  @code{case} labels outside the enumeration range also
2448 provoke warnings when this option is used.
2449
2450 @item -Wswitch-default
2451 @opindex Wswitch-switch
2452 Warn whenever a @code{switch} statement does not have a @code{default}
2453 case.
2454
2455 @item -Wswitch-enum
2456 @opindex Wswitch-enum
2457 Warn whenever a @code{switch} statement has an index of enumerated type
2458 and lacks a @code{case} for one or more of the named codes of that
2459 enumeration.  @code{case} labels outside the enumeration range also
2460 provoke warnings when this option is used.
2461
2462 @item -Wtrigraphs
2463 @opindex Wtrigraphs
2464 Warn if any trigraphs are encountered that might change the meaning of
2465 the program (trigraphs within comments are not warned about).
2466
2467 @item -Wunused-function
2468 @opindex Wunused-function
2469 Warn whenever a static function is declared but not defined or a
2470 non\-inline static function is unused.
2471
2472 @item -Wunused-label
2473 @opindex Wunused-label
2474 Warn whenever a label is declared but not used.
2475
2476 To suppress this warning use the @samp{unused} attribute
2477 (@pxref{Variable Attributes}).
2478
2479 @item -Wunused-parameter
2480 @opindex Wunused-parameter
2481 Warn whenever a function parameter is unused aside from its declaration.
2482
2483 To suppress this warning use the @samp{unused} attribute
2484 (@pxref{Variable Attributes}).
2485
2486 @item -Wunused-variable
2487 @opindex Wunused-variable
2488 Warn whenever a local variable or non-constant static variable is unused
2489 aside from its declaration
2490
2491 To suppress this warning use the @samp{unused} attribute
2492 (@pxref{Variable Attributes}).
2493
2494 @item -Wunused-value
2495 @opindex Wunused-value
2496 Warn whenever a statement computes a result that is explicitly not used.
2497
2498 To suppress this warning cast the expression to @samp{void}.
2499
2500 @item -Wunused
2501 @opindex Wunused
2502 All the above @option{-Wunused} options combined.
2503
2504 In order to get a warning about an unused function parameter, you must
2505 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2506 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2507
2508 @item -Wuninitialized
2509 @opindex Wuninitialized
2510 Warn if an automatic variable is used without first being initialized or
2511 if a variable may be clobbered by a @code{setjmp} call.
2512
2513 These warnings are possible only in optimizing compilation,
2514 because they require data flow information that is computed only
2515 when optimizing.  If you don't specify @option{-O}, you simply won't
2516 get these warnings.
2517
2518 If you want to warn about code which uses the uninitialized value of the
2519 variable in its own initializer, use the @option{-Winit-self} option.
2520
2521 These warnings occur only for variables that are candidates for
2522 register allocation.  Therefore, they do not occur for a variable that
2523 is declared @code{volatile}, or whose address is taken, or whose size
2524 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2525 structures, unions or arrays, even when they are in registers.
2526
2527 Note that there may be no warning about a variable that is used only
2528 to compute a value that itself is never used, because such
2529 computations may be deleted by data flow analysis before the warnings
2530 are printed.
2531
2532 These warnings are made optional because GCC is not smart
2533 enough to see all the reasons why the code might be correct
2534 despite appearing to have an error.  Here is one example of how
2535 this can happen:
2536
2537 @smallexample
2538 @group
2539 @{
2540   int x;
2541   switch (y)
2542     @{
2543     case 1: x = 1;
2544       break;
2545     case 2: x = 4;
2546       break;
2547     case 3: x = 5;
2548     @}
2549   foo (x);
2550 @}
2551 @end group
2552 @end smallexample
2553
2554 @noindent
2555 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2556 always initialized, but GCC doesn't know this.  Here is
2557 another common case:
2558
2559 @smallexample
2560 @{
2561   int save_y;
2562   if (change_y) save_y = y, y = new_y;
2563   @dots{}
2564   if (change_y) y = save_y;
2565 @}
2566 @end smallexample
2567
2568 @noindent
2569 This has no bug because @code{save_y} is used only if it is set.
2570
2571 @cindex @code{longjmp} warnings
2572 This option also warns when a non-volatile automatic variable might be
2573 changed by a call to @code{longjmp}.  These warnings as well are possible
2574 only in optimizing compilation.
2575
2576 The compiler sees only the calls to @code{setjmp}.  It cannot know
2577 where @code{longjmp} will be called; in fact, a signal handler could
2578 call it at any point in the code.  As a result, you may get a warning
2579 even when there is in fact no problem because @code{longjmp} cannot
2580 in fact be called at the place which would cause a problem.
2581
2582 Some spurious warnings can be avoided if you declare all the functions
2583 you use that never return as @code{noreturn}.  @xref{Function
2584 Attributes}.
2585
2586 @item -Wunknown-pragmas
2587 @opindex Wunknown-pragmas
2588 @cindex warning for unknown pragmas
2589 @cindex unknown pragmas, warning
2590 @cindex pragmas, warning of unknown
2591 Warn when a #pragma directive is encountered which is not understood by
2592 GCC@.  If this command line option is used, warnings will even be issued
2593 for unknown pragmas in system header files.  This is not the case if
2594 the warnings were only enabled by the @option{-Wall} command line option.
2595
2596 @item -Wstrict-aliasing
2597 @opindex Wstrict-aliasing
2598 This option is only active when @option{-fstrict-aliasing} is active.
2599 It warns about code which might break the strict aliasing rules that the
2600 compiler is using for optimization.  The warning does not catch all
2601 cases, but does attempt to catch the more common pitfalls.  It is
2602 included in @option{-Wall}.
2603
2604 @item -Wstrict-aliasing=2
2605 @opindex Wstrict-aliasing=2
2606 This option is only active when @option{-fstrict-aliasing} is active.
2607 It warns about all code which might break the strict aliasing rules that the
2608 compiler is using for optimization.  This warning catches all cases, but
2609 it will also give a warning for some ambiguous cases that are safe.
2610
2611 @item -Wall
2612 @opindex Wall
2613 All of the above @samp{-W} options combined.  This enables all the
2614 warnings about constructions that some users consider questionable, and
2615 that are easy to avoid (or modify to prevent the warning), even in
2616 conjunction with macros.  This also enables some language-specific
2617 warnings described in @ref{C++ Dialect Options} and
2618 @ref{Objective-C and Objective-C++ Dialect Options}.
2619 @end table
2620
2621 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2622 Some of them warn about constructions that users generally do not
2623 consider questionable, but which occasionally you might wish to check
2624 for; others warn about constructions that are necessary or hard to avoid
2625 in some cases, and there is no simple way to modify the code to suppress
2626 the warning.
2627
2628 @table @gcctabopt
2629 @item -Wextra
2630 @opindex W
2631 @opindex Wextra
2632 (This option used to be called @option{-W}.  The older name is still
2633 supported, but the newer name is more descriptive.)  Print extra warning
2634 messages for these events:
2635
2636 @itemize @bullet
2637 @item
2638 A function can return either with or without a value.  (Falling
2639 off the end of the function body is considered returning without
2640 a value.)  For example, this function would evoke such a
2641 warning:
2642
2643 @smallexample
2644 @group
2645 foo (a)
2646 @{
2647   if (a > 0)
2648     return a;
2649 @}
2650 @end group
2651 @end smallexample
2652
2653 @item
2654 An expression-statement or the left-hand side of a comma expression
2655 contains no side effects.
2656 To suppress the warning, cast the unused expression to void.
2657 For example, an expression such as @samp{x[i,j]} will cause a warning,
2658 but @samp{x[(void)i,j]} will not.
2659
2660 @item
2661 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2662
2663 @item
2664 Storage-class specifiers like @code{static} are not the first things in
2665 a declaration.  According to the C Standard, this usage is obsolescent.
2666
2667 @item
2668 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2669 arguments.
2670
2671 @item
2672 A comparison between signed and unsigned values could produce an
2673 incorrect result when the signed value is converted to unsigned.
2674 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2675
2676 @item
2677 An aggregate has an initializer which does not initialize all members.
2678 This warning can be independently controlled by
2679 @option{-Wmissing-field-initializers}.
2680
2681 @item
2682 A function parameter is declared without a type specifier in K&R-style
2683 functions:
2684
2685 @smallexample
2686 void foo(bar) @{ @}
2687 @end smallexample
2688
2689 @item
2690 An empty body occurs in an @samp{if} or @samp{else} statement.
2691
2692 @item
2693 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2694 @samp{>}, or @samp{>=}.
2695
2696 @item
2697 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2698
2699 @item
2700 Any of several floating-point events that often indicate errors, such as
2701 overflow, underflow, loss of precision, etc.
2702
2703 @item @r{(C++ only)}
2704 An enumerator and a non-enumerator both appear in a conditional expression.
2705
2706 @item @r{(C++ only)}
2707 A non-static reference or non-static @samp{const} member appears in a
2708 class without constructors.
2709
2710 @item @r{(C++ only)}
2711 Ambiguous virtual bases.
2712
2713 @item @r{(C++ only)}
2714 Subscripting an array which has been declared @samp{register}.
2715
2716 @item @r{(C++ only)}
2717 Taking the address of a variable which has been declared @samp{register}.
2718
2719 @item @r{(C++ only)}
2720 A base class is not initialized in a derived class' copy constructor.
2721 @end itemize
2722
2723 @item -Wno-div-by-zero
2724 @opindex Wno-div-by-zero
2725 @opindex Wdiv-by-zero
2726 Do not warn about compile-time integer division by zero.  Floating point
2727 division by zero is not warned about, as it can be a legitimate way of
2728 obtaining infinities and NaNs.
2729
2730 @item -Wsystem-headers
2731 @opindex Wsystem-headers
2732 @cindex warnings from system headers
2733 @cindex system headers, warnings from
2734 Print warning messages for constructs found in system header files.
2735 Warnings from system headers are normally suppressed, on the assumption
2736 that they usually do not indicate real problems and would only make the
2737 compiler output harder to read.  Using this command line option tells
2738 GCC to emit warnings from system headers as if they occurred in user
2739 code.  However, note that using @option{-Wall} in conjunction with this
2740 option will @emph{not} warn about unknown pragmas in system
2741 headers---for that, @option{-Wunknown-pragmas} must also be used.
2742
2743 @item -Wfloat-equal
2744 @opindex Wfloat-equal
2745 Warn if floating point values are used in equality comparisons.
2746
2747 The idea behind this is that sometimes it is convenient (for the
2748 programmer) to consider floating-point values as approximations to
2749 infinitely precise real numbers.  If you are doing this, then you need
2750 to compute (by analyzing the code, or in some other way) the maximum or
2751 likely maximum error that the computation introduces, and allow for it
2752 when performing comparisons (and when producing output, but that's a
2753 different problem).  In particular, instead of testing for equality, you
2754 would check to see whether the two values have ranges that overlap; and
2755 this is done with the relational operators, so equality comparisons are
2756 probably mistaken.
2757
2758 @item -Wtraditional @r{(C only)}
2759 @opindex Wtraditional
2760 Warn about certain constructs that behave differently in traditional and
2761 ISO C@.  Also warn about ISO C constructs that have no traditional C
2762 equivalent, and/or problematic constructs which should be avoided.
2763
2764 @itemize @bullet
2765 @item
2766 Macro parameters that appear within string literals in the macro body.
2767 In traditional C macro replacement takes place within string literals,
2768 but does not in ISO C@.
2769
2770 @item
2771 In traditional C, some preprocessor directives did not exist.
2772 Traditional preprocessors would only consider a line to be a directive
2773 if the @samp{#} appeared in column 1 on the line.  Therefore
2774 @option{-Wtraditional} warns about directives that traditional C
2775 understands but would ignore because the @samp{#} does not appear as the
2776 first character on the line.  It also suggests you hide directives like
2777 @samp{#pragma} not understood by traditional C by indenting them.  Some
2778 traditional implementations would not recognize @samp{#elif}, so it
2779 suggests avoiding it altogether.
2780
2781 @item
2782 A function-like macro that appears without arguments.
2783
2784 @item
2785 The unary plus operator.
2786
2787 @item
2788 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2789 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2790 constants.)  Note, these suffixes appear in macros defined in the system
2791 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2792 Use of these macros in user code might normally lead to spurious
2793 warnings, however GCC's integrated preprocessor has enough context to
2794 avoid warning in these cases.
2795
2796 @item
2797 A function declared external in one block and then used after the end of
2798 the block.
2799
2800 @item
2801 A @code{switch} statement has an operand of type @code{long}.
2802
2803 @item
2804 A non-@code{static} function declaration follows a @code{static} one.
2805 This construct is not accepted by some traditional C compilers.
2806
2807 @item
2808 The ISO type of an integer constant has a different width or
2809 signedness from its traditional type.  This warning is only issued if
2810 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2811 typically represent bit patterns, are not warned about.
2812
2813 @item
2814 Usage of ISO string concatenation is detected.
2815
2816 @item
2817 Initialization of automatic aggregates.
2818
2819 @item
2820 Identifier conflicts with labels.  Traditional C lacks a separate
2821 namespace for labels.
2822
2823 @item
2824 Initialization of unions.  If the initializer is zero, the warning is
2825 omitted.  This is done under the assumption that the zero initializer in
2826 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2827 initializer warnings and relies on default initialization to zero in the
2828 traditional C case.
2829
2830 @item
2831 Conversions by prototypes between fixed/floating point values and vice
2832 versa.  The absence of these prototypes when compiling with traditional
2833 C would cause serious problems.  This is a subset of the possible
2834 conversion warnings, for the full set use @option{-Wconversion}.
2835
2836 @item
2837 Use of ISO C style function definitions.  This warning intentionally is
2838 @emph{not} issued for prototype declarations or variadic functions
2839 because these ISO C features will appear in your code when using
2840 libiberty's traditional C compatibility macros, @code{PARAMS} and
2841 @code{VPARAMS}.  This warning is also bypassed for nested functions
2842 because that feature is already a GCC extension and thus not relevant to
2843 traditional C compatibility.
2844 @end itemize
2845
2846 @item -Wdeclaration-after-statement @r{(C only)}
2847 @opindex Wdeclaration-after-statement
2848 Warn when a declaration is found after a statement in a block.  This
2849 construct, known from C++, was introduced with ISO C99 and is by default
2850 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2851 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2852
2853 @item -Wundef
2854 @opindex Wundef
2855 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2856
2857 @item -Wendif-labels
2858 @opindex Wendif-labels
2859 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2860
2861 @item -Wshadow
2862 @opindex Wshadow
2863 Warn whenever a local variable shadows another local variable, parameter or
2864 global variable or whenever a built-in function is shadowed.
2865
2866 @item -Wlarger-than-@var{len}
2867 @opindex Wlarger-than
2868 Warn whenever an object of larger than @var{len} bytes is defined.
2869
2870 @item -Wpointer-arith
2871 @opindex Wpointer-arith
2872 Warn about anything that depends on the ``size of'' a function type or
2873 of @code{void}.  GNU C assigns these types a size of 1, for
2874 convenience in calculations with @code{void *} pointers and pointers
2875 to functions.
2876
2877 @item -Wbad-function-cast @r{(C only)}
2878 @opindex Wbad-function-cast
2879 Warn whenever a function call is cast to a non-matching type.
2880 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2881
2882 @item -Wcast-qual
2883 @opindex Wcast-qual
2884 Warn whenever a pointer is cast so as to remove a type qualifier from
2885 the target type.  For example, warn if a @code{const char *} is cast
2886 to an ordinary @code{char *}.
2887
2888 @item -Wcast-align
2889 @opindex Wcast-align
2890 Warn whenever a pointer is cast such that the required alignment of the
2891 target is increased.  For example, warn if a @code{char *} is cast to
2892 an @code{int *} on machines where integers can only be accessed at
2893 two- or four-byte boundaries.
2894
2895 @item -Wwrite-strings
2896 @opindex Wwrite-strings
2897 When compiling C, give string constants the type @code{const
2898 char[@var{length}]} so that
2899 copying the address of one into a non-@code{const} @code{char *}
2900 pointer will get a warning; when compiling C++, warn about the
2901 deprecated conversion from string constants to @code{char *}.
2902 These warnings will help you find at
2903 compile time code that can try to write into a string constant, but
2904 only if you have been very careful about using @code{const} in
2905 declarations and prototypes.  Otherwise, it will just be a nuisance;
2906 this is why we did not make @option{-Wall} request these warnings.
2907
2908 @item -Wconversion
2909 @opindex Wconversion
2910 Warn if a prototype causes a type conversion that is different from what
2911 would happen to the same argument in the absence of a prototype.  This
2912 includes conversions of fixed point to floating and vice versa, and
2913 conversions changing the width or signedness of a fixed point argument
2914 except when the same as the default promotion.
2915
2916 Also, warn if a negative integer constant expression is implicitly
2917 converted to an unsigned type.  For example, warn about the assignment
2918 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2919 casts like @code{(unsigned) -1}.
2920
2921 @item -Wsign-compare
2922 @opindex Wsign-compare
2923 @cindex warning for comparison of signed and unsigned values
2924 @cindex comparison of signed and unsigned values, warning
2925 @cindex signed and unsigned values, comparison warning
2926 Warn when a comparison between signed and unsigned values could produce
2927 an incorrect result when the signed value is converted to unsigned.
2928 This warning is also enabled by @option{-Wextra}; to get the other warnings
2929 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2930
2931 @item -Waggregate-return
2932 @opindex Waggregate-return
2933 Warn if any functions that return structures or unions are defined or
2934 called.  (In languages where you can return an array, this also elicits
2935 a warning.)
2936
2937 @item -Wstrict-prototypes @r{(C only)}
2938 @opindex Wstrict-prototypes
2939 Warn if a function is declared or defined without specifying the
2940 argument types.  (An old-style function definition is permitted without
2941 a warning if preceded by a declaration which specifies the argument
2942 types.)
2943
2944 @item -Wold-style-definition @r{(C only)}
2945 @opindex Wold-style-definition
2946 Warn if an old-style function definition is used.  A warning is given
2947 even if there is a previous prototype.
2948
2949 @item -Wmissing-prototypes @r{(C only)}
2950 @opindex Wmissing-prototypes
2951 Warn if a global function is defined without a previous prototype
2952 declaration.  This warning is issued even if the definition itself
2953 provides a prototype.  The aim is to detect global functions that fail
2954 to be declared in header files.
2955
2956 @item -Wmissing-declarations @r{(C only)}
2957 @opindex Wmissing-declarations
2958 Warn if a global function is defined without a previous declaration.
2959 Do so even if the definition itself provides a prototype.
2960 Use this option to detect global functions that are not declared in
2961 header files.
2962
2963 @item -Wmissing-field-initializers
2964 @opindex Wmissing-field-initializers
2965 @opindex W
2966 @opindex Wextra
2967 Warn if a structure's initializer has some fields missing.  For
2968 example, the following code would cause such a warning, because
2969 @code{x.h} is implicitly zero:
2970
2971 @smallexample
2972 struct s @{ int f, g, h; @};
2973 struct s x = @{ 3, 4 @};
2974 @end smallexample
2975
2976 This option does not warn about designated initializers, so the following
2977 modification would not trigger a warning:
2978
2979 @smallexample
2980 struct s @{ int f, g, h; @};
2981 struct s x = @{ .f = 3, .g = 4 @};
2982 @end smallexample
2983
2984 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2985 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2986
2987 @item -Wmissing-noreturn
2988 @opindex Wmissing-noreturn
2989 Warn about functions which might be candidates for attribute @code{noreturn}.
2990 Note these are only possible candidates, not absolute ones.  Care should
2991 be taken to manually verify functions actually do not ever return before
2992 adding the @code{noreturn} attribute, otherwise subtle code generation
2993 bugs could be introduced.  You will not get a warning for @code{main} in
2994 hosted C environments.
2995
2996 @item -Wmissing-format-attribute
2997 @opindex Wmissing-format-attribute
2998 @opindex Wformat
2999 If @option{-Wformat} is enabled, also warn about functions which might be
3000 candidates for @code{format} attributes.  Note these are only possible
3001 candidates, not absolute ones.  GCC will guess that @code{format}
3002 attributes might be appropriate for any function that calls a function
3003 like @code{vprintf} or @code{vscanf}, but this might not always be the
3004 case, and some functions for which @code{format} attributes are
3005 appropriate may not be detected.  This option has no effect unless
3006 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3007
3008 @item -Wno-multichar
3009 @opindex Wno-multichar
3010 @opindex Wmultichar
3011 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3012 Usually they indicate a typo in the user's code, as they have
3013 implementation-defined values, and should not be used in portable code.
3014
3015 @item -Wno-deprecated-declarations
3016 @opindex Wno-deprecated-declarations
3017 Do not warn about uses of functions, variables, and types marked as
3018 deprecated by using the @code{deprecated} attribute.
3019 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3020 @pxref{Type Attributes}.)
3021
3022 @item -Wpacked
3023 @opindex Wpacked
3024 Warn if a structure is given the packed attribute, but the packed
3025 attribute has no effect on the layout or size of the structure.
3026 Such structures may be mis-aligned for little benefit.  For
3027 instance, in this code, the variable @code{f.x} in @code{struct bar}
3028 will be misaligned even though @code{struct bar} does not itself
3029 have the packed attribute:
3030
3031 @smallexample
3032 @group
3033 struct foo @{
3034   int x;
3035   char a, b, c, d;
3036 @} __attribute__((packed));
3037 struct bar @{
3038   char z;
3039   struct foo f;
3040 @};
3041 @end group
3042 @end smallexample
3043
3044 @item -Wpadded
3045 @opindex Wpadded
3046 Warn if padding is included in a structure, either to align an element
3047 of the structure or to align the whole structure.  Sometimes when this
3048 happens it is possible to rearrange the fields of the structure to
3049 reduce the padding and so make the structure smaller.
3050
3051 @item -Wredundant-decls
3052 @opindex Wredundant-decls
3053 Warn if anything is declared more than once in the same scope, even in
3054 cases where multiple declaration is valid and changes nothing.
3055
3056 @item -Wnested-externs @r{(C only)}
3057 @opindex Wnested-externs
3058 Warn if an @code{extern} declaration is encountered within a function.
3059
3060 @item -Wunreachable-code
3061 @opindex Wunreachable-code
3062 Warn if the compiler detects that code will never be executed.
3063
3064 This option is intended to warn when the compiler detects that at
3065 least a whole line of source code will never be executed, because
3066 some condition is never satisfied or because it is after a
3067 procedure that never returns.
3068
3069 It is possible for this option to produce a warning even though there
3070 are circumstances under which part of the affected line can be executed,
3071 so care should be taken when removing apparently-unreachable code.
3072
3073 For instance, when a function is inlined, a warning may mean that the
3074 line is unreachable in only one inlined copy of the function.
3075
3076 This option is not made part of @option{-Wall} because in a debugging
3077 version of a program there is often substantial code which checks
3078 correct functioning of the program and is, hopefully, unreachable
3079 because the program does work.  Another common use of unreachable
3080 code is to provide behavior which is selectable at compile-time.
3081
3082 @item -Winline
3083 @opindex Winline
3084 Warn if a function can not be inlined and it was declared as inline.
3085 Even with this option, the compiler will not warn about failures to
3086 inline functions declared in system headers.
3087
3088 The compiler uses a variety of heuristics to determine whether or not
3089 to inline a function.  For example, the compiler takes into account
3090 the size of the function being inlined and the the amount of inlining
3091 that has already been done in the current function.  Therefore,
3092 seemingly insignificant changes in the source program can cause the
3093 warnings produced by @option{-Winline} to appear or disappear.
3094
3095 @item -Wno-invalid-offsetof @r{(C++ only)}
3096 @opindex Wno-invalid-offsetof
3097 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3098 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3099 to a non-POD type is undefined.  In existing C++ implementations,
3100 however, @samp{offsetof} typically gives meaningful results even when
3101 applied to certain kinds of non-POD types. (Such as a simple
3102 @samp{struct} that fails to be a POD type only by virtue of having a
3103 constructor.)  This flag is for users who are aware that they are
3104 writing nonportable code and who have deliberately chosen to ignore the
3105 warning about it.
3106
3107 The restrictions on @samp{offsetof} may be relaxed in a future version
3108 of the C++ standard.
3109
3110 @item -Winvalid-pch
3111 @opindex Winvalid-pch
3112 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3113 the search path but can't be used.
3114
3115 @item -Wlong-long
3116 @opindex Wlong-long
3117 @opindex Wno-long-long
3118 Warn if @samp{long long} type is used.  This is default.  To inhibit
3119 the warning messages, use @option{-Wno-long-long}.  Flags
3120 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3121 only when @option{-pedantic} flag is used.
3122
3123 @item -Wvariadic-macros
3124 @opindex Wvariadic-macros
3125 @opindex Wno-variadic-macros
3126 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3127 alternate syntax when in pedantic ISO C99 mode.  This is default.
3128 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3129
3130 @item -Wdisabled-optimization
3131 @opindex Wdisabled-optimization
3132 Warn if a requested optimization pass is disabled.  This warning does
3133 not generally indicate that there is anything wrong with your code; it
3134 merely indicates that GCC's optimizers were unable to handle the code
3135 effectively.  Often, the problem is that your code is too big or too
3136 complex; GCC will refuse to optimize programs when the optimization
3137 itself is likely to take inordinate amounts of time.
3138
3139 @item -Wno-pointer-sign
3140 @opindex Wno-pointer-sign
3141 Don't warn for pointer argument passing or assignment with different signedness.
3142 Only useful in the negative form since this warning is enabled by default.
3143 This option is only supported for C and Objective-C@.
3144
3145 @item -Werror
3146 @opindex Werror
3147 Make all warnings into errors.
3148 @end table
3149
3150 @node Debugging Options
3151 @section Options for Debugging Your Program or GCC
3152 @cindex options, debugging
3153 @cindex debugging information options
3154
3155 GCC has various special options that are used for debugging
3156 either your program or GCC:
3157
3158 @table @gcctabopt
3159 @item -g
3160 @opindex g
3161 Produce debugging information in the operating system's native format
3162 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3163 information.
3164
3165 On most systems that use stabs format, @option{-g} enables use of extra
3166 debugging information that only GDB can use; this extra information
3167 makes debugging work better in GDB but will probably make other debuggers
3168 crash or
3169 refuse to read the program.  If you want to control for certain whether
3170 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3171 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3172
3173 GCC allows you to use @option{-g} with
3174 @option{-O}.  The shortcuts taken by optimized code may occasionally
3175 produce surprising results: some variables you declared may not exist
3176 at all; flow of control may briefly move where you did not expect it;
3177 some statements may not be executed because they compute constant
3178 results or their values were already at hand; some statements may
3179 execute in different places because they were moved out of loops.
3180
3181 Nevertheless it proves possible to debug optimized output.  This makes
3182 it reasonable to use the optimizer for programs that might have bugs.
3183
3184 The following options are useful when GCC is generated with the
3185 capability for more than one debugging format.
3186
3187 @item -ggdb
3188 @opindex ggdb
3189 Produce debugging information for use by GDB@.  This means to use the
3190 most expressive format available (DWARF 2, stabs, or the native format
3191 if neither of those are supported), including GDB extensions if at all
3192 possible.
3193
3194 @item -gstabs
3195 @opindex gstabs
3196 Produce debugging information in stabs format (if that is supported),
3197 without GDB extensions.  This is the format used by DBX on most BSD
3198 systems.  On MIPS, Alpha and System V Release 4 systems this option
3199 produces stabs debugging output which is not understood by DBX or SDB@.
3200 On System V Release 4 systems this option requires the GNU assembler.
3201
3202 @item -feliminate-unused-debug-symbols
3203 @opindex feliminate-unused-debug-symbols
3204 Produce debugging information in stabs format (if that is supported),
3205 for only symbols that are actually used.
3206
3207 @item -gstabs+
3208 @opindex gstabs+
3209 Produce debugging information in stabs format (if that is supported),
3210 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3211 use of these extensions is likely to make other debuggers crash or
3212 refuse to read the program.
3213
3214 @item -gcoff
3215 @opindex gcoff
3216 Produce debugging information in COFF format (if that is supported).
3217 This is the format used by SDB on most System V systems prior to
3218 System V Release 4.
3219
3220 @item -gxcoff
3221 @opindex gxcoff
3222 Produce debugging information in XCOFF format (if that is supported).
3223 This is the format used by the DBX debugger on IBM RS/6000 systems.
3224
3225 @item -gxcoff+
3226 @opindex gxcoff+
3227 Produce debugging information in XCOFF format (if that is supported),
3228 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3229 use of these extensions is likely to make other debuggers crash or
3230 refuse to read the program, and may cause assemblers other than the GNU
3231 assembler (GAS) to fail with an error.
3232
3233 @item -gdwarf-2
3234 @opindex gdwarf-2
3235 Produce debugging information in DWARF version 2 format (if that is
3236 supported).  This is the format used by DBX on IRIX 6.  With this
3237 option, GCC uses features of DWARF version 3 when they are useful;
3238 version 3 is upward compatible with version 2, but may still cause
3239 problems for older debuggers.
3240
3241 @item -gvms
3242 @opindex gvms
3243 Produce debugging information in VMS debug format (if that is
3244 supported).  This is the format used by DEBUG on VMS systems.
3245
3246 @item -g@var{level}
3247 @itemx -ggdb@var{level}
3248 @itemx -gstabs@var{level}
3249 @itemx -gcoff@var{level}
3250 @itemx -gxcoff@var{level}
3251 @itemx -gvms@var{level}
3252 Request debugging information and also use @var{level} to specify how
3253 much information.  The default level is 2.
3254
3255 Level 1 produces minimal information, enough for making backtraces in
3256 parts of the program that you don't plan to debug.  This includes
3257 descriptions of functions and external variables, but no information
3258 about local variables and no line numbers.
3259
3260 Level 3 includes extra information, such as all the macro definitions
3261 present in the program.  Some debuggers support macro expansion when
3262 you use @option{-g3}.
3263
3264 @option{-gdwarf-2} does not accept a concatenated debug level, because
3265 GCC used to support an option @option{-gdwarf} that meant to generate
3266 debug information in version 1 of the DWARF format (which is very
3267 different from version 2), and it would have been too confusing.  That
3268 debug format is long obsolete, but the option cannot be changed now.
3269 Instead use an additional @option{-g@var{level}} option to change the
3270 debug level for DWARF2.
3271
3272 @item -feliminate-dwarf2-dups
3273 @opindex feliminate-dwarf2-dups
3274 Compress DWARF2 debugging information by eliminating duplicated
3275 information about each symbol.  This option only makes sense when
3276 generating DWARF2 debugging information with @option{-gdwarf-2}.
3277
3278 @cindex @command{prof}
3279 @item -p
3280 @opindex p
3281 Generate extra code to write profile information suitable for the
3282 analysis program @command{prof}.  You must use this option when compiling
3283 the source files you want data about, and you must also use it when
3284 linking.
3285
3286 @cindex @command{gprof}
3287 @item -pg
3288 @opindex pg
3289 Generate extra code to write profile information suitable for the
3290 analysis program @command{gprof}.  You must use this option when compiling
3291 the source files you want data about, and you must also use it when
3292 linking.
3293
3294 @item -Q
3295 @opindex Q
3296 Makes the compiler print out each function name as it is compiled, and
3297 print some statistics about each pass when it finishes.
3298
3299 @item -ftime-report
3300 @opindex ftime-report
3301 Makes the compiler print some statistics about the time consumed by each
3302 pass when it finishes.
3303
3304 @item -fmem-report
3305 @opindex fmem-report
3306 Makes the compiler print some statistics about permanent memory
3307 allocation when it finishes.
3308
3309 @item -fprofile-arcs
3310 @opindex fprofile-arcs
3311 Add code so that program flow @dfn{arcs} are instrumented.  During
3312 execution the program records how many times each branch and call is
3313 executed and how many times it is taken or returns.  When the compiled
3314 program exits it saves this data to a file called
3315 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3316 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3317 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3318 @var{auxname} is generated from the name of the output file, if
3319 explicitly specified and it is not the final executable, otherwise it is
3320 the basename of the source file.  In both cases any suffix is removed
3321 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3322 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3323
3324 @itemize
3325
3326 @item
3327 Compile the source files with @option{-fprofile-arcs} plus optimization
3328 and code generation options.  For test coverage analysis, use the
3329 additional @option{-ftest-coverage} option.  You do not need to profile
3330 every source file in a program.
3331
3332 @item
3333 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3334 (the latter implies the former).
3335
3336 @item
3337 Run the program on a representative workload to generate the arc profile
3338 information.  This may be repeated any number of times.  You can run
3339 concurrent instances of your program, and provided that the file system
3340 supports locking, the data files will be correctly updated.  Also
3341 @code{fork} calls are detected and correctly handled (double counting
3342 will not happen).
3343
3344 @item
3345 For profile-directed optimizations, compile the source files again with
3346 the same optimization and code generation options plus
3347 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3348 Control Optimization}).
3349
3350 @item
3351 For test coverage analysis, use @command{gcov} to produce human readable
3352 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3353 @command{gcov} documentation for further information.
3354
3355 @end itemize
3356
3357 With @option{-fprofile-arcs}, for each function of your program GCC
3358 creates a program flow graph, then finds a spanning tree for the graph.
3359 Only arcs that are not on the spanning tree have to be instrumented: the
3360 compiler adds code to count the number of times that these arcs are
3361 executed.  When an arc is the only exit or only entrance to a block, the
3362 instrumentation code can be added to the block; otherwise, a new basic
3363 block must be created to hold the instrumentation code.
3364
3365 @item -ftree-based-profiling
3366 @opindex ftree-based-profiling
3367 This option is used in addition to @option{-fprofile-arcs} or
3368 @option{-fbranch-probabilities} to control whether those optimizations
3369 are performed on a tree-based or rtl-based internal representation.
3370 If you use this option when compiling with @option{-fprofile-arcs},
3371 you must also use it when compiling later with @option{-fbranch-probabilities}.
3372 Currently the tree-based optimization is in an early stage of
3373 development, and this option is recommended only for those people
3374 working on improving it.
3375
3376 @need 2000
3377 @item -ftest-coverage
3378 @opindex ftest-coverage
3379 Produce a notes file that the @command{gcov} code-coverage utility
3380 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3381 show program coverage.  Each source file's note file is called
3382 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3383 above for a description of @var{auxname} and instructions on how to
3384 generate test coverage data.  Coverage data will match the source files
3385 more closely, if you do not optimize.
3386
3387 @item -d@var{letters}
3388 @item -fdump-rtl-@var{pass}
3389 @opindex d
3390 Says to make debugging dumps during compilation at times specified by
3391 @var{letters}.    This is used for debugging the RTL-based passes of the
3392 compiler.  The file names for most of the dumps are made by appending a
3393 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3394 from the name of the output file, if explicitly specified and it is not
3395 an executable, otherwise it is the basename of the source file.
3396
3397 Most debug dumps can be enabled either passing a letter to the @option{-d}
3398 option, or with a long @option{-fdump-rtl} switch; here are the possible
3399 letters for use in @var{letters} and @var{pass}, and their meanings:
3400
3401 @table @gcctabopt
3402 @item -dA
3403 @opindex dA
3404 Annotate the assembler output with miscellaneous debugging information.
3405
3406 @item -db
3407 @itemx -fdump-rtl-bp
3408 @opindex db
3409 @opindex fdump-rtl-bp
3410 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3411
3412 @item -dB
3413 @itemx -fdump-rtl-bbro
3414 @opindex dB
3415 @opindex fdump-rtl-bbro
3416 Dump after block reordering, to @file{@var{file}.30.bbro}.
3417
3418 @item -dc
3419 @itemx -fdump-rtl-combine
3420 @opindex dc
3421 @opindex fdump-rtl-combine
3422 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3423
3424 @item -dC
3425 @itemx -fdump-rtl-ce1
3426 @itemx -fdump-rtl-ce2
3427 @opindex dC
3428 @opindex fdump-rtl-ce1
3429 @opindex fdump-rtl-ce2
3430 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3431 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3432 and @option{-fdump-rtl-ce2} enable dumping after the second if
3433 conversion, to the file @file{@var{file}.18.ce2}.
3434
3435 @item -dd
3436 @itemx -fdump-rtl-btl
3437 @itemx -fdump-rtl-dbr
3438 @opindex dd
3439 @opindex fdump-rtl-btl
3440 @opindex fdump-rtl-dbr
3441 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3442 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3443 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3444 scheduling, to @file{@var{file}.36.dbr}.
3445
3446 @item -dD
3447 @opindex dD
3448 Dump all macro definitions, at the end of preprocessing, in addition to
3449 normal output.
3450
3451 @item -dE
3452 @itemx -fdump-rtl-ce3
3453 @opindex dE
3454 @opindex fdump-rtl-ce3
3455 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3456
3457 @item -df
3458 @itemx -fdump-rtl-cfg
3459 @itemx -fdump-rtl-life
3460 @opindex df
3461 @opindex fdump-rtl-cfg
3462 @opindex fdump-rtl-life
3463 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3464 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3465 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3466 to @file{@var{file}.16.life}.
3467
3468 @item -dg
3469 @itemx -fdump-rtl-greg
3470 @opindex dg
3471 @opindex fdump-rtl-greg
3472 Dump after global register allocation, to @file{@var{file}.23.greg}.
3473
3474 @item -dG
3475 @itemx -fdump-rtl-gcse
3476 @itemx -fdump-rtl-bypass
3477 @opindex dG
3478 @opindex fdump-rtl-gcse
3479 @opindex fdump-rtl-bypass
3480 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3481 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3482 enable dumping after jump bypassing and control flow optimizations, to
3483 @file{@var{file}.07.bypass}.
3484
3485 @item -dh
3486 @itemx -fdump-rtl-eh
3487 @opindex dh
3488 @opindex fdump-rtl-eh
3489 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3490
3491 @item -di
3492 @itemx -fdump-rtl-sibling
3493 @opindex di
3494 @opindex fdump-rtl-sibling
3495 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3496
3497 @item -dj
3498 @itemx -fdump-rtl-jump
3499 @opindex dj
3500 @opindex fdump-rtl-jump
3501 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3502
3503 @item -dk
3504 @itemx -fdump-rtl-stack
3505 @opindex dk
3506 @opindex fdump-rtl-stack
3507 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3508
3509 @item -dl
3510 @itemx -fdump-rtl-lreg
3511 @opindex dl
3512 @opindex fdump-rtl-lreg
3513 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3514
3515 @item -dL
3516 @itemx -fdump-rtl-loop
3517 @itemx -fdump-rtl-loop2
3518 @opindex dL
3519 @opindex fdump-rtl-loop
3520 @opindex fdump-rtl-loop2
3521 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3522 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3523 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3524 @file{@var{file}.13.loop2}.
3525
3526 @item -dm
3527 @itemx -fdump-rtl-sms
3528 @opindex dm
3529 @opindex fdump-rtl-sms
3530 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3531
3532 @item -dM
3533 @itemx -fdump-rtl-mach
3534 @opindex dM
3535 @opindex fdump-rtl-mach
3536 Dump after performing the machine dependent reorganization pass, to
3537 @file{@var{file}.35.mach}.
3538
3539 @item -dn
3540 @itemx -fdump-rtl-rnreg
3541 @opindex dn
3542 @opindex fdump-rtl-rnreg
3543 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3544
3545 @item -dN
3546 @itemx -fdump-rtl-regmove
3547 @opindex dN
3548 @opindex fdump-rtl-regmove
3549 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3550
3551 @item -do
3552 @itemx -fdump-rtl-postreload
3553 @opindex do
3554 @opindex fdump-rtl-postreload
3555 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3556
3557 @item -dr
3558 @itemx -fdump-rtl-expand
3559 @opindex dr
3560 @opindex fdump-rtl-expand
3561 Dump after RTL generation, to @file{@var{file}.00.expand}.
3562
3563 @item -dR
3564 @itemx -fdump-rtl-sched2
3565 @opindex dR
3566 @opindex fdump-rtl-sched2
3567 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3568
3569 @item -ds
3570 @itemx -fdump-rtl-cse
3571 @opindex ds
3572 @opindex fdump-rtl-cse
3573 Dump after CSE (including the jump optimization that sometimes follows
3574 CSE), to @file{@var{file}.04.cse}.
3575
3576 @item -dS
3577 @itemx -fdump-rtl-sched
3578 @opindex dS
3579 @opindex fdump-rtl-sched
3580 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3581
3582 @item -dt
3583 @itemx -fdump-rtl-cse2
3584 @opindex dt
3585 @opindex fdump-rtl-cse2
3586 Dump after the second CSE pass (including the jump optimization that
3587 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3588
3589 @item -dT
3590 @itemx -fdump-rtl-tracer
3591 @opindex dT
3592 @opindex fdump-rtl-tracer
3593 Dump after running tracer, to @file{@var{file}.12.tracer}.
3594
3595 @item -dV
3596 @itemx -fdump-rtl-vpt
3597 @itemx -fdump-rtl-vartrack
3598 @opindex dV
3599 @opindex fdump-rtl-vpt
3600 @opindex fdump-rtl-vartrack
3601 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3602 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3603 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3604 to @file{@var{file}.34.vartrack}.
3605
3606 @item -dw
3607 @itemx -fdump-rtl-flow2
3608 @opindex dw
3609 @opindex fdump-rtl-flow2
3610 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3611
3612 @item -dz
3613 @itemx -fdump-rtl-peephole2
3614 @opindex dz
3615 @opindex fdump-rtl-peephole2
3616 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3617
3618 @item -dZ
3619 @itemx -fdump-rtl-web
3620 @opindex dZ
3621 @opindex fdump-rtl-web
3622 Dump after live range splitting, to @file{@var{file}.14.web}.
3623
3624 @item -da
3625 @itemx -fdump-rtl-all
3626 @opindex da
3627 @opindex fdump-rtl-all
3628 Produce all the dumps listed above.
3629
3630 @item -dH
3631 @opindex dH
3632 Produce a core dump whenever an error occurs.
3633
3634 @item -dm
3635 @opindex dm
3636 Print statistics on memory usage, at the end of the run, to
3637 standard error.
3638
3639 @item -dp
3640 @opindex dp
3641 Annotate the assembler output with a comment indicating which
3642 pattern and alternative was used.  The length of each instruction is
3643 also printed.
3644
3645 @item -dP
3646 @opindex dP
3647 Dump the RTL in the assembler output as a comment before each instruction.
3648 Also turns on @option{-dp} annotation.
3649
3650 @item -dv
3651 @opindex dv
3652 For each of the other indicated dump files (either with @option{-d} or
3653 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3654 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3655
3656 @item -dx
3657 @opindex dx
3658 Just generate RTL for a function instead of compiling it.  Usually used
3659 with @samp{r} (@option{-fdump-rtl-expand}).
3660
3661 @item -dy
3662 @opindex dy
3663 Dump debugging information during parsing, to standard error.
3664 @end table
3665
3666 @item -fdump-unnumbered
3667 @opindex fdump-unnumbered
3668 When doing debugging dumps (see @option{-d} option above), suppress instruction
3669 numbers and line number note output.  This makes it more feasible to
3670 use diff on debugging dumps for compiler invocations with different
3671 options, in particular with and without @option{-g}.
3672
3673 @item -fdump-translation-unit @r{(C and C++ only)}
3674 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3675 @opindex fdump-translation-unit
3676 Dump a representation of the tree structure for the entire translation
3677 unit to a file.  The file name is made by appending @file{.tu} to the
3678 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3679 controls the details of the dump as described for the
3680 @option{-fdump-tree} options.
3681
3682 @item -fdump-class-hierarchy @r{(C++ only)}
3683 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3684 @opindex fdump-class-hierarchy
3685 Dump a representation of each class's hierarchy and virtual function
3686 table layout to a file.  The file name is made by appending @file{.class}
3687 to the source file name.  If the @samp{-@var{options}} form is used,
3688 @var{options} controls the details of the dump as described for the
3689 @option{-fdump-tree} options.
3690
3691 @item -fdump-ipa-@var{switch}
3692 @opindex fdump-ipa
3693 Control the dumping at various stages of inter-procedural analysis
3694 language tree to a file.  The file name is generated by appending a switch
3695 specific suffix to the source file name.  The following dumps are possible:
3696
3697 @table @samp
3698 @item all
3699 Enables all inter-procedural analysis dumps; currently the only produced
3700 dump is the @samp{cgraph} dump.
3701
3702 @item cgraph
3703 Dumps information about call-graph optimization, unused function removal,
3704 and inlining decisions.
3705 @end table
3706
3707 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3708 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3709 @opindex fdump-tree
3710 Control the dumping at various stages of processing the intermediate
3711 language tree to a file.  The file name is generated by appending a switch
3712 specific suffix to the source file name.  If the @samp{-@var{options}}
3713 form is used, @var{options} is a list of @samp{-} separated options that
3714 control the details of the dump.  Not all options are applicable to all
3715 dumps, those which are not meaningful will be ignored.  The following
3716 options are available
3717
3718 @table @samp
3719 @item address
3720 Print the address of each node.  Usually this is not meaningful as it
3721 changes according to the environment and source file.  Its primary use
3722 is for tying up a dump file with a debug environment.
3723 @item slim
3724 Inhibit dumping of members of a scope or body of a function merely
3725 because that scope has been reached.  Only dump such items when they
3726 are directly reachable by some other path.  When dumping pretty-printed
3727 trees, this option inhibits dumping the bodies of control structures.
3728 @item raw
3729 Print a raw representation of the tree.  By default, trees are
3730 pretty-printed into a C-like representation.
3731 @item details
3732 Enable more detailed dumps (not honored by every dump option).
3733 @item stats
3734 Enable dumping various statistics about the pass (not honored by every dump
3735 option).
3736 @item blocks
3737 Enable showing basic block boundaries (disabled in raw dumps).
3738 @item vops
3739 Enable showing virtual operands for every statement.
3740 @item lineno
3741 Enable showing line numbers for statements.
3742 @item uid
3743 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3744 @item all
3745 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3746 @end table
3747
3748 The following tree dumps are possible:
3749 @table @samp
3750
3751 @item original
3752 Dump before any tree based optimization, to @file{@var{file}.original}.
3753
3754 @item optimized
3755 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3756
3757 @item inlined
3758 Dump after function inlining, to @file{@var{file}.inlined}.
3759
3760 @item gimple
3761 @opindex fdump-tree-gimple
3762 Dump each function before and after the gimplification pass to a file.  The
3763 file name is made by appending @file{.gimple} to the source file name.
3764
3765 @item cfg
3766 @opindex fdump-tree-cfg
3767 Dump the control flow graph of each function to a file.  The file name is
3768 made by appending @file{.cfg} to the source file name.
3769
3770 @item vcg
3771 @opindex fdump-tree-vcg
3772 Dump the control flow graph of each function to a file in VCG format.  The
3773 file name is made by appending @file{.vcg} to the source file name.  Note
3774 that if the file contains more than one function, the generated file cannot
3775 be used directly by VCG@.  You will need to cut and paste each function's
3776 graph into its own separate file first.
3777
3778 @item ch
3779 @opindex fdump-tree-ch
3780 Dump each function after copying loop headers.  The file name is made by
3781 appending @file{.ch} to the source file name.
3782
3783 @item ssa
3784 @opindex fdump-tree-ssa
3785 Dump SSA related information to a file.  The file name is made by appending
3786 @file{.ssa} to the source file name.
3787
3788 @item alias
3789 @opindex fdump-tree-alias
3790 Dump aliasing information for each function.  The file name is made by
3791 appending @file{.alias} to the source file name.
3792
3793 @item ccp
3794 @opindex fdump-tree-ccp
3795 Dump each function after CCP@.  The file name is made by appending
3796 @file{.ccp} to the source file name.
3797
3798 @item pre
3799 @opindex fdump-tree-pre
3800 Dump trees after partial redundancy elimination.  The file name is made
3801 by appending @file{.pre} to the source file name.
3802
3803 @item fre
3804 @opindex fdump-tree-fre
3805 Dump trees after full redundancy elimination.  The file name is made
3806 by appending @file{.fre} to the source file name.
3807
3808 @item dce
3809 @opindex fdump-tree-dce
3810 Dump each function after dead code elimination.  The file name is made by
3811 appending @file{.dce} to the source file name.
3812
3813 @item mudflap
3814 @opindex fdump-tree-mudflap
3815 Dump each function after adding mudflap instrumentation.  The file name is
3816 made by appending @file{.mudflap} to the source file name.
3817
3818 @item sra
3819 @opindex fdump-tree-sra
3820 Dump each function after performing scalar replacement of aggregates.  The
3821 file name is made by appending @file{.sra} to the source file name.
3822
3823 @item dom
3824 @opindex fdump-tree-dom
3825 Dump each function after applying dominator tree optimizations.  The file
3826 name is made by appending @file{.dom} to the source file name.
3827
3828 @item dse
3829 @opindex fdump-tree-dse
3830 Dump each function after applying dead store elimination.  The file
3831 name is made by appending @file{.dse} to the source file name.
3832
3833 @item phiopt
3834 @opindex fdump-tree-phiopt
3835 Dump each function after optimizing PHI nodes into straightline code.  The file
3836 name is made by appending @file{.phiopt} to the source file name.
3837
3838 @item forwprop
3839 @opindex fdump-tree-forwprop
3840 Dump each function after forward propagating single use variables.  The file
3841 name is made by appending @file{.forwprop} to the source file name.
3842
3843 @item copyrename
3844 @opindex fdump-tree-copyrename
3845 Dump each function after applying the copy rename optimization.  The file
3846 name is made by appending @file{.copyrename} to the source file name.
3847
3848 @item nrv
3849 @opindex fdump-tree-nrv
3850 Dump each function after applying the named return value optimization on
3851 generic trees.  The file name is made by appending @file{.nrv} to the source
3852 file name.
3853
3854 @item vect
3855 @opindex fdump-tree-vect
3856 Dump each function after applying vectorization of loops.  The file name is
3857 made by appending @file{.vect} to the source file name.
3858
3859 @item all
3860 @opindex fdump-tree-all
3861 Enable all the available tree dumps with the flags provided in this option.
3862 @end table
3863
3864 @item -frandom-seed=@var{string}
3865 @opindex frandom-string
3866 This option provides a seed that GCC uses when it would otherwise use
3867 random numbers.  It is used to generate certain symbol names
3868 that have to be different in every compiled file.  It is also used to
3869 place unique stamps in coverage data files and the object files that
3870 produce them.  You can use the @option{-frandom-seed} option to produce
3871 reproducibly identical object files.
3872
3873 The @var{string} should be different for every file you compile.
3874
3875 @item -fsched-verbose=@var{n}
3876 @opindex fsched-verbose
3877 On targets that use instruction scheduling, this option controls the
3878 amount of debugging output the scheduler prints.  This information is
3879 written to standard error, unless @option{-dS} or @option{-dR} is
3880 specified, in which case it is output to the usual dump
3881 listing file, @file{.sched} or @file{.sched2} respectively.  However
3882 for @var{n} greater than nine, the output is always printed to standard
3883 error.
3884
3885 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3886 same information as @option{-dRS}.  For @var{n} greater than one, it
3887 also output basic block probabilities, detailed ready list information
3888 and unit/insn info.  For @var{n} greater than two, it includes RTL
3889 at abort point, control-flow and regions info.  And for @var{n} over
3890 four, @option{-fsched-verbose} also includes dependence info.
3891
3892 @item -save-temps
3893 @opindex save-temps
3894 Store the usual ``temporary'' intermediate files permanently; place them
3895 in the current directory and name them based on the source file.  Thus,
3896 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3897 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3898 preprocessed @file{foo.i} output file even though the compiler now
3899 normally uses an integrated preprocessor.
3900
3901 When used in combination with the @option{-x} command line option,
3902 @option{-save-temps} is sensible enough to avoid over writing an
3903 input source file with the same extension as an intermediate file.
3904 The corresponding intermediate file may be obtained by renaming the
3905 source file before using @option{-save-temps}.
3906
3907 @item -time
3908 @opindex time
3909 Report the CPU time taken by each subprocess in the compilation
3910 sequence.  For C source files, this is the compiler proper and assembler
3911 (plus the linker if linking is done).  The output looks like this:
3912
3913 @smallexample
3914 # cc1 0.12 0.01
3915 # as 0.00 0.01
3916 @end smallexample
3917
3918 The first number on each line is the ``user time'', that is time spent
3919 executing the program itself.  The second number is ``system time'',
3920 time spent executing operating system routines on behalf of the program.
3921 Both numbers are in seconds.
3922
3923 @item -fvar-tracking
3924 @opindex fvar-tracking
3925 Run variable tracking pass.  It computes where variables are stored at each
3926 position in code.  Better debugging information is then generated
3927 (if the debugging information format supports this information).
3928
3929 It is enabled by default when compiling with optimization (@option{-Os},
3930 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3931 the debug info format supports it.
3932
3933 @item -print-file-name=@var{library}
3934 @opindex print-file-name
3935 Print the full absolute name of the library file @var{library} that
3936 would be used when linking---and don't do anything else.  With this
3937 option, GCC does not compile or link anything; it just prints the
3938 file name.
3939
3940 @item -print-multi-directory
3941 @opindex print-multi-directory
3942 Print the directory name corresponding to the multilib selected by any
3943 other switches present in the command line.  This directory is supposed
3944 to exist in @env{GCC_EXEC_PREFIX}.
3945
3946 @item -print-multi-lib
3947 @opindex print-multi-lib
3948 Print the mapping from multilib directory names to compiler switches
3949 that enable them.  The directory name is separated from the switches by
3950 @samp{;}, and each switch starts with an @samp{@@} instead of the
3951 @samp{-}, without spaces between multiple switches.  This is supposed to
3952 ease shell-processing.
3953
3954 @item -print-prog-name=@var{program}
3955 @opindex print-prog-name
3956 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3957
3958 @item -print-libgcc-file-name
3959 @opindex print-libgcc-file-name
3960 Same as @option{-print-file-name=libgcc.a}.
3961
3962 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3963 but you do want to link with @file{libgcc.a}.  You can do
3964
3965 @smallexample
3966 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3967 @end smallexample
3968
3969 @item -print-search-dirs
3970 @opindex print-search-dirs
3971 Print the name of the configured installation directory and a list of
3972 program and library directories @command{gcc} will search---and don't do anything else.
3973
3974 This is useful when @command{gcc} prints the error message
3975 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3976 To resolve this you either need to put @file{cpp0} and the other compiler
3977 components where @command{gcc} expects to find them, or you can set the environment
3978 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3979 Don't forget the trailing @samp{/}.
3980 @xref{Environment Variables}.
3981
3982 @item -dumpmachine
3983 @opindex dumpmachine
3984 Print the compiler's target machine (for example,
3985 @samp{i686-pc-linux-gnu})---and don't do anything else.
3986
3987 @item -dumpversion
3988 @opindex dumpversion
3989 Print the compiler version (for example, @samp{3.0})---and don't do
3990 anything else.
3991
3992 @item -dumpspecs
3993 @opindex dumpspecs
3994 Print the compiler's built-in specs---and don't do anything else.  (This
3995 is used when GCC itself is being built.)  @xref{Spec Files}.
3996
3997 @item -feliminate-unused-debug-types
3998 @opindex feliminate-unused-debug-types
3999 Normally, when producing DWARF2 output, GCC will emit debugging
4000 information for all types declared in a compilation
4001 unit, regardless of whether or not they are actually used
4002 in that compilation unit.  Sometimes this is useful, such as
4003 if, in the debugger, you want to cast a value to a type that is
4004 not actually used in your program (but is declared).  More often,
4005 however, this results in a significant amount of wasted space.
4006 With this option, GCC will avoid producing debug symbol output
4007 for types that are nowhere used in the source file being compiled.
4008 @end table
4009
4010 @node Optimize Options
4011 @section Options That Control Optimization
4012 @cindex optimize options
4013 @cindex options, optimization
4014
4015 These options control various sorts of optimizations.
4016
4017 Without any optimization option, the compiler's goal is to reduce the
4018 cost of compilation and to make debugging produce the expected
4019 results.  Statements are independent: if you stop the program with a
4020 breakpoint between statements, you can then assign a new value to any
4021 variable or change the program counter to any other statement in the
4022 function and get exactly the results you would expect from the source
4023 code.
4024
4025 Turning on optimization flags makes the compiler attempt to improve
4026 the performance and/or code size at the expense of compilation time
4027 and possibly the ability to debug the program.
4028
4029 The compiler performs optimization based on the knowledge it has of
4030 the program.  Optimization levels @option{-O2} and above, in
4031 particular, enable @emph{unit-at-a-time} mode, which allows the
4032 compiler to consider information gained from later functions in
4033 the file when compiling a function.  Compiling multiple files at
4034 once to a single output file in @emph{unit-at-a-time} mode allows
4035 the compiler to use information gained from all of the files when
4036 compiling each of them.
4037
4038 Not all optimizations are controlled directly by a flag.  Only
4039 optimizations that have a flag are listed.
4040
4041 @table @gcctabopt
4042 @item -O
4043 @itemx -O1
4044 @opindex O
4045 @opindex O1
4046 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4047 more memory for a large function.
4048
4049 With @option{-O}, the compiler tries to reduce code size and execution
4050 time, without performing any optimizations that take a great deal of
4051 compilation time.
4052
4053 @option{-O} turns on the following optimization flags:
4054 @gccoptlist{-fdefer-pop @gol
4055 -fmerge-constants @gol
4056 -fthread-jumps @gol
4057 -floop-optimize @gol
4058 -fif-conversion @gol
4059 -fif-conversion2 @gol
4060 -fdelayed-branch @gol
4061 -fguess-branch-probability @gol
4062 -fcprop-registers}
4063
4064 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4065 where doing so does not interfere with debugging.
4066
4067 @item -O2
4068 @opindex O2
4069 Optimize even more.  GCC performs nearly all supported optimizations
4070 that do not involve a space-speed tradeoff.  The compiler does not
4071 perform loop unrolling or function inlining when you specify @option{-O2}.
4072 As compared to @option{-O}, this option increases both compilation time
4073 and the performance of the generated code.
4074
4075 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4076 also turns on the following optimization flags:
4077 @gccoptlist{-fforce-mem @gol
4078 -foptimize-sibling-calls @gol
4079 -fstrength-reduce @gol
4080 -fcse-follow-jumps  -fcse-skip-blocks @gol
4081 -frerun-cse-after-loop  -frerun-loop-opt @gol
4082 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
4083 -fdelete-null-pointer-checks @gol
4084 -fexpensive-optimizations @gol
4085 -fregmove @gol
4086 -fschedule-insns  -fschedule-insns2 @gol
4087 -fsched-interblock  -fsched-spec @gol
4088 -fcaller-saves @gol
4089 -fpeephole2 @gol
4090 -freorder-blocks  -freorder-functions @gol
4091 -fstrict-aliasing @gol
4092 -funit-at-a-time @gol
4093 -falign-functions  -falign-jumps @gol
4094 -falign-loops  -falign-labels @gol
4095 -fcrossjumping}
4096
4097 Please note the warning under @option{-fgcse} about
4098 invoking @option{-O2} on programs that use computed gotos.
4099
4100 @item -O3
4101 @opindex O3
4102 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4103 @option{-O2} and also turns on the @option{-finline-functions},
4104 @option{-fweb} and @option{-fgcse-after-reload} options.
4105
4106 @item -O0
4107 @opindex O0
4108 Do not optimize.  This is the default.
4109
4110 @item -Os
4111 @opindex Os
4112 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4113 do not typically increase code size.  It also performs further
4114 optimizations designed to reduce code size.
4115
4116 @option{-Os} disables the following optimization flags:
4117 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4118 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4119
4120 If you use multiple @option{-O} options, with or without level numbers,
4121 the last such option is the one that is effective.
4122 @end table
4123
4124 Options of the form @option{-f@var{flag}} specify machine-independent
4125 flags.  Most flags have both positive and negative forms; the negative
4126 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4127 below, only one of the forms is listed---the one you typically will
4128 use.  You can figure out the other form by either removing @samp{no-}
4129 or adding it.
4130
4131 The following options control specific optimizations.  They are either
4132 activated by @option{-O} options or are related to ones that are.  You
4133 can use the following flags in the rare cases when ``fine-tuning'' of
4134 optimizations to be performed is desired.
4135
4136 @table @gcctabopt
4137 @item -fno-default-inline
4138 @opindex fno-default-inline
4139 Do not make member functions inline by default merely because they are
4140 defined inside the class scope (C++ only).  Otherwise, when you specify
4141 @w{@option{-O}}, member functions defined inside class scope are compiled
4142 inline by default; i.e., you don't need to add @samp{inline} in front of
4143 the member function name.
4144
4145 @item -fno-defer-pop
4146 @opindex fno-defer-pop
4147 Always pop the arguments to each function call as soon as that function
4148 returns.  For machines which must pop arguments after a function call,
4149 the compiler normally lets arguments accumulate on the stack for several
4150 function calls and pops them all at once.
4151
4152 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4153
4154 @item -fforce-mem
4155 @opindex fforce-mem
4156 Force memory operands to be copied into registers before doing
4157 arithmetic on them.  This produces better code by making all memory
4158 references potential common subexpressions.  When they are not common
4159 subexpressions, instruction combination should eliminate the separate
4160 register-load.
4161
4162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4163
4164 @item -fforce-addr
4165 @opindex fforce-addr
4166 Force memory address constants to be copied into registers before
4167 doing arithmetic on them.  This may produce better code just as
4168 @option{-fforce-mem} may.
4169
4170 @item -fomit-frame-pointer
4171 @opindex fomit-frame-pointer
4172 Don't keep the frame pointer in a register for functions that
4173 don't need one.  This avoids the instructions to save, set up and
4174 restore frame pointers; it also makes an extra register available
4175 in many functions.  @strong{It also makes debugging impossible on
4176 some machines.}
4177
4178 On some machines, such as the VAX, this flag has no effect, because
4179 the standard calling sequence automatically handles the frame pointer
4180 and nothing is saved by pretending it doesn't exist.  The
4181 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4182 whether a target machine supports this flag.  @xref{Registers,,Register
4183 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4184
4185 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186
4187 @item -foptimize-sibling-calls
4188 @opindex foptimize-sibling-calls
4189 Optimize sibling and tail recursive calls.
4190
4191 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4192
4193 @item -fno-inline
4194 @opindex fno-inline
4195 Don't pay attention to the @code{inline} keyword.  Normally this option
4196 is used to keep the compiler from expanding any functions inline.
4197 Note that if you are not optimizing, no functions can be expanded inline.
4198
4199 @item -finline-functions
4200 @opindex finline-functions
4201 Integrate all simple functions into their callers.  The compiler
4202 heuristically decides which functions are simple enough to be worth
4203 integrating in this way.
4204
4205 If all calls to a given function are integrated, and the function is
4206 declared @code{static}, then the function is normally not output as
4207 assembler code in its own right.
4208
4209 Enabled at level @option{-O3}.
4210
4211 @item -finline-limit=@var{n}
4212 @opindex finline-limit
4213 By default, GCC limits the size of functions that can be inlined.  This flag
4214 allows the control of this limit for functions that are explicitly marked as
4215 inline (i.e., marked with the inline keyword or defined within the class
4216 definition in c++).  @var{n} is the size of functions that can be inlined in
4217 number of pseudo instructions (not counting parameter handling).  The default
4218 value of @var{n} is 600.
4219 Increasing this value can result in more inlined code at
4220 the cost of compilation time and memory consumption.  Decreasing usually makes
4221 the compilation faster and less code will be inlined (which presumably
4222 means slower programs).  This option is particularly useful for programs that
4223 use inlining heavily such as those based on recursive templates with C++.
4224
4225 Inlining is actually controlled by a number of parameters, which may be
4226 specified individually by using @option{--param @var{name}=@var{value}}.
4227 The @option{-finline-limit=@var{n}} option sets some of these parameters
4228 as follows:
4229
4230 @table @gcctabopt
4231  @item max-inline-insns-single
4232   is set to @var{n}/2.
4233  @item max-inline-insns-auto
4234   is set to @var{n}/2.
4235  @item min-inline-insns
4236   is set to 130 or @var{n}/4, whichever is smaller.
4237  @item max-inline-insns-rtl
4238   is set to @var{n}.
4239 @end table
4240
4241 See below for a documentation of the individual
4242 parameters controlling inlining.
4243
4244 @emph{Note:} pseudo instruction represents, in this particular context, an
4245 abstract measurement of function's size.  In no way, it represents a count
4246 of assembly instructions and as such its exact meaning might change from one
4247 release to an another.
4248
4249 @item -fkeep-inline-functions
4250 @opindex fkeep-inline-functions
4251 In C, emit @code{static} functions that are declared @code{inline}
4252 into the object file, even if the function has been inlined into all
4253 of its callers.  This switch does not affect functions using the
4254 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4255 inline functions into the object file.
4256
4257 @item -fkeep-static-consts
4258 @opindex fkeep-static-consts
4259 Emit variables declared @code{static const} when optimization isn't turned
4260 on, even if the variables aren't referenced.
4261
4262 GCC enables this option by default.  If you want to force the compiler to
4263 check if the variable was referenced, regardless of whether or not
4264 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4265
4266 @item -fmerge-constants
4267 Attempt to merge identical constants (string constants and floating point
4268 constants) across compilation units.
4269
4270 This option is the default for optimized compilation if the assembler and
4271 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4272 behavior.
4273
4274 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4275
4276 @item -fmerge-all-constants
4277 Attempt to merge identical constants and identical variables.
4278
4279 This option implies @option{-fmerge-constants}.  In addition to
4280 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4281 arrays or initialized constant variables with integral or floating point
4282 types.  Languages like C or C++ require each non-automatic variable to
4283 have distinct location, so using this option will result in non-conforming
4284 behavior.
4285
4286 @item -fmodulo-sched
4287 @opindex fmodulo-sched
4288 Perform swing modulo scheduling immediately before the first scheduling
4289 pass.  This pass looks at innermost loops and reorders their
4290 instructions by overlapping different iterations.
4291
4292 @item -fno-branch-count-reg
4293 @opindex fno-branch-count-reg
4294 Do not use ``decrement and branch'' instructions on a count register,
4295 but instead generate a sequence of instructions that decrement a
4296 register, compare it against zero, then branch based upon the result.
4297 This option is only meaningful on architectures that support such
4298 instructions, which include x86, PowerPC, IA-64 and S/390.
4299
4300 The default is @option{-fbranch-count-reg}, enabled when
4301 @option{-fstrength-reduce} is enabled.
4302
4303 @item -fno-function-cse
4304 @opindex fno-function-cse
4305 Do not put function addresses in registers; make each instruction that
4306 calls a constant function contain the function's address explicitly.
4307
4308 This option results in less efficient code, but some strange hacks
4309 that alter the assembler output may be confused by the optimizations
4310 performed when this option is not used.
4311
4312 The default is @option{-ffunction-cse}
4313
4314 @item -fno-zero-initialized-in-bss
4315 @opindex fno-zero-initialized-in-bss
4316 If the target supports a BSS section, GCC by default puts variables that
4317 are initialized to zero into BSS@.  This can save space in the resulting
4318 code.
4319
4320 This option turns off this behavior because some programs explicitly
4321 rely on variables going to the data section.  E.g., so that the
4322 resulting executable can find the beginning of that section and/or make
4323 assumptions based on that.
4324
4325 The default is @option{-fzero-initialized-in-bss}.
4326
4327 @item -fbounds-check
4328 @opindex fbounds-check
4329 For front-ends that support it, generate additional code to check that
4330 indices used to access arrays are within the declared range.  This is
4331 currently only supported by the Java and Fortran front-ends, where
4332 this option defaults to true and false respectively.
4333
4334 @item -fmudflap -fmudflapth -fmudflapir
4335 @opindex fmudflap
4336 @opindex fmudflapth
4337 @opindex fmudflapir
4338 @cindex bounds checking
4339 @cindex mudflap
4340 For front-ends that support it (C and C++), instrument all risky
4341 pointer/array dereferencing operations, some standard library
4342 string/heap functions, and some other associated constructs with
4343 range/validity tests.  Modules so instrumented should be immune to
4344 buffer overflows, invalid heap use, and some other classes of C/C++
4345 programming errors.  The instrumentation relies on a separate runtime
4346 library (@file{libmudflap}), which will be linked into a program if
4347 @option{-fmudflap} is given at link time.  Run-time behavior of the
4348 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4349 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4350 for its options.
4351
4352 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4353 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4354 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4355 instrumentation should ignore pointer reads.  This produces less
4356 instrumentation (and therefore faster execution) and still provides
4357 some protection against outright memory corrupting writes, but allows
4358 erroneously read data to propagate within a program.
4359
4360 @item -fstrength-reduce
4361 @opindex fstrength-reduce
4362 Perform the optimizations of loop strength reduction and
4363 elimination of iteration variables.
4364
4365 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4366
4367 @item -fthread-jumps
4368 @opindex fthread-jumps
4369 Perform optimizations where we check to see if a jump branches to a
4370 location where another comparison subsumed by the first is found.  If
4371 so, the first branch is redirected to either the destination of the
4372 second branch or a point immediately following it, depending on whether
4373 the condition is known to be true or false.
4374
4375 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4376
4377 @item -fcse-follow-jumps
4378 @opindex fcse-follow-jumps
4379 In common subexpression elimination, scan through jump instructions
4380 when the target of the jump is not reached by any other path.  For
4381 example, when CSE encounters an @code{if} statement with an
4382 @code{else} clause, CSE will follow the jump when the condition
4383 tested is false.
4384
4385 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4386
4387 @item -fcse-skip-blocks
4388 @opindex fcse-skip-blocks
4389 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4390 follow jumps which conditionally skip over blocks.  When CSE
4391 encounters a simple @code{if} statement with no else clause,
4392 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4393 body of the @code{if}.
4394
4395 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4396
4397 @item -frerun-cse-after-loop
4398 @opindex frerun-cse-after-loop
4399 Re-run common subexpression elimination after loop optimizations has been
4400 performed.
4401
4402 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4403
4404 @item -frerun-loop-opt
4405 @opindex frerun-loop-opt
4406 Run the loop optimizer twice.
4407
4408 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4409
4410 @item -fgcse
4411 @opindex fgcse
4412 Perform a global common subexpression elimination pass.
4413 This pass also performs global constant and copy propagation.
4414
4415 @emph{Note:} When compiling a program using computed gotos, a GCC
4416 extension, you may get better runtime performance if you disable
4417 the global common subexpression elimination pass by adding
4418 @option{-fno-gcse} to the command line.
4419
4420 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4421
4422 @item -fgcse-lm
4423 @opindex fgcse-lm
4424 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4425 attempt to move loads which are only killed by stores into themselves.  This
4426 allows a loop containing a load/store sequence to be changed to a load outside
4427 the loop, and a copy/store within the loop.
4428
4429 Enabled by default when gcse is enabled.
4430
4431 @item -fgcse-sm
4432 @opindex fgcse-sm
4433 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4434 global common subexpression elimination.  This pass will attempt to move
4435 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4436 loops containing a load/store sequence can be changed to a load before
4437 the loop and a store after the loop.
4438
4439 Enabled by default when gcse is enabled.
4440
4441 @item -fgcse-las
4442 @opindex fgcse-las
4443 When @option{-fgcse-las} is enabled, the global common subexpression
4444 elimination pass eliminates redundant loads that come after stores to the
4445 same memory location (both partial and full redundancies).
4446
4447 Enabled by default when gcse is enabled.
4448
4449 @item -fgcse-after-reload
4450 @opindex fgcse-after-reload
4451 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4452 pass is performed after reload.  The purpose of this pass is to cleanup
4453 redundant spilling.
4454
4455 @item -floop-optimize
4456 @opindex floop-optimize
4457 Perform loop optimizations: move constant expressions out of loops, simplify
4458 exit test conditions and optionally do strength-reduction as well.
4459
4460 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4461
4462 @item -floop-optimize2
4463 @opindex floop-optimize2
4464 Perform loop optimizations using the new loop optimizer.  The optimizations
4465 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4466 by separate flags.
4467
4468 @item -fcrossjumping
4469 @opindex crossjumping
4470 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4471 resulting code may or may not perform better than without cross-jumping.
4472
4473 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4474
4475 @item -fif-conversion
4476 @opindex if-conversion
4477 Attempt to transform conditional jumps into branch-less equivalents.  This
4478 include use of conditional moves, min, max, set flags and abs instructions, and
4479 some tricks doable by standard arithmetics.  The use of conditional execution
4480 on chips where it is available is controlled by @code{if-conversion2}.
4481
4482 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4483
4484 @item -fif-conversion2
4485 @opindex if-conversion2
4486 Use conditional execution (where available) to transform conditional jumps into
4487 branch-less equivalents.
4488
4489 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4490
4491 @item -fdelete-null-pointer-checks
4492 @opindex fdelete-null-pointer-checks
4493 Use global dataflow analysis to identify and eliminate useless checks
4494 for null pointers.  The compiler assumes that dereferencing a null
4495 pointer would have halted the program.  If a pointer is checked after
4496 it has already been dereferenced, it cannot be null.
4497
4498 In some environments, this assumption is not true, and programs can
4499 safely dereference null pointers.  Use
4500 @option{-fno-delete-null-pointer-checks} to disable this optimization
4501 for programs which depend on that behavior.
4502
4503 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4504
4505 @item -fexpensive-optimizations
4506 @opindex fexpensive-optimizations
4507 Perform a number of minor optimizations that are relatively expensive.
4508
4509 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4510
4511 @item -foptimize-register-move
4512 @itemx -fregmove
4513 @opindex foptimize-register-move
4514 @opindex fregmove
4515 Attempt to reassign register numbers in move instructions and as
4516 operands of other simple instructions in order to maximize the amount of
4517 register tying.  This is especially helpful on machines with two-operand
4518 instructions.
4519
4520 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4521 optimization.
4522
4523 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4524
4525 @item -fdelayed-branch
4526 @opindex fdelayed-branch
4527 If supported for the target machine, attempt to reorder instructions
4528 to exploit instruction slots available after delayed branch
4529 instructions.
4530
4531 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4532
4533 @item -fschedule-insns
4534 @opindex fschedule-insns
4535 If supported for the target machine, attempt to reorder instructions to
4536 eliminate execution stalls due to required data being unavailable.  This
4537 helps machines that have slow floating point or memory load instructions
4538 by allowing other instructions to be issued until the result of the load
4539 or floating point instruction is required.
4540
4541 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4542
4543 @item -fschedule-insns2
4544 @opindex fschedule-insns2
4545 Similar to @option{-fschedule-insns}, but requests an additional pass of
4546 instruction scheduling after register allocation has been done.  This is
4547 especially useful on machines with a relatively small number of
4548 registers and where memory load instructions take more than one cycle.
4549
4550 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4551
4552 @item -fno-sched-interblock
4553 @opindex fno-sched-interblock
4554 Don't schedule instructions across basic blocks.  This is normally
4555 enabled by default when scheduling before register allocation, i.e.@:
4556 with @option{-fschedule-insns} or at @option{-O2} or higher.
4557
4558 @item -fno-sched-spec
4559 @opindex fno-sched-spec
4560 Don't allow speculative motion of non-load instructions.  This is normally
4561 enabled by default when scheduling before register allocation, i.e.@:
4562 with @option{-fschedule-insns} or at @option{-O2} or higher.
4563
4564 @item -fsched-spec-load
4565 @opindex fsched-spec-load
4566 Allow speculative motion of some load instructions.  This only makes
4567 sense when scheduling before register allocation, i.e.@: with
4568 @option{-fschedule-insns} or at @option{-O2} or higher.
4569
4570 @item -fsched-spec-load-dangerous
4571 @opindex fsched-spec-load-dangerous
4572 Allow speculative motion of more load instructions.  This only makes
4573 sense when scheduling before register allocation, i.e.@: with
4574 @option{-fschedule-insns} or at @option{-O2} or higher.
4575
4576 @item -fsched-stalled-insns=@var{n}
4577 @opindex fsched-stalled-insns
4578 Define how many insns (if any) can be moved prematurely from the queue
4579 of stalled insns into the ready list, during the second scheduling pass.
4580
4581 @item -fsched-stalled-insns-dep=@var{n}
4582 @opindex fsched-stalled-insns-dep
4583 Define how many insn groups (cycles) will be examined for a dependency
4584 on a stalled insn that is candidate for premature removal from the queue
4585 of stalled insns.  Has an effect only during the second scheduling pass,
4586 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4587
4588 @item -fsched2-use-superblocks
4589 @opindex fsched2-use-superblocks
4590 When scheduling after register allocation, do use superblock scheduling
4591 algorithm.  Superblock scheduling allows motion across basic block boundaries
4592 resulting on faster schedules.  This option is experimental, as not all machine
4593 descriptions used by GCC model the CPU closely enough to avoid unreliable
4594 results from the algorithm.
4595
4596 This only makes sense when scheduling after register allocation, i.e.@: with
4597 @option{-fschedule-insns2} or at @option{-O2} or higher.
4598
4599 @item -fsched2-use-traces
4600 @opindex fsched2-use-traces
4601 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4602 allocation and additionally perform code duplication in order to increase the
4603 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4604 trace formation.
4605
4606 This mode should produce faster but significantly longer programs.  Also
4607 without @option{-fbranch-probabilities} the traces constructed may not
4608 match the reality and hurt the performance.  This only makes
4609 sense when scheduling after register allocation, i.e.@: with
4610 @option{-fschedule-insns2} or at @option{-O2} or higher.
4611
4612 @item -freschedule-modulo-scheduled-loops
4613 @opindex fscheduling-in-modulo-scheduled-loops
4614 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4615 we may want to prevent the later scheduling passes from changing its schedule, we use this
4616 option to control that.
4617
4618 @item -fcaller-saves
4619 @opindex fcaller-saves
4620 Enable values to be allocated in registers that will be clobbered by
4621 function calls, by emitting extra instructions to save and restore the
4622 registers around such calls.  Such allocation is done only when it
4623 seems to result in better code than would otherwise be produced.
4624
4625 This option is always enabled by default on certain machines, usually
4626 those which have no call-preserved registers to use instead.
4627
4628 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4629
4630 @item -ftree-pre
4631 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4632 enabled by default at @option{-O} and higher.
4633
4634 @item -ftree-fre
4635 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4636 between FRE and PRE is that FRE only considers expressions
4637 that are computed on all paths leading to the redundant computation.
4638 This analysis faster than PRE, though it exposes fewer redundancies.
4639 This flag is enabled by default at @option{-O} and higher.
4640
4641 @item -ftree-ccp
4642 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4643 is enabled by default at @option{-O} and higher.
4644
4645 @item -ftree-dce
4646 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4647 default at @option{-O} and higher.
4648
4649 @item -ftree-dominator-opts
4650 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4651 default at @option{-O} and higher.
4652
4653 @item -ftree-ch
4654 Perform loop header copying on trees.  This is beneficial since it increases
4655 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4656 is enabled by default at @option{-O} and higher.  It is not enabled
4657 for @option{-Os}, since it usually increases code size.
4658
4659 @item -ftree-loop-optimize
4660 Perform loop optimizations on trees.  This flag is enabled by default
4661 at @option{-O} and higher.
4662
4663 @item -ftree-loop-linear
4664 Perform linear loop transformations on tree.  This flag can improve cache
4665 performance and allow further loop optimizations to take place.
4666
4667 @item -ftree-lim
4668 Perform loop invariant motion on trees.  This pass moves only invartiants that
4669 would be hard to handle on rtl level (function calls, operations that expand to
4670 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4671 operands of conditions that are invariant out of the loop, so that we can use
4672 just trivial invariantness analysis in loop unswitching.  The pass also includes
4673 store motion.
4674
4675 @item -fivcanon
4676 Create a canonical counter for number of iterations in the loop for that
4677 determining number of iterations requires complicated analysis.  Later
4678 optimizations then may determine the number easily.  Useful especially
4679 in connection with unrolling.
4680
4681 @item -fivopts
4682 Perform induction variable optimizations (strength reduction, induction
4683 variable merging and induction variable elimination) on trees.
4684
4685 @item -ftree-sra
4686 Perform scalar replacement of aggregates.  This pass replaces structure
4687 references with scalars to prevent committing structures to memory too
4688 early.  This flag is enabled by default at @option{-O} and higher.
4689
4690 @item -ftree-copyrename
4691 Perform copy renaming on trees.  This pass attempts to rename compiler
4692 temporaries to other variables at copy locations, usually resulting in
4693 variable names which more closely resemble the original variables.  This flag
4694 is enabled by default at @option{-O} and higher.
4695
4696 @item -ftree-ter
4697 Perform temporary expression replacement during the SSA->normal phase.  Single
4698 use/single def temporaries are replaced at their use location with their
4699 defining expression.  This results in non-GIMPLE code, but gives the expanders
4700 much more complex trees to work on resulting in better RTL generation.  This is
4701 enabled by default at @option{-O} and higher.
4702
4703 @item -ftree-lrs
4704 Perform live range splitting during the SSA->normal phase.  Distinct live
4705 ranges of a variable are split into unique variables, allowing for better
4706 optimization later.  This is enabled by default at @option{-O} and higher.
4707
4708 @item -ftree-vectorize
4709 Perform loop vectorization on trees.
4710
4711 @item -ftracer
4712 @opindex ftracer
4713 Perform tail duplication to enlarge superblock size.  This transformation
4714 simplifies the control flow of the function allowing other optimizations to do
4715 better job.
4716
4717 @item -funroll-loops
4718 @opindex funroll-loops
4719 Unroll loops whose number of iterations can be determined at compile
4720 time or upon entry to the loop.  @option{-funroll-loops} implies both
4721 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4722 option makes code larger, and may or may not make it run faster.
4723
4724 @item -funroll-all-loops
4725 @opindex funroll-all-loops
4726 Unroll all loops, even if their number of iterations is uncertain when
4727 the loop is entered.  This usually makes programs run more slowly.
4728 @option{-funroll-all-loops} implies the same options as
4729 @option{-funroll-loops},
4730
4731 @item -fsplit-ivs-in-unroller
4732 @opindex -fsplit-ivs-in-unroller
4733 Enables expressing of values of induction variables in later iterations
4734 of the unrolled loop using the value in the first iteration.  This breaks
4735 long dependency chains, thus improving efficiency of the scheduling passes
4736 (for best results, @option{-fweb} should be used as well).
4737
4738 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4739 same effect.  However in cases the loop body is more complicated than
4740 a single basic block, this is not reliable.  It also does not work at all
4741 on some of the architectures due to restrictions in the CSE pass.
4742
4743 This optimization is enabled by default.
4744
4745 @item -fvariable-expansion-in-unroller
4746 @opindex -fvariable-expansion-in-unroller
4747 With this option, the compiler will create multiple copies of some
4748 local variables when unrolling a loop which can result in superior code.
4749
4750 @item -fprefetch-loop-arrays
4751 @opindex fprefetch-loop-arrays
4752 If supported by the target machine, generate instructions to prefetch
4753 memory to improve the performance of loops that access large arrays.
4754
4755 These options may generate better or worse code; results are highly
4756 dependent on the structure of loops within the source code.
4757
4758 @item -fno-peephole
4759 @itemx -fno-peephole2
4760 @opindex fno-peephole
4761 @opindex fno-peephole2
4762 Disable any machine-specific peephole optimizations.  The difference
4763 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4764 are implemented in the compiler; some targets use one, some use the
4765 other, a few use both.
4766
4767 @option{-fpeephole} is enabled by default.
4768 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4769
4770 @item -fno-guess-branch-probability
4771 @opindex fno-guess-branch-probability
4772 Do not guess branch probabilities using heuristics.
4773
4774 GCC will use heuristics to guess branch probabilities if they are
4775 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4776 heuristics are based on the control flow graph.  If some branch probabilities
4777 are specified by @samp{__builtin_expect}, then the heuristics will be
4778 used to guess branch probabilities for the rest of the control flow graph,
4779 taking the @samp{__builtin_expect} info into account.  The interactions
4780 between the heuristics and @samp{__builtin_expect} can be complex, and in
4781 some cases, it may be useful to disable the heuristics so that the effects
4782 of @samp{__builtin_expect} are easier to understand.
4783
4784 The default is @option{-fguess-branch-probability} at levels
4785 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4786
4787 @item -freorder-blocks
4788 @opindex freorder-blocks
4789 Reorder basic blocks in the compiled function in order to reduce number of
4790 taken branches and improve code locality.
4791
4792 Enabled at levels @option{-O2}, @option{-O3}.
4793
4794 @item -freorder-blocks-and-partition
4795 @opindex freorder-blocks-and-partition
4796 In addition to reordering basic blocks in the compiled function, in order
4797 to reduce number of taken branches, partitions hot and cold basic blocks
4798 into separate sections of the assembly and .o files, to improve
4799 paging and cache locality performance.
4800
4801 This optimization is automatically turned off in the presence of
4802 exception handling, for linkonce sections, for functions with a user-defined
4803 section attribute and on any architecture that does not support named
4804 sections.
4805
4806 @item -freorder-functions
4807 @opindex freorder-functions
4808 Reorder basic blocks in the compiled function in order to reduce number of
4809 taken branches and improve code locality.  This is implemented by using special
4810 subsections @code{.text.hot} for most frequently executed functions and
4811 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4812 the linker so object file format must support named sections and linker must
4813 place them in a reasonable way.
4814
4815 Also profile feedback must be available in to make this option effective.  See
4816 @option{-fprofile-arcs} for details.
4817
4818 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4819
4820 @item -fstrict-aliasing
4821 @opindex fstrict-aliasing
4822 Allows the compiler to assume the strictest aliasing rules applicable to
4823 the language being compiled.  For C (and C++), this activates
4824 optimizations based on the type of expressions.  In particular, an
4825 object of one type is assumed never to reside at the same address as an
4826 object of a different type, unless the types are almost the same.  For
4827 example, an @code{unsigned int} can alias an @code{int}, but not a
4828 @code{void*} or a @code{double}.  A character type may alias any other
4829 type.
4830
4831 Pay special attention to code like this:
4832 @smallexample
4833 union a_union @{
4834   int i;
4835   double d;
4836 @};
4837
4838 int f() @{
4839   a_union t;
4840   t.d = 3.0;
4841   return t.i;
4842 @}
4843 @end smallexample
4844 The practice of reading from a different union member than the one most
4845 recently written to (called ``type-punning'') is common.  Even with
4846 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4847 is accessed through the union type.  So, the code above will work as
4848 expected.  However, this code might not:
4849 @smallexample
4850 int f() @{
4851   a_union t;
4852   int* ip;
4853   t.d = 3.0;
4854   ip = &t.i;
4855   return *ip;
4856 @}
4857 @end smallexample
4858
4859 Every language that wishes to perform language-specific alias analysis
4860 should define a function that computes, given an @code{tree}
4861 node, an alias set for the node.  Nodes in different alias sets are not
4862 allowed to alias.  For an example, see the C front-end function
4863 @code{c_get_alias_set}.
4864
4865 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4866
4867 @item -falign-functions
4868 @itemx -falign-functions=@var{n}
4869 @opindex falign-functions
4870 Align the start of functions to the next power-of-two greater than
4871 @var{n}, skipping up to @var{n} bytes.  For instance,
4872 @option{-falign-functions=32} aligns functions to the next 32-byte
4873 boundary, but @option{-falign-functions=24} would align to the next
4874 32-byte boundary only if this can be done by skipping 23 bytes or less.
4875
4876 @option{-fno-align-functions} and @option{-falign-functions=1} are
4877 equivalent and mean that functions will not be aligned.
4878
4879 Some assemblers only support this flag when @var{n} is a power of two;
4880 in that case, it is rounded up.
4881
4882 If @var{n} is not specified or is zero, use a machine-dependent default.
4883
4884 Enabled at levels @option{-O2}, @option{-O3}.
4885
4886 @item -falign-labels
4887 @itemx -falign-labels=@var{n}
4888 @opindex falign-labels
4889 Align all branch targets to a power-of-two boundary, skipping up to
4890 @var{n} bytes like @option{-falign-functions}.  This option can easily
4891 make code slower, because it must insert dummy operations for when the
4892 branch target is reached in the usual flow of the code.
4893
4894 @option{-fno-align-labels} and @option{-falign-labels=1} are
4895 equivalent and mean that labels will not be aligned.
4896
4897 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4898 are greater than this value, then their values are used instead.
4899
4900 If @var{n} is not specified or is zero, use a machine-dependent default
4901 which is very likely to be @samp{1}, meaning no alignment.
4902
4903 Enabled at levels @option{-O2}, @option{-O3}.
4904
4905 @item -falign-loops
4906 @itemx -falign-loops=@var{n}
4907 @opindex falign-loops
4908 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4909 like @option{-falign-functions}.  The hope is that the loop will be
4910 executed many times, which will make up for any execution of the dummy
4911 operations.
4912
4913 @option{-fno-align-loops} and @option{-falign-loops=1} are
4914 equivalent and mean that loops will not be aligned.
4915
4916 If @var{n} is not specified or is zero, use a machine-dependent default.
4917
4918 Enabled at levels @option{-O2}, @option{-O3}.
4919
4920 @item -falign-jumps
4921 @itemx -falign-jumps=@var{n}
4922 @opindex falign-jumps
4923 Align branch targets to a power-of-two boundary, for branch targets
4924 where the targets can only be reached by jumping, skipping up to @var{n}
4925 bytes like @option{-falign-functions}.  In this case, no dummy operations
4926 need be executed.
4927
4928 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4929 equivalent and mean that loops will not be aligned.
4930
4931 If @var{n} is not specified or is zero, use a machine-dependent default.
4932
4933 Enabled at levels @option{-O2}, @option{-O3}.
4934
4935 @item -funit-at-a-time
4936 @opindex funit-at-a-time
4937 Parse the whole compilation unit before starting to produce code.
4938 This allows some extra optimizations to take place but consumes
4939 more memory (in general).  There are some compatibility issues
4940 with @emph{unit-at-at-time} mode:
4941 @itemize @bullet
4942 @item
4943 enabling @emph{unit-at-a-time} mode may change the order
4944 in which functions, variables, and top-level @code{asm} statements
4945 are emitted, and will likely break code relying on some particular
4946 ordering.  The majority of such top-level @code{asm} statements,
4947 though, can be replaced by @code{section} attributes.
4948
4949 @item
4950 @emph{unit-at-a-time} mode removes unreferenced static variables
4951 and functions are removed.  This may result in undefined references
4952 when an @code{asm} statement refers directly to variables or functions
4953 that are otherwise unused.  In that case either the variable/function
4954 shall be listed as an operand of the @code{asm} statement operand or,
4955 in the case of top-level @code{asm} statements the attribute @code{used}
4956 shall be used on the declaration.
4957
4958 @item
4959 Static functions now can use non-standard passing conventions that
4960 may break @code{asm} statements calling functions directly.  Again,
4961 attribute @code{used} will prevent this behavior.
4962 @end itemize
4963
4964 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4965 but this scheme may not be supported by future releases of GCC@.
4966
4967 Enabled at levels @option{-O2}, @option{-O3}.
4968
4969 @item -fweb
4970 @opindex fweb
4971 Constructs webs as commonly used for register allocation purposes and assign
4972 each web individual pseudo register.  This allows the register allocation pass
4973 to operate on pseudos directly, but also strengthens several other optimization
4974 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4975 however, make debugging impossible, since variables will no longer stay in a
4976 ``home register''.
4977
4978 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4979 on targets where the default format for debugging information supports
4980 variable tracking.
4981
4982 @item -fno-cprop-registers
4983 @opindex fno-cprop-registers
4984 After register allocation and post-register allocation instruction splitting,
4985 we perform a copy-propagation pass to try to reduce scheduling dependencies
4986 and occasionally eliminate the copy.
4987
4988 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4989
4990 @item -fprofile-generate
4991 @opindex fprofile-generate
4992
4993 Enable options usually used for instrumenting application to produce
4994 profile useful for later recompilation with profile feedback based
4995 optimization.  You must use @option{-fprofile-generate} both when
4996 compiling and when linking your program.
4997
4998 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4999
5000 @item -fprofile-use
5001 @opindex fprofile-use
5002 Enable profile feedback directed optimizations, and optimizations
5003 generally profitable only with profile feedback available.
5004
5005 The following options are enabled: @code{-fbranch-probabilities},
5006 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5007
5008 @end table
5009
5010 The following options control compiler behavior regarding floating
5011 point arithmetic.  These options trade off between speed and
5012 correctness.  All must be specifically enabled.
5013
5014 @table @gcctabopt
5015 @item -ffloat-store
5016 @opindex ffloat-store
5017 Do not store floating point variables in registers, and inhibit other
5018 options that might change whether a floating point value is taken from a
5019 register or memory.
5020
5021 @cindex floating point precision
5022 This option prevents undesirable excess precision on machines such as
5023 the 68000 where the floating registers (of the 68881) keep more
5024 precision than a @code{double} is supposed to have.  Similarly for the
5025 x86 architecture.  For most programs, the excess precision does only
5026 good, but a few programs rely on the precise definition of IEEE floating
5027 point.  Use @option{-ffloat-store} for such programs, after modifying
5028 them to store all pertinent intermediate computations into variables.
5029
5030 @item -ffast-math
5031 @opindex ffast-math
5032 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5033 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5034 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5035
5036 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5037
5038 This option should never be turned on by any @option{-O} option since
5039 it can result in incorrect output for programs which depend on
5040 an exact implementation of IEEE or ISO rules/specifications for
5041 math functions.
5042
5043 @item -fno-math-errno
5044 @opindex fno-math-errno
5045 Do not set ERRNO after calling math functions that are executed
5046 with a single instruction, e.g., sqrt.  A program that relies on
5047 IEEE exceptions for math error handling may want to use this flag
5048 for speed while maintaining IEEE arithmetic compatibility.
5049
5050 This option should never be turned on by any @option{-O} option since
5051 it can result in incorrect output for programs which depend on
5052 an exact implementation of IEEE or ISO rules/specifications for
5053 math functions.
5054
5055 The default is @option{-fmath-errno}.
5056
5057 @item -funsafe-math-optimizations
5058 @opindex funsafe-math-optimizations
5059 Allow optimizations for floating-point arithmetic that (a) assume
5060 that arguments and results are valid and (b) may violate IEEE or
5061 ANSI standards.  When used at link-time, it may include libraries
5062 or startup files that change the default FPU control word or other
5063 similar optimizations.
5064
5065 This option should never be turned on by any @option{-O} option since
5066 it can result in incorrect output for programs which depend on
5067 an exact implementation of IEEE or ISO rules/specifications for
5068 math functions.
5069
5070 The default is @option{-fno-unsafe-math-optimizations}.
5071
5072 @item -ffinite-math-only
5073 @opindex ffinite-math-only
5074 Allow optimizations for floating-point arithmetic that assume
5075 that arguments and results are not NaNs or +-Infs.
5076
5077 This option should never be turned on by any @option{-O} option since
5078 it can result in incorrect output for programs which depend on
5079 an exact implementation of IEEE or ISO rules/specifications.
5080
5081 The default is @option{-fno-finite-math-only}.
5082
5083 @item -fno-trapping-math
5084 @opindex fno-trapping-math
5085 Compile code assuming that floating-point operations cannot generate
5086 user-visible traps.  These traps include division by zero, overflow,
5087 underflow, inexact result and invalid operation.  This option implies
5088 @option{-fno-signaling-nans}.  Setting this option may allow faster
5089 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5090
5091 This option should never be turned on by any @option{-O} option since
5092 it can result in incorrect output for programs which depend on
5093 an exact implementation of IEEE or ISO rules/specifications for
5094 math functions.
5095
5096 The default is @option{-ftrapping-math}.
5097
5098 @item -frounding-math
5099 @opindex frounding-math
5100 Disable transformations and optimizations that assume default floating
5101 point rounding behavior.  This is round-to-zero for all floating point
5102 to integer conversions, and round-to-nearest for all other arithmetic
5103 truncations.  This option should be specified for programs that change
5104 the FP rounding mode dynamically, or that may be executed with a
5105 non-default rounding mode.  This option disables constant folding of
5106 floating point expressions at compile-time (which may be affected by
5107 rounding mode) and arithmetic transformations that are unsafe in the
5108 presence of sign-dependent rounding modes.
5109
5110 The default is @option{-fno-rounding-math}.
5111
5112 This option is experimental and does not currently guarantee to
5113 disable all GCC optimizations that are affected by rounding mode.
5114 Future versions of GCC may provide finer control of this setting
5115 using C99's @code{FENV_ACCESS} pragma.  This command line option
5116 will be used to specify the default state for @code{FENV_ACCESS}.
5117
5118 @item -fsignaling-nans
5119 @opindex fsignaling-nans
5120 Compile code assuming that IEEE signaling NaNs may generate user-visible
5121 traps during floating-point operations.  Setting this option disables
5122 optimizations that may change the number of exceptions visible with
5123 signaling NaNs.  This option implies @option{-ftrapping-math}.
5124
5125 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5126 be defined.
5127
5128 The default is @option{-fno-signaling-nans}.
5129
5130 This option is experimental and does not currently guarantee to
5131 disable all GCC optimizations that affect signaling NaN behavior.
5132
5133 @item -fsingle-precision-constant
5134 @opindex fsingle-precision-constant
5135 Treat floating point constant as single precision constant instead of
5136 implicitly converting it to double precision constant.
5137
5138
5139 @end table
5140
5141 The following options control optimizations that may improve
5142 performance, but are not enabled by any @option{-O} options.  This
5143 section includes experimental options that may produce broken code.
5144
5145 @table @gcctabopt
5146 @item -fbranch-probabilities
5147 @opindex fbranch-probabilities
5148 After running a program compiled with @option{-fprofile-arcs}
5149 (@pxref{Debugging Options,, Options for Debugging Your Program or
5150 @command{gcc}}), you can compile it a second time using
5151 @option{-fbranch-probabilities}, to improve optimizations based on
5152 the number of times each branch was taken.  When the program
5153 compiled with @option{-fprofile-arcs} exits it saves arc execution
5154 counts to a file called @file{@var{sourcename}.gcda} for each source
5155 file  The information in this data file is very dependent on the
5156 structure of the generated code, so you must use the same source code
5157 and the same optimization options for both compilations.
5158
5159 With @option{-fbranch-probabilities}, GCC puts a
5160 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5161 These can be used to improve optimization.  Currently, they are only
5162 used in one place: in @file{reorg.c}, instead of guessing which path a
5163 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5164 exactly determine which path is taken more often.
5165
5166 @item -fprofile-values
5167 @opindex fprofile-values
5168 If combined with @option{-fprofile-arcs}, it adds code so that some
5169 data about values of expressions in the program is gathered.
5170
5171 With @option{-fbranch-probabilities}, it reads back the data gathered
5172 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5173 notes to instructions for their later usage in optimizations.
5174
5175 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5176
5177 @item -fvpt
5178 @opindex fvpt
5179 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5180 a code to gather information about values of expressions.
5181
5182 With @option{-fbranch-probabilities}, it reads back the data gathered
5183 and actually performs the optimizations based on them.
5184 Currently the optimizations include specialization of division operation
5185 using the knowledge about the value of the denominator.
5186
5187 @item -fspeculative-prefetching
5188 @opindex fspeculative-prefetching
5189 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5190 a code to gather information about addresses of memory references in the
5191 program.
5192
5193 With @option{-fbranch-probabilities}, it reads back the data gathered
5194 and issues prefetch instructions according to them.  In addition to the opportunities
5195 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5196 memory access patterns---for example accesses to the data stored in linked
5197 list whose elements are usually allocated sequentially.
5198
5199 In order to prevent issuing double prefetches, usage of
5200 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5201
5202 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5203
5204 @item -frename-registers
5205 @opindex frename-registers
5206 Attempt to avoid false dependencies in scheduled code by making use
5207 of registers left over after register allocation.  This optimization
5208 will most benefit processors with lots of registers.  Depending on the
5209 debug information format adopted by the target, however, it can
5210 make debugging impossible, since variables will no longer stay in
5211 a ``home register''.
5212
5213 Not enabled by default at any level because it has known bugs.
5214
5215 @item -ftracer
5216 @opindex ftracer
5217 Perform tail duplication to enlarge superblock size.  This transformation
5218 simplifies the control flow of the function allowing other optimizations to do
5219 better job.
5220
5221 Enabled with @option{-fprofile-use}.
5222
5223 @item -funroll-loops
5224 @opindex funroll-loops
5225 Unroll loops whose number of iterations can be determined at compile time or
5226 upon entry to the loop.  @option{-funroll-loops} implies
5227 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5228 (i.e.@: complete removal of loops with small constant number of iterations).
5229 This option makes code larger, and may or may not make it run faster.
5230
5231 Enabled with @option{-fprofile-use}.
5232
5233 @item -funroll-all-loops
5234 @opindex funroll-all-loops
5235 Unroll all loops, even if their number of iterations is uncertain when
5236 the loop is entered.  This usually makes programs run more slowly.
5237 @option{-funroll-all-loops} implies the same options as
5238 @option{-funroll-loops}.
5239
5240 @item -fpeel-loops
5241 @opindex fpeel-loops
5242 Peels the loops for that there is enough information that they do not
5243 roll much (from profile feedback).  It also turns on complete loop peeling
5244 (i.e.@: complete removal of loops with small constant number of iterations).
5245
5246 Enabled with @option{-fprofile-use}.
5247
5248 @item -fmove-loop-invariants
5249 @opindex fmove-loop-invariants
5250 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5251 at level @option{-O1}
5252
5253 @item -funswitch-loops
5254 @opindex funswitch-loops
5255 Move branches with loop invariant conditions out of the loop, with duplicates
5256 of the loop on both branches (modified according to result of the condition).
5257
5258 @item -fprefetch-loop-arrays
5259 @opindex fprefetch-loop-arrays
5260 If supported by the target machine, generate instructions to prefetch
5261 memory to improve the performance of loops that access large arrays.
5262
5263 Disabled at level @option{-Os}.
5264
5265 @item -ffunction-sections
5266 @itemx -fdata-sections
5267 @opindex ffunction-sections
5268 @opindex fdata-sections
5269 Place each function or data item into its own section in the output
5270 file if the target supports arbitrary sections.  The name of the
5271 function or the name of the data item determines the section's name
5272 in the output file.
5273
5274 Use these options on systems where the linker can perform optimizations
5275 to improve locality of reference in the instruction space.  Most systems
5276 using the ELF object format and SPARC processors running Solaris 2 have
5277 linkers with such optimizations.  AIX may have these optimizations in
5278 the future.
5279
5280 Only use these options when there are significant benefits from doing
5281 so.  When you specify these options, the assembler and linker will
5282 create larger object and executable files and will also be slower.
5283 You will not be able to use @code{gprof} on all systems if you
5284 specify this option and you may have problems with debugging if
5285 you specify both this option and @option{-g}.
5286
5287 @item -fbranch-target-load-optimize
5288 @opindex fbranch-target-load-optimize
5289 Perform branch target register load optimization before prologue / epilogue
5290 threading.
5291 The use of target registers can typically be exposed only during reload,
5292 thus hoisting loads out of loops and doing inter-block scheduling needs
5293 a separate optimization pass.
5294
5295 @item -fbranch-target-load-optimize2
5296 @opindex fbranch-target-load-optimize2
5297 Perform branch target register load optimization after prologue / epilogue
5298 threading.
5299
5300 @item -fbtr-bb-exclusive
5301 @opindex fbtr-bb-exclusive
5302 When performing branch target register load optimization, don't reuse
5303 branch target registers in within any basic block.
5304
5305 @item --param @var{name}=@var{value}
5306 @opindex param
5307 In some places, GCC uses various constants to control the amount of
5308 optimization that is done.  For example, GCC will not inline functions
5309 that contain more that a certain number of instructions.  You can
5310 control some of these constants on the command-line using the
5311 @option{--param} option.
5312
5313 The names of specific parameters, and the meaning of the values, are
5314 tied to the internals of the compiler, and are subject to change
5315 without notice in future releases.
5316
5317 In each case, the @var{value} is an integer.  The allowable choices for
5318 @var{name} are given in the following table:
5319
5320 @table @gcctabopt
5321 @item sra-max-structure-size
5322 The maximum structure size, in bytes, at which the scalar replacement
5323 of aggregates (SRA) optimization will perform block copies.  The
5324 default value, 0, implies that GCC will select the most appropriate
5325 size itself.
5326
5327 @item sra-field-structure-ratio
5328 The threshold ratio (as a percentage) between instantiated fields and
5329 the complete structure size.  We say that if the ratio of the number
5330 of bytes in instantiated fields to the number of bytes in the complete
5331 structure exceeds this parameter, then block copies are not used.  The
5332 default is 75.
5333
5334 @item max-crossjump-edges
5335 The maximum number of incoming edges to consider for crossjumping.
5336 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5337 the number of edges incoming to each block.  Increasing values mean
5338 more aggressive optimization, making the compile time increase with
5339 probably small improvement in executable size.
5340
5341 @item min-crossjump-insns
5342 The minimum number of instructions which must be matched at the end
5343 of two blocks before crossjumping will be performed on them.  This
5344 value is ignored in the case where all instructions in the block being
5345 crossjumped from are matched.  The default value is 5.
5346
5347 @item max-delay-slot-insn-search
5348 The maximum number of instructions to consider when looking for an
5349 instruction to fill a delay slot.  If more than this arbitrary number of
5350 instructions is searched, the time savings from filling the delay slot
5351 will be minimal so stop searching.  Increasing values mean more
5352 aggressive optimization, making the compile time increase with probably
5353 small improvement in executable run time.
5354
5355 @item max-delay-slot-live-search
5356 When trying to fill delay slots, the maximum number of instructions to
5357 consider when searching for a block with valid live register
5358 information.  Increasing this arbitrarily chosen value means more
5359 aggressive optimization, increasing the compile time.  This parameter
5360 should be removed when the delay slot code is rewritten to maintain the
5361 control-flow graph.
5362
5363 @item max-gcse-memory
5364 The approximate maximum amount of memory that will be allocated in
5365 order to perform the global common subexpression elimination
5366 optimization.  If more memory than specified is required, the
5367 optimization will not be done.
5368
5369 @item max-gcse-passes
5370 The maximum number of passes of GCSE to run.  The default is 1.
5371
5372 @item max-pending-list-length
5373 The maximum number of pending dependencies scheduling will allow
5374 before flushing the current state and starting over.  Large functions
5375 with few branches or calls can create excessively large lists which
5376 needlessly consume memory and resources.
5377
5378 @item max-inline-insns-single
5379 Several parameters control the tree inliner used in gcc.
5380 This number sets the maximum number of instructions (counted in GCC's
5381 internal representation) in a single function that the tree inliner
5382 will consider for inlining.  This only affects functions declared
5383 inline and methods implemented in a class declaration (C++).
5384 The default value is 500.
5385
5386 @item max-inline-insns-auto
5387 When you use @option{-finline-functions} (included in @option{-O3}),
5388 a lot of functions that would otherwise not be considered for inlining
5389 by the compiler will be investigated.  To those functions, a different
5390 (more restrictive) limit compared to functions declared inline can
5391 be applied.
5392 The default value is 120.
5393
5394 @item large-function-insns
5395 The limit specifying really large functions.  For functions larger than this
5396 limit after inlining inlining is constrained by
5397 @option{--param large-function-growth}.  This parameter is useful primarily
5398 to avoid extreme compilation time caused by non-linear algorithms used by the
5399 backend.
5400 This parameter is ignored when @option{-funit-at-a-time} is not used.
5401 The default value is 3000.
5402
5403 @item large-function-growth
5404 Specifies maximal growth of large function caused by inlining in percents.
5405 This parameter is ignored when @option{-funit-at-a-time} is not used.
5406 The default value is 100 which limits large function growth to 2.0 times
5407 the original size.
5408
5409 @item inline-unit-growth
5410 Specifies maximal overall growth of the compilation unit caused by inlining.
5411 This parameter is ignored when @option{-funit-at-a-time} is not used.
5412 The default value is 50 which limits unit growth to 1.5 times the original
5413 size.
5414
5415 @item max-inline-insns-recursive
5416 @itemx max-inline-insns-recursive-auto
5417 Specifies maximum number of instructions out-of-line copy of self recursive inline
5418 function can grow into by performing recursive inlining.
5419
5420 For functions declared inline @option{--param max-inline-insns-recursive} is
5421 taken into acount.  For function not declared inline, recursive inlining
5422 happens only when @option{-finline-functions} (included in @option{-O3}) is
5423 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5424 default value is 500.
5425
5426 @item max-inline-recursive-depth
5427 @itemx max-inline-recursive-depth-auto
5428 Specifies maximum recursion depth used by the recursive inlining.
5429
5430 For functions declared inline @option{--param max-inline-recursive-depth} is
5431 taken into acount.  For function not declared inline, recursive inlining
5432 happens only when @option{-finline-functions} (included in @option{-O3}) is
5433 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5434 default value is 500.
5435
5436 @item max-unrolled-insns
5437 The maximum number of instructions that a loop should have if that loop
5438 is unrolled, and if the loop is unrolled, it determines how many times
5439 the loop code is unrolled.
5440
5441 @item max-average-unrolled-insns
5442 The maximum number of instructions biased by probabilities of their execution
5443 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5444 it determines how many times the loop code is unrolled.
5445
5446 @item max-unroll-times
5447 The maximum number of unrollings of a single loop.
5448
5449 @item max-peeled-insns
5450 The maximum number of instructions that a loop should have if that loop
5451 is peeled, and if the loop is peeled, it determines how many times
5452 the loop code is peeled.
5453
5454 @item max-peel-times
5455 The maximum number of peelings of a single loop.
5456
5457 @item max-completely-peeled-insns
5458 The maximum number of insns of a completely peeled loop.
5459
5460 @item max-completely-peel-times
5461 The maximum number of iterations of a loop to be suitable for complete peeling.
5462
5463 @item max-unswitch-insns
5464 The maximum number of insns of an unswitched loop.
5465
5466 @item max-unswitch-level
5467 The maximum number of branches unswitched in a single loop.
5468
5469 @item lim-expensive
5470 The minimum cost of an expensive expression in the loop invariant motion.
5471
5472 @item iv-consider-all-candidates-bound
5473 Bound on number of candidates for induction variables below that
5474 all candidates are considered for each use in induction variable
5475 optimizations.  Only the most relevant candidates are considered
5476 if there are more candidates, to avoid quadratic time complexity.
5477
5478 @item iv-max-considered-uses
5479 The induction variable optimizations give up on loops that contain more
5480 induction variable uses.
5481
5482 @item iv-always-prune-cand-set-bound
5483 If number of candidates in the set is smaller than this value,
5484 we always try to remove unnecessary ivs from the set during its
5485 optimization when a new iv is added to the set.
5486
5487 @item max-iterations-to-track
5488
5489 The maximum number of iterations of a loop the brute force algorithm
5490 for analysis of # of iterations of the loop tries to evaluate.
5491
5492 @item hot-bb-count-fraction
5493 Select fraction of the maximal count of repetitions of basic block in program
5494 given basic block needs to have to be considered hot.
5495
5496 @item hot-bb-frequency-fraction
5497 Select fraction of the maximal frequency of executions of basic block in
5498 function given basic block needs to have to be considered hot
5499
5500 @item tracer-dynamic-coverage
5501 @itemx tracer-dynamic-coverage-feedback
5502
5503 This value is used to limit superblock formation once the given percentage of
5504 executed instructions is covered.  This limits unnecessary code size
5505 expansion.
5506
5507 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5508 feedback is available.  The real profiles (as opposed to statically estimated
5509 ones) are much less balanced allowing the threshold to be larger value.
5510
5511 @item tracer-max-code-growth
5512 Stop tail duplication once code growth has reached given percentage.  This is
5513 rather hokey argument, as most of the duplicates will be eliminated later in
5514 cross jumping, so it may be set to much higher values than is the desired code
5515 growth.
5516
5517 @item tracer-min-branch-ratio
5518
5519 Stop reverse growth when the reverse probability of best edge is less than this
5520 threshold (in percent).
5521
5522 @item tracer-min-branch-ratio
5523 @itemx tracer-min-branch-ratio-feedback
5524
5525 Stop forward growth if the best edge do have probability lower than this
5526 threshold.
5527
5528 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5529 compilation for profile feedback and one for compilation without.  The value
5530 for compilation with profile feedback needs to be more conservative (higher) in
5531 order to make tracer effective.
5532
5533 @item max-cse-path-length
5534
5535 Maximum number of basic blocks on path that cse considers.  The default is 10.
5536
5537 @item global-var-threshold
5538
5539 Counts the number of function calls (@var{n}) and the number of
5540 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5541 single artificial variable will be created to represent all the
5542 call-clobbered variables at function call sites.  This artificial
5543 variable will then be made to alias every call-clobbered variable.
5544 (done as @code{int * size_t} on the host machine; beware overflow).
5545
5546 @item max-aliased-vops
5547
5548 Maximum number of virtual operands allowed to represent aliases
5549 before triggering the alias grouping heuristic.  Alias grouping
5550 reduces compile times and memory consumption needed for aliasing at
5551 the expense of precision loss in alias information.
5552
5553 @item ggc-min-expand
5554
5555 GCC uses a garbage collector to manage its own memory allocation.  This
5556 parameter specifies the minimum percentage by which the garbage
5557 collector's heap should be allowed to expand between collections.
5558 Tuning this may improve compilation speed; it has no effect on code
5559 generation.
5560
5561 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5562 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5563 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5564 GCC is not able to calculate RAM on a particular platform, the lower
5565 bound of 30% is used.  Setting this parameter and
5566 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5567 every opportunity.  This is extremely slow, but can be useful for
5568 debugging.
5569
5570 @item ggc-min-heapsize
5571
5572 Minimum size of the garbage collector's heap before it begins bothering
5573 to collect garbage.  The first collection occurs after the heap expands
5574 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5575 tuning this may improve compilation speed, and has no effect on code
5576 generation.
5577
5578 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5579 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5580 with a lower bound of 4096 (four megabytes) and an upper bound of
5581 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5582 particular platform, the lower bound is used.  Setting this parameter
5583 very large effectively disables garbage collection.  Setting this
5584 parameter and @option{ggc-min-expand} to zero causes a full collection
5585 to occur at every opportunity.
5586
5587 @item max-reload-search-insns
5588 The maximum number of instruction reload should look backward for equivalent
5589 register.  Increasing values mean more aggressive optimization, making the
5590 compile time increase with probably slightly better performance.  The default
5591 value is 100.
5592
5593 @item max-cselib-memory-location
5594 The maximum number of memory locations cselib should take into acount.
5595 Increasing values mean more aggressive optimization, making the compile time
5596 increase with probably slightly better performance.  The default value is 500.
5597
5598 @item reorder-blocks-duplicate
5599 @itemx reorder-blocks-duplicate-feedback
5600
5601 Used by basic block reordering pass to decide whether to use unconditional
5602 branch or duplicate the code on its destination.  Code is duplicated when its
5603 estimated size is smaller than this value multiplied by the estimated size of
5604 unconditional jump in the hot spots of the program.
5605
5606 The @option{reorder-block-duplicate-feedback} is used only when profile
5607 feedback is available and may be set to higher values than
5608 @option{reorder-block-duplicate} since information about the hot spots is more
5609 accurate.
5610
5611 @item max-sched-region-blocks
5612 The maximum number of blocks in a region to be considered for
5613 interblock scheduling.  The default value is 10.
5614
5615 @item max-sched-region-insns
5616 The maximum number of insns in a region to be considered for
5617 interblock scheduling.  The default value is 100.
5618
5619 @item max-last-value-rtl
5620
5621 The maximum size measured as number of RTLs that can be recorded in an expression
5622 in combiner for a pseudo register as last known value of that register.  The default
5623 is 10000.
5624
5625 @item integer-share-limit
5626 Small integer constants can use a shared data structure, reducing the
5627 compiler's memory usage and increasing its speed.  This sets the maximum
5628 value of a shared integer constant's.  The default value is 256.
5629
5630 @end table
5631 @end table
5632
5633 @node Preprocessor Options
5634 @section Options Controlling the Preprocessor
5635 @cindex preprocessor options
5636 @cindex options, preprocessor
5637
5638 These options control the C preprocessor, which is run on each C source
5639 file before actual compilation.
5640
5641 If you use the @option{-E} option, nothing is done except preprocessing.
5642 Some of these options make sense only together with @option{-E} because
5643 they cause the preprocessor output to be unsuitable for actual
5644 compilation.
5645
5646 @table @gcctabopt
5647 @opindex Wp
5648 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5649 and pass @var{option} directly through to the preprocessor.  If
5650 @var{option} contains commas, it is split into multiple options at the
5651 commas.  However, many options are modified, translated or interpreted
5652 by the compiler driver before being passed to the preprocessor, and
5653 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5654 interface is undocumented and subject to change, so whenever possible
5655 you should avoid using @option{-Wp} and let the driver handle the
5656 options instead.
5657
5658 @item -Xpreprocessor @var{option}
5659 @opindex preprocessor
5660 Pass @var{option} as an option to the preprocessor.  You can use this to
5661 supply system-specific preprocessor options which GCC does not know how to
5662 recognize.
5663
5664 If you want to pass an option that takes an argument, you must use
5665 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5666 @end table
5667
5668 @include cppopts.texi
5669
5670 @node Assembler Options
5671 @section Passing Options to the Assembler
5672
5673 @c prevent bad page break with this line
5674 You can pass options to the assembler.
5675
5676 @table @gcctabopt
5677 @item -Wa,@var{option}
5678 @opindex Wa
5679 Pass @var{option} as an option to the assembler.  If @var{option}
5680 contains commas, it is split into multiple options at the commas.
5681
5682 @item -Xassembler @var{option}
5683 @opindex Xassembler
5684 Pass @var{option} as an option to the assembler.  You can use this to
5685 supply system-specific assembler options which GCC does not know how to
5686 recognize.
5687
5688 If you want to pass an option that takes an argument, you must use
5689 @option{-Xassembler} twice, once for the option and once for the argument.
5690
5691 @end table
5692
5693 @node Link Options
5694 @section Options for Linking
5695 @cindex link options
5696 @cindex options, linking
5697
5698 These options come into play when the compiler links object files into
5699 an executable output file.  They are meaningless if the compiler is
5700 not doing a link step.
5701
5702 @table @gcctabopt
5703 @cindex file names
5704 @item @var{object-file-name}
5705 A file name that does not end in a special recognized suffix is
5706 considered to name an object file or library.  (Object files are
5707 distinguished from libraries by the linker according to the file
5708 contents.)  If linking is done, these object files are used as input
5709 to the linker.
5710
5711 @item -c
5712 @itemx -S
5713 @itemx -E
5714 @opindex c
5715 @opindex S
5716 @opindex E
5717 If any of these options is used, then the linker is not run, and
5718 object file names should not be used as arguments.  @xref{Overall
5719 Options}.
5720
5721 @cindex Libraries
5722 @item -l@var{library}
5723 @itemx -l @var{library}
5724 @opindex l
5725 Search the library named @var{library} when linking.  (The second
5726 alternative with the library as a separate argument is only for
5727 POSIX compliance and is not recommended.)
5728
5729 It makes a difference where in the command you write this option; the
5730 linker searches and processes libraries and object files in the order they
5731 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5732 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5733 to functions in @samp{z}, those functions may not be loaded.
5734
5735 The linker searches a standard list of directories for the library,
5736 which is actually a file named @file{lib@var{library}.a}.  The linker
5737 then uses this file as if it had been specified precisely by name.
5738
5739 The directories searched include several standard system directories
5740 plus any that you specify with @option{-L}.
5741
5742 Normally the files found this way are library files---archive files
5743 whose members are object files.  The linker handles an archive file by
5744 scanning through it for members which define symbols that have so far
5745 been referenced but not defined.  But if the file that is found is an
5746 ordinary object file, it is linked in the usual fashion.  The only
5747 difference between using an @option{-l} option and specifying a file name
5748 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5749 and searches several directories.
5750
5751 @item -lobjc
5752 @opindex lobjc
5753 You need this special case of the @option{-l} option in order to
5754 link an Objective-C or Objective-C++ program.
5755
5756 @item -nostartfiles
5757 @opindex nostartfiles
5758 Do not use the standard system startup files when linking.
5759 The standard system libraries are used normally, unless @option{-nostdlib}
5760 or @option{-nodefaultlibs} is used.
5761
5762 @item -nodefaultlibs
5763 @opindex nodefaultlibs
5764 Do not use the standard system libraries when linking.
5765 Only the libraries you specify will be passed to the linker.
5766 The standard startup files are used normally, unless @option{-nostartfiles}
5767 is used.  The compiler may generate calls to @code{memcmp},
5768 @code{memset}, @code{memcpy} and @code{memmove}.
5769 These entries are usually resolved by entries in
5770 libc.  These entry points should be supplied through some other
5771 mechanism when this option is specified.
5772
5773 @item -nostdlib
5774 @opindex nostdlib
5775 Do not use the standard system startup files or libraries when linking.
5776 No startup files and only the libraries you specify will be passed to
5777 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5778 @code{memcpy} and @code{memmove}.
5779 These entries are usually resolved by entries in
5780 libc.  These entry points should be supplied through some other
5781 mechanism when this option is specified.
5782
5783 @cindex @option{-lgcc}, use with @option{-nostdlib}
5784 @cindex @option{-nostdlib} and unresolved references
5785 @cindex unresolved references and @option{-nostdlib}
5786 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5787 @cindex @option{-nodefaultlibs} and unresolved references
5788 @cindex unresolved references and @option{-nodefaultlibs}
5789 One of the standard libraries bypassed by @option{-nostdlib} and
5790 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5791 that GCC uses to overcome shortcomings of particular machines, or special
5792 needs for some languages.
5793 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5794 Collection (GCC) Internals},
5795 for more discussion of @file{libgcc.a}.)
5796 In most cases, you need @file{libgcc.a} even when you want to avoid
5797 other standard libraries.  In other words, when you specify @option{-nostdlib}
5798 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5799 This ensures that you have no unresolved references to internal GCC
5800 library subroutines.  (For example, @samp{__main}, used to ensure C++
5801 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5802 GNU Compiler Collection (GCC) Internals}.)
5803
5804 @item -pie
5805 @opindex pie
5806 Produce a position independent executable on targets which support it.
5807 For predictable results, you must also specify the same set of options
5808 that were used to generate code (@option{-fpie}, @option{-fPIE},
5809 or model suboptions) when you specify this option.
5810
5811 @item -s
5812 @opindex s
5813 Remove all symbol table and relocation information from the executable.
5814
5815 @item -static
5816 @opindex static
5817 On systems that support dynamic linking, this prevents linking with the shared
5818 libraries.  On other systems, this option has no effect.
5819
5820 @item -shared
5821 @opindex shared
5822 Produce a shared object which can then be linked with other objects to
5823 form an executable.  Not all systems support this option.  For predictable
5824 results, you must also specify the same set of options that were used to
5825 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5826 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5827 needs to build supplementary stub code for constructors to work.  On
5828 multi-libbed systems, @samp{gcc -shared} must select the correct support
5829 libraries to link against.  Failing to supply the correct flags may lead
5830 to subtle defects.  Supplying them in cases where they are not necessary
5831 is innocuous.}
5832
5833 @item -shared-libgcc
5834 @itemx -static-libgcc
5835 @opindex shared-libgcc
5836 @opindex static-libgcc
5837 On systems that provide @file{libgcc} as a shared library, these options
5838 force the use of either the shared or static version respectively.
5839 If no shared version of @file{libgcc} was built when the compiler was
5840 configured, these options have no effect.
5841
5842 There are several situations in which an application should use the
5843 shared @file{libgcc} instead of the static version.  The most common
5844 of these is when the application wishes to throw and catch exceptions
5845 across different shared libraries.  In that case, each of the libraries
5846 as well as the application itself should use the shared @file{libgcc}.
5847
5848 Therefore, the G++ and GCJ drivers automatically add
5849 @option{-shared-libgcc} whenever you build a shared library or a main
5850 executable, because C++ and Java programs typically use exceptions, so
5851 this is the right thing to do.
5852
5853 If, instead, you use the GCC driver to create shared libraries, you may
5854 find that they will not always be linked with the shared @file{libgcc}.
5855 If GCC finds, at its configuration time, that you have a non-GNU linker
5856 or a GNU linker that does not support option @option{--eh-frame-hdr},
5857 it will link the shared version of @file{libgcc} into shared libraries
5858 by default.  Otherwise, it will take advantage of the linker and optimize
5859 away the linking with the shared version of @file{libgcc}, linking with
5860 the static version of libgcc by default.  This allows exceptions to
5861 propagate through such shared libraries, without incurring relocation
5862 costs at library load time.
5863
5864 However, if a library or main executable is supposed to throw or catch
5865 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5866 for the languages used in the program, or using the option
5867 @option{-shared-libgcc}, such that it is linked with the shared
5868 @file{libgcc}.
5869
5870 @item -symbolic
5871 @opindex symbolic
5872 Bind references to global symbols when building a shared object.  Warn
5873 about any unresolved references (unless overridden by the link editor
5874 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5875 this option.
5876
5877 @item -Xlinker @var{option}
5878 @opindex Xlinker
5879 Pass @var{option} as an option to the linker.  You can use this to
5880 supply system-specific linker options which GCC does not know how to
5881 recognize.
5882
5883 If you want to pass an option that takes an argument, you must use
5884 @option{-Xlinker} twice, once for the option and once for the argument.
5885 For example, to pass @option{-assert definitions}, you must write
5886 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5887 @option{-Xlinker "-assert definitions"}, because this passes the entire
5888 string as a single argument, which is not what the linker expects.
5889
5890 @item -Wl,@var{option}
5891 @opindex Wl
5892 Pass @var{option} as an option to the linker.  If @var{option} contains
5893 commas, it is split into multiple options at the commas.
5894
5895 @item -u @var{symbol}
5896 @opindex u
5897 Pretend the symbol @var{symbol} is undefined, to force linking of
5898 library modules to define it.  You can use @option{-u} multiple times with
5899 different symbols to force loading of additional library modules.
5900 @end table
5901
5902 @node Directory Options
5903 @section Options for Directory Search
5904 @cindex directory options
5905 @cindex options, directory search
5906 @cindex search path
5907
5908 These options specify directories to search for header files, for
5909 libraries and for parts of the compiler:
5910
5911 @table @gcctabopt
5912 @item -I@var{dir}
5913 @opindex I
5914 Add the directory @var{dir} to the head of the list of directories to be
5915 searched for header files.  This can be used to override a system header
5916 file, substituting your own version, since these directories are
5917 searched before the system header file directories.  However, you should
5918 not use this option to add directories that contain vendor-supplied
5919 system header files (use @option{-isystem} for that).  If you use more than
5920 one @option{-I} option, the directories are scanned in left-to-right
5921 order; the standard system directories come after.
5922
5923 If a standard system include directory, or a directory specified with
5924 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5925 option will be ignored.  The directory will still be searched but as a
5926 system directory at its normal position in the system include chain.
5927 This is to ensure that GCC's procedure to fix buggy system headers and
5928 the ordering for the include_next directive are not inadvertently changed.
5929 If you really need to change the search order for system directories,
5930 use the @option{-nostdinc} and/or @option{-isystem} options.
5931
5932 @item -iquote@var{dir}
5933 @opindex iquote
5934 Add the directory @var{dir} to the head of the list of directories to
5935 be searched for header files only for the case of @samp{#include
5936 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5937 otherwise just like @option{-I}.
5938
5939 @item -L@var{dir}
5940 @opindex L
5941 Add directory @var{dir} to the list of directories to be searched
5942 for @option{-l}.
5943
5944 @item -B@var{prefix}
5945 @opindex B
5946 This option specifies where to find the executables, libraries,
5947 include files, and data files of the compiler itself.
5948
5949 The compiler driver program runs one or more of the subprograms
5950 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5951 @var{prefix} as a prefix for each program it tries to run, both with and
5952 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5953
5954 For each subprogram to be run, the compiler driver first tries the
5955 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5956 was not specified, the driver tries two standard prefixes, which are
5957 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5958 those results in a file name that is found, the unmodified program
5959 name is searched for using the directories specified in your
5960 @env{PATH} environment variable.
5961
5962 The compiler will check to see if the path provided by the @option{-B}
5963 refers to a directory, and if necessary it will add a directory
5964 separator character at the end of the path.
5965
5966 @option{-B} prefixes that effectively specify directory names also apply
5967 to libraries in the linker, because the compiler translates these
5968 options into @option{-L} options for the linker.  They also apply to
5969 includes files in the preprocessor, because the compiler translates these
5970 options into @option{-isystem} options for the preprocessor.  In this case,
5971 the compiler appends @samp{include} to the prefix.
5972
5973 The run-time support file @file{libgcc.a} can also be searched for using
5974 the @option{-B} prefix, if needed.  If it is not found there, the two
5975 standard prefixes above are tried, and that is all.  The file is left
5976 out of the link if it is not found by those means.
5977
5978 Another way to specify a prefix much like the @option{-B} prefix is to use
5979 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5980 Variables}.
5981
5982 As a special kludge, if the path provided by @option{-B} is
5983 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5984 9, then it will be replaced by @file{[dir/]include}.  This is to help
5985 with boot-strapping the compiler.
5986
5987 @item -specs=@var{file}
5988 @opindex specs
5989 Process @var{file} after the compiler reads in the standard @file{specs}
5990 file, in order to override the defaults that the @file{gcc} driver
5991 program uses when determining what switches to pass to @file{cc1},
5992 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5993 @option{-specs=@var{file}} can be specified on the command line, and they
5994 are processed in order, from left to right.
5995
5996 @item -I-
5997 @opindex I-
5998 This option has been deprecated.  Please use @option{-iquote} instead for
5999 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6000 Any directories you specify with @option{-I} options before the @option{-I-}
6001 option are searched only for the case of @samp{#include "@var{file}"};
6002 they are not searched for @samp{#include <@var{file}>}.
6003
6004 If additional directories are specified with @option{-I} options after
6005 the @option{-I-}, these directories are searched for all @samp{#include}
6006 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6007 this way.)
6008
6009 In addition, the @option{-I-} option inhibits the use of the current
6010 directory (where the current input file came from) as the first search
6011 directory for @samp{#include "@var{file}"}.  There is no way to
6012 override this effect of @option{-I-}.  With @option{-I.} you can specify
6013 searching the directory which was current when the compiler was
6014 invoked.  That is not exactly the same as what the preprocessor does
6015 by default, but it is often satisfactory.
6016
6017 @option{-I-} does not inhibit the use of the standard system directories
6018 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6019 independent.
6020 @end table
6021
6022 @c man end
6023
6024 @node Spec Files
6025 @section Specifying subprocesses and the switches to pass to them
6026 @cindex Spec Files
6027
6028 @command{gcc} is a driver program.  It performs its job by invoking a
6029 sequence of other programs to do the work of compiling, assembling and
6030 linking.  GCC interprets its command-line parameters and uses these to
6031 deduce which programs it should invoke, and which command-line options
6032 it ought to place on their command lines.  This behavior is controlled
6033 by @dfn{spec strings}.  In most cases there is one spec string for each
6034 program that GCC can invoke, but a few programs have multiple spec
6035 strings to control their behavior.  The spec strings built into GCC can
6036 be overridden by using the @option{-specs=} command-line switch to specify
6037 a spec file.
6038
6039 @dfn{Spec files} are plaintext files that are used to construct spec
6040 strings.  They consist of a sequence of directives separated by blank
6041 lines.  The type of directive is determined by the first non-whitespace
6042 character on the line and it can be one of the following:
6043
6044 @table @code
6045 @item %@var{command}
6046 Issues a @var{command} to the spec file processor.  The commands that can
6047 appear here are:
6048
6049 @table @code
6050 @item %include <@var{file}>
6051 @cindex %include
6052 Search for @var{file} and insert its text at the current point in the
6053 specs file.
6054
6055 @item %include_noerr <@var{file}>
6056 @cindex %include_noerr
6057 Just like @samp{%include}, but do not generate an error message if the include
6058 file cannot be found.
6059
6060 @item %rename @var{old_name} @var{new_name}
6061 @cindex %rename
6062 Rename the spec string @var{old_name} to @var{new_name}.
6063
6064 @end table
6065
6066 @item *[@var{spec_name}]:
6067 This tells the compiler to create, override or delete the named spec
6068 string.  All lines after this directive up to the next directive or
6069 blank line are considered to be the text for the spec string.  If this
6070 results in an empty string then the spec will be deleted.  (Or, if the
6071 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6072 does not currently exist a new spec will be created.  If the spec does
6073 exist then its contents will be overridden by the text of this
6074 directive, unless the first character of that text is the @samp{+}
6075 character, in which case the text will be appended to the spec.
6076
6077 @item [@var{suffix}]:
6078 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6079 and up to the next directive or blank line are considered to make up the
6080 spec string for the indicated suffix.  When the compiler encounters an
6081 input file with the named suffix, it will processes the spec string in
6082 order to work out how to compile that file.  For example:
6083
6084 @smallexample
6085 .ZZ:
6086 z-compile -input %i
6087 @end smallexample
6088
6089 This says that any input file whose name ends in @samp{.ZZ} should be
6090 passed to the program @samp{z-compile}, which should be invoked with the
6091 command-line switch @option{-input} and with the result of performing the
6092 @samp{%i} substitution.  (See below.)
6093
6094 As an alternative to providing a spec string, the text that follows a
6095 suffix directive can be one of the following:
6096
6097 @table @code
6098 @item @@@var{language}
6099 This says that the suffix is an alias for a known @var{language}.  This is
6100 similar to using the @option{-x} command-line switch to GCC to specify a
6101 language explicitly.  For example:
6102
6103 @smallexample
6104 .ZZ:
6105 @@c++
6106 @end smallexample
6107
6108 Says that .ZZ files are, in fact, C++ source files.
6109
6110 @item #@var{name}
6111 This causes an error messages saying:
6112
6113 @smallexample
6114 @var{name} compiler not installed on this system.
6115 @end smallexample
6116 @end table
6117
6118 GCC already has an extensive list of suffixes built into it.
6119 This directive will add an entry to the end of the list of suffixes, but
6120 since the list is searched from the end backwards, it is effectively
6121 possible to override earlier entries using this technique.
6122
6123 @end table
6124
6125 GCC has the following spec strings built into it.  Spec files can
6126 override these strings or create their own.  Note that individual
6127 targets can also add their own spec strings to this list.
6128
6129 @smallexample
6130 asm          Options to pass to the assembler
6131 asm_final    Options to pass to the assembler post-processor
6132 cpp          Options to pass to the C preprocessor
6133 cc1          Options to pass to the C compiler
6134 cc1plus      Options to pass to the C++ compiler
6135 endfile      Object files to include at the end of the link
6136 link         Options to pass to the linker
6137 lib          Libraries to include on the command line to the linker
6138 libgcc       Decides which GCC support library to pass to the linker
6139 linker       Sets the name of the linker
6140 predefines   Defines to be passed to the C preprocessor
6141 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6142              by default
6143 startfile    Object files to include at the start of the link
6144 @end smallexample
6145
6146 Here is a small example of a spec file:
6147
6148 @smallexample
6149 %rename lib                 old_lib
6150
6151 *lib:
6152 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6153 @end smallexample
6154
6155 This example renames the spec called @samp{lib} to @samp{old_lib} and
6156 then overrides the previous definition of @samp{lib} with a new one.
6157 The new definition adds in some extra command-line options before
6158 including the text of the old definition.
6159
6160 @dfn{Spec strings} are a list of command-line options to be passed to their
6161 corresponding program.  In addition, the spec strings can contain
6162 @samp{%}-prefixed sequences to substitute variable text or to
6163 conditionally insert text into the command line.  Using these constructs
6164 it is possible to generate quite complex command lines.
6165
6166 Here is a table of all defined @samp{%}-sequences for spec
6167 strings.  Note that spaces are not generated automatically around the
6168 results of expanding these sequences.  Therefore you can concatenate them
6169 together or combine them with constant text in a single argument.
6170
6171 @table @code
6172 @item %%
6173 Substitute one @samp{%} into the program name or argument.
6174
6175 @item %i
6176 Substitute the name of the input file being processed.
6177
6178 @item %b
6179 Substitute the basename of the input file being processed.
6180 This is the substring up to (and not including) the last period
6181 and not including the directory.
6182
6183 @item %B
6184 This is the same as @samp{%b}, but include the file suffix (text after
6185 the last period).
6186
6187 @item %d
6188 Marks the argument containing or following the @samp{%d} as a
6189 temporary file name, so that that file will be deleted if GCC exits
6190 successfully.  Unlike @samp{%g}, this contributes no text to the
6191 argument.
6192
6193 @item %g@var{suffix}
6194 Substitute a file name that has suffix @var{suffix} and is chosen
6195 once per compilation, and mark the argument in the same way as
6196 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6197 name is now chosen in a way that is hard to predict even when previously
6198 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6199 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6200 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6201 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6202 was simply substituted with a file name chosen once per compilation,
6203 without regard to any appended suffix (which was therefore treated
6204 just like ordinary text), making such attacks more likely to succeed.
6205
6206 @item %u@var{suffix}
6207 Like @samp{%g}, but generates a new temporary file name even if
6208 @samp{%u@var{suffix}} was already seen.
6209
6210 @item %U@var{suffix}
6211 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6212 new one if there is no such last file name.  In the absence of any
6213 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6214 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6215 would involve the generation of two distinct file names, one
6216 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6217 simply substituted with a file name chosen for the previous @samp{%u},
6218 without regard to any appended suffix.
6219
6220 @item %j@var{suffix}
6221 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6222 writable, and if save-temps is off; otherwise, substitute the name
6223 of a temporary file, just like @samp{%u}.  This temporary file is not
6224 meant for communication between processes, but rather as a junk
6225 disposal mechanism.
6226
6227 @item %|@var{suffix}
6228 @itemx %m@var{suffix}
6229 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6230 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6231 all.  These are the two most common ways to instruct a program that it
6232 should read from standard input or write to standard output.  If you
6233 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6234 construct: see for example @file{f/lang-specs.h}.
6235
6236 @item %.@var{SUFFIX}
6237 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6238 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6239 terminated by the next space or %.
6240
6241 @item %w
6242 Marks the argument containing or following the @samp{%w} as the
6243 designated output file of this compilation.  This puts the argument
6244 into the sequence of arguments that @samp{%o} will substitute later.
6245
6246 @item %o
6247 Substitutes the names of all the output files, with spaces
6248 automatically placed around them.  You should write spaces
6249 around the @samp{%o} as well or the results are undefined.
6250 @samp{%o} is for use in the specs for running the linker.
6251 Input files whose names have no recognized suffix are not compiled
6252 at all, but they are included among the output files, so they will
6253 be linked.
6254
6255 @item %O
6256 Substitutes the suffix for object files.  Note that this is
6257 handled specially when it immediately follows @samp{%g, %u, or %U},
6258 because of the need for those to form complete file names.  The
6259 handling is such that @samp{%O} is treated exactly as if it had already
6260 been substituted, except that @samp{%g, %u, and %U} do not currently
6261 support additional @var{suffix} characters following @samp{%O} as they would
6262 following, for example, @samp{.o}.
6263
6264 @item %p
6265 Substitutes the standard macro predefinitions for the
6266 current target machine.  Use this when running @code{cpp}.
6267
6268 @item %P
6269 Like @samp{%p}, but puts @samp{__} before and after the name of each
6270 predefined macro, except for macros that start with @samp{__} or with
6271 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6272 C@.
6273
6274 @item %I
6275 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6276 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6277 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6278 as necessary.
6279
6280 @item %s
6281 Current argument is the name of a library or startup file of some sort.
6282 Search for that file in a standard list of directories and substitute
6283 the full name found.
6284
6285 @item %e@var{str}
6286 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6287 Use this when inconsistent options are detected.
6288
6289 @item %(@var{name})
6290 Substitute the contents of spec string @var{name} at this point.
6291
6292 @item %[@var{name}]
6293 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6294
6295 @item %x@{@var{option}@}
6296 Accumulate an option for @samp{%X}.
6297
6298 @item %X
6299 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6300 spec string.
6301
6302 @item %Y
6303 Output the accumulated assembler options specified by @option{-Wa}.
6304
6305 @item %Z
6306 Output the accumulated preprocessor options specified by @option{-Wp}.
6307
6308 @item %a
6309 Process the @code{asm} spec.  This is used to compute the
6310 switches to be passed to the assembler.
6311
6312 @item %A
6313 Process the @code{asm_final} spec.  This is a spec string for
6314 passing switches to an assembler post-processor, if such a program is
6315 needed.
6316
6317 @item %l
6318 Process the @code{link} spec.  This is the spec for computing the
6319 command line passed to the linker.  Typically it will make use of the
6320 @samp{%L %G %S %D and %E} sequences.
6321
6322 @item %D
6323 Dump out a @option{-L} option for each directory that GCC believes might
6324 contain startup files.  If the target supports multilibs then the
6325 current multilib directory will be prepended to each of these paths.
6326
6327 @item %M
6328 Output the multilib directory with directory separators replaced with
6329 @samp{_}.  If multilib directories are not set, or the multilib directory is
6330 @file{.} then this option emits nothing.
6331
6332 @item %L
6333 Process the @code{lib} spec.  This is a spec string for deciding which
6334 libraries should be included on the command line to the linker.
6335
6336 @item %G
6337 Process the @code{libgcc} spec.  This is a spec string for deciding
6338 which GCC support library should be included on the command line to the linker.
6339
6340 @item %S
6341 Process the @code{startfile} spec.  This is a spec for deciding which
6342 object files should be the first ones passed to the linker.  Typically
6343 this might be a file named @file{crt0.o}.
6344
6345 @item %E
6346 Process the @code{endfile} spec.  This is a spec string that specifies
6347 the last object files that will be passed to the linker.
6348
6349 @item %C
6350 Process the @code{cpp} spec.  This is used to construct the arguments
6351 to be passed to the C preprocessor.
6352
6353 @item %1
6354 Process the @code{cc1} spec.  This is used to construct the options to be
6355 passed to the actual C compiler (@samp{cc1}).
6356
6357 @item %2
6358 Process the @code{cc1plus} spec.  This is used to construct the options to be
6359 passed to the actual C++ compiler (@samp{cc1plus}).
6360
6361 @item %*
6362 Substitute the variable part of a matched option.  See below.
6363 Note that each comma in the substituted string is replaced by
6364 a single space.
6365
6366 @item %<@code{S}
6367 Remove all occurrences of @code{-S} from the command line.  Note---this
6368 command is position dependent.  @samp{%} commands in the spec string
6369 before this one will see @code{-S}, @samp{%} commands in the spec string
6370 after this one will not.
6371
6372 @item %:@var{function}(@var{args})
6373 Call the named function @var{function}, passing it @var{args}.
6374 @var{args} is first processed as a nested spec string, then split
6375 into an argument vector in the usual fashion.  The function returns
6376 a string which is processed as if it had appeared literally as part
6377 of the current spec.
6378
6379 The following built-in spec functions are provided:
6380
6381 @table @code
6382 @item @code{if-exists}
6383 The @code{if-exists} spec function takes one argument, an absolute
6384 pathname to a file.  If the file exists, @code{if-exists} returns the
6385 pathname.  Here is a small example of its usage:
6386
6387 @smallexample
6388 *startfile:
6389 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6390 @end smallexample
6391
6392 @item @code{if-exists-else}
6393 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6394 spec function, except that it takes two arguments.  The first argument is
6395 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6396 returns the pathname.  If it does not exist, it returns the second argument.
6397 This way, @code{if-exists-else} can be used to select one file or another,
6398 based on the existence of the first.  Here is a small example of its usage:
6399
6400 @smallexample
6401 *startfile:
6402 crt0%O%s %:if-exists(crti%O%s) \
6403 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6404 @end smallexample
6405
6406 @item @code{replace-outfile}
6407 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6408 first argument in the outfiles array and replaces it with the second argument.  Here
6409 is a small example of its usage:
6410
6411 @smallexample
6412 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6413 @end smallexample
6414
6415 @end table
6416
6417 @item %@{@code{S}@}
6418 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6419 If that switch was not specified, this substitutes nothing.  Note that
6420 the leading dash is omitted when specifying this option, and it is
6421 automatically inserted if the substitution is performed.  Thus the spec
6422 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6423 and would output the command line option @option{-foo}.
6424
6425 @item %W@{@code{S}@}
6426 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6427 deleted on failure.
6428
6429 @item %@{@code{S}*@}
6430 Substitutes all the switches specified to GCC whose names start
6431 with @code{-S}, but which also take an argument.  This is used for
6432 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6433 GCC considers @option{-o foo} as being
6434 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6435 text, including the space.  Thus two arguments would be generated.
6436
6437 @item %@{@code{S}*&@code{T}*@}
6438 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6439 (the order of @code{S} and @code{T} in the spec is not significant).
6440 There can be any number of ampersand-separated variables; for each the
6441 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6442
6443 @item %@{@code{S}:@code{X}@}
6444 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6445
6446 @item %@{!@code{S}:@code{X}@}
6447 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6448
6449 @item %@{@code{S}*:@code{X}@}
6450 Substitutes @code{X} if one or more switches whose names start with
6451 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6452 once, no matter how many such switches appeared.  However, if @code{%*}
6453 appears somewhere in @code{X}, then @code{X} will be substituted once
6454 for each matching switch, with the @code{%*} replaced by the part of
6455 that switch that matched the @code{*}.
6456
6457 @item %@{.@code{S}:@code{X}@}
6458 Substitutes @code{X}, if processing a file with suffix @code{S}.
6459
6460 @item %@{!.@code{S}:@code{X}@}
6461 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6462
6463 @item %@{@code{S}|@code{P}:@code{X}@}
6464 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6465 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6466 although they have a stronger binding than the @samp{|}.  If @code{%*}
6467 appears in @code{X}, all of the alternatives must be starred, and only
6468 the first matching alternative is substituted.
6469
6470 For example, a spec string like this:
6471
6472 @smallexample
6473 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6474 @end smallexample
6475
6476 will output the following command-line options from the following input
6477 command-line options:
6478
6479 @smallexample
6480 fred.c        -foo -baz
6481 jim.d         -bar -boggle
6482 -d fred.c     -foo -baz -boggle
6483 -d jim.d      -bar -baz -boggle
6484 @end smallexample
6485
6486 @item %@{S:X; T:Y; :D@}
6487
6488 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6489 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6490 be as many clauses as you need.  This may be combined with @code{.},
6491 @code{!}, @code{|}, and @code{*} as needed.
6492
6493
6494 @end table
6495
6496 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6497 construct may contain other nested @samp{%} constructs or spaces, or
6498 even newlines.  They are processed as usual, as described above.
6499 Trailing white space in @code{X} is ignored.  White space may also
6500 appear anywhere on the left side of the colon in these constructs,
6501 except between @code{.} or @code{*} and the corresponding word.
6502
6503 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6504 handled specifically in these constructs.  If another value of
6505 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6506 @option{-W} switch is found later in the command line, the earlier
6507 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6508 just one letter, which passes all matching options.
6509
6510 The character @samp{|} at the beginning of the predicate text is used to
6511 indicate that a command should be piped to the following command, but
6512 only if @option{-pipe} is specified.
6513
6514 It is built into GCC which switches take arguments and which do not.
6515 (You might think it would be useful to generalize this to allow each
6516 compiler's spec to say which switches take arguments.  But this cannot
6517 be done in a consistent fashion.  GCC cannot even decide which input
6518 files have been specified without knowing which switches take arguments,
6519 and it must know which input files to compile in order to tell which
6520 compilers to run).
6521
6522 GCC also knows implicitly that arguments starting in @option{-l} are to be
6523 treated as compiler output files, and passed to the linker in their
6524 proper position among the other output files.
6525
6526 @c man begin OPTIONS
6527
6528 @node Target Options
6529 @section Specifying Target Machine and Compiler Version
6530 @cindex target options
6531 @cindex cross compiling
6532 @cindex specifying machine version
6533 @cindex specifying compiler version and target machine
6534 @cindex compiler version, specifying
6535 @cindex target machine, specifying
6536
6537 The usual way to run GCC is to run the executable called @file{gcc}, or
6538 @file{<machine>-gcc} when cross-compiling, or
6539 @file{<machine>-gcc-<version>} to run a version other than the one that
6540 was installed last.  Sometimes this is inconvenient, so GCC provides
6541 options that will switch to another cross-compiler or version.
6542
6543 @table @gcctabopt
6544 @item -b @var{machine}
6545 @opindex b
6546 The argument @var{machine} specifies the target machine for compilation.
6547
6548 The value to use for @var{machine} is the same as was specified as the
6549 machine type when configuring GCC as a cross-compiler.  For
6550 example, if a cross-compiler was configured with @samp{configure
6551 i386v}, meaning to compile for an 80386 running System V, then you
6552 would specify @option{-b i386v} to run that cross compiler.
6553
6554 @item -V @var{version}
6555 @opindex V
6556 The argument @var{version} specifies which version of GCC to run.
6557 This is useful when multiple versions are installed.  For example,
6558 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6559 @end table
6560
6561 The @option{-V} and @option{-b} options work by running the
6562 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6563 use them if you can just run that directly.
6564
6565 @node Submodel Options
6566 @section Hardware Models and Configurations
6567 @cindex submodel options
6568 @cindex specifying hardware config
6569 @cindex hardware models and configurations, specifying
6570 @cindex machine dependent options
6571
6572 Earlier we discussed the standard option @option{-b} which chooses among
6573 different installed compilers for completely different target
6574 machines, such as VAX vs.@: 68000 vs.@: 80386.
6575
6576 In addition, each of these target machine types can have its own
6577 special options, starting with @samp{-m}, to choose among various
6578 hardware models or configurations---for example, 68010 vs 68020,
6579 floating coprocessor or none.  A single installed version of the
6580 compiler can compile for any model or configuration, according to the
6581 options specified.
6582
6583 Some configurations of the compiler also support additional special
6584 options, usually for compatibility with other compilers on the same
6585 platform.
6586
6587 These options are defined by the macro @code{TARGET_SWITCHES} in the
6588 machine description.  The default for the options is also defined by
6589 that macro, which enables you to change the defaults.
6590
6591 @c This list is ordered alphanumerically by subsection name.
6592 @c It should be the same order and spelling as these options are listed
6593 @c in Machine Dependent Options
6594
6595 @menu
6596 * ARC Options::
6597 * ARM Options::
6598 * AVR Options::
6599 * CRIS Options::
6600 * Darwin Options::
6601 * DEC Alpha Options::
6602 * DEC Alpha/VMS Options::
6603 * FRV Options::
6604 * H8/300 Options::
6605 * HPPA Options::
6606 * i386 and x86-64 Options::
6607 * IA-64 Options::
6608 * M32R/D Options::
6609 * M680x0 Options::
6610 * M68hc1x Options::
6611 * MCore Options::
6612 * MIPS Options::
6613 * MMIX Options::
6614 * MN10300 Options::
6615 * NS32K Options::
6616 * PDP-11 Options::
6617 * PowerPC Options::
6618 * RS/6000 and PowerPC Options::
6619 * S/390 and zSeries Options::
6620 * SH Options::
6621 * SPARC Options::
6622 * System V Options::
6623 * TMS320C3x/C4x Options::
6624 * V850 Options::
6625 * VAX Options::
6626 * x86-64 Options::
6627 * Xstormy16 Options::
6628 * Xtensa Options::
6629 * zSeries Options::
6630 @end menu
6631
6632 @node ARC Options
6633 @subsection ARC Options
6634 @cindex ARC Options
6635
6636 These options are defined for ARC implementations:
6637
6638 @table @gcctabopt
6639 @item -EL
6640 @opindex EL
6641 Compile code for little endian mode.  This is the default.
6642
6643 @item -EB
6644 @opindex EB
6645 Compile code for big endian mode.
6646
6647 @item -mmangle-cpu
6648 @opindex mmangle-cpu
6649 Prepend the name of the cpu to all public symbol names.
6650 In multiple-processor systems, there are many ARC variants with different
6651 instruction and register set characteristics.  This flag prevents code
6652 compiled for one cpu to be linked with code compiled for another.
6653 No facility exists for handling variants that are ``almost identical''.
6654 This is an all or nothing option.
6655
6656 @item -mcpu=@var{cpu}
6657 @opindex mcpu
6658 Compile code for ARC variant @var{cpu}.
6659 Which variants are supported depend on the configuration.
6660 All variants support @option{-mcpu=base}, this is the default.
6661
6662 @item -mtext=@var{text-section}
6663 @itemx -mdata=@var{data-section}
6664 @itemx -mrodata=@var{readonly-data-section}
6665 @opindex mtext
6666 @opindex mdata
6667 @opindex mrodata
6668 Put functions, data, and readonly data in @var{text-section},
6669 @var{data-section}, and @var{readonly-data-section} respectively
6670 by default.  This can be overridden with the @code{section} attribute.
6671 @xref{Variable Attributes}.
6672
6673 @end table
6674
6675 @node ARM Options
6676 @subsection ARM Options
6677 @cindex ARM options
6678
6679 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6680 architectures:
6681
6682 @table @gcctabopt
6683 @item -mabi=@var{name}
6684 @opindex mabi
6685 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6686 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6687
6688 @item -mapcs-frame
6689 @opindex mapcs-frame
6690 Generate a stack frame that is compliant with the ARM Procedure Call
6691 Standard for all functions, even if this is not strictly necessary for
6692 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6693 with this option will cause the stack frames not to be generated for
6694 leaf functions.  The default is @option{-mno-apcs-frame}.
6695
6696 @item -mapcs
6697 @opindex mapcs
6698 This is a synonym for @option{-mapcs-frame}.
6699
6700 @ignore
6701 @c not currently implemented
6702 @item -mapcs-stack-check
6703 @opindex mapcs-stack-check
6704 Generate code to check the amount of stack space available upon entry to
6705 every function (that actually uses some stack space).  If there is
6706 insufficient space available then either the function
6707 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6708 called, depending upon the amount of stack space required.  The run time
6709 system is required to provide these functions.  The default is
6710 @option{-mno-apcs-stack-check}, since this produces smaller code.
6711
6712 @c not currently implemented
6713 @item -mapcs-float
6714 @opindex mapcs-float
6715 Pass floating point arguments using the float point registers.  This is
6716 one of the variants of the APCS@.  This option is recommended if the
6717 target hardware has a floating point unit or if a lot of floating point
6718 arithmetic is going to be performed by the code.  The default is
6719 @option{-mno-apcs-float}, since integer only code is slightly increased in
6720 size if @option{-mapcs-float} is used.
6721
6722 @c not currently implemented
6723 @item -mapcs-reentrant
6724 @opindex mapcs-reentrant
6725 Generate reentrant, position independent code.  The default is
6726 @option{-mno-apcs-reentrant}.
6727 @end ignore
6728
6729 @item -mthumb-interwork
6730 @opindex mthumb-interwork
6731 Generate code which supports calling between the ARM and Thumb
6732 instruction sets.  Without this option the two instruction sets cannot
6733 be reliably used inside one program.  The default is
6734 @option{-mno-thumb-interwork}, since slightly larger code is generated
6735 when @option{-mthumb-interwork} is specified.
6736
6737 @item -mno-sched-prolog
6738 @opindex mno-sched-prolog
6739 Prevent the reordering of instructions in the function prolog, or the
6740 merging of those instruction with the instructions in the function's
6741 body.  This means that all functions will start with a recognizable set
6742 of instructions (or in fact one of a choice from a small set of
6743 different function prologues), and this information can be used to
6744 locate the start if functions inside an executable piece of code.  The
6745 default is @option{-msched-prolog}.
6746
6747 @item -mhard-float
6748 @opindex mhard-float
6749 Generate output containing floating point instructions.  This is the
6750 default.
6751
6752 @item -msoft-float
6753 @opindex msoft-float
6754 Generate output containing library calls for floating point.
6755 @strong{Warning:} the requisite libraries are not available for all ARM
6756 targets.  Normally the facilities of the machine's usual C compiler are
6757 used, but this cannot be done directly in cross-compilation.  You must make
6758 your own arrangements to provide suitable library functions for
6759 cross-compilation.
6760
6761 @option{-msoft-float} changes the calling convention in the output file;
6762 therefore, it is only useful if you compile @emph{all} of a program with
6763 this option.  In particular, you need to compile @file{libgcc.a}, the
6764 library that comes with GCC, with @option{-msoft-float} in order for
6765 this to work.
6766
6767 @item -mfloat-abi=@var{name}
6768 @opindex mfloat-abi
6769 Specifies which ABI to use for floating point values.  Permissible values
6770 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6771
6772 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6773 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6774 of floating point instructions, but still uses the soft-float calling
6775 conventions.
6776
6777 @item -mlittle-endian
6778 @opindex mlittle-endian
6779 Generate code for a processor running in little-endian mode.  This is
6780 the default for all standard configurations.
6781
6782 @item -mbig-endian
6783 @opindex mbig-endian
6784 Generate code for a processor running in big-endian mode; the default is
6785 to compile code for a little-endian processor.
6786
6787 @item -mwords-little-endian
6788 @opindex mwords-little-endian
6789 This option only applies when generating code for big-endian processors.
6790 Generate code for a little-endian word order but a big-endian byte
6791 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6792 option should only be used if you require compatibility with code for
6793 big-endian ARM processors generated by versions of the compiler prior to
6794 2.8.
6795
6796 @item -mcpu=@var{name}
6797 @opindex mcpu
6798 This specifies the name of the target ARM processor.  GCC uses this name
6799 to determine what kind of instructions it can emit when generating
6800 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6801 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6802 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6803 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6804 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6805 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6806 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6807 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6808 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6809 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6810 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6811 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6812 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6813 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6814 @samp{ep9312}.
6815
6816 @itemx -mtune=@var{name}
6817 @opindex mtune
6818 This option is very similar to the @option{-mcpu=} option, except that
6819 instead of specifying the actual target processor type, and hence
6820 restricting which instructions can be used, it specifies that GCC should
6821 tune the performance of the code as if the target were of the type
6822 specified in this option, but still choosing the instructions that it
6823 will generate based on the cpu specified by a @option{-mcpu=} option.
6824 For some ARM implementations better performance can be obtained by using
6825 this option.
6826
6827 @item -march=@var{name}
6828 @opindex march
6829 This specifies the name of the target ARM architecture.  GCC uses this
6830 name to determine what kind of instructions it can emit when generating
6831 assembly code.  This option can be used in conjunction with or instead
6832 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6833 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6834 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6835 @samp{iwmmxt}, @samp{ep9312}.
6836
6837 @item -mfpu=@var{name}
6838 @itemx -mfpe=@var{number}
6839 @itemx -mfp=@var{number}
6840 @opindex mfpu
6841 @opindex mfpe
6842 @opindex mfp
6843 This specifies what floating point hardware (or hardware emulation) is
6844 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6845 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6846 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6847 with older versions of GCC@.
6848
6849 If @option{-msoft-float} is specified this specifies the format of
6850 floating point values.
6851
6852 @item -mstructure-size-boundary=@var{n}
6853 @opindex mstructure-size-boundary
6854 The size of all structures and unions will be rounded up to a multiple
6855 of the number of bits set by this option.  Permissible values are 8, 32
6856 and 64.  The default value varies for different toolchains.  For the COFF
6857 targeted toolchain the default value is 8.  A value of 64 is only allowed
6858 if the underlying ABI supports it.
6859
6860 Specifying the larger number can produce faster, more efficient code, but
6861 can also increase the size of the program.  Different values are potentially
6862 incompatible.  Code compiled with one value cannot necessarily expect to
6863 work with code or libraries compiled with another value, if they exchange
6864 information using structures or unions.
6865
6866 @item -mabort-on-noreturn
6867 @opindex mabort-on-noreturn
6868 Generate a call to the function @code{abort} at the end of a
6869 @code{noreturn} function.  It will be executed if the function tries to
6870 return.
6871
6872 @item -mlong-calls
6873 @itemx -mno-long-calls
6874 @opindex mlong-calls
6875 @opindex mno-long-calls
6876 Tells the compiler to perform function calls by first loading the
6877 address of the function into a register and then performing a subroutine
6878 call on this register.  This switch is needed if the target function
6879 will lie outside of the 64 megabyte addressing range of the offset based
6880 version of subroutine call instruction.
6881
6882 Even if this switch is enabled, not all function calls will be turned
6883 into long calls.  The heuristic is that static functions, functions
6884 which have the @samp{short-call} attribute, functions that are inside
6885 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6886 definitions have already been compiled within the current compilation
6887 unit, will not be turned into long calls.  The exception to this rule is
6888 that weak function definitions, functions with the @samp{long-call}
6889 attribute or the @samp{section} attribute, and functions that are within
6890 the scope of a @samp{#pragma long_calls} directive, will always be
6891 turned into long calls.
6892
6893 This feature is not enabled by default.  Specifying
6894 @option{-mno-long-calls} will restore the default behavior, as will
6895 placing the function calls within the scope of a @samp{#pragma
6896 long_calls_off} directive.  Note these switches have no effect on how
6897 the compiler generates code to handle function calls via function
6898 pointers.
6899
6900 @item -mnop-fun-dllimport
6901 @opindex mnop-fun-dllimport
6902 Disable support for the @code{dllimport} attribute.
6903
6904 @item -msingle-pic-base
6905 @opindex msingle-pic-base
6906 Treat the register used for PIC addressing as read-only, rather than
6907 loading it in the prologue for each function.  The run-time system is
6908 responsible for initializing this register with an appropriate value
6909 before execution begins.
6910
6911 @item -mpic-register=@var{reg}
6912 @opindex mpic-register
6913 Specify the register to be used for PIC addressing.  The default is R10
6914 unless stack-checking is enabled, when R9 is used.
6915
6916 @item -mcirrus-fix-invalid-insns
6917 @opindex mcirrus-fix-invalid-insns
6918 @opindex mno-cirrus-fix-invalid-insns
6919 Insert NOPs into the instruction stream to in order to work around
6920 problems with invalid Maverick instruction combinations.  This option
6921 is only valid if the @option{-mcpu=ep9312} option has been used to
6922 enable generation of instructions for the Cirrus Maverick floating
6923 point co-processor.  This option is not enabled by default, since the
6924 problem is only present in older Maverick implementations.  The default
6925 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6926 switch.
6927
6928 @item -mpoke-function-name
6929 @opindex mpoke-function-name
6930 Write the name of each function into the text section, directly
6931 preceding the function prologue.  The generated code is similar to this:
6932
6933 @smallexample
6934      t0
6935          .ascii "arm_poke_function_name", 0
6936          .align
6937      t1
6938          .word 0xff000000 + (t1 - t0)
6939      arm_poke_function_name
6940          mov     ip, sp
6941          stmfd   sp!, @{fp, ip, lr, pc@}
6942          sub     fp, ip, #4
6943 @end smallexample
6944
6945 When performing a stack backtrace, code can inspect the value of
6946 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6947 location @code{pc - 12} and the top 8 bits are set, then we know that
6948 there is a function name embedded immediately preceding this location
6949 and has length @code{((pc[-3]) & 0xff000000)}.
6950
6951 @item -mthumb
6952 @opindex mthumb
6953 Generate code for the 16-bit Thumb instruction set.  The default is to
6954 use the 32-bit ARM instruction set.
6955
6956 @item -mtpcs-frame
6957 @opindex mtpcs-frame
6958 Generate a stack frame that is compliant with the Thumb Procedure Call
6959 Standard for all non-leaf functions.  (A leaf function is one that does
6960 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6961
6962 @item -mtpcs-leaf-frame
6963 @opindex mtpcs-leaf-frame
6964 Generate a stack frame that is compliant with the Thumb Procedure Call
6965 Standard for all leaf functions.  (A leaf function is one that does
6966 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6967
6968 @item -mcallee-super-interworking
6969 @opindex mcallee-super-interworking
6970 Gives all externally visible functions in the file being compiled an ARM
6971 instruction set header which switches to Thumb mode before executing the
6972 rest of the function.  This allows these functions to be called from
6973 non-interworking code.
6974
6975 @item -mcaller-super-interworking
6976 @opindex mcaller-super-interworking
6977 Allows calls via function pointers (including virtual functions) to
6978 execute correctly regardless of whether the target code has been
6979 compiled for interworking or not.  There is a small overhead in the cost
6980 of executing a function pointer if this option is enabled.
6981
6982 @end table
6983
6984 @node AVR Options
6985 @subsection AVR Options
6986 @cindex AVR Options
6987
6988 These options are defined for AVR implementations:
6989
6990 @table @gcctabopt
6991 @item -mmcu=@var{mcu}
6992 @opindex mmcu
6993 Specify ATMEL AVR instruction set or MCU type.
6994
6995 Instruction set avr1 is for the minimal AVR core, not supported by the C
6996 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6997 attiny11, attiny12, attiny15, attiny28).
6998
6999 Instruction set avr2 (default) is for the classic AVR core with up to
7000 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7001 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7002 at90c8534, at90s8535).
7003
7004 Instruction set avr3 is for the classic AVR core with up to 128K program
7005 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7006
7007 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7008 memory space (MCU types: atmega8, atmega83, atmega85).
7009
7010 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7011 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7012 atmega64, atmega128, at43usb355, at94k).
7013
7014 @item -msize
7015 @opindex msize
7016 Output instruction sizes to the asm file.
7017
7018 @item -minit-stack=@var{N}
7019 @opindex minit-stack
7020 Specify the initial stack address, which may be a symbol or numeric value,
7021 @samp{__stack} is the default.
7022
7023 @item -mno-interrupts
7024 @opindex mno-interrupts
7025 Generated code is not compatible with hardware interrupts.
7026 Code size will be smaller.
7027
7028 @item -mcall-prologues
7029 @opindex mcall-prologues
7030 Functions prologues/epilogues expanded as call to appropriate
7031 subroutines.  Code size will be smaller.
7032
7033 @item -mno-tablejump
7034 @opindex mno-tablejump
7035 Do not generate tablejump insns which sometimes increase code size.
7036
7037 @item -mtiny-stack
7038 @opindex mtiny-stack
7039 Change only the low 8 bits of the stack pointer.
7040
7041 @item -mint8
7042 @opindex mint8
7043 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7044 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7045 and long long will be 4 bytes.  Please note that this option does not
7046 comply to the C standards, but it will provide you with smaller code
7047 size.
7048 @end table
7049
7050 @node CRIS Options
7051 @subsection CRIS Options
7052 @cindex CRIS Options
7053
7054 These options are defined specifically for the CRIS ports.
7055
7056 @table @gcctabopt
7057 @item -march=@var{architecture-type}
7058 @itemx -mcpu=@var{architecture-type}
7059 @opindex march
7060 @opindex mcpu
7061 Generate code for the specified architecture.  The choices for
7062 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7063 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7064 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7065 @samp{v10}.
7066
7067 @item -mtune=@var{architecture-type}
7068 @opindex mtune
7069 Tune to @var{architecture-type} everything applicable about the generated
7070 code, except for the ABI and the set of available instructions.  The
7071 choices for @var{architecture-type} are the same as for
7072 @option{-march=@var{architecture-type}}.
7073
7074 @item -mmax-stack-frame=@var{n}
7075 @opindex mmax-stack-frame
7076 Warn when the stack frame of a function exceeds @var{n} bytes.
7077
7078 @item -melinux-stacksize=@var{n}
7079 @opindex melinux-stacksize
7080 Only available with the @samp{cris-axis-aout} target.  Arranges for
7081 indications in the program to the kernel loader that the stack of the
7082 program should be set to @var{n} bytes.
7083
7084 @item -metrax4
7085 @itemx -metrax100
7086 @opindex metrax4
7087 @opindex metrax100
7088 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7089 @option{-march=v3} and @option{-march=v8} respectively.
7090
7091 @item -mmul-bug-workaround
7092 @itemx -mno-mul-bug-workaround
7093 @opindex mmul-bug-workaround
7094 @opindex mno-mul-bug-workaround
7095 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7096 models where it applies.  This option is active by default.
7097
7098 @item -mpdebug
7099 @opindex mpdebug
7100 Enable CRIS-specific verbose debug-related information in the assembly
7101 code.  This option also has the effect to turn off the @samp{#NO_APP}
7102 formatted-code indicator to the assembler at the beginning of the
7103 assembly file.
7104
7105 @item -mcc-init
7106 @opindex mcc-init
7107 Do not use condition-code results from previous instruction; always emit
7108 compare and test instructions before use of condition codes.
7109
7110 @item -mno-side-effects
7111 @opindex mno-side-effects
7112 Do not emit instructions with side-effects in addressing modes other than
7113 post-increment.
7114
7115 @item -mstack-align
7116 @itemx -mno-stack-align
7117 @itemx -mdata-align
7118 @itemx -mno-data-align
7119 @itemx -mconst-align
7120 @itemx -mno-const-align
7121 @opindex mstack-align
7122 @opindex mno-stack-align
7123 @opindex mdata-align
7124 @opindex mno-data-align
7125 @opindex mconst-align
7126 @opindex mno-const-align
7127 These options (no-options) arranges (eliminate arrangements) for the
7128 stack-frame, individual data and constants to be aligned for the maximum
7129 single data access size for the chosen CPU model.  The default is to
7130 arrange for 32-bit alignment.  ABI details such as structure layout are
7131 not affected by these options.
7132
7133 @item -m32-bit
7134 @itemx -m16-bit
7135 @itemx -m8-bit
7136 @opindex m32-bit
7137 @opindex m16-bit
7138 @opindex m8-bit
7139 Similar to the stack- data- and const-align options above, these options
7140 arrange for stack-frame, writable data and constants to all be 32-bit,
7141 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7142
7143 @item -mno-prologue-epilogue
7144 @itemx -mprologue-epilogue
7145 @opindex mno-prologue-epilogue
7146 @opindex mprologue-epilogue
7147 With @option{-mno-prologue-epilogue}, the normal function prologue and
7148 epilogue that sets up the stack-frame are omitted and no return
7149 instructions or return sequences are generated in the code.  Use this
7150 option only together with visual inspection of the compiled code: no
7151 warnings or errors are generated when call-saved registers must be saved,
7152 or storage for local variable needs to be allocated.
7153
7154 @item -mno-gotplt
7155 @itemx -mgotplt
7156 @opindex mno-gotplt
7157 @opindex mgotplt
7158 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7159 instruction sequences that load addresses for functions from the PLT part
7160 of the GOT rather than (traditional on other architectures) calls to the
7161 PLT@.  The default is @option{-mgotplt}.
7162
7163 @item -maout
7164 @opindex maout
7165 Legacy no-op option only recognized with the cris-axis-aout target.
7166
7167 @item -melf
7168 @opindex melf
7169 Legacy no-op option only recognized with the cris-axis-elf and
7170 cris-axis-linux-gnu targets.
7171
7172 @item -melinux
7173 @opindex melinux
7174 Only recognized with the cris-axis-aout target, where it selects a
7175 GNU/linux-like multilib, include files and instruction set for
7176 @option{-march=v8}.
7177
7178 @item -mlinux
7179 @opindex mlinux
7180 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7181
7182 @item -sim
7183 @opindex sim
7184 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7185 to link with input-output functions from a simulator library.  Code,
7186 initialized data and zero-initialized data are allocated consecutively.
7187
7188 @item -sim2
7189 @opindex sim2
7190 Like @option{-sim}, but pass linker options to locate initialized data at
7191 0x40000000 and zero-initialized data at 0x80000000.
7192 @end table
7193
7194 @node Darwin Options
7195 @subsection Darwin Options
7196 @cindex Darwin options
7197
7198 These options are defined for all architectures running the Darwin operating
7199 system.
7200
7201 FSF GCC on Darwin does not create ``fat'' object files; it will create
7202 an object file for the single architecture that it was built to
7203 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7204 @option{-arch} options are used; it does so by running the compiler or
7205 linker multiple times and joining the results together with
7206 @file{lipo}.
7207
7208 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7209 @samp{i686}) is determined by the flags that specify the ISA
7210 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7211 @option{-force_cpusubtype_ALL} option can be used to override this.
7212
7213 The Darwin tools vary in their behaviour when presented with an ISA
7214 mismatch.  The assembler, @file{as}, will only permit instructions to
7215 be used that are valid for the subtype of the file it is generating,
7216 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7217 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7218 and print an error if asked to create a shared library with a less
7219 restrictive subtype than its input files (for instance, trying to put
7220 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7221 for executables, @file{ld}, will quietly give the executable the most
7222 restrictive subtype of any of its input files.
7223
7224 @table @gcctabopt
7225 @item -F@var{dir}
7226 @opindex F
7227 Add the framework directory @var{dir} to the head of the list of
7228 directories to be searched for header files.  These directories are
7229 interleaved with those specified by @option{-I} options and are
7230 scanned in a left-to-right order.
7231
7232 A framework directory is a directory with frameworks in it.  A
7233 framework is a directory with a @samp{"Headers"} and/or
7234 @samp{"PrivateHeaders"} directory contained directly in it that ends
7235 in @samp{".framework"}.  The name of a framework is the name of this
7236 directory excluding the @samp{".framework"}.  Headers associated with
7237 the framework are found in one of those two directories, with
7238 @samp{"Headers"} being searched first.  A subframework is a framework
7239 directory that is in a framework's @samp{"Frameworks"} directory.
7240 Includes of subframework headers can only appear in a header of a
7241 framework that contains the subframework, or in a sibling subframework
7242 header.  Two subframeworks are siblings if they occur in the same
7243 framework.  A subframework should not have the same name as a
7244 framework, a warning will be issued if this is violated.  Currently a
7245 subframework cannot have subframeworks, in the future, the mechanism
7246 may be extended to support this.  The standard frameworks can be found
7247 in @samp{"/System/Library/Frameworks"} and
7248 @samp{"/Library/Frameworks"}.  An example include looks like
7249 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7250 the name of the framework and header.h is found in the
7251 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7252
7253 @item -gused
7254 @opindex -gused
7255 Emit debugging information for symbols that are used.  For STABS
7256 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7257 This is by default ON@.
7258
7259 @item -gfull
7260 @opindex -gfull
7261 Emit debugging information for all symbols and types.
7262
7263 @item -mone-byte-bool
7264 @opindex -mone-byte-bool
7265 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7266 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7267 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7268 option has no effect on x86.
7269
7270 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7271 to generate code that is not binary compatible with code generated
7272 without that switch.  Using this switch may require recompiling all
7273 other modules in a program, including system libraries.  Use this
7274 switch to conform to a non-default data model.
7275
7276 @item -mfix-and-continue
7277 @itemx -ffix-and-continue
7278 @itemx -findirect-data
7279 @opindex mfix-and-continue
7280 @opindex ffix-and-continue
7281 @opindex findirect-data
7282 Generate code suitable for fast turn around development.  Needed to
7283 enable gdb to dynamically load @code{.o} files into already running
7284 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7285 are provided for backwards compatibility.
7286
7287 @item -all_load
7288 @opindex all_load
7289 Loads all members of static archive libraries.
7290 See man ld(1) for more information.
7291
7292 @item -arch_errors_fatal
7293 @opindex arch_errors_fatal
7294 Cause the errors having to do with files that have the wrong architecture
7295 to be fatal.
7296
7297 @item -bind_at_load
7298 @opindex bind_at_load
7299 Causes the output file to be marked such that the dynamic linker will
7300 bind all undefined references when the file is loaded or launched.
7301
7302 @item -bundle
7303 @opindex bundle
7304 Produce a Mach-o bundle format file.
7305 See man ld(1) for more information.
7306
7307 @item -bundle_loader @var{executable}
7308 @opindex bundle_loader
7309 This option specifies the @var{executable} that will be loading the build
7310 output file being linked.  See man ld(1) for more information.
7311
7312 @item -dynamiclib
7313 @opindex -dynamiclib
7314 When passed this option, GCC will produce a dynamic library instead of
7315 an executable when linking, using the Darwin @file{libtool} command.
7316
7317 @item -force_cpusubtype_ALL
7318 @opindex -force_cpusubtype_ALL
7319 This causes GCC's output file to have the @var{ALL} subtype, instead of
7320 one controlled by the @option{-mcpu} or @option{-march} option.
7321
7322 @item -allowable_client  @var{client_name}
7323 @itemx -client_name
7324 @itemx -compatibility_version
7325 @itemx -current_version
7326 @itemx -dead_strip
7327 @itemx -dependency-file
7328 @itemx -dylib_file
7329 @itemx -dylinker_install_name
7330 @itemx -dynamic
7331 @itemx -exported_symbols_list
7332 @itemx -filelist
7333 @itemx -flat_namespace
7334 @itemx -force_flat_namespace
7335 @itemx -headerpad_max_install_names
7336 @itemx -image_base
7337 @itemx -init
7338 @itemx -install_name
7339 @itemx -keep_private_externs
7340 @itemx -multi_module
7341 @itemx -multiply_defined
7342 @itemx -multiply_defined_unused
7343 @itemx -noall_load
7344 @itemx -no_dead_strip_inits_and_terms
7345 @itemx -nofixprebinding
7346 @itemx -nomultidefs
7347 @itemx -noprebind
7348 @itemx -noseglinkedit
7349 @itemx -pagezero_size
7350 @itemx -prebind
7351 @itemx -prebind_all_twolevel_modules
7352 @itemx -private_bundle
7353 @itemx -read_only_relocs
7354 @itemx -sectalign
7355 @itemx -sectobjectsymbols
7356 @itemx -whyload
7357 @itemx -seg1addr
7358 @itemx -sectcreate
7359 @itemx -sectobjectsymbols
7360 @itemx -sectorder
7361 @itemx -segaddr
7362 @itemx -segs_read_only_addr
7363 @itemx -segs_read_write_addr
7364 @itemx -seg_addr_table
7365 @itemx -seg_addr_table_filename
7366 @itemx -seglinkedit
7367 @itemx -segprot
7368 @itemx -segs_read_only_addr
7369 @itemx -segs_read_write_addr
7370 @itemx -single_module
7371 @itemx -static
7372 @itemx -sub_library
7373 @itemx -sub_umbrella
7374 @itemx -twolevel_namespace
7375 @itemx -umbrella
7376 @itemx -undefined
7377 @itemx -unexported_symbols_list
7378 @itemx -weak_reference_mismatches
7379 @itemx -whatsloaded
7380
7381 @opindex allowable_client
7382 @opindex client_name
7383 @opindex compatibility_version
7384 @opindex current_version
7385 @opindex dead_strip
7386 @opindex dependency-file
7387 @opindex dylib_file
7388 @opindex dylinker_install_name
7389 @opindex dynamic
7390 @opindex exported_symbols_list
7391 @opindex filelist
7392 @opindex flat_namespace
7393 @opindex force_flat_namespace
7394 @opindex headerpad_max_install_names
7395 @opindex image_base
7396 @opindex init
7397 @opindex install_name
7398 @opindex keep_private_externs
7399 @opindex multi_module
7400 @opindex multiply_defined
7401 @opindex multiply_defined_unused
7402 @opindex noall_load
7403 @opindex no_dead_strip_inits_and_terms
7404 @opindex nofixprebinding
7405 @opindex nomultidefs
7406 @opindex noprebind
7407 @opindex noseglinkedit
7408 @opindex pagezero_size
7409 @opindex prebind
7410 @opindex prebind_all_twolevel_modules
7411 @opindex private_bundle
7412 @opindex read_only_relocs
7413 @opindex sectalign
7414 @opindex sectobjectsymbols
7415 @opindex whyload
7416 @opindex seg1addr
7417 @opindex sectcreate
7418 @opindex sectobjectsymbols
7419 @opindex sectorder
7420 @opindex segaddr
7421 @opindex segs_read_only_addr
7422 @opindex segs_read_write_addr
7423 @opindex seg_addr_table
7424 @opindex seg_addr_table_filename
7425 @opindex seglinkedit
7426 @opindex segprot
7427 @opindex segs_read_only_addr
7428 @opindex segs_read_write_addr
7429 @opindex single_module
7430 @opindex static
7431 @opindex sub_library
7432 @opindex sub_umbrella
7433 @opindex twolevel_namespace
7434 @opindex umbrella
7435 @opindex undefined
7436 @opindex unexported_symbols_list
7437 @opindex weak_reference_mismatches
7438 @opindex whatsloaded
7439
7440 These options are passed to the Darwin linker.  The Darwin linker man page
7441 describes them in detail.
7442 @end table
7443
7444 @node DEC Alpha Options
7445 @subsection DEC Alpha Options
7446
7447 These @samp{-m} options are defined for the DEC Alpha implementations:
7448
7449 @table @gcctabopt
7450 @item -mno-soft-float
7451 @itemx -msoft-float
7452 @opindex mno-soft-float
7453 @opindex msoft-float
7454 Use (do not use) the hardware floating-point instructions for
7455 floating-point operations.  When @option{-msoft-float} is specified,
7456 functions in @file{libgcc.a} will be used to perform floating-point
7457 operations.  Unless they are replaced by routines that emulate the
7458 floating-point operations, or compiled in such a way as to call such
7459 emulations routines, these routines will issue floating-point
7460 operations.   If you are compiling for an Alpha without floating-point
7461 operations, you must ensure that the library is built so as not to call
7462 them.
7463
7464 Note that Alpha implementations without floating-point operations are
7465 required to have floating-point registers.
7466
7467 @item -mfp-reg
7468 @itemx -mno-fp-regs
7469 @opindex mfp-reg
7470 @opindex mno-fp-regs
7471 Generate code that uses (does not use) the floating-point register set.
7472 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7473 register set is not used, floating point operands are passed in integer
7474 registers as if they were integers and floating-point results are passed
7475 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7476 so any function with a floating-point argument or return value called by code
7477 compiled with @option{-mno-fp-regs} must also be compiled with that
7478 option.
7479
7480 A typical use of this option is building a kernel that does not use,
7481 and hence need not save and restore, any floating-point registers.
7482
7483 @item -mieee
7484 @opindex mieee
7485 The Alpha architecture implements floating-point hardware optimized for
7486 maximum performance.  It is mostly compliant with the IEEE floating
7487 point standard.  However, for full compliance, software assistance is
7488 required.  This option generates code fully IEEE compliant code
7489 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7490 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7491 defined during compilation.  The resulting code is less efficient but is
7492 able to correctly support denormalized numbers and exceptional IEEE
7493 values such as not-a-number and plus/minus infinity.  Other Alpha
7494 compilers call this option @option{-ieee_with_no_inexact}.
7495
7496 @item -mieee-with-inexact
7497 @opindex mieee-with-inexact
7498 This is like @option{-mieee} except the generated code also maintains
7499 the IEEE @var{inexact-flag}.  Turning on this option causes the
7500 generated code to implement fully-compliant IEEE math.  In addition to
7501 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7502 macro.  On some Alpha implementations the resulting code may execute
7503 significantly slower than the code generated by default.  Since there is
7504 very little code that depends on the @var{inexact-flag}, you should
7505 normally not specify this option.  Other Alpha compilers call this
7506 option @option{-ieee_with_inexact}.
7507
7508 @item -mfp-trap-mode=@var{trap-mode}
7509 @opindex mfp-trap-mode
7510 This option controls what floating-point related traps are enabled.
7511 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7512 The trap mode can be set to one of four values:
7513
7514 @table @samp
7515 @item n
7516 This is the default (normal) setting.  The only traps that are enabled
7517 are the ones that cannot be disabled in software (e.g., division by zero
7518 trap).
7519
7520 @item u
7521 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7522 as well.
7523
7524 @item su
7525 Like @samp{su}, but the instructions are marked to be safe for software
7526 completion (see Alpha architecture manual for details).
7527
7528 @item sui
7529 Like @samp{su}, but inexact traps are enabled as well.
7530 @end table
7531
7532 @item -mfp-rounding-mode=@var{rounding-mode}
7533 @opindex mfp-rounding-mode
7534 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7535 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7536 of:
7537
7538 @table @samp
7539 @item n
7540 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7541 the nearest machine number or towards the even machine number in case
7542 of a tie.
7543
7544 @item m
7545 Round towards minus infinity.
7546
7547 @item c
7548 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7549
7550 @item d
7551 Dynamic rounding mode.  A field in the floating point control register
7552 (@var{fpcr}, see Alpha architecture reference manual) controls the
7553 rounding mode in effect.  The C library initializes this register for
7554 rounding towards plus infinity.  Thus, unless your program modifies the
7555 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7556 @end table
7557
7558 @item -mtrap-precision=@var{trap-precision}
7559 @opindex mtrap-precision
7560 In the Alpha architecture, floating point traps are imprecise.  This
7561 means without software assistance it is impossible to recover from a
7562 floating trap and program execution normally needs to be terminated.
7563 GCC can generate code that can assist operating system trap handlers
7564 in determining the exact location that caused a floating point trap.
7565 Depending on the requirements of an application, different levels of
7566 precisions can be selected:
7567
7568 @table @samp
7569 @item p
7570 Program precision.  This option is the default and means a trap handler
7571 can only identify which program caused a floating point exception.
7572
7573 @item f
7574 Function precision.  The trap handler can determine the function that
7575 caused a floating point exception.
7576
7577 @item i
7578 Instruction precision.  The trap handler can determine the exact
7579 instruction that caused a floating point exception.
7580 @end table
7581
7582 Other Alpha compilers provide the equivalent options called
7583 @option{-scope_safe} and @option{-resumption_safe}.
7584
7585 @item -mieee-conformant
7586 @opindex mieee-conformant
7587 This option marks the generated code as IEEE conformant.  You must not
7588 use this option unless you also specify @option{-mtrap-precision=i} and either
7589 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7590 is to emit the line @samp{.eflag 48} in the function prologue of the
7591 generated assembly file.  Under DEC Unix, this has the effect that
7592 IEEE-conformant math library routines will be linked in.
7593
7594 @item -mbuild-constants
7595 @opindex mbuild-constants
7596 Normally GCC examines a 32- or 64-bit integer constant to
7597 see if it can construct it from smaller constants in two or three
7598 instructions.  If it cannot, it will output the constant as a literal and
7599 generate code to load it from the data segment at runtime.
7600
7601 Use this option to require GCC to construct @emph{all} integer constants
7602 using code, even if it takes more instructions (the maximum is six).
7603
7604 You would typically use this option to build a shared library dynamic
7605 loader.  Itself a shared library, it must relocate itself in memory
7606 before it can find the variables and constants in its own data segment.
7607
7608 @item -malpha-as
7609 @itemx -mgas
7610 @opindex malpha-as
7611 @opindex mgas
7612 Select whether to generate code to be assembled by the vendor-supplied
7613 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7614
7615 @item -mbwx
7616 @itemx -mno-bwx
7617 @itemx -mcix
7618 @itemx -mno-cix
7619 @itemx -mfix
7620 @itemx -mno-fix
7621 @itemx -mmax
7622 @itemx -mno-max
7623 @opindex mbwx
7624 @opindex mno-bwx
7625 @opindex mcix
7626 @opindex mno-cix
7627 @opindex mfix
7628 @opindex mno-fix
7629 @opindex mmax
7630 @opindex mno-max
7631 Indicate whether GCC should generate code to use the optional BWX,
7632 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7633 sets supported by the CPU type specified via @option{-mcpu=} option or that
7634 of the CPU on which GCC was built if none was specified.
7635
7636 @item -mfloat-vax
7637 @itemx -mfloat-ieee
7638 @opindex mfloat-vax
7639 @opindex mfloat-ieee
7640 Generate code that uses (does not use) VAX F and G floating point
7641 arithmetic instead of IEEE single and double precision.
7642
7643 @item -mexplicit-relocs
7644 @itemx -mno-explicit-relocs
7645 @opindex mexplicit-relocs
7646 @opindex mno-explicit-relocs
7647 Older Alpha assemblers provided no way to generate symbol relocations
7648 except via assembler macros.  Use of these macros does not allow
7649 optimal instruction scheduling.  GNU binutils as of version 2.12
7650 supports a new syntax that allows the compiler to explicitly mark
7651 which relocations should apply to which instructions.  This option
7652 is mostly useful for debugging, as GCC detects the capabilities of
7653 the assembler when it is built and sets the default accordingly.
7654
7655 @item -msmall-data
7656 @itemx -mlarge-data
7657 @opindex msmall-data
7658 @opindex mlarge-data
7659 When @option{-mexplicit-relocs} is in effect, static data is
7660 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7661 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7662 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7663 16-bit relocations off of the @code{$gp} register.  This limits the
7664 size of the small data area to 64KB, but allows the variables to be
7665 directly accessed via a single instruction.
7666
7667 The default is @option{-mlarge-data}.  With this option the data area
7668 is limited to just below 2GB@.  Programs that require more than 2GB of
7669 data must use @code{malloc} or @code{mmap} to allocate the data in the
7670 heap instead of in the program's data segment.
7671
7672 When generating code for shared libraries, @option{-fpic} implies
7673 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7674
7675 @item -msmall-text
7676 @itemx -mlarge-text
7677 @opindex msmall-text
7678 @opindex mlarge-text
7679 When @option{-msmall-text} is used, the compiler assumes that the
7680 code of the entire program (or shared library) fits in 4MB, and is
7681 thus reachable with a branch instruction.  When @option{-msmall-data}
7682 is used, the compiler can assume that all local symbols share the
7683 same @code{$gp} value, and thus reduce the number of instructions
7684 required for a function call from 4 to 1.
7685
7686 The default is @option{-mlarge-text}.
7687
7688 @item -mcpu=@var{cpu_type}
7689 @opindex mcpu
7690 Set the instruction set and instruction scheduling parameters for
7691 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7692 style name or the corresponding chip number.  GCC supports scheduling
7693 parameters for the EV4, EV5 and EV6 family of processors and will
7694 choose the default values for the instruction set from the processor
7695 you specify.  If you do not specify a processor type, GCC will default
7696 to the processor on which the compiler was built.
7697
7698 Supported values for @var{cpu_type} are
7699
7700 @table @samp
7701 @item ev4
7702 @itemx ev45
7703 @itemx 21064
7704 Schedules as an EV4 and has no instruction set extensions.
7705
7706 @item ev5
7707 @itemx 21164
7708 Schedules as an EV5 and has no instruction set extensions.
7709
7710 @item ev56
7711 @itemx 21164a
7712 Schedules as an EV5 and supports the BWX extension.
7713
7714 @item pca56
7715 @itemx 21164pc
7716 @itemx 21164PC
7717 Schedules as an EV5 and supports the BWX and MAX extensions.
7718
7719 @item ev6
7720 @itemx 21264
7721 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7722
7723 @item ev67
7724 @itemx 21264a
7725 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7726 @end table
7727
7728 @item -mtune=@var{cpu_type}
7729 @opindex mtune
7730 Set only the instruction scheduling parameters for machine type
7731 @var{cpu_type}.  The instruction set is not changed.
7732
7733 @item -mmemory-latency=@var{time}
7734 @opindex mmemory-latency
7735 Sets the latency the scheduler should assume for typical memory
7736 references as seen by the application.  This number is highly
7737 dependent on the memory access patterns used by the application
7738 and the size of the external cache on the machine.
7739
7740 Valid options for @var{time} are
7741
7742 @table @samp
7743 @item @var{number}
7744 A decimal number representing clock cycles.
7745
7746 @item L1
7747 @itemx L2
7748 @itemx L3
7749 @itemx main
7750 The compiler contains estimates of the number of clock cycles for
7751 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7752 (also called Dcache, Scache, and Bcache), as well as to main memory.
7753 Note that L3 is only valid for EV5.
7754
7755 @end table
7756 @end table
7757
7758 @node DEC Alpha/VMS Options
7759 @subsection DEC Alpha/VMS Options
7760
7761 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7762
7763 @table @gcctabopt
7764 @item -mvms-return-codes
7765 @opindex mvms-return-codes
7766 Return VMS condition codes from main.  The default is to return POSIX
7767 style condition (e.g.@ error) codes.
7768 @end table
7769
7770 @node FRV Options
7771 @subsection FRV Options
7772 @cindex FRV Options
7773
7774 @table @gcctabopt
7775 @item -mgpr-32
7776 @opindex mgpr-32
7777
7778 Only use the first 32 general purpose registers.
7779
7780 @item -mgpr-64
7781 @opindex mgpr-64
7782
7783 Use all 64 general purpose registers.
7784
7785 @item -mfpr-32
7786 @opindex mfpr-32
7787
7788 Use only the first 32 floating point registers.
7789
7790 @item -mfpr-64
7791 @opindex mfpr-64
7792
7793 Use all 64 floating point registers
7794
7795 @item -mhard-float
7796 @opindex mhard-float
7797
7798 Use hardware instructions for floating point operations.
7799
7800 @item -msoft-float
7801 @opindex msoft-float
7802
7803 Use library routines for floating point operations.
7804
7805 @item -malloc-cc
7806 @opindex malloc-cc
7807
7808 Dynamically allocate condition code registers.
7809
7810 @item -mfixed-cc
7811 @opindex mfixed-cc
7812
7813 Do not try to dynamically allocate condition code registers, only
7814 use @code{icc0} and @code{fcc0}.
7815
7816 @item -mdword
7817 @opindex mdword
7818
7819 Change ABI to use double word insns.
7820
7821 @item -mno-dword
7822 @opindex mno-dword
7823
7824 Do not use double word instructions.
7825
7826 @item -mdouble
7827 @opindex mdouble
7828
7829 Use floating point double instructions.
7830
7831 @item -mno-double
7832 @opindex mno-double
7833
7834 Do not use floating point double instructions.
7835
7836 @item -mmedia
7837 @opindex mmedia
7838
7839 Use media instructions.
7840
7841 @item -mno-media
7842 @opindex mno-media
7843
7844 Do not use media instructions.
7845
7846 @item -mmuladd
7847 @opindex mmuladd
7848
7849 Use multiply and add/subtract instructions.
7850
7851 @item -mno-muladd
7852 @opindex mno-muladd
7853
7854 Do not use multiply and add/subtract instructions.
7855
7856 @item -mfdpic
7857 @opindex mfdpic
7858
7859 Select the FDPIC ABI, that uses function descriptors to represent
7860 pointers to functions.  Without any PIC/PIE-related options, it
7861 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7862 assumes GOT entries and small data are within a 12-bit range from the
7863 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7864 are computed with 32 bits.
7865
7866 @item -minline-plt
7867 @opindex minline-plt
7868
7869 Enable inlining of PLT entries in function calls to functions that are
7870 not known to bind locally.  It has no effect without @option{-mfdpic}.
7871 It's enabled by default if optimizing for speed and compiling for
7872 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7873 optimization option such as @option{-O3} or above is present in the
7874 command line.
7875
7876 @item -mTLS
7877 @opindex TLS
7878
7879 Assume a large TLS segment when generating thread-local code.
7880
7881 @item -mtls
7882 @opindex tls
7883
7884 Do not assume a large TLS segment when generating thread-local code.
7885
7886 @item -mgprel-ro
7887 @opindex mgprel-ro
7888
7889 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7890 that is known to be in read-only sections.  It's enabled by default,
7891 except for @option{-fpic} or @option{-fpie}: even though it may help
7892 make the global offset table smaller, it trades 1 instruction for 4.
7893 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7894 one of which may be shared by multiple symbols, and it avoids the need
7895 for a GOT entry for the referenced symbol, so it's more likely to be a
7896 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7897
7898 @item -multilib-library-pic
7899 @opindex multilib-library-pic
7900
7901 Link with the (library, not FD) pic libraries.  It's implied by
7902 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7903 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7904 it explicitly.
7905
7906 @item -mlinked-fp
7907 @opindex mlinked-fp
7908
7909 Follow the EABI requirement of always creating a frame pointer whenever
7910 a stack frame is allocated.  This option is enabled by default and can
7911 be disabled with @option{-mno-linked-fp}.
7912
7913 @item -mlong-calls
7914 @opindex mlong-calls
7915
7916 Use indirect addressing to call functions outside the current
7917 compilation unit.  This allows the functions to be placed anywhere
7918 within the 32-bit address space.
7919
7920 @item -malign-labels
7921 @opindex malign-labels
7922
7923 Try to align labels to an 8-byte boundary by inserting nops into the
7924 previous packet.  This option only has an effect when VLIW packing
7925 is enabled.  It doesn't create new packets; it merely adds nops to
7926 existing ones.
7927
7928 @item -mlibrary-pic
7929 @opindex mlibrary-pic
7930
7931 Generate position-independent EABI code.
7932
7933 @item -macc-4
7934 @opindex macc-4
7935
7936 Use only the first four media accumulator registers.
7937
7938 @item -macc-8
7939 @opindex macc-8
7940
7941 Use all eight media accumulator registers.
7942
7943 @item -mpack
7944 @opindex mpack
7945
7946 Pack VLIW instructions.
7947
7948 @item -mno-pack
7949 @opindex mno-pack
7950
7951 Do not pack VLIW instructions.
7952
7953 @item -mno-eflags
7954 @opindex mno-eflags
7955
7956 Do not mark ABI switches in e_flags.
7957
7958 @item -mcond-move
7959 @opindex mcond-move
7960
7961 Enable the use of conditional-move instructions (default).
7962
7963 This switch is mainly for debugging the compiler and will likely be removed
7964 in a future version.
7965
7966 @item -mno-cond-move
7967 @opindex mno-cond-move
7968
7969 Disable the use of conditional-move instructions.
7970
7971 This switch is mainly for debugging the compiler and will likely be removed
7972 in a future version.
7973
7974 @item -mscc
7975 @opindex mscc
7976
7977 Enable the use of conditional set instructions (default).
7978
7979 This switch is mainly for debugging the compiler and will likely be removed
7980 in a future version.
7981
7982 @item -mno-scc
7983 @opindex mno-scc
7984
7985 Disable the use of conditional set instructions.
7986
7987 This switch is mainly for debugging the compiler and will likely be removed
7988 in a future version.
7989
7990 @item -mcond-exec
7991 @opindex mcond-exec
7992
7993 Enable the use of conditional execution (default).
7994
7995 This switch is mainly for debugging the compiler and will likely be removed
7996 in a future version.
7997
7998 @item -mno-cond-exec
7999 @opindex mno-cond-exec
8000
8001 Disable the use of conditional execution.
8002
8003 This switch is mainly for debugging the compiler and will likely be removed
8004 in a future version.
8005
8006 @item -mvliw-branch
8007 @opindex mvliw-branch
8008
8009 Run a pass to pack branches into VLIW instructions (default).
8010
8011 This switch is mainly for debugging the compiler and will likely be removed
8012 in a future version.
8013
8014 @item -mno-vliw-branch
8015 @opindex mno-vliw-branch
8016
8017 Do not run a pass to pack branches into VLIW instructions.
8018
8019 This switch is mainly for debugging the compiler and will likely be removed
8020 in a future version.
8021
8022 @item -mmulti-cond-exec
8023 @opindex mmulti-cond-exec
8024
8025 Enable optimization of @code{&&} and @code{||} in conditional execution
8026 (default).
8027
8028 This switch is mainly for debugging the compiler and will likely be removed
8029 in a future version.
8030
8031 @item -mno-multi-cond-exec
8032 @opindex mno-multi-cond-exec
8033
8034 Disable optimization of @code{&&} and @code{||} in conditional execution.
8035
8036 This switch is mainly for debugging the compiler and will likely be removed
8037 in a future version.
8038
8039 @item -mnested-cond-exec
8040 @opindex mnested-cond-exec
8041
8042 Enable nested conditional execution optimizations (default).
8043
8044 This switch is mainly for debugging the compiler and will likely be removed
8045 in a future version.
8046
8047 @item -mno-nested-cond-exec
8048 @opindex mno-nested-cond-exec
8049
8050 Disable nested conditional execution optimizations.
8051
8052 This switch is mainly for debugging the compiler and will likely be removed
8053 in a future version.
8054
8055 @item -mtomcat-stats
8056 @opindex mtomcat-stats
8057
8058 Cause gas to print out tomcat statistics.
8059
8060 @item -mcpu=@var{cpu}
8061 @opindex mcpu
8062
8063 Select the processor type for which to generate code.  Possible values are
8064 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8065 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8066
8067 @end table
8068
8069 @node H8/300 Options
8070 @subsection H8/300 Options
8071
8072 These @samp{-m} options are defined for the H8/300 implementations:
8073
8074 @table @gcctabopt
8075 @item -mrelax
8076 @opindex mrelax
8077 Shorten some address references at link time, when possible; uses the
8078 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8079 ld, Using ld}, for a fuller description.
8080
8081 @item -mh
8082 @opindex mh
8083 Generate code for the H8/300H@.
8084
8085 @item -ms
8086 @opindex ms
8087 Generate code for the H8S@.
8088
8089 @item -mn
8090 @opindex mn
8091 Generate code for the H8S and H8/300H in the normal mode.  This switch
8092 must be used either with @option{-mh} or @option{-ms}.
8093
8094 @item -ms2600
8095 @opindex ms2600
8096 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8097
8098 @item -mint32
8099 @opindex mint32
8100 Make @code{int} data 32 bits by default.
8101
8102 @item -malign-300
8103 @opindex malign-300
8104 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8105 The default for the H8/300H and H8S is to align longs and floats on 4
8106 byte boundaries.
8107 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8108 This option has no effect on the H8/300.
8109 @end table
8110
8111 @node HPPA Options
8112 @subsection HPPA Options
8113 @cindex HPPA Options
8114
8115 These @samp{-m} options are defined for the HPPA family of computers:
8116
8117 @table @gcctabopt
8118 @item -march=@var{architecture-type}
8119 @opindex march
8120 Generate code for the specified architecture.  The choices for
8121 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8122 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8123 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8124 architecture option for your machine.  Code compiled for lower numbered
8125 architectures will run on higher numbered architectures, but not the
8126 other way around.
8127
8128 @item -mpa-risc-1-0
8129 @itemx -mpa-risc-1-1
8130 @itemx -mpa-risc-2-0
8131 @opindex mpa-risc-1-0
8132 @opindex mpa-risc-1-1
8133 @opindex mpa-risc-2-0
8134 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8135
8136 @item -mbig-switch
8137 @opindex mbig-switch
8138 Generate code suitable for big switch tables.  Use this option only if
8139 the assembler/linker complain about out of range branches within a switch
8140 table.
8141
8142 @item -mjump-in-delay
8143 @opindex mjump-in-delay
8144 Fill delay slots of function calls with unconditional jump instructions
8145 by modifying the return pointer for the function call to be the target
8146 of the conditional jump.
8147
8148 @item -mdisable-fpregs
8149 @opindex mdisable-fpregs
8150 Prevent floating point registers from being used in any manner.  This is
8151 necessary for compiling kernels which perform lazy context switching of
8152 floating point registers.  If you use this option and attempt to perform
8153 floating point operations, the compiler will abort.
8154
8155 @item -mdisable-indexing
8156 @opindex mdisable-indexing
8157 Prevent the compiler from using indexing address modes.  This avoids some
8158 rather obscure problems when compiling MIG generated code under MACH@.
8159
8160 @item -mno-space-regs
8161 @opindex mno-space-regs
8162 Generate code that assumes the target has no space registers.  This allows
8163 GCC to generate faster indirect calls and use unscaled index address modes.
8164
8165 Such code is suitable for level 0 PA systems and kernels.
8166
8167 @item -mfast-indirect-calls
8168 @opindex mfast-indirect-calls
8169 Generate code that assumes calls never cross space boundaries.  This
8170 allows GCC to emit code which performs faster indirect calls.
8171
8172 This option will not work in the presence of shared libraries or nested
8173 functions.
8174
8175 @item -mfixed-range=@var{register-range}
8176 @opindex mfixed-range
8177 Generate code treating the given register range as fixed registers.
8178 A fixed register is one that the register allocator can not use.  This is
8179 useful when compiling kernel code.  A register range is specified as
8180 two registers separated by a dash.  Multiple register ranges can be
8181 specified separated by a comma.
8182
8183 @item -mlong-load-store
8184 @opindex mlong-load-store
8185 Generate 3-instruction load and store sequences as sometimes required by
8186 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8187 the HP compilers.
8188
8189 @item -mportable-runtime
8190 @opindex mportable-runtime
8191 Use the portable calling conventions proposed by HP for ELF systems.
8192
8193 @item -mgas
8194 @opindex mgas
8195 Enable the use of assembler directives only GAS understands.
8196
8197 @item -mschedule=@var{cpu-type}
8198 @opindex mschedule
8199 Schedule code according to the constraints for the machine type
8200 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8201 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8202 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8203 proper scheduling option for your machine.  The default scheduling is
8204 @samp{8000}.
8205
8206 @item -mlinker-opt
8207 @opindex mlinker-opt
8208 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8209 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8210 linkers in which they give bogus error messages when linking some programs.
8211
8212 @item -msoft-float
8213 @opindex msoft-float
8214 Generate output containing library calls for floating point.
8215 @strong{Warning:} the requisite libraries are not available for all HPPA
8216 targets.  Normally the facilities of the machine's usual C compiler are
8217 used, but this cannot be done directly in cross-compilation.  You must make
8218 your own arrangements to provide suitable library functions for
8219 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8220 does provide software floating point support.
8221
8222 @option{-msoft-float} changes the calling convention in the output file;
8223 therefore, it is only useful if you compile @emph{all} of a program with
8224 this option.  In particular, you need to compile @file{libgcc.a}, the
8225 library that comes with GCC, with @option{-msoft-float} in order for
8226 this to work.
8227
8228 @item -msio
8229 @opindex msio
8230 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8231 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8232 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8233 options are available under HP-UX and HI-UX@.
8234
8235 @item -mgnu-ld
8236 @opindex gnu-ld
8237 Use GNU ld specific options.  This passes @option{-shared} to ld when
8238 building a shared library.  It is the default when GCC is configured,
8239 explicitly or implicitly, with the GNU linker.  This option does not
8240 have any affect on which ld is called, it only changes what parameters
8241 are passed to that ld.  The ld that is called is determined by the
8242 @option{--with-ld} configure option, GCC's program search path, and
8243 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8244 using @samp{which `gcc -print-prog-name=ld`}.
8245
8246 @item -mhp-ld
8247 @opindex hp-ld
8248 Use HP ld specific options.  This passes @option{-b} to ld when building
8249 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8250 links.  It is the default when GCC is configured, explicitly or
8251 implicitly, with the HP linker.  This option does not have any affect on
8252 which ld is called, it only changes what parameters are passed to that
8253 ld.  The ld that is called is determined by the @option{--with-ld}
8254 configure option, GCC's program search path, and finally by the user's
8255 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8256 `gcc -print-prog-name=ld`}.
8257
8258 @item -mlong-calls
8259 @opindex mno-long-calls
8260 Generate code that uses long call sequences.  This ensures that a call
8261 is always able to reach linker generated stubs.  The default is to generate
8262 long calls only when the distance from the call site to the beginning
8263 of the function or translation unit, as the case may be, exceeds a
8264 predefined limit set by the branch type being used.  The limits for
8265 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8266 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8267 240,000 bytes.
8268
8269 Distances are measured from the beginning of functions when using the
8270 @option{-ffunction-sections} option, or when using the @option{-mgas}
8271 and @option{-mno-portable-runtime} options together under HP-UX with
8272 the SOM linker.
8273
8274 It is normally not desirable to use this option as it will degrade
8275 performance.  However, it may be useful in large applications,
8276 particularly when partial linking is used to build the application.
8277
8278 The types of long calls used depends on the capabilities of the
8279 assembler and linker, and the type of code being generated.  The
8280 impact on systems that support long absolute calls, and long pic
8281 symbol-difference or pc-relative calls should be relatively small.
8282 However, an indirect call is used on 32-bit ELF systems in pic code
8283 and it is quite long.
8284
8285 @item -munix=@var{unix-std}
8286 @opindex march
8287 Generate compiler predefines and select a startfile for the specified
8288 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8289 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8290 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8291 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8292 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8293 and later.
8294
8295 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8296 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8297 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8298 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8299 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8300 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8301
8302 It is @emph{important} to note that this option changes the interfaces
8303 for various library routines.  It also affects the operational behavior
8304 of the C library.  Thus, @emph{extreme} care is needed in using this
8305 option.
8306
8307 Library code that is intended to operate with more than one UNIX
8308 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8309 as appropriate.  Most GNU software doesn't provide this capability.
8310
8311 @item -nolibdld
8312 @opindex nolibdld
8313 Suppress the generation of link options to search libdld.sl when the
8314 @option{-static} option is specified on HP-UX 10 and later.
8315
8316 @item -static
8317 @opindex static
8318 The HP-UX implementation of setlocale in libc has a dependency on
8319 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8320 when the @option{-static} option is specified, special link options
8321 are needed to resolve this dependency.
8322
8323 On HP-UX 10 and later, the GCC driver adds the necessary options to
8324 link with libdld.sl when the @option{-static} option is specified.
8325 This causes the resulting binary to be dynamic.  On the 64-bit port,
8326 the linkers generate dynamic binaries by default in any case.  The
8327 @option{-nolibdld} option can be used to prevent the GCC driver from
8328 adding these link options.
8329
8330 @item -threads
8331 @opindex threads
8332 Add support for multithreading with the @dfn{dce thread} library
8333 under HP-UX@.  This option sets flags for both the preprocessor and
8334 linker.
8335 @end table
8336
8337 @node i386 and x86-64 Options
8338 @subsection Intel 386 and AMD x86-64 Options
8339 @cindex i386 Options
8340 @cindex x86-64 Options
8341 @cindex Intel 386 Options
8342 @cindex AMD x86-64 Options
8343
8344 These @samp{-m} options are defined for the i386 and x86-64 family of
8345 computers:
8346
8347 @table @gcctabopt
8348 @item -mtune=@var{cpu-type}
8349 @opindex mtune
8350 Tune to @var{cpu-type} everything applicable about the generated code, except
8351 for the ABI and the set of available instructions.  The choices for
8352 @var{cpu-type} are:
8353 @table @emph
8354 @item i386
8355 Original Intel's i386 CPU@.
8356 @item i486
8357 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8358 @item i586, pentium
8359 Intel Pentium CPU with no MMX support.
8360 @item pentium-mmx
8361 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8362 @item i686, pentiumpro
8363 Intel PentiumPro CPU@.
8364 @item pentium2
8365 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8366 @item pentium3, pentium3m
8367 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8368 support.
8369 @item pentium-m
8370 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8371 support.  Used by Centrino notebooks.
8372 @item pentium4, pentium4m
8373 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8374 @item prescott
8375 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8376 set support.
8377 @item nocona
8378 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8379 SSE2 and SSE3 instruction set support.
8380 @item k6
8381 AMD K6 CPU with MMX instruction set support.
8382 @item k6-2, k6-3
8383 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8384 @item athlon, athlon-tbird
8385 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8386 support.
8387 @item athlon-4, athlon-xp, athlon-mp
8388 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8389 instruction set support.
8390 @item k8, opteron, athlon64, athlon-fx
8391 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8392 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8393 @item winchip-c6
8394 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8395 set support.
8396 @item winchip2
8397 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8398 instruction set support.
8399 @item c3
8400 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8401 implemented for this chip.)
8402 @item c3-2
8403 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8404 implemented for this chip.)
8405 @end table
8406
8407 While picking a specific @var{cpu-type} will schedule things appropriately
8408 for that particular chip, the compiler will not generate any code that
8409 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8410 being used.
8411
8412 @item -march=@var{cpu-type}
8413 @opindex march
8414 Generate instructions for the machine type @var{cpu-type}.  The choices
8415 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8416 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8417
8418 @item -mcpu=@var{cpu-type}
8419 @opindex mcpu
8420 A deprecated synonym for @option{-mtune}.
8421
8422 @item -m386
8423 @itemx -m486
8424 @itemx -mpentium
8425 @itemx -mpentiumpro
8426 @opindex m386
8427 @opindex m486
8428 @opindex mpentium
8429 @opindex mpentiumpro
8430 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8431 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8432 These synonyms are deprecated.
8433
8434 @item -mfpmath=@var{unit}
8435 @opindex march
8436 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8437 for @var{unit} are:
8438
8439 @table @samp
8440 @item 387
8441 Use the standard 387 floating point coprocessor present majority of chips and
8442 emulated otherwise.  Code compiled with this option will run almost everywhere.
8443 The temporary results are computed in 80bit precision instead of precision
8444 specified by the type resulting in slightly different results compared to most
8445 of other chips.  See @option{-ffloat-store} for more detailed description.
8446
8447 This is the default choice for i386 compiler.
8448
8449 @item sse
8450 Use scalar floating point instructions present in the SSE instruction set.
8451 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8452 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8453 instruction set supports only single precision arithmetics, thus the double and
8454 extended precision arithmetics is still done using 387.  Later version, present
8455 only in Pentium4 and the future AMD x86-64 chips supports double precision
8456 arithmetics too.
8457
8458 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8459 or @option{-msse2} switches to enable SSE extensions and make this option
8460 effective.  For the x86-64 compiler, these extensions are enabled by default.
8461
8462 The resulting code should be considerably faster in the majority of cases and avoid
8463 the numerical instability problems of 387 code, but may break some existing
8464 code that expects temporaries to be 80bit.
8465
8466 This is the default choice for the x86-64 compiler.
8467
8468 @item sse,387
8469 Attempt to utilize both instruction sets at once.  This effectively double the
8470 amount of available registers and on chips with separate execution units for
8471 387 and SSE the execution resources too.  Use this option with care, as it is
8472 still experimental, because the GCC register allocator does not model separate
8473 functional units well resulting in instable performance.
8474 @end table
8475
8476 @item -masm=@var{dialect}
8477 @opindex masm=@var{dialect}
8478 Output asm instructions using selected @var{dialect}.  Supported choices are
8479 @samp{intel} or @samp{att} (the default one).
8480
8481 @item -mieee-fp
8482 @itemx -mno-ieee-fp
8483 @opindex mieee-fp
8484 @opindex mno-ieee-fp
8485 Control whether or not the compiler uses IEEE floating point
8486 comparisons.  These handle correctly the case where the result of a
8487 comparison is unordered.
8488
8489 @item -msoft-float
8490 @opindex msoft-float
8491 Generate output containing library calls for floating point.
8492 @strong{Warning:} the requisite libraries are not part of GCC@.
8493 Normally the facilities of the machine's usual C compiler are used, but
8494 this can't be done directly in cross-compilation.  You must make your
8495 own arrangements to provide suitable library functions for
8496 cross-compilation.
8497
8498 On machines where a function returns floating point results in the 80387
8499 register stack, some floating point opcodes may be emitted even if
8500 @option{-msoft-float} is used.
8501
8502 @item -mno-fp-ret-in-387
8503 @opindex mno-fp-ret-in-387
8504 Do not use the FPU registers for return values of functions.
8505
8506 The usual calling convention has functions return values of types
8507 @code{float} and @code{double} in an FPU register, even if there
8508 is no FPU@.  The idea is that the operating system should emulate
8509 an FPU@.
8510
8511 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8512 in ordinary CPU registers instead.
8513
8514 @item -mno-fancy-math-387
8515 @opindex mno-fancy-math-387
8516 Some 387 emulators do not support the @code{sin}, @code{cos} and
8517 @code{sqrt} instructions for the 387.  Specify this option to avoid
8518 generating those instructions.  This option is the default on FreeBSD,
8519 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8520 indicates that the target cpu will always have an FPU and so the
8521 instruction will not need emulation.  As of revision 2.6.1, these
8522 instructions are not generated unless you also use the
8523 @option{-funsafe-math-optimizations} switch.
8524
8525 @item -malign-double
8526 @itemx -mno-align-double
8527 @opindex malign-double
8528 @opindex mno-align-double
8529 Control whether GCC aligns @code{double}, @code{long double}, and
8530 @code{long long} variables on a two word boundary or a one word
8531 boundary.  Aligning @code{double} variables on a two word boundary will
8532 produce code that runs somewhat faster on a @samp{Pentium} at the
8533 expense of more memory.
8534
8535 @strong{Warning:} if you use the @option{-malign-double} switch,
8536 structures containing the above types will be aligned differently than
8537 the published application binary interface specifications for the 386
8538 and will not be binary compatible with structures in code compiled
8539 without that switch.
8540
8541 @item -m96bit-long-double
8542 @itemx -m128bit-long-double
8543 @opindex m96bit-long-double
8544 @opindex m128bit-long-double
8545 These switches control the size of @code{long double} type.  The i386
8546 application binary interface specifies the size to be 96 bits,
8547 so @option{-m96bit-long-double} is the default in 32 bit mode.
8548
8549 Modern architectures (Pentium and newer) would prefer @code{long double}
8550 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8551 conforming to the ABI, this would not be possible.  So specifying a
8552 @option{-m128bit-long-double} will align @code{long double}
8553 to a 16 byte boundary by padding the @code{long double} with an additional
8554 32 bit zero.
8555
8556 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8557 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8558
8559 Notice that neither of these options enable any extra precision over the x87
8560 standard of 80 bits for a @code{long double}.
8561
8562 @strong{Warning:} if you override the default value for your target ABI, the
8563 structures and arrays containing @code{long double} variables will change
8564 their size as well as function calling convention for function taking
8565 @code{long double} will be modified.  Hence they will not be binary
8566 compatible with arrays or structures in code compiled without that switch.
8567
8568
8569 @item -msvr3-shlib
8570 @itemx -mno-svr3-shlib
8571 @opindex msvr3-shlib
8572 @opindex mno-svr3-shlib
8573 Control whether GCC places uninitialized local variables into the
8574 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8575 into @code{bss}.  These options are meaningful only on System V Release 3.
8576
8577 @item -mrtd
8578 @opindex mrtd
8579 Use a different function-calling convention, in which functions that
8580 take a fixed number of arguments return with the @code{ret} @var{num}
8581 instruction, which pops their arguments while returning.  This saves one
8582 instruction in the caller since there is no need to pop the arguments
8583 there.
8584
8585 You can specify that an individual function is called with this calling
8586 sequence with the function attribute @samp{stdcall}.  You can also
8587 override the @option{-mrtd} option by using the function attribute
8588 @samp{cdecl}.  @xref{Function Attributes}.
8589
8590 @strong{Warning:} this calling convention is incompatible with the one
8591 normally used on Unix, so you cannot use it if you need to call
8592 libraries compiled with the Unix compiler.
8593
8594 Also, you must provide function prototypes for all functions that
8595 take variable numbers of arguments (including @code{printf});
8596 otherwise incorrect code will be generated for calls to those
8597 functions.
8598
8599 In addition, seriously incorrect code will result if you call a
8600 function with too many arguments.  (Normally, extra arguments are
8601 harmlessly ignored.)
8602
8603 @item -mregparm=@var{num}
8604 @opindex mregparm
8605 Control how many registers are used to pass integer arguments.  By
8606 default, no registers are used to pass arguments, and at most 3
8607 registers can be used.  You can control this behavior for a specific
8608 function by using the function attribute @samp{regparm}.
8609 @xref{Function Attributes}.
8610
8611 @strong{Warning:} if you use this switch, and
8612 @var{num} is nonzero, then you must build all modules with the same
8613 value, including any libraries.  This includes the system libraries and
8614 startup modules.
8615
8616 @item -mpreferred-stack-boundary=@var{num}
8617 @opindex mpreferred-stack-boundary
8618 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8619 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8620 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8621 size (@option{-Os}), in which case the default is the minimum correct
8622 alignment (4 bytes for x86, and 8 bytes for x86-64).
8623
8624 On Pentium and PentiumPro, @code{double} and @code{long double} values
8625 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8626 suffer significant run time performance penalties.  On Pentium III, the
8627 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8628 penalties if it is not 16 byte aligned.
8629
8630 To ensure proper alignment of this values on the stack, the stack boundary
8631 must be as aligned as that required by any value stored on the stack.
8632 Further, every function must be generated such that it keeps the stack
8633 aligned.  Thus calling a function compiled with a higher preferred
8634 stack boundary from a function compiled with a lower preferred stack
8635 boundary will most likely misalign the stack.  It is recommended that
8636 libraries that use callbacks always use the default setting.
8637
8638 This extra alignment does consume extra stack space, and generally
8639 increases code size.  Code that is sensitive to stack space usage, such
8640 as embedded systems and operating system kernels, may want to reduce the
8641 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8642
8643 @item -mmmx
8644 @itemx -mno-mmx
8645 @item -msse
8646 @itemx -mno-sse
8647 @item -msse2
8648 @itemx -mno-sse2
8649 @item -msse3
8650 @itemx -mno-sse3
8651 @item -m3dnow
8652 @itemx -mno-3dnow
8653 @opindex mmmx
8654 @opindex mno-mmx
8655 @opindex msse
8656 @opindex mno-sse
8657 @opindex m3dnow
8658 @opindex mno-3dnow
8659 These switches enable or disable the use of built-in functions that allow
8660 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8661 instruction set.
8662
8663 @xref{X86 Built-in Functions}, for details of the functions enabled
8664 and disabled by these switches.
8665
8666 To have SSE/SSE2 instructions generated automatically from floating-point
8667 code, see @option{-mfpmath=sse}.
8668
8669 @item -mpush-args
8670 @itemx -mno-push-args
8671 @opindex mpush-args
8672 @opindex mno-push-args
8673 Use PUSH operations to store outgoing parameters.  This method is shorter
8674 and usually equally fast as method using SUB/MOV operations and is enabled
8675 by default.  In some cases disabling it may improve performance because of
8676 improved scheduling and reduced dependencies.
8677
8678 @item -maccumulate-outgoing-args
8679 @opindex maccumulate-outgoing-args
8680 If enabled, the maximum amount of space required for outgoing arguments will be
8681 computed in the function prologue.  This is faster on most modern CPUs
8682 because of reduced dependencies, improved scheduling and reduced stack usage
8683 when preferred stack boundary is not equal to 2.  The drawback is a notable
8684 increase in code size.  This switch implies @option{-mno-push-args}.
8685
8686 @item -mthreads
8687 @opindex mthreads
8688 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8689 on thread-safe exception handling must compile and link all code with the
8690 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8691 @option{-D_MT}; when linking, it links in a special thread helper library
8692 @option{-lmingwthrd} which cleans up per thread exception handling data.
8693
8694 @item -mno-align-stringops
8695 @opindex mno-align-stringops
8696 Do not align destination of inlined string operations.  This switch reduces
8697 code size and improves performance in case the destination is already aligned,
8698 but GCC doesn't know about it.
8699
8700 @item -minline-all-stringops
8701 @opindex minline-all-stringops
8702 By default GCC inlines string operations only when destination is known to be
8703 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8704 size, but may improve performance of code that depends on fast memcpy, strlen
8705 and memset for short lengths.
8706
8707 @item -momit-leaf-frame-pointer
8708 @opindex momit-leaf-frame-pointer
8709 Don't keep the frame pointer in a register for leaf functions.  This
8710 avoids the instructions to save, set up and restore frame pointers and
8711 makes an extra register available in leaf functions.  The option
8712 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8713 which might make debugging harder.
8714
8715 @item -mtls-direct-seg-refs
8716 @itemx -mno-tls-direct-seg-refs
8717 @opindex mtls-direct-seg-refs
8718 Controls whether TLS variables may be accessed with offsets from the
8719 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8720 or whether the thread base pointer must be added.  Whether or not this
8721 is legal depends on the operating system, and whether it maps the
8722 segment to cover the entire TLS area.
8723
8724 For systems that use GNU libc, the default is on.
8725 @end table
8726
8727 These @samp{-m} switches are supported in addition to the above
8728 on AMD x86-64 processors in 64-bit environments.
8729
8730 @table @gcctabopt
8731 @item -m32
8732 @itemx -m64
8733 @opindex m32
8734 @opindex m64
8735 Generate code for a 32-bit or 64-bit environment.
8736 The 32-bit environment sets int, long and pointer to 32 bits and
8737 generates code that runs on any i386 system.
8738 The 64-bit environment sets int to 32 bits and long and pointer
8739 to 64 bits and generates code for AMD's x86-64 architecture.
8740
8741 @item -mno-red-zone
8742 @opindex no-red-zone
8743 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8744 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8745 stack pointer that will not be modified by signal or interrupt handlers
8746 and therefore can be used for temporary data without adjusting the stack
8747 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8748
8749 @item -mcmodel=small
8750 @opindex mcmodel=small
8751 Generate code for the small code model: the program and its symbols must
8752 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8753 Programs can be statically or dynamically linked.  This is the default
8754 code model.
8755
8756 @item -mcmodel=kernel
8757 @opindex mcmodel=kernel
8758 Generate code for the kernel code model.  The kernel runs in the
8759 negative 2 GB of the address space.
8760 This model has to be used for Linux kernel code.
8761
8762 @item -mcmodel=medium
8763 @opindex mcmodel=medium
8764 Generate code for the medium model: The program is linked in the lower 2
8765 GB of the address space but symbols can be located anywhere in the
8766 address space.  Programs can be statically or dynamically linked, but
8767 building of shared libraries are not supported with the medium model.
8768
8769 @item -mcmodel=large
8770 @opindex mcmodel=large
8771 Generate code for the large model: This model makes no assumptions
8772 about addresses and sizes of sections.  Currently GCC does not implement
8773 this model.
8774 @end table
8775
8776 @node IA-64 Options
8777 @subsection IA-64 Options
8778 @cindex IA-64 Options
8779
8780 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8781
8782 @table @gcctabopt
8783 @item -mbig-endian
8784 @opindex mbig-endian
8785 Generate code for a big endian target.  This is the default for HP-UX@.
8786
8787 @item -mlittle-endian
8788 @opindex mlittle-endian
8789 Generate code for a little endian target.  This is the default for AIX5
8790 and GNU/Linux.
8791
8792 @item -mgnu-as
8793 @itemx -mno-gnu-as
8794 @opindex mgnu-as
8795 @opindex mno-gnu-as
8796 Generate (or don't) code for the GNU assembler.  This is the default.
8797 @c Also, this is the default if the configure option @option{--with-gnu-as}
8798 @c is used.
8799
8800 @item -mgnu-ld
8801 @itemx -mno-gnu-ld
8802 @opindex mgnu-ld
8803 @opindex mno-gnu-ld
8804 Generate (or don't) code for the GNU linker.  This is the default.
8805 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8806 @c is used.
8807
8808 @item -mno-pic
8809 @opindex mno-pic
8810 Generate code that does not use a global pointer register.  The result
8811 is not position independent code, and violates the IA-64 ABI@.
8812
8813 @item -mvolatile-asm-stop
8814 @itemx -mno-volatile-asm-stop
8815 @opindex mvolatile-asm-stop
8816 @opindex mno-volatile-asm-stop
8817 Generate (or don't) a stop bit immediately before and after volatile asm
8818 statements.
8819
8820 @item -mb-step
8821 @opindex mb-step
8822 Generate code that works around Itanium B step errata.
8823
8824 @item -mregister-names
8825 @itemx -mno-register-names
8826 @opindex mregister-names
8827 @opindex mno-register-names
8828 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8829 the stacked registers.  This may make assembler output more readable.
8830
8831 @item -mno-sdata
8832 @itemx -msdata
8833 @opindex mno-sdata
8834 @opindex msdata
8835 Disable (or enable) optimizations that use the small data section.  This may
8836 be useful for working around optimizer bugs.
8837
8838 @item -mconstant-gp
8839 @opindex mconstant-gp
8840 Generate code that uses a single constant global pointer value.  This is
8841 useful when compiling kernel code.
8842
8843 @item -mauto-pic
8844 @opindex mauto-pic
8845 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8846 This is useful when compiling firmware code.
8847
8848 @item -minline-float-divide-min-latency
8849 @opindex minline-float-divide-min-latency
8850 Generate code for inline divides of floating point values
8851 using the minimum latency algorithm.
8852
8853 @item -minline-float-divide-max-throughput
8854 @opindex minline-float-divide-max-throughput
8855 Generate code for inline divides of floating point values
8856 using the maximum throughput algorithm.
8857
8858 @item -minline-int-divide-min-latency
8859 @opindex minline-int-divide-min-latency
8860 Generate code for inline divides of integer values
8861 using the minimum latency algorithm.
8862
8863 @item -minline-int-divide-max-throughput
8864 @opindex minline-int-divide-max-throughput
8865 Generate code for inline divides of integer values
8866 using the maximum throughput algorithm.
8867
8868 @item -minline-sqrt-min-latency
8869 @opindex minline-sqrt-min-latency
8870 Generate code for inline square roots
8871 using the minimum latency algorithm.
8872
8873 @item -minline-sqrt-max-throughput
8874 @opindex minline-sqrt-max-throughput
8875 Generate code for inline square roots
8876 using the maximum throughput algorithm.
8877
8878 @item -mno-dwarf2-asm
8879 @itemx -mdwarf2-asm
8880 @opindex mno-dwarf2-asm
8881 @opindex mdwarf2-asm
8882 Don't (or do) generate assembler code for the DWARF2 line number debugging
8883 info.  This may be useful when not using the GNU assembler.
8884
8885 @item -mearly-stop-bits
8886 @itemx -mno-early-stop-bits
8887 @opindex mearly-stop-bits
8888 @opindex mno-early-stop-bits
8889 Allow stop bits to be placed earlier than immediately preceding the
8890 instruction that triggered the stop bit.  This can improve instruction
8891 scheduling, but does not always do so.
8892
8893 @item -mfixed-range=@var{register-range}
8894 @opindex mfixed-range
8895 Generate code treating the given register range as fixed registers.
8896 A fixed register is one that the register allocator can not use.  This is
8897 useful when compiling kernel code.  A register range is specified as
8898 two registers separated by a dash.  Multiple register ranges can be
8899 specified separated by a comma.
8900
8901 @item -mtls-size=@var{tls-size}
8902 @opindex mtls-size
8903 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
8904 64.
8905
8906 @item -mtune-arch=@var{cpu-type}
8907 @opindex mtune-arch
8908 Tune the instruction scheduling for a particular CPU, Valid values are
8909 itanium, itanium1, merced, itanium2, and mckinley.
8910
8911 @item -mt
8912 @itemx -pthread
8913 @opindex mt
8914 @opindex pthread
8915 Add support for multithreading using the POSIX threads library.  This
8916 option sets flags for both the preprocessor and linker.  It does
8917 not affect the thread safety of object code produced by the compiler or
8918 that of libraries supplied with it.  These are HP-UX specific flags.
8919
8920 @item -milp32
8921 @itemx -mlp64
8922 @opindex milp32
8923 @opindex mlp64
8924 Generate code for a 32-bit or 64-bit environment.
8925 The 32-bit environment sets int, long and pointer to 32 bits.
8926 The 64-bit environment sets int to 32 bits and long and pointer
8927 to 64 bits.  These are HP-UX specific flags.
8928
8929 @end table
8930
8931 @node M32R/D Options
8932 @subsection M32R/D Options
8933 @cindex M32R/D options
8934
8935 These @option{-m} options are defined for Renesas M32R/D architectures:
8936
8937 @table @gcctabopt
8938 @item -m32r2
8939 @opindex m32r2
8940 Generate code for the M32R/2@.
8941
8942 @item -m32rx
8943 @opindex m32rx
8944 Generate code for the M32R/X@.
8945
8946 @item -m32r
8947 @opindex m32r
8948 Generate code for the M32R@.  This is the default.
8949
8950 @item -mmodel=small
8951 @opindex mmodel=small
8952 Assume all objects live in the lower 16MB of memory (so that their addresses
8953 can be loaded with the @code{ld24} instruction), and assume all subroutines
8954 are reachable with the @code{bl} instruction.
8955 This is the default.
8956
8957 The addressability of a particular object can be set with the
8958 @code{model} attribute.
8959
8960 @item -mmodel=medium
8961 @opindex mmodel=medium
8962 Assume objects may be anywhere in the 32-bit address space (the compiler
8963 will generate @code{seth/add3} instructions to load their addresses), and
8964 assume all subroutines are reachable with the @code{bl} instruction.
8965
8966 @item -mmodel=large
8967 @opindex mmodel=large
8968 Assume objects may be anywhere in the 32-bit address space (the compiler
8969 will generate @code{seth/add3} instructions to load their addresses), and
8970 assume subroutines may not be reachable with the @code{bl} instruction
8971 (the compiler will generate the much slower @code{seth/add3/jl}
8972 instruction sequence).
8973
8974 @item -msdata=none
8975 @opindex msdata=none
8976 Disable use of the small data area.  Variables will be put into
8977 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8978 @code{section} attribute has been specified).
8979 This is the default.
8980
8981 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8982 Objects may be explicitly put in the small data area with the
8983 @code{section} attribute using one of these sections.
8984
8985 @item -msdata=sdata
8986 @opindex msdata=sdata
8987 Put small global and static data in the small data area, but do not
8988 generate special code to reference them.
8989
8990 @item -msdata=use
8991 @opindex msdata=use
8992 Put small global and static data in the small data area, and generate
8993 special instructions to reference them.
8994
8995 @item -G @var{num}
8996 @opindex G
8997 @cindex smaller data references
8998 Put global and static objects less than or equal to @var{num} bytes
8999 into the small data or bss sections instead of the normal data or bss
9000 sections.  The default value of @var{num} is 8.
9001 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9002 for this option to have any effect.
9003
9004 All modules should be compiled with the same @option{-G @var{num}} value.
9005 Compiling with different values of @var{num} may or may not work; if it
9006 doesn't the linker will give an error message---incorrect code will not be
9007 generated.
9008
9009 @item -mdebug
9010 @opindex mdebug
9011 Makes the M32R specific code in the compiler display some statistics
9012 that might help in debugging programs.
9013
9014 @item -malign-loops
9015 @opindex malign-loops
9016 Align all loops to a 32-byte boundary.
9017
9018 @item -mno-align-loops
9019 @opindex mno-align-loops
9020 Do not enforce a 32-byte alignment for loops.  This is the default.
9021
9022 @item -missue-rate=@var{number}
9023 @opindex missue-rate=@var{number}
9024 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9025 or 2.
9026
9027 @item -mbranch-cost=@var{number}
9028 @opindex mbranch-cost=@var{number}
9029 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9030 preferred over conditional code, if it is 2, then the opposite will
9031 apply.
9032
9033 @item -mflush-trap=@var{number}
9034 @opindex mflush-trap=@var{number}
9035 Specifies the trap number to use to flush the cache.  The default is
9036 12.  Valid numbers are between 0 and 15 inclusive.
9037
9038 @item -mno-flush-trap
9039 @opindex mno-flush-trap
9040 Specifies that the cache cannot be flushed by using a trap.
9041
9042 @item -mflush-func=@var{name}
9043 @opindex mflush-func=@var{name}
9044 Specifies the name of the operating system function to call to flush
9045 the cache.  The default is @emph{_flush_cache}, but a function call
9046 will only be used if a trap is not available.
9047
9048 @item -mno-flush-func
9049 @opindex mno-flush-func
9050 Indicates that there is no OS function for flushing the cache.
9051
9052 @end table
9053
9054 @node M680x0 Options
9055 @subsection M680x0 Options
9056 @cindex M680x0 options
9057
9058 These are the @samp{-m} options defined for the 68000 series.  The default
9059 values for these options depends on which style of 68000 was selected when
9060 the compiler was configured; the defaults for the most common choices are
9061 given below.
9062
9063 @table @gcctabopt
9064 @item -m68000
9065 @itemx -mc68000
9066 @opindex m68000
9067 @opindex mc68000
9068 Generate output for a 68000.  This is the default
9069 when the compiler is configured for 68000-based systems.
9070
9071 Use this option for microcontrollers with a 68000 or EC000 core,
9072 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9073
9074 @item -m68020
9075 @itemx -mc68020
9076 @opindex m68020
9077 @opindex mc68020
9078 Generate output for a 68020.  This is the default
9079 when the compiler is configured for 68020-based systems.
9080
9081 @item -m68881
9082 @opindex m68881
9083 Generate output containing 68881 instructions for floating point.
9084 This is the default for most 68020 systems unless @option{--nfp} was
9085 specified when the compiler was configured.
9086
9087 @item -m68030
9088 @opindex m68030
9089 Generate output for a 68030.  This is the default when the compiler is
9090 configured for 68030-based systems.
9091
9092 @item -m68040
9093 @opindex m68040
9094 Generate output for a 68040.  This is the default when the compiler is
9095 configured for 68040-based systems.
9096
9097 This option inhibits the use of 68881/68882 instructions that have to be
9098 emulated by software on the 68040.  Use this option if your 68040 does not
9099 have code to emulate those instructions.
9100
9101 @item -m68060
9102 @opindex m68060
9103 Generate output for a 68060.  This is the default when the compiler is
9104 configured for 68060-based systems.
9105
9106 This option inhibits the use of 68020 and 68881/68882 instructions that
9107 have to be emulated by software on the 68060.  Use this option if your 68060
9108 does not have code to emulate those instructions.
9109
9110 @item -mcpu32
9111 @opindex mcpu32
9112 Generate output for a CPU32.  This is the default
9113 when the compiler is configured for CPU32-based systems.
9114
9115 Use this option for microcontrollers with a
9116 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9117 68336, 68340, 68341, 68349 and 68360.
9118
9119 @item -m5200
9120 @opindex m5200
9121 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9122 when the compiler is configured for 520X-based systems.
9123
9124 Use this option for microcontroller with a 5200 core, including
9125 the MCF5202, MCF5203, MCF5204 and MCF5202.
9126
9127
9128 @item -m68020-40
9129 @opindex m68020-40
9130 Generate output for a 68040, without using any of the new instructions.
9131 This results in code which can run relatively efficiently on either a
9132 68020/68881 or a 68030 or a 68040.  The generated code does use the
9133 68881 instructions that are emulated on the 68040.
9134
9135 @item -m68020-60
9136 @opindex m68020-60
9137 Generate output for a 68060, without using any of the new instructions.
9138 This results in code which can run relatively efficiently on either a
9139 68020/68881 or a 68030 or a 68040.  The generated code does use the
9140 68881 instructions that are emulated on the 68060.
9141
9142 @item -msoft-float
9143 @opindex msoft-float
9144 Generate output containing library calls for floating point.
9145 @strong{Warning:} the requisite libraries are not available for all m68k
9146 targets.  Normally the facilities of the machine's usual C compiler are
9147 used, but this can't be done directly in cross-compilation.  You must
9148 make your own arrangements to provide suitable library functions for
9149 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9150 @samp{m68k-*-coff} do provide software floating point support.
9151
9152 @item -mshort
9153 @opindex mshort
9154 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9155 Additionally, parameters passed on the stack are also aligned to a
9156 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9157
9158 @item -mnobitfield
9159 @opindex mnobitfield
9160 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9161 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9162
9163 @item -mbitfield
9164 @opindex mbitfield
9165 Do use the bit-field instructions.  The @option{-m68020} option implies
9166 @option{-mbitfield}.  This is the default if you use a configuration
9167 designed for a 68020.
9168
9169 @item -mrtd
9170 @opindex mrtd
9171 Use a different function-calling convention, in which functions
9172 that take a fixed number of arguments return with the @code{rtd}
9173 instruction, which pops their arguments while returning.  This
9174 saves one instruction in the caller since there is no need to pop
9175 the arguments there.
9176
9177 This calling convention is incompatible with the one normally
9178 used on Unix, so you cannot use it if you need to call libraries
9179 compiled with the Unix compiler.
9180
9181 Also, you must provide function prototypes for all functions that
9182 take variable numbers of arguments (including @code{printf});
9183 otherwise incorrect code will be generated for calls to those
9184 functions.
9185
9186 In addition, seriously incorrect code will result if you call a
9187 function with too many arguments.  (Normally, extra arguments are
9188 harmlessly ignored.)
9189
9190 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9191 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9192
9193 @item -malign-int
9194 @itemx -mno-align-int
9195 @opindex malign-int
9196 @opindex mno-align-int
9197 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9198 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9199 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9200 Aligning variables on 32-bit boundaries produces code that runs somewhat
9201 faster on processors with 32-bit busses at the expense of more memory.
9202
9203 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9204 align structures containing the above types  differently than
9205 most published application binary interface specifications for the m68k.
9206
9207 @item -mpcrel
9208 @opindex mpcrel
9209 Use the pc-relative addressing mode of the 68000 directly, instead of
9210 using a global offset table.  At present, this option implies @option{-fpic},
9211 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9212 not presently supported with @option{-mpcrel}, though this could be supported for
9213 68020 and higher processors.
9214
9215 @item -mno-strict-align
9216 @itemx -mstrict-align
9217 @opindex mno-strict-align
9218 @opindex mstrict-align
9219 Do not (do) assume that unaligned memory references will be handled by
9220 the system.
9221
9222 @item -msep-data
9223 Generate code that allows the data segment to be located in a different
9224 area of memory from the text segment.  This allows for execute in place in
9225 an environment without virtual memory management.  This option implies
9226 @option{-fPIC}.
9227
9228 @item -mno-sep-data
9229 Generate code that assumes that the data segment follows the text segment.
9230 This is the default.
9231
9232 @item -mid-shared-library
9233 Generate code that supports shared libraries via the library ID method.
9234 This allows for execute in place and shared libraries in an environment
9235 without virtual memory management.  This option implies @option{-fPIC}.
9236
9237 @item -mno-id-shared-library
9238 Generate code that doesn't assume ID based shared libraries are being used.
9239 This is the default.
9240
9241 @item -mshared-library-id=n
9242 Specified the identification number of the ID based shared library being
9243 compiled.  Specifying a value of 0 will generate more compact code, specifying
9244 other values will force the allocation of that number to the current
9245 library but is no more space or time efficient than omitting this option.
9246
9247 @end table
9248
9249 @node M68hc1x Options
9250 @subsection M68hc1x Options
9251 @cindex M68hc1x options
9252
9253 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9254 microcontrollers.  The default values for these options depends on
9255 which style of microcontroller was selected when the compiler was configured;
9256 the defaults for the most common choices are given below.
9257
9258 @table @gcctabopt
9259 @item -m6811
9260 @itemx -m68hc11
9261 @opindex m6811
9262 @opindex m68hc11
9263 Generate output for a 68HC11.  This is the default
9264 when the compiler is configured for 68HC11-based systems.
9265
9266 @item -m6812
9267 @itemx -m68hc12
9268 @opindex m6812
9269 @opindex m68hc12
9270 Generate output for a 68HC12.  This is the default
9271 when the compiler is configured for 68HC12-based systems.
9272
9273 @item -m68S12
9274 @itemx -m68hcs12
9275 @opindex m68S12
9276 @opindex m68hcs12
9277 Generate output for a 68HCS12.
9278
9279 @item -mauto-incdec
9280 @opindex mauto-incdec
9281 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9282 addressing modes.
9283
9284 @item -minmax
9285 @itemx -nominmax
9286 @opindex minmax
9287 @opindex mnominmax
9288 Enable the use of 68HC12 min and max instructions.
9289
9290 @item -mlong-calls
9291 @itemx -mno-long-calls
9292 @opindex mlong-calls
9293 @opindex mno-long-calls
9294 Treat all calls as being far away (near).  If calls are assumed to be
9295 far away, the compiler will use the @code{call} instruction to
9296 call a function and the @code{rtc} instruction for returning.
9297
9298 @item -mshort
9299 @opindex mshort
9300 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9301
9302 @item -msoft-reg-count=@var{count}
9303 @opindex msoft-reg-count
9304 Specify the number of pseudo-soft registers which are used for the
9305 code generation.  The maximum number is 32.  Using more pseudo-soft
9306 register may or may not result in better code depending on the program.
9307 The default is 4 for 68HC11 and 2 for 68HC12.
9308
9309 @end table
9310
9311 @node MCore Options
9312 @subsection MCore Options
9313 @cindex MCore options
9314
9315 These are the @samp{-m} options defined for the Motorola M*Core
9316 processors.
9317
9318 @table @gcctabopt
9319
9320 @item -mhardlit
9321 @itemx -mno-hardlit
9322 @opindex mhardlit
9323 @opindex mno-hardlit
9324 Inline constants into the code stream if it can be done in two
9325 instructions or less.
9326
9327 @item -mdiv
9328 @itemx -mno-div
9329 @opindex mdiv
9330 @opindex mno-div
9331 Use the divide instruction.  (Enabled by default).
9332
9333 @item -mrelax-immediate
9334 @itemx -mno-relax-immediate
9335 @opindex mrelax-immediate
9336 @opindex mno-relax-immediate
9337 Allow arbitrary sized immediates in bit operations.
9338
9339 @item -mwide-bitfields
9340 @itemx -mno-wide-bitfields
9341 @opindex mwide-bitfields
9342 @opindex mno-wide-bitfields
9343 Always treat bit-fields as int-sized.
9344
9345 @item -m4byte-functions
9346 @itemx -mno-4byte-functions
9347 @opindex m4byte-functions
9348 @opindex mno-4byte-functions
9349 Force all functions to be aligned to a four byte boundary.
9350
9351 @item -mcallgraph-data
9352 @itemx -mno-callgraph-data
9353 @opindex mcallgraph-data
9354 @opindex mno-callgraph-data
9355 Emit callgraph information.
9356
9357 @item -mslow-bytes
9358 @itemx -mno-slow-bytes
9359 @opindex mslow-bytes
9360 @opindex mno-slow-bytes
9361 Prefer word access when reading byte quantities.
9362
9363 @item -mlittle-endian
9364 @itemx -mbig-endian
9365 @opindex mlittle-endian
9366 @opindex mbig-endian
9367 Generate code for a little endian target.
9368
9369 @item -m210
9370 @itemx -m340
9371 @opindex m210
9372 @opindex m340
9373 Generate code for the 210 processor.
9374 @end table
9375
9376 @node MIPS Options
9377 @subsection MIPS Options
9378 @cindex MIPS options
9379
9380 @table @gcctabopt
9381
9382 @item -EB
9383 @opindex EB
9384 Generate big-endian code.
9385
9386 @item -EL
9387 @opindex EL
9388 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9389 configurations.
9390
9391 @item -march=@var{arch}
9392 @opindex march
9393 Generate code that will run on @var{arch}, which can be the name of a
9394 generic MIPS ISA, or the name of a particular processor.
9395 The ISA names are:
9396 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9397 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9398 The processor names are:
9399 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9400 @samp{m4k},
9401 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9402 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9403 @samp{rm9000},
9404 @samp{orion},
9405 @samp{sb1},
9406 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9407 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9408 The special value @samp{from-abi} selects the
9409 most compatible architecture for the selected ABI (that is,
9410 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9411
9412 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9413 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9414 @samp{vr} may be written @samp{r}.
9415
9416 GCC defines two macros based on the value of this option.  The first
9417 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9418 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9419 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9420 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9421 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9422
9423 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9424 above.  In other words, it will have the full prefix and will not
9425 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9426 the macro names the resolved architecture (either @samp{"mips1"} or
9427 @samp{"mips3"}).  It names the default architecture when no
9428 @option{-march} option is given.
9429
9430 @item -mtune=@var{arch}
9431 @opindex mtune
9432 Optimize for @var{arch}.  Among other things, this option controls
9433 the way instructions are scheduled, and the perceived cost of arithmetic
9434 operations.  The list of @var{arch} values is the same as for
9435 @option{-march}.
9436
9437 When this option is not used, GCC will optimize for the processor
9438 specified by @option{-march}.  By using @option{-march} and
9439 @option{-mtune} together, it is possible to generate code that will
9440 run on a family of processors, but optimize the code for one
9441 particular member of that family.
9442
9443 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9444 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9445 @samp{-march} ones described above.
9446
9447 @item -mips1
9448 @opindex mips1
9449 Equivalent to @samp{-march=mips1}.
9450
9451 @item -mips2
9452 @opindex mips2
9453 Equivalent to @samp{-march=mips2}.
9454
9455 @item -mips3
9456 @opindex mips3
9457 Equivalent to @samp{-march=mips3}.
9458
9459 @item -mips4
9460 @opindex mips4
9461 Equivalent to @samp{-march=mips4}.
9462
9463 @item -mips32
9464 @opindex mips32
9465 Equivalent to @samp{-march=mips32}.
9466
9467 @item -mips32r2
9468 @opindex mips32r2
9469 Equivalent to @samp{-march=mips32r2}.
9470
9471 @item -mips64
9472 @opindex mips64
9473 Equivalent to @samp{-march=mips64}.
9474
9475 @item -mips16
9476 @itemx -mno-mips16
9477 @opindex mips16
9478 @opindex mno-mips16
9479 Use (do not use) the MIPS16 ISA@.
9480
9481 @item -mabi=32
9482 @itemx -mabi=o64
9483 @itemx -mabi=n32
9484 @itemx -mabi=64
9485 @itemx -mabi=eabi
9486 @opindex mabi=32
9487 @opindex mabi=o64
9488 @opindex mabi=n32
9489 @opindex mabi=64
9490 @opindex mabi=eabi
9491 Generate code for the given ABI@.
9492
9493 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9494 generates 64-bit code when you select a 64-bit architecture, but you
9495 can use @option{-mgp32} to get 32-bit code instead.
9496
9497 For information about the O64 ABI, see
9498 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9499
9500 @item -mabicalls
9501 @itemx -mno-abicalls
9502 @opindex mabicalls
9503 @opindex mno-abicalls
9504 Generate (do not generate) SVR4-style position-independent code.
9505 @option{-mabicalls} is the default for SVR4-based systems.
9506
9507 @item -mxgot
9508 @itemx -mno-xgot
9509 @opindex mxgot
9510 @opindex mno-xgot
9511 Lift (do not lift) the usual restrictions on the size of the global
9512 offset table.
9513
9514 GCC normally uses a single instruction to load values from the GOT@.
9515 While this is relatively efficient, it will only work if the GOT
9516 is smaller than about 64k.  Anything larger will cause the linker
9517 to report an error such as:
9518
9519 @cindex relocation truncated to fit (MIPS)
9520 @smallexample
9521 relocation truncated to fit: R_MIPS_GOT16 foobar
9522 @end smallexample
9523
9524 If this happens, you should recompile your code with @option{-mxgot}.
9525 It should then work with very large GOTs, although it will also be
9526 less efficient, since it will take three instructions to fetch the
9527 value of a global symbol.
9528
9529 Note that some linkers can create multiple GOTs.  If you have such a
9530 linker, you should only need to use @option{-mxgot} when a single object
9531 file accesses more than 64k's worth of GOT entries.  Very few do.
9532
9533 These options have no effect unless GCC is generating position
9534 independent code.
9535
9536 @item -mgp32
9537 @opindex mgp32
9538 Assume that general-purpose registers are 32 bits wide.
9539
9540 @item -mgp64
9541 @opindex mgp64
9542 Assume that general-purpose registers are 64 bits wide.
9543
9544 @item -mfp32
9545 @opindex mfp32
9546 Assume that floating-point registers are 32 bits wide.
9547
9548 @item -mfp64
9549 @opindex mfp64
9550 Assume that floating-point registers are 64 bits wide.
9551
9552 @item -mhard-float
9553 @opindex mhard-float
9554 Use floating-point coprocessor instructions.
9555
9556 @item -msoft-float
9557 @opindex msoft-float
9558 Do not use floating-point coprocessor instructions.  Implement
9559 floating-point calculations using library calls instead.
9560
9561 @item -msingle-float
9562 @opindex msingle-float
9563 Assume that the floating-point coprocessor only supports single-precision
9564 operations.
9565
9566 @itemx -mdouble-float
9567 @opindex mdouble-float
9568 Assume that the floating-point coprocessor supports double-precision
9569 operations.  This is the default.
9570
9571 @itemx -mpaired-single
9572 @itemx -mno-paired-single
9573 @opindex mpaired-single
9574 @opindex mno-paired-single
9575 Use (do not use) paired-single floating-point instructions.
9576 @xref{MIPS Paired-Single Support}.  This option can only be used
9577 when generating 64-bit code and requires hardware floating-point
9578 support to be enabled.
9579
9580 @itemx -mips3d
9581 @itemx -mno-mips3d
9582 @opindex mips3d
9583 @opindex mno-mips3d
9584 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9585 The option @option{-mips3d} implies @option{-mpaired-single}.
9586
9587 @item -mint64
9588 @opindex mint64
9589 Force @code{int} and @code{long} types to be 64 bits wide.  See
9590 @option{-mlong32} for an explanation of the default and the way
9591 that the pointer size is determined.
9592
9593 @item -mlong64
9594 @opindex mlong64
9595 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9596 an explanation of the default and the way that the pointer size is
9597 determined.
9598
9599 @item -mlong32
9600 @opindex mlong32
9601 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9602
9603 The default size of @code{int}s, @code{long}s and pointers depends on
9604 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9605 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9606 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9607 or the same size as integer registers, whichever is smaller.
9608
9609 @item -G @var{num}
9610 @opindex G
9611 @cindex smaller data references (MIPS)
9612 @cindex gp-relative references (MIPS)
9613 Put global and static items less than or equal to @var{num} bytes into
9614 the small data or bss section instead of the normal data or bss section.
9615 This allows the data to be accessed using a single instruction.
9616
9617 All modules should be compiled with the same @option{-G @var{num}}
9618 value.
9619
9620 @item -membedded-data
9621 @itemx -mno-embedded-data
9622 @opindex membedded-data
9623 @opindex mno-embedded-data
9624 Allocate variables to the read-only data section first if possible, then
9625 next in the small data section if possible, otherwise in data.  This gives
9626 slightly slower code than the default, but reduces the amount of RAM required
9627 when executing, and thus may be preferred for some embedded systems.
9628
9629 @item -muninit-const-in-rodata
9630 @itemx -mno-uninit-const-in-rodata
9631 @opindex muninit-const-in-rodata
9632 @opindex mno-uninit-const-in-rodata
9633 Put uninitialized @code{const} variables in the read-only data section.
9634 This option is only meaningful in conjunction with @option{-membedded-data}.
9635
9636 @item -msplit-addresses
9637 @itemx -mno-split-addresses
9638 @opindex msplit-addresses
9639 @opindex mno-split-addresses
9640 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9641 relocation operators.  This option has been superceded by
9642 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9643
9644 @item -mexplicit-relocs
9645 @itemx -mno-explicit-relocs
9646 @opindex mexplicit-relocs
9647 @opindex mno-explicit-relocs
9648 Use (do not use) assembler relocation operators when dealing with symbolic
9649 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9650 is to use assembler macros instead.
9651
9652 @option{-mexplicit-relocs} is the default if GCC was configured
9653 to use an assembler that supports relocation operators.
9654
9655 @item -mcheck-zero-division
9656 @itemx -mno-check-zero-division
9657 @opindex mcheck-zero-division
9658 @opindex mno-check-zero-division
9659 Trap (do not trap) on integer division by zero.  The default is
9660 @option{-mcheck-zero-division}.
9661
9662 @item -mdivide-traps
9663 @itemx -mdivide-breaks
9664 @opindex mdivide-traps
9665 @opindex mdivide-breaks
9666 MIPS systems check for division by zero by generating either a
9667 conditional trap or a break instruction.  Using traps results in
9668 smaller code, but is only supported on MIPS II and later.  Also, some
9669 versions of the Linux kernel have a bug that prevents trap from
9670 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9671 allow conditional traps on architectures that support them and
9672 @option{-mdivide-breaks} to force the use of breaks.
9673
9674 The default is usually @option{-mdivide-traps}, but this can be
9675 overridden at configure time using @option{--with-divide=breaks}.
9676 Divide-by-zero checks can be completely disabled using
9677 @option{-mno-check-zero-division}.
9678
9679 @item -mmemcpy
9680 @itemx -mno-memcpy
9681 @opindex mmemcpy
9682 @opindex mno-memcpy
9683 Force (do not force) the use of @code{memcpy()} for non-trivial block
9684 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9685 most constant-sized copies.
9686
9687 @item -mlong-calls
9688 @itemx -mno-long-calls
9689 @opindex mlong-calls
9690 @opindex mno-long-calls
9691 Disable (do not disable) use of the @code{jal} instruction.  Calling
9692 functions using @code{jal} is more efficient but requires the caller
9693 and callee to be in the same 256 megabyte segment.
9694
9695 This option has no effect on abicalls code.  The default is
9696 @option{-mno-long-calls}.
9697
9698 @item -mmad
9699 @itemx -mno-mad
9700 @opindex mmad
9701 @opindex mno-mad
9702 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9703 instructions, as provided by the R4650 ISA@.
9704
9705 @item -mfused-madd
9706 @itemx -mno-fused-madd
9707 @opindex mfused-madd
9708 @opindex mno-fused-madd
9709 Enable (disable) use of the floating point multiply-accumulate
9710 instructions, when they are available.  The default is
9711 @option{-mfused-madd}.
9712
9713 When multiply-accumulate instructions are used, the intermediate
9714 product is calculated to infinite precision and is not subject to
9715 the FCSR Flush to Zero bit.  This may be undesirable in some
9716 circumstances.
9717
9718 @item -nocpp
9719 @opindex nocpp
9720 Tell the MIPS assembler to not run its preprocessor over user
9721 assembler files (with a @samp{.s} suffix) when assembling them.
9722
9723 @item -mfix-r4000
9724 @itemx -mno-fix-r4000
9725 @opindex mfix-r4000
9726 @opindex mno-fix-r4000
9727 Work around certain R4000 CPU errata:
9728 @itemize @minus
9729 @item
9730 A double-word or a variable shift may give an incorrect result if executed
9731 immediately after starting an integer division.
9732 @item
9733 A double-word or a variable shift may give an incorrect result if executed
9734 while an integer multiplication is in progress.
9735 @item
9736 An integer division may give an incorrect result if started in a delay slot
9737 of a taken branch or a jump.
9738 @end itemize
9739
9740 @item -mfix-r4400
9741 @itemx -mno-fix-r4400
9742 @opindex mfix-r4400
9743 @opindex mno-fix-r4400
9744 Work around certain R4400 CPU errata:
9745 @itemize @minus
9746 @item
9747 A double-word or a variable shift may give an incorrect result if executed
9748 immediately after starting an integer division.
9749 @end itemize
9750
9751 @item -mfix-vr4120
9752 @itemx -mno-fix-vr4120
9753 @opindex mfix-vr4120
9754 Work around certain VR4120 errata:
9755 @itemize @minus
9756 @item
9757 @code{dmultu} does not always produce the correct result.
9758 @item
9759 @code{div} and @code{ddiv} do not always produce the correct result if one
9760 of the operands is negative.
9761 @end itemize
9762 The workarounds for the division errata rely on special functions in
9763 @file{libgcc.a}.  At present, these functions are only provided by
9764 the @code{mips64vr*-elf} configurations.
9765
9766 Other VR4120 errata require a nop to be inserted between certain pairs of
9767 instructions.  These errata are handled by the assembler, not by GCC itself.
9768
9769 @item -mfix-sb1
9770 @itemx -mno-fix-sb1
9771 @opindex mfix-sb1
9772 Work around certain SB-1 CPU core errata.
9773 (This flag currently works around the SB-1 revision 2
9774 ``F1'' and ``F2'' floating point errata.)
9775
9776 @item -mflush-func=@var{func}
9777 @itemx -mno-flush-func
9778 @opindex mflush-func
9779 Specifies the function to call to flush the I and D caches, or to not
9780 call any such function.  If called, the function must take the same
9781 arguments as the common @code{_flush_func()}, that is, the address of the
9782 memory range for which the cache is being flushed, the size of the
9783 memory range, and the number 3 (to flush both caches).  The default
9784 depends on the target GCC was configured for, but commonly is either
9785 @samp{_flush_func} or @samp{__cpu_flush}.
9786
9787 @item -mbranch-likely
9788 @itemx -mno-branch-likely
9789 @opindex mbranch-likely
9790 @opindex mno-branch-likely
9791 Enable or disable use of Branch Likely instructions, regardless of the
9792 default for the selected architecture.  By default, Branch Likely
9793 instructions may be generated if they are supported by the selected
9794 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9795 and processors which implement those architectures; for those, Branch
9796 Likely instructions will not be generated by default because the MIPS32
9797 and MIPS64 architectures specifically deprecate their use.
9798
9799 @item -mfp-exceptions
9800 @itemx -mno-fp-exceptions
9801 @opindex mfp-exceptions
9802 Specifies whether FP exceptions are enabled.  This affects how we schedule
9803 FP instructions for some processors.  The default is that FP exceptions are
9804 enabled.
9805
9806 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9807 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9808 FP pipe.
9809
9810 @item -mvr4130-align
9811 @itemx -mno-vr4130-align
9812 @opindex mvr4130-align
9813 The VR4130 pipeline is two-way superscalar, but can only issue two
9814 instructions together if the first one is 8-byte aligned.  When this
9815 option is enabled, GCC will align pairs of instructions that it
9816 thinks should execute in parallel.
9817
9818 This option only has an effect when optimizing for the VR4130.
9819 It normally makes code faster, but at the expense of making it bigger.
9820 It is enabled by default at optimization level @option{-O3}.
9821 @end table
9822
9823 @node MMIX Options
9824 @subsection MMIX Options
9825 @cindex MMIX Options
9826
9827 These options are defined for the MMIX:
9828
9829 @table @gcctabopt
9830 @item -mlibfuncs
9831 @itemx -mno-libfuncs
9832 @opindex mlibfuncs
9833 @opindex mno-libfuncs
9834 Specify that intrinsic library functions are being compiled, passing all
9835 values in registers, no matter the size.
9836
9837 @item -mepsilon
9838 @itemx -mno-epsilon
9839 @opindex mepsilon
9840 @opindex mno-epsilon
9841 Generate floating-point comparison instructions that compare with respect
9842 to the @code{rE} epsilon register.
9843
9844 @item -mabi=mmixware
9845 @itemx -mabi=gnu
9846 @opindex mabi-mmixware
9847 @opindex mabi=gnu
9848 Generate code that passes function parameters and return values that (in
9849 the called function) are seen as registers @code{$0} and up, as opposed to
9850 the GNU ABI which uses global registers @code{$231} and up.
9851
9852 @item -mzero-extend
9853 @itemx -mno-zero-extend
9854 @opindex mzero-extend
9855 @opindex mno-zero-extend
9856 When reading data from memory in sizes shorter than 64 bits, use (do not
9857 use) zero-extending load instructions by default, rather than
9858 sign-extending ones.
9859
9860 @item -mknuthdiv
9861 @itemx -mno-knuthdiv
9862 @opindex mknuthdiv
9863 @opindex mno-knuthdiv
9864 Make the result of a division yielding a remainder have the same sign as
9865 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9866 remainder follows the sign of the dividend.  Both methods are
9867 arithmetically valid, the latter being almost exclusively used.
9868
9869 @item -mtoplevel-symbols
9870 @itemx -mno-toplevel-symbols
9871 @opindex mtoplevel-symbols
9872 @opindex mno-toplevel-symbols
9873 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9874 code can be used with the @code{PREFIX} assembly directive.
9875
9876 @item -melf
9877 @opindex melf
9878 Generate an executable in the ELF format, rather than the default
9879 @samp{mmo} format used by the @command{mmix} simulator.
9880
9881 @item -mbranch-predict
9882 @itemx -mno-branch-predict
9883 @opindex mbranch-predict
9884 @opindex mno-branch-predict
9885 Use (do not use) the probable-branch instructions, when static branch
9886 prediction indicates a probable branch.
9887
9888 @item -mbase-addresses
9889 @itemx -mno-base-addresses
9890 @opindex mbase-addresses
9891 @opindex mno-base-addresses
9892 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9893 base address automatically generates a request (handled by the assembler
9894 and the linker) for a constant to be set up in a global register.  The
9895 register is used for one or more base address requests within the range 0
9896 to 255 from the value held in the register.  The generally leads to short
9897 and fast code, but the number of different data items that can be
9898 addressed is limited.  This means that a program that uses lots of static
9899 data may require @option{-mno-base-addresses}.
9900
9901 @item -msingle-exit
9902 @itemx -mno-single-exit
9903 @opindex msingle-exit
9904 @opindex mno-single-exit
9905 Force (do not force) generated code to have a single exit point in each
9906 function.
9907 @end table
9908
9909 @node MN10300 Options
9910 @subsection MN10300 Options
9911 @cindex MN10300 options
9912
9913 These @option{-m} options are defined for Matsushita MN10300 architectures:
9914
9915 @table @gcctabopt
9916 @item -mmult-bug
9917 @opindex mmult-bug
9918 Generate code to avoid bugs in the multiply instructions for the MN10300
9919 processors.  This is the default.
9920
9921 @item -mno-mult-bug
9922 @opindex mno-mult-bug
9923 Do not generate code to avoid bugs in the multiply instructions for the
9924 MN10300 processors.
9925
9926 @item -mam33
9927 @opindex mam33
9928 Generate code which uses features specific to the AM33 processor.
9929
9930 @item -mno-am33
9931 @opindex mno-am33
9932 Do not generate code which uses features specific to the AM33 processor.  This
9933 is the default.
9934
9935 @item -mno-crt0
9936 @opindex mno-crt0
9937 Do not link in the C run-time initialization object file.
9938
9939 @item -mrelax
9940 @opindex mrelax
9941 Indicate to the linker that it should perform a relaxation optimization pass
9942 to shorten branches, calls and absolute memory addresses.  This option only
9943 has an effect when used on the command line for the final link step.
9944
9945 This option makes symbolic debugging impossible.
9946 @end table
9947
9948 @node NS32K Options
9949 @subsection NS32K Options
9950 @cindex NS32K options
9951
9952 These are the @samp{-m} options defined for the 32000 series.  The default
9953 values for these options depends on which style of 32000 was selected when
9954 the compiler was configured; the defaults for the most common choices are
9955 given below.
9956
9957 @table @gcctabopt
9958 @item -m32032
9959 @itemx -m32032
9960 @opindex m32032
9961 @opindex m32032
9962 Generate output for a 32032.  This is the default
9963 when the compiler is configured for 32032 and 32016 based systems.
9964
9965 @item -m32332
9966 @itemx -m32332
9967 @opindex m32332
9968 @opindex m32332
9969 Generate output for a 32332.  This is the default
9970 when the compiler is configured for 32332-based systems.
9971
9972 @item -m32532
9973 @itemx -m32532
9974 @opindex m32532
9975 @opindex m32532
9976 Generate output for a 32532.  This is the default
9977 when the compiler is configured for 32532-based systems.
9978
9979 @item -m32081
9980 @opindex m32081
9981 Generate output containing 32081 instructions for floating point.
9982 This is the default for all systems.
9983
9984 @item -m32381
9985 @opindex m32381
9986 Generate output containing 32381 instructions for floating point.  This
9987 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9988 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9989
9990 @item -mmulti-add
9991 @opindex mmulti-add
9992 Try and generate multiply-add floating point instructions @code{polyF}
9993 and @code{dotF}.  This option is only available if the @option{-m32381}
9994 option is in effect.  Using these instructions requires changes to
9995 register allocation which generally has a negative impact on
9996 performance.  This option should only be enabled when compiling code
9997 particularly likely to make heavy use of multiply-add instructions.
9998
9999 @item -mnomulti-add
10000 @opindex mnomulti-add
10001 Do not try and generate multiply-add floating point instructions
10002 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10003
10004 @item -msoft-float
10005 @opindex msoft-float
10006 Generate output containing library calls for floating point.
10007 @strong{Warning:} the requisite libraries may not be available.
10008
10009 @item -mieee-compare
10010 @itemx -mno-ieee-compare
10011 @opindex mieee-compare
10012 @opindex mno-ieee-compare
10013 Control whether or not the compiler uses IEEE floating point
10014 comparisons.  These handle correctly the case where the result of a
10015 comparison is unordered.
10016 @strong{Warning:} the requisite kernel support may not be available.
10017
10018 @item -mnobitfield
10019 @opindex mnobitfield
10020 Do not use the bit-field instructions.  On some machines it is faster to
10021 use shifting and masking operations.  This is the default for the pc532.
10022
10023 @item -mbitfield
10024 @opindex mbitfield
10025 Do use the bit-field instructions.  This is the default for all platforms
10026 except the pc532.
10027
10028 @item -mrtd
10029 @opindex mrtd
10030 Use a different function-calling convention, in which functions
10031 that take a fixed number of arguments return pop their
10032 arguments on return with the @code{ret} instruction.
10033
10034 This calling convention is incompatible with the one normally
10035 used on Unix, so you cannot use it if you need to call libraries
10036 compiled with the Unix compiler.
10037
10038 Also, you must provide function prototypes for all functions that
10039 take variable numbers of arguments (including @code{printf});
10040 otherwise incorrect code will be generated for calls to those
10041 functions.
10042
10043 In addition, seriously incorrect code will result if you call a
10044 function with too many arguments.  (Normally, extra arguments are
10045 harmlessly ignored.)
10046
10047 This option takes its name from the 680x0 @code{rtd} instruction.
10048
10049
10050 @item -mregparam
10051 @opindex mregparam
10052 Use a different function-calling convention where the first two arguments
10053 are passed in registers.
10054
10055 This calling convention is incompatible with the one normally
10056 used on Unix, so you cannot use it if you need to call libraries
10057 compiled with the Unix compiler.
10058
10059 @item -mnoregparam
10060 @opindex mnoregparam
10061 Do not pass any arguments in registers.  This is the default for all
10062 targets.
10063
10064 @item -msb
10065 @opindex msb
10066 It is OK to use the sb as an index register which is always loaded with
10067 zero.  This is the default for the pc532-netbsd target.
10068
10069 @item -mnosb
10070 @opindex mnosb
10071 The sb register is not available for use or has not been initialized to
10072 zero by the run time system.  This is the default for all targets except
10073 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10074 @option{-fpic} is set.
10075
10076 @item -mhimem
10077 @opindex mhimem
10078 Many ns32000 series addressing modes use displacements of up to 512MB@.
10079 If an address is above 512MB then displacements from zero can not be used.
10080 This option causes code to be generated which can be loaded above 512MB@.
10081 This may be useful for operating systems or ROM code.
10082
10083 @item -mnohimem
10084 @opindex mnohimem
10085 Assume code will be loaded in the first 512MB of virtual address space.
10086 This is the default for all platforms.
10087
10088 @end table
10089
10090 @node PDP-11 Options
10091 @subsection PDP-11 Options
10092 @cindex PDP-11 Options
10093
10094 These options are defined for the PDP-11:
10095
10096 @table @gcctabopt
10097 @item -mfpu
10098 @opindex mfpu
10099 Use hardware FPP floating point.  This is the default.  (FIS floating
10100 point on the PDP-11/40 is not supported.)
10101
10102 @item -msoft-float
10103 @opindex msoft-float
10104 Do not use hardware floating point.
10105
10106 @item -mac0
10107 @opindex mac0
10108 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10109
10110 @item -mno-ac0
10111 @opindex mno-ac0
10112 Return floating-point results in memory.  This is the default.
10113
10114 @item -m40
10115 @opindex m40
10116 Generate code for a PDP-11/40.
10117
10118 @item -m45
10119 @opindex m45
10120 Generate code for a PDP-11/45.  This is the default.
10121
10122 @item -m10
10123 @opindex m10
10124 Generate code for a PDP-11/10.
10125
10126 @item -mbcopy-builtin
10127 @opindex bcopy-builtin
10128 Use inline @code{movmemhi} patterns for copying memory.  This is the
10129 default.
10130
10131 @item -mbcopy
10132 @opindex mbcopy
10133 Do not use inline @code{movmemhi} patterns for copying memory.
10134
10135 @item -mint16
10136 @itemx -mno-int32
10137 @opindex mint16
10138 @opindex mno-int32
10139 Use 16-bit @code{int}.  This is the default.
10140
10141 @item -mint32
10142 @itemx -mno-int16
10143 @opindex mint32
10144 @opindex mno-int16
10145 Use 32-bit @code{int}.
10146
10147 @item -mfloat64
10148 @itemx -mno-float32
10149 @opindex mfloat64
10150 @opindex mno-float32
10151 Use 64-bit @code{float}.  This is the default.
10152
10153 @item -mfloat32
10154 @itemx -mno-float64
10155 @opindex mfloat32
10156 @opindex mno-float64
10157 Use 32-bit @code{float}.
10158
10159 @item -mabshi
10160 @opindex mabshi
10161 Use @code{abshi2} pattern.  This is the default.
10162
10163 @item -mno-abshi
10164 @opindex mno-abshi
10165 Do not use @code{abshi2} pattern.
10166
10167 @item -mbranch-expensive
10168 @opindex mbranch-expensive
10169 Pretend that branches are expensive.  This is for experimenting with
10170 code generation only.
10171
10172 @item -mbranch-cheap
10173 @opindex mbranch-cheap
10174 Do not pretend that branches are expensive.  This is the default.
10175
10176 @item -msplit
10177 @opindex msplit
10178 Generate code for a system with split I&D@.
10179
10180 @item -mno-split
10181 @opindex mno-split
10182 Generate code for a system without split I&D@.  This is the default.
10183
10184 @item -munix-asm
10185 @opindex munix-asm
10186 Use Unix assembler syntax.  This is the default when configured for
10187 @samp{pdp11-*-bsd}.
10188
10189 @item -mdec-asm
10190 @opindex mdec-asm
10191 Use DEC assembler syntax.  This is the default when configured for any
10192 PDP-11 target other than @samp{pdp11-*-bsd}.
10193 @end table
10194
10195 @node PowerPC Options
10196 @subsection PowerPC Options
10197 @cindex PowerPC options
10198
10199 These are listed under @xref{RS/6000 and PowerPC Options}.
10200
10201 @node RS/6000 and PowerPC Options
10202 @subsection IBM RS/6000 and PowerPC Options
10203 @cindex RS/6000 and PowerPC Options
10204 @cindex IBM RS/6000 and PowerPC Options
10205
10206 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10207 @table @gcctabopt
10208 @item -mpower
10209 @itemx -mno-power
10210 @itemx -mpower2
10211 @itemx -mno-power2
10212 @itemx -mpowerpc
10213 @itemx -mno-powerpc
10214 @itemx -mpowerpc-gpopt
10215 @itemx -mno-powerpc-gpopt
10216 @itemx -mpowerpc-gfxopt
10217 @itemx -mno-powerpc-gfxopt
10218 @itemx -mpowerpc64
10219 @itemx -mno-powerpc64
10220 @opindex mpower
10221 @opindex mno-power
10222 @opindex mpower2
10223 @opindex mno-power2
10224 @opindex mpowerpc
10225 @opindex mno-powerpc
10226 @opindex mpowerpc-gpopt
10227 @opindex mno-powerpc-gpopt
10228 @opindex mpowerpc-gfxopt
10229 @opindex mno-powerpc-gfxopt
10230 @opindex mpowerpc64
10231 @opindex mno-powerpc64
10232 GCC supports two related instruction set architectures for the
10233 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10234 instructions supported by the @samp{rios} chip set used in the original
10235 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10236 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10237 the IBM 4xx microprocessors.
10238
10239 Neither architecture is a subset of the other.  However there is a
10240 large common subset of instructions supported by both.  An MQ
10241 register is included in processors supporting the POWER architecture.
10242
10243 You use these options to specify which instructions are available on the
10244 processor you are using.  The default value of these options is
10245 determined when configuring GCC@.  Specifying the
10246 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10247 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10248 rather than the options listed above.
10249
10250 The @option{-mpower} option allows GCC to generate instructions that
10251 are found only in the POWER architecture and to use the MQ register.
10252 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10253 to generate instructions that are present in the POWER2 architecture but
10254 not the original POWER architecture.
10255
10256 The @option{-mpowerpc} option allows GCC to generate instructions that
10257 are found only in the 32-bit subset of the PowerPC architecture.
10258 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10259 GCC to use the optional PowerPC architecture instructions in the
10260 General Purpose group, including floating-point square root.  Specifying
10261 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10262 use the optional PowerPC architecture instructions in the Graphics
10263 group, including floating-point select.
10264
10265 The @option{-mpowerpc64} option allows GCC to generate the additional
10266 64-bit instructions that are found in the full PowerPC64 architecture
10267 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10268 @option{-mno-powerpc64}.
10269
10270 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10271 will use only the instructions in the common subset of both
10272 architectures plus some special AIX common-mode calls, and will not use
10273 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10274 permits GCC to use any instruction from either architecture and to
10275 allow use of the MQ register; specify this for the Motorola MPC601.
10276
10277 @item -mnew-mnemonics
10278 @itemx -mold-mnemonics
10279 @opindex mnew-mnemonics
10280 @opindex mold-mnemonics
10281 Select which mnemonics to use in the generated assembler code.  With
10282 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10283 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10284 assembler mnemonics defined for the POWER architecture.  Instructions
10285 defined in only one architecture have only one mnemonic; GCC uses that
10286 mnemonic irrespective of which of these options is specified.
10287
10288 GCC defaults to the mnemonics appropriate for the architecture in
10289 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10290 value of these option.  Unless you are building a cross-compiler, you
10291 should normally not specify either @option{-mnew-mnemonics} or
10292 @option{-mold-mnemonics}, but should instead accept the default.
10293
10294 @item -mcpu=@var{cpu_type}
10295 @opindex mcpu
10296 Set architecture type, register usage, choice of mnemonics, and
10297 instruction scheduling parameters for machine type @var{cpu_type}.
10298 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10299 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10300 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10301 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10302 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10303 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10304 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10305 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10306 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10307
10308 @option{-mcpu=common} selects a completely generic processor.  Code
10309 generated under this option will run on any POWER or PowerPC processor.
10310 GCC will use only the instructions in the common subset of both
10311 architectures, and will not use the MQ register.  GCC assumes a generic
10312 processor model for scheduling purposes.
10313
10314 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10315 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10316 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10317 types, with an appropriate, generic processor model assumed for
10318 scheduling purposes.
10319
10320 The other options specify a specific processor.  Code generated under
10321 those options will run best on that processor, and may not run at all on
10322 others.
10323
10324 The @option{-mcpu} options automatically enable or disable the
10325 following options: @option{-maltivec}, @option{-mhard-float},
10326 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10327 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10328 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10329 @option{-mstring}.  The particular options set for any particular CPU
10330 will vary between compiler versions, depending on what setting seems
10331 to produce optimal code for that CPU; it doesn't necessarily reflect
10332 the actual hardware's capabilities.  If you wish to set an individual
10333 option to a particular value, you may specify it after the
10334 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10335
10336 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10337 not enabled or disabled by the @option{-mcpu} option at present, since
10338 AIX does not have full support for these options.  You may still
10339 enable or disable them individually if you're sure it'll work in your
10340 environment.
10341
10342 @item -mtune=@var{cpu_type}
10343 @opindex mtune
10344 Set the instruction scheduling parameters for machine type
10345 @var{cpu_type}, but do not set the architecture type, register usage, or
10346 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10347 values for @var{cpu_type} are used for @option{-mtune} as for
10348 @option{-mcpu}.  If both are specified, the code generated will use the
10349 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10350 scheduling parameters set by @option{-mtune}.
10351
10352 @item -maltivec
10353 @itemx -mno-altivec
10354 @opindex maltivec
10355 @opindex mno-altivec
10356 Generate code that uses (does not use) AltiVec instructions, and also
10357 enable the use of built-in functions that allow more direct access to
10358 the AltiVec instruction set.  You may also need to set
10359 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10360 enhancements.
10361
10362 @item -mabi=spe
10363 @opindex mabi=spe
10364 Extend the current ABI with SPE ABI extensions.  This does not change
10365 the default ABI, instead it adds the SPE ABI extensions to the current
10366 ABI@.
10367
10368 @item -mabi=no-spe
10369 @opindex mabi=no-spe
10370 Disable Booke SPE ABI extensions for the current ABI@.
10371
10372 @item -misel=@var{yes/no}
10373 @itemx -misel
10374 @opindex misel
10375 This switch enables or disables the generation of ISEL instructions.
10376
10377 @item -mspe=@var{yes/no}
10378 @itemx -mspe
10379 @opindex mspe
10380 This switch enables or disables the generation of SPE simd
10381 instructions.
10382
10383 @item -mfloat-gprs=@var{yes/single/double/no}
10384 @itemx -mfloat-gprs
10385 @opindex mfloat-gprs
10386 This switch enables or disables the generation of floating point
10387 operations on the general purpose registers for architectures that
10388 support it.
10389
10390 The argument @var{yes} or @var{single} enables the use of
10391 single-precision floating point operations.
10392
10393 The argument @var{double} enables the use of single and
10394 double-precision floating point operations.
10395
10396 The argument @var{no} disables floating point operations on the
10397 general purpose registers.
10398
10399 This option is currently only available on the MPC854x.
10400
10401 @item -m32
10402 @itemx -m64
10403 @opindex m32
10404 @opindex m64
10405 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10406 targets (including GNU/Linux).  The 32-bit environment sets int, long
10407 and pointer to 32 bits and generates code that runs on any PowerPC
10408 variant.  The 64-bit environment sets int to 32 bits and long and
10409 pointer to 64 bits, and generates code for PowerPC64, as for
10410 @option{-mpowerpc64}.
10411
10412 @item -mfull-toc
10413 @itemx -mno-fp-in-toc
10414 @itemx -mno-sum-in-toc
10415 @itemx -mminimal-toc
10416 @opindex mfull-toc
10417 @opindex mno-fp-in-toc
10418 @opindex mno-sum-in-toc
10419 @opindex mminimal-toc
10420 Modify generation of the TOC (Table Of Contents), which is created for
10421 every executable file.  The @option{-mfull-toc} option is selected by
10422 default.  In that case, GCC will allocate at least one TOC entry for
10423 each unique non-automatic variable reference in your program.  GCC
10424 will also place floating-point constants in the TOC@.  However, only
10425 16,384 entries are available in the TOC@.
10426
10427 If you receive a linker error message that saying you have overflowed
10428 the available TOC space, you can reduce the amount of TOC space used
10429 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10430 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10431 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10432 generate code to calculate the sum of an address and a constant at
10433 run-time instead of putting that sum into the TOC@.  You may specify one
10434 or both of these options.  Each causes GCC to produce very slightly
10435 slower and larger code at the expense of conserving TOC space.
10436
10437 If you still run out of space in the TOC even when you specify both of
10438 these options, specify @option{-mminimal-toc} instead.  This option causes
10439 GCC to make only one TOC entry for every file.  When you specify this
10440 option, GCC will produce code that is slower and larger but which
10441 uses extremely little TOC space.  You may wish to use this option
10442 only on files that contain less frequently executed code.
10443
10444 @item -maix64
10445 @itemx -maix32
10446 @opindex maix64
10447 @opindex maix32
10448 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10449 @code{long} type, and the infrastructure needed to support them.
10450 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10451 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10452 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10453
10454 @item -mxl-call
10455 @itemx -mno-xl-call
10456 @opindex mxl-call
10457 @opindex mno-xl-call
10458 On AIX, pass floating-point arguments to prototyped functions beyond the
10459 register save area (RSA) on the stack in addition to argument FPRs.  The
10460 AIX calling convention was extended but not initially documented to
10461 handle an obscure K&R C case of calling a function that takes the
10462 address of its arguments with fewer arguments than declared.  AIX XL
10463 compilers access floating point arguments which do not fit in the
10464 RSA from the stack when a subroutine is compiled without
10465 optimization.  Because always storing floating-point arguments on the
10466 stack is inefficient and rarely needed, this option is not enabled by
10467 default and only is necessary when calling subroutines compiled by AIX
10468 XL compilers without optimization.
10469
10470 @item -mpe
10471 @opindex mpe
10472 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10473 application written to use message passing with special startup code to
10474 enable the application to run.  The system must have PE installed in the
10475 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10476 must be overridden with the @option{-specs=} option to specify the
10477 appropriate directory location.  The Parallel Environment does not
10478 support threads, so the @option{-mpe} option and the @option{-pthread}
10479 option are incompatible.
10480
10481 @item -malign-natural
10482 @itemx -malign-power
10483 @opindex malign-natural
10484 @opindex malign-power
10485 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10486 @option{-malign-natural} overrides the ABI-defined alignment of larger
10487 types, such as floating-point doubles, on their natural size-based boundary.
10488 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10489 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10490
10491 @item -msoft-float
10492 @itemx -mhard-float
10493 @opindex msoft-float
10494 @opindex mhard-float
10495 Generate code that does not use (uses) the floating-point register set.
10496 Software floating point emulation is provided if you use the
10497 @option{-msoft-float} option, and pass the option to GCC when linking.
10498
10499 @item -mmultiple
10500 @itemx -mno-multiple
10501 @opindex mmultiple
10502 @opindex mno-multiple
10503 Generate code that uses (does not use) the load multiple word
10504 instructions and the store multiple word instructions.  These
10505 instructions are generated by default on POWER systems, and not
10506 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10507 endian PowerPC systems, since those instructions do not work when the
10508 processor is in little endian mode.  The exceptions are PPC740 and
10509 PPC750 which permit the instructions usage in little endian mode.
10510
10511 @item -mstring
10512 @itemx -mno-string
10513 @opindex mstring
10514 @opindex mno-string
10515 Generate code that uses (does not use) the load string instructions
10516 and the store string word instructions to save multiple registers and
10517 do small block moves.  These instructions are generated by default on
10518 POWER systems, and not generated on PowerPC systems.  Do not use
10519 @option{-mstring} on little endian PowerPC systems, since those
10520 instructions do not work when the processor is in little endian mode.
10521 The exceptions are PPC740 and PPC750 which permit the instructions
10522 usage in little endian mode.
10523
10524 @item -mupdate
10525 @itemx -mno-update
10526 @opindex mupdate
10527 @opindex mno-update
10528 Generate code that uses (does not use) the load or store instructions
10529 that update the base register to the address of the calculated memory
10530 location.  These instructions are generated by default.  If you use
10531 @option{-mno-update}, there is a small window between the time that the
10532 stack pointer is updated and the address of the previous frame is
10533 stored, which means code that walks the stack frame across interrupts or
10534 signals may get corrupted data.
10535
10536 @item -mfused-madd
10537 @itemx -mno-fused-madd
10538 @opindex mfused-madd
10539 @opindex mno-fused-madd
10540 Generate code that uses (does not use) the floating point multiply and
10541 accumulate instructions.  These instructions are generated by default if
10542 hardware floating is used.
10543
10544 @item -mno-bit-align
10545 @itemx -mbit-align
10546 @opindex mno-bit-align
10547 @opindex mbit-align
10548 On System V.4 and embedded PowerPC systems do not (do) force structures
10549 and unions that contain bit-fields to be aligned to the base type of the
10550 bit-field.
10551
10552 For example, by default a structure containing nothing but 8
10553 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10554 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10555 the structure would be aligned to a 1 byte boundary and be one byte in
10556 size.
10557
10558 @item -mno-strict-align
10559 @itemx -mstrict-align
10560 @opindex mno-strict-align
10561 @opindex mstrict-align
10562 On System V.4 and embedded PowerPC systems do not (do) assume that
10563 unaligned memory references will be handled by the system.
10564
10565 @item -mrelocatable
10566 @itemx -mno-relocatable
10567 @opindex mrelocatable
10568 @opindex mno-relocatable
10569 On embedded PowerPC systems generate code that allows (does not allow)
10570 the program to be relocated to a different address at runtime.  If you
10571 use @option{-mrelocatable} on any module, all objects linked together must
10572 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10573
10574 @item -mrelocatable-lib
10575 @itemx -mno-relocatable-lib
10576 @opindex mrelocatable-lib
10577 @opindex mno-relocatable-lib
10578 On embedded PowerPC systems generate code that allows (does not allow)
10579 the program to be relocated to a different address at runtime.  Modules
10580 compiled with @option{-mrelocatable-lib} can be linked with either modules
10581 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10582 with modules compiled with the @option{-mrelocatable} options.
10583
10584 @item -mno-toc
10585 @itemx -mtoc
10586 @opindex mno-toc
10587 @opindex mtoc
10588 On System V.4 and embedded PowerPC systems do not (do) assume that
10589 register 2 contains a pointer to a global area pointing to the addresses
10590 used in the program.
10591
10592 @item -mlittle
10593 @itemx -mlittle-endian
10594 @opindex mlittle
10595 @opindex mlittle-endian
10596 On System V.4 and embedded PowerPC systems compile code for the
10597 processor in little endian mode.  The @option{-mlittle-endian} option is
10598 the same as @option{-mlittle}.
10599
10600 @item -mbig
10601 @itemx -mbig-endian
10602 @opindex mbig
10603 @opindex mbig-endian
10604 On System V.4 and embedded PowerPC systems compile code for the
10605 processor in big endian mode.  The @option{-mbig-endian} option is
10606 the same as @option{-mbig}.
10607
10608 @item -mdynamic-no-pic
10609 @opindex mdynamic-no-pic
10610 On Darwin and Mac OS X systems, compile code so that it is not
10611 relocatable, but that its external references are relocatable.  The
10612 resulting code is suitable for applications, but not shared
10613 libraries.
10614
10615 @item -mprioritize-restricted-insns=@var{priority}
10616 @opindex mprioritize-restricted-insns
10617 This option controls the priority that is assigned to
10618 dispatch-slot restricted instructions during the second scheduling
10619 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10620 @var{no/highest/second-highest} priority to dispatch slot restricted
10621 instructions.
10622
10623 @item -msched-costly-dep=@var{dependence_type}
10624 @opindex msched-costly-dep
10625 This option controls which dependences are considered costly
10626 by the target during instruction scheduling.  The argument
10627 @var{dependence_type} takes one of the following values:
10628 @var{no}: no dependence is costly,
10629 @var{all}: all dependences are costly,
10630 @var{true_store_to_load}: a true dependence from store to load is costly,
10631 @var{store_to_load}: any dependence from store to load is costly,
10632 @var{number}: any dependence which latency >= @var{number} is costly.
10633
10634 @item -minsert-sched-nops=@var{scheme}
10635 @opindex minsert-sched-nops
10636 This option controls which nop insertion scheme will be used during
10637 the second scheduling pass.  The argument @var{scheme} takes one of the
10638 following values:
10639 @var{no}: Don't insert nops.
10640 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10641 according to the scheduler's grouping.
10642 @var{regroup_exact}: Insert nops to force costly dependent insns into
10643 separate groups.  Insert exactly as many nops as needed to force an insn
10644 to a new group, according to the estimated processor grouping.
10645 @var{number}: Insert nops to force costly dependent insns into
10646 separate groups.  Insert @var{number} nops to force an insn to a new group.
10647
10648 @item -mcall-sysv
10649 @opindex mcall-sysv
10650 On System V.4 and embedded PowerPC systems compile code using calling
10651 conventions that adheres to the March 1995 draft of the System V
10652 Application Binary Interface, PowerPC processor supplement.  This is the
10653 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10654
10655 @item -mcall-sysv-eabi
10656 @opindex mcall-sysv-eabi
10657 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10658
10659 @item -mcall-sysv-noeabi
10660 @opindex mcall-sysv-noeabi
10661 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10662
10663 @item -mcall-solaris
10664 @opindex mcall-solaris
10665 On System V.4 and embedded PowerPC systems compile code for the Solaris
10666 operating system.
10667
10668 @item -mcall-linux
10669 @opindex mcall-linux
10670 On System V.4 and embedded PowerPC systems compile code for the
10671 Linux-based GNU system.
10672
10673 @item -mcall-gnu
10674 @opindex mcall-gnu
10675 On System V.4 and embedded PowerPC systems compile code for the
10676 Hurd-based GNU system.
10677
10678 @item -mcall-netbsd
10679 @opindex mcall-netbsd
10680 On System V.4 and embedded PowerPC systems compile code for the
10681 NetBSD operating system.
10682
10683 @item -maix-struct-return
10684 @opindex maix-struct-return
10685 Return all structures in memory (as specified by the AIX ABI)@.
10686
10687 @item -msvr4-struct-return
10688 @opindex msvr4-struct-return
10689 Return structures smaller than 8 bytes in registers (as specified by the
10690 SVR4 ABI)@.
10691
10692 @item -mabi=altivec
10693 @opindex mabi=altivec
10694 Extend the current ABI with AltiVec ABI extensions.  This does not
10695 change the default ABI, instead it adds the AltiVec ABI extensions to
10696 the current ABI@.
10697
10698 @item -mabi=no-altivec
10699 @opindex mabi=no-altivec
10700 Disable AltiVec ABI extensions for the current ABI@.
10701
10702 @item -mprototype
10703 @itemx -mno-prototype
10704 @opindex mprototype
10705 @opindex mno-prototype
10706 On System V.4 and embedded PowerPC systems assume that all calls to
10707 variable argument functions are properly prototyped.  Otherwise, the
10708 compiler must insert an instruction before every non prototyped call to
10709 set or clear bit 6 of the condition code register (@var{CR}) to
10710 indicate whether floating point values were passed in the floating point
10711 registers in case the function takes a variable arguments.  With
10712 @option{-mprototype}, only calls to prototyped variable argument functions
10713 will set or clear the bit.
10714
10715 @item -msim
10716 @opindex msim
10717 On embedded PowerPC systems, assume that the startup module is called
10718 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10719 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10720 configurations.
10721
10722 @item -mmvme
10723 @opindex mmvme
10724 On embedded PowerPC systems, assume that the startup module is called
10725 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10726 @file{libc.a}.
10727
10728 @item -mads
10729 @opindex mads
10730 On embedded PowerPC systems, assume that the startup module is called
10731 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10732 @file{libc.a}.
10733
10734 @item -myellowknife
10735 @opindex myellowknife
10736 On embedded PowerPC systems, assume that the startup module is called
10737 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10738 @file{libc.a}.
10739
10740 @item -mvxworks
10741 @opindex mvxworks
10742 On System V.4 and embedded PowerPC systems, specify that you are
10743 compiling for a VxWorks system.
10744
10745 @item -mwindiss
10746 @opindex mwindiss
10747 Specify that you are compiling for the WindISS simulation environment.
10748
10749 @item -memb
10750 @opindex memb
10751 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10752 header to indicate that @samp{eabi} extended relocations are used.
10753
10754 @item -meabi
10755 @itemx -mno-eabi
10756 @opindex meabi
10757 @opindex mno-eabi
10758 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10759 Embedded Applications Binary Interface (eabi) which is a set of
10760 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10761 means that the stack is aligned to an 8 byte boundary, a function
10762 @code{__eabi} is called to from @code{main} to set up the eabi
10763 environment, and the @option{-msdata} option can use both @code{r2} and
10764 @code{r13} to point to two separate small data areas.  Selecting
10765 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10766 do not call an initialization function from @code{main}, and the
10767 @option{-msdata} option will only use @code{r13} to point to a single
10768 small data area.  The @option{-meabi} option is on by default if you
10769 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10770
10771 @item -msdata=eabi
10772 @opindex msdata=eabi
10773 On System V.4 and embedded PowerPC systems, put small initialized
10774 @code{const} global and static data in the @samp{.sdata2} section, which
10775 is pointed to by register @code{r2}.  Put small initialized
10776 non-@code{const} global and static data in the @samp{.sdata} section,
10777 which is pointed to by register @code{r13}.  Put small uninitialized
10778 global and static data in the @samp{.sbss} section, which is adjacent to
10779 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10780 incompatible with the @option{-mrelocatable} option.  The
10781 @option{-msdata=eabi} option also sets the @option{-memb} option.
10782
10783 @item -msdata=sysv
10784 @opindex msdata=sysv
10785 On System V.4 and embedded PowerPC systems, put small global and static
10786 data in the @samp{.sdata} section, which is pointed to by register
10787 @code{r13}.  Put small uninitialized global and static data in the
10788 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10789 The @option{-msdata=sysv} option is incompatible with the
10790 @option{-mrelocatable} option.
10791
10792 @item -msdata=default
10793 @itemx -msdata
10794 @opindex msdata=default
10795 @opindex msdata
10796 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10797 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10798 same as @option{-msdata=sysv}.
10799
10800 @item -msdata-data
10801 @opindex msdata-data
10802 On System V.4 and embedded PowerPC systems, put small global and static
10803 data in the @samp{.sdata} section.  Put small uninitialized global and
10804 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10805 to address small data however.  This is the default behavior unless
10806 other @option{-msdata} options are used.
10807
10808 @item -msdata=none
10809 @itemx -mno-sdata
10810 @opindex msdata=none
10811 @opindex mno-sdata
10812 On embedded PowerPC systems, put all initialized global and static data
10813 in the @samp{.data} section, and all uninitialized data in the
10814 @samp{.bss} section.
10815
10816 @item -G @var{num}
10817 @opindex G
10818 @cindex smaller data references (PowerPC)
10819 @cindex .sdata/.sdata2 references (PowerPC)
10820 On embedded PowerPC systems, put global and static items less than or
10821 equal to @var{num} bytes into the small data or bss sections instead of
10822 the normal data or bss section.  By default, @var{num} is 8.  The
10823 @option{-G @var{num}} switch is also passed to the linker.
10824 All modules should be compiled with the same @option{-G @var{num}} value.
10825
10826 @item -mregnames
10827 @itemx -mno-regnames
10828 @opindex mregnames
10829 @opindex mno-regnames
10830 On System V.4 and embedded PowerPC systems do (do not) emit register
10831 names in the assembly language output using symbolic forms.
10832
10833 @item -mlongcall
10834 @itemx -mno-longcall
10835 @opindex mlongcall
10836 @opindex mno-longcall
10837 Default to making all function calls indirectly, using a register, so
10838 that functions which reside further than 32 megabytes (33,554,432
10839 bytes) from the current location can be called.  This setting can be
10840 overridden by the @code{shortcall} function attribute, or by
10841 @code{#pragma longcall(0)}.
10842
10843 Some linkers are capable of detecting out-of-range calls and generating
10844 glue code on the fly.  On these systems, long calls are unnecessary and
10845 generate slower code.  As of this writing, the AIX linker can do this,
10846 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10847 to the GNU linker for 32-bit PowerPC systems as well.
10848
10849 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10850 callee, L42'', plus a ``branch island'' (glue code).  The two target
10851 addresses represent the callee and the ``branch island''.  The
10852 Darwin/PPC linker will prefer the first address and generate a ``bl
10853 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10854 otherwise, the linker will generate ``bl L42'' to call the ``branch
10855 island''.  The ``branch island'' is appended to the body of the
10856 calling function; it computes the full 32-bit address of the callee
10857 and jumps to it.
10858
10859 On Mach-O (Darwin) systems, this option directs the compiler emit to
10860 the glue for every direct call, and the Darwin linker decides whether
10861 to use or discard it.
10862
10863 In the future, we may cause GCC to ignore all longcall specifications
10864 when the linker is known to generate glue.
10865
10866 @item -pthread
10867 @opindex pthread
10868 Adds support for multithreading with the @dfn{pthreads} library.
10869 This option sets flags for both the preprocessor and linker.
10870
10871 @end table
10872
10873 @node S/390 and zSeries Options
10874 @subsection S/390 and zSeries Options
10875 @cindex S/390 and zSeries Options
10876
10877 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10878
10879 @table @gcctabopt
10880 @item -mhard-float
10881 @itemx -msoft-float
10882 @opindex mhard-float
10883 @opindex msoft-float
10884 Use (do not use) the hardware floating-point instructions and registers
10885 for floating-point operations.  When @option{-msoft-float} is specified,
10886 functions in @file{libgcc.a} will be used to perform floating-point
10887 operations.  When @option{-mhard-float} is specified, the compiler
10888 generates IEEE floating-point instructions.  This is the default.
10889
10890 @item -mbackchain
10891 @itemx -mno-backchain
10892 @opindex mbackchain
10893 @opindex mno-backchain
10894 Store (do not store) the address of the caller's frame as backchain pointer
10895 into the callee's stack frame.
10896 A backchain may be needed to allow debugging using tools that do not understand
10897 DWARF-2 call frame information.
10898 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
10899 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
10900 the backchain is placed into the topmost word of the 96/160 byte register
10901 save area.
10902
10903 In general, code compiled with @option{-mbackchain} is call-compatible with
10904 code compiled with @option{-mmo-backchain}; however, use of the backchain
10905 for debugging purposes usually requires that the whole binary is built with
10906 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
10907 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10908 to build a linux kernel use @option{-msoft-float}.
10909
10910 The default is to not maintain the backchain.
10911
10912 @item -mpacked-stack
10913 @item -mno-packed-stack
10914 @opindex mpacked-stack
10915 @opindex mno-packed-stack
10916 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
10917 specified, the compiler uses the all fields of the 96/160 byte register save
10918 area only for their default purpose; unused fields still take up stack space.
10919 When @option{-mpacked-stack} is specified, register save slots are densely
10920 packed at the top of the register save area; unused space is reused for other
10921 purposes, allowing for more efficient use of the available stack space.
10922 However, when @option{-mbackchain} is also in effect, the topmost word of
10923 the save area is always used to store the backchain, and the return address
10924 register is always saved two words below the backchain.
10925
10926 As long as the stack frame backchain is not used, code generated with
10927 @option{-mpacked-stack} is call-compatible with code generated with
10928 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
10929 S/390 or zSeries generated code that uses the stack frame backchain at run
10930 time, not just for debugging purposes.  Such code is not call-compatible
10931 with code compiled with @option{-mpacked-stack}.  Also, note that the
10932 combination of @option{-mbackchain},
10933 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10934 to build a linux kernel use @option{-msoft-float}.
10935
10936 The default is to not use the packed stack layout.
10937
10938 @item -msmall-exec
10939 @itemx -mno-small-exec
10940 @opindex msmall-exec
10941 @opindex mno-small-exec
10942 Generate (or do not generate) code using the @code{bras} instruction
10943 to do subroutine calls.
10944 This only works reliably if the total executable size does not
10945 exceed 64k.  The default is to use the @code{basr} instruction instead,
10946 which does not have this limitation.
10947
10948 @item -m64
10949 @itemx -m31
10950 @opindex m64
10951 @opindex m31
10952 When @option{-m31} is specified, generate code compliant to the
10953 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10954 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10955 particular to generate 64-bit instructions.  For the @samp{s390}
10956 targets, the default is @option{-m31}, while the @samp{s390x}
10957 targets default to @option{-m64}.
10958
10959 @item -mzarch
10960 @itemx -mesa
10961 @opindex mzarch
10962 @opindex mesa
10963 When @option{-mzarch} is specified, generate code using the
10964 instructions available on z/Architecture.
10965 When @option{-mesa} is specified, generate code using the
10966 instructions available on ESA/390.  Note that @option{-mesa} is
10967 not possible with @option{-m64}.
10968 When generating code compliant to the GNU/Linux for S/390 ABI,
10969 the default is @option{-mesa}.  When generating code compliant
10970 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10971
10972 @item -mmvcle
10973 @itemx -mno-mvcle
10974 @opindex mmvcle
10975 @opindex mno-mvcle
10976 Generate (or do not generate) code using the @code{mvcle} instruction
10977 to perform block moves.  When @option{-mno-mvcle} is specified,
10978 use a @code{mvc} loop instead.  This is the default.
10979
10980 @item -mdebug
10981 @itemx -mno-debug
10982 @opindex mdebug
10983 @opindex mno-debug
10984 Print (or do not print) additional debug information when compiling.
10985 The default is to not print debug information.
10986
10987 @item -march=@var{cpu-type}
10988 @opindex march
10989 Generate code that will run on @var{cpu-type}, which is the name of a system
10990 representing a certain processor type.  Possible values for
10991 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10992 When generating code using the instructions available on z/Architecture,
10993 the default is @option{-march=z900}.  Otherwise, the default is
10994 @option{-march=g5}.
10995
10996 @item -mtune=@var{cpu-type}
10997 @opindex mtune
10998 Tune to @var{cpu-type} everything applicable about the generated code,
10999 except for the ABI and the set of available instructions.
11000 The list of @var{cpu-type} values is the same as for @option{-march}.
11001 The default is the value used for @option{-march}.
11002
11003 @item -mtpf-trace
11004 @itemx -mno-tpf-trace
11005 @opindex mtpf-trace
11006 @opindex mno-tpf-trace
11007 Generate code that adds (does not add) in TPF OS specific branches to trace
11008 routines in the operating system.  This option is off by default, even
11009 when compiling for the TPF OS@.
11010
11011 @item -mfused-madd
11012 @itemx -mno-fused-madd
11013 @opindex mfused-madd
11014 @opindex mno-fused-madd
11015 Generate code that uses (does not use) the floating point multiply and
11016 accumulate instructions.  These instructions are generated by default if
11017 hardware floating point is used.
11018
11019 @item -mwarn-framesize=@var{framesize}
11020 @opindex mwarn-framesize
11021 Emit a warning if the current function exceeds the given frame size.  Because
11022 this is a compile time check it doesn't need to be a real problem when the program
11023 runs.  It is intended to identify functions which most probably cause
11024 a stack overflow.  It is useful to be used in an environment with limited stack
11025 size e.g.@: the linux kernel.
11026
11027 @item -mwarn-dynamicstack
11028 @opindex mwarn-dynamicstack
11029 Emit a warning if the function calls alloca or uses dynamically
11030 sized arrays.  This is generally a bad idea with a limited stack size.
11031
11032 @item -mstack-guard=@var{stack-guard}
11033 @item -mstack-size=@var{stack-size}
11034 @opindex mstack-guard
11035 @opindex mstack-size
11036 These arguments always have to be used in conjunction.  If they are present the s390
11037 back end emits additional instructions in the function prologue which trigger a trap
11038 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11039 (remember that the stack on s390 grows downward).  These options are intended to
11040 be used to help debugging stack overflow problems.  The additionally emitted code
11041 cause only little overhead and hence can also be used in production like systems
11042 without greater performance degradation.  The given values have to be exact
11043 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11044 In order to be efficient the extra code makes the assumption that the stack starts
11045 at an address aligned to the value given by @var{stack-size}.
11046 @end table
11047
11048 @node SH Options
11049 @subsection SH Options
11050
11051 These @samp{-m} options are defined for the SH implementations:
11052
11053 @table @gcctabopt
11054 @item -m1
11055 @opindex m1
11056 Generate code for the SH1.
11057
11058 @item -m2
11059 @opindex m2
11060 Generate code for the SH2.
11061
11062 @item -m2e
11063 Generate code for the SH2e.
11064
11065 @item -m3
11066 @opindex m3
11067 Generate code for the SH3.
11068
11069 @item -m3e
11070 @opindex m3e
11071 Generate code for the SH3e.
11072
11073 @item -m4-nofpu
11074 @opindex m4-nofpu
11075 Generate code for the SH4 without a floating-point unit.
11076
11077 @item -m4-single-only
11078 @opindex m4-single-only
11079 Generate code for the SH4 with a floating-point unit that only
11080 supports single-precision arithmetic.
11081
11082 @item -m4-single
11083 @opindex m4-single
11084 Generate code for the SH4 assuming the floating-point unit is in
11085 single-precision mode by default.
11086
11087 @item -m4
11088 @opindex m4
11089 Generate code for the SH4.
11090
11091 @item -m4a-nofpu
11092 @opindex m4a-nofpu
11093 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11094 floating-point unit is not used.
11095
11096 @item -m4a-single-only
11097 @opindex m4a-single-only
11098 Generate code for the SH4a, in such a way that no double-precision
11099 floating point operations are used.
11100
11101 @item -m4a-single
11102 @opindex m4a-single
11103 Generate code for the SH4a assuming the floating-point unit is in
11104 single-precision mode by default.
11105
11106 @item -m4a
11107 @opindex m4a
11108 Generate code for the SH4a.
11109
11110 @item -m4al
11111 @opindex m4al
11112 Same as @option{-m4a-nofpu}, except that it implicitly passes
11113 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11114 instructions at the moment.
11115
11116 @item -mb
11117 @opindex mb
11118 Compile code for the processor in big endian mode.
11119
11120 @item -ml
11121 @opindex ml
11122 Compile code for the processor in little endian mode.
11123
11124 @item -mdalign
11125 @opindex mdalign
11126 Align doubles at 64-bit boundaries.  Note that this changes the calling
11127 conventions, and thus some functions from the standard C library will
11128 not work unless you recompile it first with @option{-mdalign}.
11129
11130 @item -mrelax
11131 @opindex mrelax
11132 Shorten some address references at link time, when possible; uses the
11133 linker option @option{-relax}.
11134
11135 @item -mbigtable
11136 @opindex mbigtable
11137 Use 32-bit offsets in @code{switch} tables.  The default is to use
11138 16-bit offsets.
11139
11140 @item -mfmovd
11141 @opindex mfmovd
11142 Enable the use of the instruction @code{fmovd}.
11143
11144 @item -mhitachi
11145 @opindex mhitachi
11146 Comply with the calling conventions defined by Renesas.
11147
11148 @item -mrenesas
11149 @opindex mhitachi
11150 Comply with the calling conventions defined by Renesas.
11151
11152 @item -mno-renesas
11153 @opindex mhitachi
11154 Comply with the calling conventions defined for GCC before the Renesas
11155 conventions were available.  This option is the default for all
11156 targets of the SH toolchain except for @samp{sh-symbianelf}.
11157
11158 @item -mnomacsave
11159 @opindex mnomacsave
11160 Mark the @code{MAC} register as call-clobbered, even if
11161 @option{-mhitachi} is given.
11162
11163 @item -mieee
11164 @opindex mieee
11165 Increase IEEE-compliance of floating-point code.
11166
11167 @item -misize
11168 @opindex misize
11169 Dump instruction size and location in the assembly code.
11170
11171 @item -mpadstruct
11172 @opindex mpadstruct
11173 This option is deprecated.  It pads structures to multiple of 4 bytes,
11174 which is incompatible with the SH ABI@.
11175
11176 @item -mspace
11177 @opindex mspace
11178 Optimize for space instead of speed.  Implied by @option{-Os}.
11179
11180 @item -mprefergot
11181 @opindex mprefergot
11182 When generating position-independent code, emit function calls using
11183 the Global Offset Table instead of the Procedure Linkage Table.
11184
11185 @item -musermode
11186 @opindex musermode
11187 Generate a library function call to invalidate instruction cache
11188 entries, after fixing up a trampoline.  This library function call
11189 doesn't assume it can write to the whole memory address space.  This
11190 is the default when the target is @code{sh-*-linux*}.
11191 @end table
11192
11193 @node SPARC Options
11194 @subsection SPARC Options
11195 @cindex SPARC options
11196
11197 These @samp{-m} options are supported on the SPARC:
11198
11199 @table @gcctabopt
11200 @item -mno-app-regs
11201 @itemx -mapp-regs
11202 @opindex mno-app-regs
11203 @opindex mapp-regs
11204 Specify @option{-mapp-regs} to generate output using the global registers
11205 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11206 is the default.
11207
11208 To be fully SVR4 ABI compliant at the cost of some performance loss,
11209 specify @option{-mno-app-regs}.  You should compile libraries and system
11210 software with this option.
11211
11212 @item -mfpu
11213 @itemx -mhard-float
11214 @opindex mfpu
11215 @opindex mhard-float
11216 Generate output containing floating point instructions.  This is the
11217 default.
11218
11219 @item -mno-fpu
11220 @itemx -msoft-float
11221 @opindex mno-fpu
11222 @opindex msoft-float
11223 Generate output containing library calls for floating point.
11224 @strong{Warning:} the requisite libraries are not available for all SPARC
11225 targets.  Normally the facilities of the machine's usual C compiler are
11226 used, but this cannot be done directly in cross-compilation.  You must make
11227 your own arrangements to provide suitable library functions for
11228 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11229 @samp{sparclite-*-*} do provide software floating point support.
11230
11231 @option{-msoft-float} changes the calling convention in the output file;
11232 therefore, it is only useful if you compile @emph{all} of a program with
11233 this option.  In particular, you need to compile @file{libgcc.a}, the
11234 library that comes with GCC, with @option{-msoft-float} in order for
11235 this to work.
11236
11237 @item -mhard-quad-float
11238 @opindex mhard-quad-float
11239 Generate output containing quad-word (long double) floating point
11240 instructions.
11241
11242 @item -msoft-quad-float
11243 @opindex msoft-quad-float
11244 Generate output containing library calls for quad-word (long double)
11245 floating point instructions.  The functions called are those specified
11246 in the SPARC ABI@.  This is the default.
11247
11248 As of this writing, there are no SPARC implementations that have hardware
11249 support for the quad-word floating point instructions.  They all invoke
11250 a trap handler for one of these instructions, and then the trap handler
11251 emulates the effect of the instruction.  Because of the trap handler overhead,
11252 this is much slower than calling the ABI library routines.  Thus the
11253 @option{-msoft-quad-float} option is the default.
11254
11255 @item -mno-unaligned-doubles
11256 @itemx -munaligned-doubles
11257 @opindex mno-unaligned-doubles
11258 @opindex munaligned-doubles
11259 Assume that doubles have 8 byte alignment.  This is the default.
11260
11261 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11262 alignment only if they are contained in another type, or if they have an
11263 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11264 Specifying this option avoids some rare compatibility problems with code
11265 generated by other compilers.  It is not the default because it results
11266 in a performance loss, especially for floating point code.
11267
11268 @item -mno-faster-structs
11269 @itemx -mfaster-structs
11270 @opindex mno-faster-structs
11271 @opindex mfaster-structs
11272 With @option{-mfaster-structs}, the compiler assumes that structures
11273 should have 8 byte alignment.  This enables the use of pairs of
11274 @code{ldd} and @code{std} instructions for copies in structure
11275 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11276 However, the use of this changed alignment directly violates the SPARC
11277 ABI@.  Thus, it's intended only for use on targets where the developer
11278 acknowledges that their resulting code will not be directly in line with
11279 the rules of the ABI@.
11280
11281 @item -mimpure-text
11282 @opindex mimpure-text
11283 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11284 the compiler to not pass @option{-z text} to the linker when linking a
11285 shared object.  Using this option, you can link position-dependent
11286 code into a shared object.
11287
11288 @option{-mimpure-text} suppresses the ``relocations remain against
11289 allocatable but non-writable sections'' linker error message.
11290 However, the necessary relocations will trigger copy-on-write, and the
11291 shared object is not actually shared across processes.  Instead of
11292 using @option{-mimpure-text}, you should compile all source code with
11293 @option{-fpic} or @option{-fPIC}.
11294
11295 This option is only available on SunOS and Solaris.
11296
11297 @item -mcpu=@var{cpu_type}
11298 @opindex mcpu
11299 Set the instruction set, register set, and instruction scheduling parameters
11300 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11301 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11302 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11303 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11304 @samp{ultrasparc3}.
11305
11306 Default instruction scheduling parameters are used for values that select
11307 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11308 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11309
11310 Here is a list of each supported architecture and their supported
11311 implementations.
11312
11313 @smallexample
11314     v7:             cypress
11315     v8:             supersparc, hypersparc
11316     sparclite:      f930, f934, sparclite86x
11317     sparclet:       tsc701
11318     v9:             ultrasparc, ultrasparc3
11319 @end smallexample
11320
11321 By default (unless configured otherwise), GCC generates code for the V7
11322 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11323 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11324 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11325 SPARCStation 1, 2, IPX etc.
11326
11327 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11328 architecture.  The only difference from V7 code is that the compiler emits
11329 the integer multiply and integer divide instructions which exist in SPARC-V8
11330 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11331 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11332 2000 series.
11333
11334 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11335 the SPARC architecture.  This adds the integer multiply, integer divide step
11336 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11337 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11338 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11339 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11340 MB86934 chip, which is the more recent SPARClite with FPU@.
11341
11342 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11343 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11344 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11345 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11346 optimizes it for the TEMIC SPARClet chip.
11347
11348 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11349 architecture.  This adds 64-bit integer and floating-point move instructions,
11350 3 additional floating-point condition code registers and conditional move
11351 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11352 optimizes it for the Sun UltraSPARC I/II chips.  With
11353 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11354 Sun UltraSPARC III chip.
11355
11356 @item -mtune=@var{cpu_type}
11357 @opindex mtune
11358 Set the instruction scheduling parameters for machine type
11359 @var{cpu_type}, but do not set the instruction set or register set that the
11360 option @option{-mcpu=@var{cpu_type}} would.
11361
11362 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11363 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11364 that select a particular cpu implementation.  Those are @samp{cypress},
11365 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11366 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11367 @samp{ultrasparc3}.
11368
11369 @item -mv8plus
11370 @itemx -mno-v8plus
11371 @opindex mv8plus
11372 @opindex mno-v8plus
11373 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11374 difference from the V8 ABI is that the global and out registers are
11375 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11376 mode for all SPARC-V9 processors.
11377
11378 @item -mvis
11379 @itemx -mno-vis
11380 @opindex mvis
11381 @opindex mno-vis
11382 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11383 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11384 @end table
11385
11386 These @samp{-m} options are supported in addition to the above
11387 on SPARC-V9 processors in 64-bit environments:
11388
11389 @table @gcctabopt
11390 @item -mlittle-endian
11391 @opindex mlittle-endian
11392 Generate code for a processor running in little-endian mode.  It is only
11393 available for a few configurations and most notably not on Solaris.
11394
11395 @item -m32
11396 @itemx -m64
11397 @opindex m32
11398 @opindex m64
11399 Generate code for a 32-bit or 64-bit environment.
11400 The 32-bit environment sets int, long and pointer to 32 bits.
11401 The 64-bit environment sets int to 32 bits and long and pointer
11402 to 64 bits.
11403
11404 @item -mcmodel=medlow
11405 @opindex mcmodel=medlow
11406 Generate code for the Medium/Low code model: 64-bit addresses, programs
11407 must be linked in the low 32 bits of memory.  Programs can be statically
11408 or dynamically linked.
11409
11410 @item -mcmodel=medmid
11411 @opindex mcmodel=medmid
11412 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11413 must be linked in the low 44 bits of memory, the text and data segments must
11414 be less than 2GB in size and the data segment must be located within 2GB of
11415 the text segment.
11416
11417 @item -mcmodel=medany
11418 @opindex mcmodel=medany
11419 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11420 may be linked anywhere in memory, the text and data segments must be less
11421 than 2GB in size and the data segment must be located within 2GB of the
11422 text segment.
11423
11424 @item -mcmodel=embmedany
11425 @opindex mcmodel=embmedany
11426 Generate code for the Medium/Anywhere code model for embedded systems:
11427 64-bit addresses, the text and data segments must be less than 2GB in
11428 size, both starting anywhere in memory (determined at link time).  The
11429 global register %g4 points to the base of the data segment.  Programs
11430 are statically linked and PIC is not supported.
11431
11432 @item -mstack-bias
11433 @itemx -mno-stack-bias
11434 @opindex mstack-bias
11435 @opindex mno-stack-bias
11436 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11437 frame pointer if present, are offset by @minus{}2047 which must be added back
11438 when making stack frame references.  This is the default in 64-bit mode.
11439 Otherwise, assume no such offset is present.
11440 @end table
11441
11442 These switches are supported in addition to the above on Solaris:
11443
11444 @table @gcctabopt
11445 @item -threads
11446 @opindex threads
11447 Add support for multithreading using the Solaris threads library.  This
11448 option sets flags for both the preprocessor and linker.  This option does
11449 not affect the thread safety of object code produced by the compiler or
11450 that of libraries supplied with it.
11451
11452 @item -pthreads
11453 @opindex pthreads
11454 Add support for multithreading using the POSIX threads library.  This
11455 option sets flags for both the preprocessor and linker.  This option does
11456 not affect the thread safety of object code produced  by the compiler or
11457 that of libraries supplied with it.
11458 @end table
11459
11460 @node System V Options
11461 @subsection Options for System V
11462
11463 These additional options are available on System V Release 4 for
11464 compatibility with other compilers on those systems:
11465
11466 @table @gcctabopt
11467 @item -G
11468 @opindex G
11469 Create a shared object.
11470 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11471
11472 @item -Qy
11473 @opindex Qy
11474 Identify the versions of each tool used by the compiler, in a
11475 @code{.ident} assembler directive in the output.
11476
11477 @item -Qn
11478 @opindex Qn
11479 Refrain from adding @code{.ident} directives to the output file (this is
11480 the default).
11481
11482 @item -YP,@var{dirs}
11483 @opindex YP
11484 Search the directories @var{dirs}, and no others, for libraries
11485 specified with @option{-l}.
11486
11487 @item -Ym,@var{dir}
11488 @opindex Ym
11489 Look in the directory @var{dir} to find the M4 preprocessor.
11490 The assembler uses this option.
11491 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11492 @c the generic assembler that comes with Solaris takes just -Ym.
11493 @end table
11494
11495 @node TMS320C3x/C4x Options
11496 @subsection TMS320C3x/C4x Options
11497 @cindex TMS320C3x/C4x Options
11498
11499 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11500
11501 @table @gcctabopt
11502
11503 @item -mcpu=@var{cpu_type}
11504 @opindex mcpu
11505 Set the instruction set, register set, and instruction scheduling
11506 parameters for machine type @var{cpu_type}.  Supported values for
11507 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11508 @samp{c44}.  The default is @samp{c40} to generate code for the
11509 TMS320C40.
11510
11511 @item -mbig-memory
11512 @itemx -mbig
11513 @itemx -msmall-memory
11514 @itemx -msmall
11515 @opindex mbig-memory
11516 @opindex mbig
11517 @opindex msmall-memory
11518 @opindex msmall
11519 Generates code for the big or small memory model.  The small memory
11520 model assumed that all data fits into one 64K word page.  At run-time
11521 the data page (DP) register must be set to point to the 64K page
11522 containing the .bss and .data program sections.  The big memory model is
11523 the default and requires reloading of the DP register for every direct
11524 memory access.
11525
11526 @item -mbk
11527 @itemx -mno-bk
11528 @opindex mbk
11529 @opindex mno-bk
11530 Allow (disallow) allocation of general integer operands into the block
11531 count register BK@.
11532
11533 @item -mdb
11534 @itemx -mno-db
11535 @opindex mdb
11536 @opindex mno-db
11537 Enable (disable) generation of code using decrement and branch,
11538 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11539 on the safe side, this is disabled for the C3x, since the maximum
11540 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11541 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11542 that it can utilize the decrement and branch instruction, but will give
11543 up if there is more than one memory reference in the loop.  Thus a loop
11544 where the loop counter is decremented can generate slightly more
11545 efficient code, in cases where the RPTB instruction cannot be utilized.
11546
11547 @item -mdp-isr-reload
11548 @itemx -mparanoid
11549 @opindex mdp-isr-reload
11550 @opindex mparanoid
11551 Force the DP register to be saved on entry to an interrupt service
11552 routine (ISR), reloaded to point to the data section, and restored on
11553 exit from the ISR@.  This should not be required unless someone has
11554 violated the small memory model by modifying the DP register, say within
11555 an object library.
11556
11557 @item -mmpyi
11558 @itemx -mno-mpyi
11559 @opindex mmpyi
11560 @opindex mno-mpyi
11561 For the C3x use the 24-bit MPYI instruction for integer multiplies
11562 instead of a library call to guarantee 32-bit results.  Note that if one
11563 of the operands is a constant, then the multiplication will be performed
11564 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11565 then squaring operations are performed inline instead of a library call.
11566
11567 @item -mfast-fix
11568 @itemx -mno-fast-fix
11569 @opindex mfast-fix
11570 @opindex mno-fast-fix
11571 The C3x/C4x FIX instruction to convert a floating point value to an
11572 integer value chooses the nearest integer less than or equal to the
11573 floating point value rather than to the nearest integer.  Thus if the
11574 floating point number is negative, the result will be incorrectly
11575 truncated an additional code is necessary to detect and correct this
11576 case.  This option can be used to disable generation of the additional
11577 code required to correct the result.
11578
11579 @item -mrptb
11580 @itemx -mno-rptb
11581 @opindex mrptb
11582 @opindex mno-rptb
11583 Enable (disable) generation of repeat block sequences using the RPTB
11584 instruction for zero overhead looping.  The RPTB construct is only used
11585 for innermost loops that do not call functions or jump across the loop
11586 boundaries.  There is no advantage having nested RPTB loops due to the
11587 overhead required to save and restore the RC, RS, and RE registers.
11588 This is enabled by default with @option{-O2}.
11589
11590 @item -mrpts=@var{count}
11591 @itemx -mno-rpts
11592 @opindex mrpts
11593 @opindex mno-rpts
11594 Enable (disable) the use of the single instruction repeat instruction
11595 RPTS@.  If a repeat block contains a single instruction, and the loop
11596 count can be guaranteed to be less than the value @var{count}, GCC will
11597 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11598 then a RPTS will be emitted even if the loop count cannot be determined
11599 at compile time.  Note that the repeated instruction following RPTS does
11600 not have to be reloaded from memory each iteration, thus freeing up the
11601 CPU buses for operands.  However, since interrupts are blocked by this
11602 instruction, it is disabled by default.
11603
11604 @item -mloop-unsigned
11605 @itemx -mno-loop-unsigned
11606 @opindex mloop-unsigned
11607 @opindex mno-loop-unsigned
11608 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11609 is @math{2^{31} + 1} since these instructions test if the iteration count is
11610 negative to terminate the loop.  If the iteration count is unsigned
11611 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11612 exceeded.  This switch allows an unsigned iteration count.
11613
11614 @item -mti
11615 @opindex mti
11616 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11617 with.  This also enforces compatibility with the API employed by the TI
11618 C3x C compiler.  For example, long doubles are passed as structures
11619 rather than in floating point registers.
11620
11621 @item -mregparm
11622 @itemx -mmemparm
11623 @opindex mregparm
11624 @opindex mmemparm
11625 Generate code that uses registers (stack) for passing arguments to functions.
11626 By default, arguments are passed in registers where possible rather
11627 than by pushing arguments on to the stack.
11628
11629 @item -mparallel-insns
11630 @itemx -mno-parallel-insns
11631 @opindex mparallel-insns
11632 @opindex mno-parallel-insns
11633 Allow the generation of parallel instructions.  This is enabled by
11634 default with @option{-O2}.
11635
11636 @item -mparallel-mpy
11637 @itemx -mno-parallel-mpy
11638 @opindex mparallel-mpy
11639 @opindex mno-parallel-mpy
11640 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11641 provided @option{-mparallel-insns} is also specified.  These instructions have
11642 tight register constraints which can pessimize the code generation
11643 of large functions.
11644
11645 @end table
11646
11647 @node V850 Options
11648 @subsection V850 Options
11649 @cindex V850 Options
11650
11651 These @samp{-m} options are defined for V850 implementations:
11652
11653 @table @gcctabopt
11654 @item -mlong-calls
11655 @itemx -mno-long-calls
11656 @opindex mlong-calls
11657 @opindex mno-long-calls
11658 Treat all calls as being far away (near).  If calls are assumed to be
11659 far away, the compiler will always load the functions address up into a
11660 register, and call indirect through the pointer.
11661
11662 @item -mno-ep
11663 @itemx -mep
11664 @opindex mno-ep
11665 @opindex mep
11666 Do not optimize (do optimize) basic blocks that use the same index
11667 pointer 4 or more times to copy pointer into the @code{ep} register, and
11668 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11669 option is on by default if you optimize.
11670
11671 @item -mno-prolog-function
11672 @itemx -mprolog-function
11673 @opindex mno-prolog-function
11674 @opindex mprolog-function
11675 Do not use (do use) external functions to save and restore registers
11676 at the prologue and epilogue of a function.  The external functions
11677 are slower, but use less code space if more than one function saves
11678 the same number of registers.  The @option{-mprolog-function} option
11679 is on by default if you optimize.
11680
11681 @item -mspace
11682 @opindex mspace
11683 Try to make the code as small as possible.  At present, this just turns
11684 on the @option{-mep} and @option{-mprolog-function} options.
11685
11686 @item -mtda=@var{n}
11687 @opindex mtda
11688 Put static or global variables whose size is @var{n} bytes or less into
11689 the tiny data area that register @code{ep} points to.  The tiny data
11690 area can hold up to 256 bytes in total (128 bytes for byte references).
11691
11692 @item -msda=@var{n}
11693 @opindex msda
11694 Put static or global variables whose size is @var{n} bytes or less into
11695 the small data area that register @code{gp} points to.  The small data
11696 area can hold up to 64 kilobytes.
11697
11698 @item -mzda=@var{n}
11699 @opindex mzda
11700 Put static or global variables whose size is @var{n} bytes or less into
11701 the first 32 kilobytes of memory.
11702
11703 @item -mv850
11704 @opindex mv850
11705 Specify that the target processor is the V850.
11706
11707 @item -mbig-switch
11708 @opindex mbig-switch
11709 Generate code suitable for big switch tables.  Use this option only if
11710 the assembler/linker complain about out of range branches within a switch
11711 table.
11712
11713 @item -mapp-regs
11714 @opindex mapp-regs
11715 This option will cause r2 and r5 to be used in the code generated by
11716 the compiler.  This setting is the default.
11717
11718 @item -mno-app-regs
11719 @opindex mno-app-regs
11720 This option will cause r2 and r5 to be treated as fixed registers.
11721
11722 @item -mv850e1
11723 @opindex mv850e1
11724 Specify that the target processor is the V850E1.  The preprocessor
11725 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11726 this option is used.
11727
11728 @item -mv850e
11729 @opindex mv850e
11730 Specify that the target processor is the V850E@.  The preprocessor
11731 constant @samp{__v850e__} will be defined if this option is used.
11732
11733 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11734 are defined then a default target processor will be chosen and the
11735 relevant @samp{__v850*__} preprocessor constant will be defined.
11736
11737 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11738 defined, regardless of which processor variant is the target.
11739
11740 @item -mdisable-callt
11741 @opindex mdisable-callt
11742 This option will suppress generation of the CALLT instruction for the
11743 v850e and v850e1 flavors of the v850 architecture.  The default is
11744 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11745
11746 @end table
11747
11748 @node VAX Options
11749 @subsection VAX Options
11750 @cindex VAX options
11751
11752 These @samp{-m} options are defined for the VAX:
11753
11754 @table @gcctabopt
11755 @item -munix
11756 @opindex munix
11757 Do not output certain jump instructions (@code{aobleq} and so on)
11758 that the Unix assembler for the VAX cannot handle across long
11759 ranges.
11760
11761 @item -mgnu
11762 @opindex mgnu
11763 Do output those jump instructions, on the assumption that you
11764 will assemble with the GNU assembler.
11765
11766 @item -mg
11767 @opindex mg
11768 Output code for g-format floating point numbers instead of d-format.
11769 @end table
11770
11771 @node x86-64 Options
11772 @subsection x86-64 Options
11773 @cindex x86-64 options
11774
11775 These are listed under @xref{i386 and x86-64 Options}.
11776
11777 @node Xstormy16 Options
11778 @subsection Xstormy16 Options
11779 @cindex Xstormy16 Options
11780
11781 These options are defined for Xstormy16:
11782
11783 @table @gcctabopt
11784 @item -msim
11785 @opindex msim
11786 Choose startup files and linker script suitable for the simulator.
11787 @end table
11788
11789 @node Xtensa Options
11790 @subsection Xtensa Options
11791 @cindex Xtensa Options
11792
11793 These options are supported for Xtensa targets:
11794
11795 @table @gcctabopt
11796 @item -mconst16
11797 @itemx -mno-const16
11798 @opindex mconst16
11799 @opindex mno-const16
11800 Enable or disable use of @code{CONST16} instructions for loading
11801 constant values.  The @code{CONST16} instruction is currently not a
11802 standard option from Tensilica.  When enabled, @code{CONST16}
11803 instructions are always used in place of the standard @code{L32R}
11804 instructions.  The use of @code{CONST16} is enabled by default only if
11805 the @code{L32R} instruction is not available.
11806
11807 @item -mfused-madd
11808 @itemx -mno-fused-madd
11809 @opindex mfused-madd
11810 @opindex mno-fused-madd
11811 Enable or disable use of fused multiply/add and multiply/subtract
11812 instructions in the floating-point option.  This has no effect if the
11813 floating-point option is not also enabled.  Disabling fused multiply/add
11814 and multiply/subtract instructions forces the compiler to use separate
11815 instructions for the multiply and add/subtract operations.  This may be
11816 desirable in some cases where strict IEEE 754-compliant results are
11817 required: the fused multiply add/subtract instructions do not round the
11818 intermediate result, thereby producing results with @emph{more} bits of
11819 precision than specified by the IEEE standard.  Disabling fused multiply
11820 add/subtract instructions also ensures that the program output is not
11821 sensitive to the compiler's ability to combine multiply and add/subtract
11822 operations.
11823
11824 @item -mtext-section-literals
11825 @itemx -mno-text-section-literals
11826 @opindex mtext-section-literals
11827 @opindex mno-text-section-literals
11828 Control the treatment of literal pools.  The default is
11829 @option{-mno-text-section-literals}, which places literals in a separate
11830 section in the output file.  This allows the literal pool to be placed
11831 in a data RAM/ROM, and it also allows the linker to combine literal
11832 pools from separate object files to remove redundant literals and
11833 improve code size.  With @option{-mtext-section-literals}, the literals
11834 are interspersed in the text section in order to keep them as close as
11835 possible to their references.  This may be necessary for large assembly
11836 files.
11837
11838 @item -mtarget-align
11839 @itemx -mno-target-align
11840 @opindex mtarget-align
11841 @opindex mno-target-align
11842 When this option is enabled, GCC instructs the assembler to
11843 automatically align instructions to reduce branch penalties at the
11844 expense of some code density.  The assembler attempts to widen density
11845 instructions to align branch targets and the instructions following call
11846 instructions.  If there are not enough preceding safe density
11847 instructions to align a target, no widening will be performed.  The
11848 default is @option{-mtarget-align}.  These options do not affect the
11849 treatment of auto-aligned instructions like @code{LOOP}, which the
11850 assembler will always align, either by widening density instructions or
11851 by inserting no-op instructions.
11852
11853 @item -mlongcalls
11854 @itemx -mno-longcalls
11855 @opindex mlongcalls
11856 @opindex mno-longcalls
11857 When this option is enabled, GCC instructs the assembler to translate
11858 direct calls to indirect calls unless it can determine that the target
11859 of a direct call is in the range allowed by the call instruction.  This
11860 translation typically occurs for calls to functions in other source
11861 files.  Specifically, the assembler translates a direct @code{CALL}
11862 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11863 The default is @option{-mno-longcalls}.  This option should be used in
11864 programs where the call target can potentially be out of range.  This
11865 option is implemented in the assembler, not the compiler, so the
11866 assembly code generated by GCC will still show direct call
11867 instructions---look at the disassembled object code to see the actual
11868 instructions.  Note that the assembler will use an indirect call for
11869 every cross-file call, not just those that really will be out of range.
11870 @end table
11871
11872 @node zSeries Options
11873 @subsection zSeries Options
11874 @cindex zSeries options
11875
11876 These are listed under @xref{S/390 and zSeries Options}.
11877
11878 @node Code Gen Options
11879 @section Options for Code Generation Conventions
11880 @cindex code generation conventions
11881 @cindex options, code generation
11882 @cindex run-time options
11883
11884 These machine-independent options control the interface conventions
11885 used in code generation.
11886
11887 Most of them have both positive and negative forms; the negative form
11888 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11889 one of the forms is listed---the one which is not the default.  You
11890 can figure out the other form by either removing @samp{no-} or adding
11891 it.
11892
11893 @table @gcctabopt
11894 @item -fbounds-check
11895 @opindex fbounds-check
11896 For front-ends that support it, generate additional code to check that
11897 indices used to access arrays are within the declared range.  This is
11898 currently only supported by the Java and Fortran 77 front-ends, where
11899 this option defaults to true and false respectively.
11900
11901 @item -ftrapv
11902 @opindex ftrapv
11903 This option generates traps for signed overflow on addition, subtraction,
11904 multiplication operations.
11905
11906 @item -fwrapv
11907 @opindex fwrapv
11908 This option instructs the compiler to assume that signed arithmetic
11909 overflow of addition, subtraction and multiplication wraps around
11910 using twos-complement representation.  This flag enables some optimizations
11911 and disables other.  This option is enabled by default for the Java
11912 front-end, as required by the Java language specification.
11913
11914 @item -fexceptions
11915 @opindex fexceptions
11916 Enable exception handling.  Generates extra code needed to propagate
11917 exceptions.  For some targets, this implies GCC will generate frame
11918 unwind information for all functions, which can produce significant data
11919 size overhead, although it does not affect execution.  If you do not
11920 specify this option, GCC will enable it by default for languages like
11921 C++ which normally require exception handling, and disable it for
11922 languages like C that do not normally require it.  However, you may need
11923 to enable this option when compiling C code that needs to interoperate
11924 properly with exception handlers written in C++.  You may also wish to
11925 disable this option if you are compiling older C++ programs that don't
11926 use exception handling.
11927
11928 @item -fnon-call-exceptions
11929 @opindex fnon-call-exceptions
11930 Generate code that allows trapping instructions to throw exceptions.
11931 Note that this requires platform-specific runtime support that does
11932 not exist everywhere.  Moreover, it only allows @emph{trapping}
11933 instructions to throw exceptions, i.e.@: memory references or floating
11934 point instructions.  It does not allow exceptions to be thrown from
11935 arbitrary signal handlers such as @code{SIGALRM}.
11936
11937 @item -funwind-tables
11938 @opindex funwind-tables
11939 Similar to @option{-fexceptions}, except that it will just generate any needed
11940 static data, but will not affect the generated code in any other way.
11941 You will normally not enable this option; instead, a language processor
11942 that needs this handling would enable it on your behalf.
11943
11944 @item -fasynchronous-unwind-tables
11945 @opindex fasynchronous-unwind-tables
11946 Generate unwind table in dwarf2 format, if supported by target machine.  The
11947 table is exact at each instruction boundary, so it can be used for stack
11948 unwinding from asynchronous events (such as debugger or garbage collector).
11949
11950 @item -fpcc-struct-return
11951 @opindex fpcc-struct-return
11952 Return ``short'' @code{struct} and @code{union} values in memory like
11953 longer ones, rather than in registers.  This convention is less
11954 efficient, but it has the advantage of allowing intercallability between
11955 GCC-compiled files and files compiled with other compilers, particularly
11956 the Portable C Compiler (pcc).
11957
11958 The precise convention for returning structures in memory depends
11959 on the target configuration macros.
11960
11961 Short structures and unions are those whose size and alignment match
11962 that of some integer type.
11963
11964 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11965 switch is not binary compatible with code compiled with the
11966 @option{-freg-struct-return} switch.
11967 Use it to conform to a non-default application binary interface.
11968
11969 @item -freg-struct-return
11970 @opindex freg-struct-return
11971 Return @code{struct} and @code{union} values in registers when possible.
11972 This is more efficient for small structures than
11973 @option{-fpcc-struct-return}.
11974
11975 If you specify neither @option{-fpcc-struct-return} nor
11976 @option{-freg-struct-return}, GCC defaults to whichever convention is
11977 standard for the target.  If there is no standard convention, GCC
11978 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11979 the principal compiler.  In those cases, we can choose the standard, and
11980 we chose the more efficient register return alternative.
11981
11982 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11983 switch is not binary compatible with code compiled with the
11984 @option{-fpcc-struct-return} switch.
11985 Use it to conform to a non-default application binary interface.
11986
11987 @item -fshort-enums
11988 @opindex fshort-enums
11989 Allocate to an @code{enum} type only as many bytes as it needs for the
11990 declared range of possible values.  Specifically, the @code{enum} type
11991 will be equivalent to the smallest integer type which has enough room.
11992
11993 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11994 code that is not binary compatible with code generated without that switch.
11995 Use it to conform to a non-default application binary interface.
11996
11997 @item -fshort-double
11998 @opindex fshort-double
11999 Use the same size for @code{double} as for @code{float}.
12000
12001 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12002 code that is not binary compatible with code generated without that switch.
12003 Use it to conform to a non-default application binary interface.
12004
12005 @item -fshort-wchar
12006 @opindex fshort-wchar
12007 Override the underlying type for @samp{wchar_t} to be @samp{short
12008 unsigned int} instead of the default for the target.  This option is
12009 useful for building programs to run under WINE@.
12010
12011 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12012 code that is not binary compatible with code generated without that switch.
12013 Use it to conform to a non-default application binary interface.
12014
12015 @item -fshared-data
12016 @opindex fshared-data
12017 Requests that the data and non-@code{const} variables of this
12018 compilation be shared data rather than private data.  The distinction
12019 makes sense only on certain operating systems, where shared data is
12020 shared between processes running the same program, while private data
12021 exists in one copy per process.
12022
12023 @item -fno-common
12024 @opindex fno-common
12025 In C, allocate even uninitialized global variables in the data section of the
12026 object file, rather than generating them as common blocks.  This has the
12027 effect that if the same variable is declared (without @code{extern}) in
12028 two different compilations, you will get an error when you link them.
12029 The only reason this might be useful is if you wish to verify that the
12030 program will work on other systems which always work this way.
12031
12032 @item -fno-ident
12033 @opindex fno-ident
12034 Ignore the @samp{#ident} directive.
12035
12036 @item -finhibit-size-directive
12037 @opindex finhibit-size-directive
12038 Don't output a @code{.size} assembler directive, or anything else that
12039 would cause trouble if the function is split in the middle, and the
12040 two halves are placed at locations far apart in memory.  This option is
12041 used when compiling @file{crtstuff.c}; you should not need to use it
12042 for anything else.
12043
12044 @item -fverbose-asm
12045 @opindex fverbose-asm
12046 Put extra commentary information in the generated assembly code to
12047 make it more readable.  This option is generally only of use to those
12048 who actually need to read the generated assembly code (perhaps while
12049 debugging the compiler itself).
12050
12051 @option{-fno-verbose-asm}, the default, causes the
12052 extra information to be omitted and is useful when comparing two assembler
12053 files.
12054
12055 @item -fpic
12056 @opindex fpic
12057 @cindex global offset table
12058 @cindex PIC
12059 Generate position-independent code (PIC) suitable for use in a shared
12060 library, if supported for the target machine.  Such code accesses all
12061 constant addresses through a global offset table (GOT)@.  The dynamic
12062 loader resolves the GOT entries when the program starts (the dynamic
12063 loader is not part of GCC; it is part of the operating system).  If
12064 the GOT size for the linked executable exceeds a machine-specific
12065 maximum size, you get an error message from the linker indicating that
12066 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12067 instead.  (These maximums are 8k on the SPARC and 32k
12068 on the m68k and RS/6000.  The 386 has no such limit.)
12069
12070 Position-independent code requires special support, and therefore works
12071 only on certain machines.  For the 386, GCC supports PIC for System V
12072 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12073 position-independent.
12074
12075 @item -fPIC
12076 @opindex fPIC
12077 If supported for the target machine, emit position-independent code,
12078 suitable for dynamic linking and avoiding any limit on the size of the
12079 global offset table.  This option makes a difference on the m68k,
12080 PowerPC and SPARC@.
12081
12082 Position-independent code requires special support, and therefore works
12083 only on certain machines.
12084
12085 @item -fpie
12086 @itemx -fPIE
12087 @opindex fpie
12088 @opindex fPIE
12089 These options are similar to @option{-fpic} and @option{-fPIC}, but
12090 generated position independent code can be only linked into executables.
12091 Usually these options are used when @option{-pie} GCC option will be
12092 used during linking.
12093
12094 @item -ffixed-@var{reg}
12095 @opindex ffixed
12096 Treat the register named @var{reg} as a fixed register; generated code
12097 should never refer to it (except perhaps as a stack pointer, frame
12098 pointer or in some other fixed role).
12099
12100 @var{reg} must be the name of a register.  The register names accepted
12101 are machine-specific and are defined in the @code{REGISTER_NAMES}
12102 macro in the machine description macro file.
12103
12104 This flag does not have a negative form, because it specifies a
12105 three-way choice.
12106
12107 @item -fcall-used-@var{reg}
12108 @opindex fcall-used
12109 Treat the register named @var{reg} as an allocable register that is
12110 clobbered by function calls.  It may be allocated for temporaries or
12111 variables that do not live across a call.  Functions compiled this way
12112 will not save and restore the register @var{reg}.
12113
12114 It is an error to used this flag with the frame pointer or stack pointer.
12115 Use of this flag for other registers that have fixed pervasive roles in
12116 the machine's execution model will produce disastrous results.
12117
12118 This flag does not have a negative form, because it specifies a
12119 three-way choice.
12120
12121 @item -fcall-saved-@var{reg}
12122 @opindex fcall-saved
12123 Treat the register named @var{reg} as an allocable register saved by
12124 functions.  It may be allocated even for temporaries or variables that
12125 live across a call.  Functions compiled this way will save and restore
12126 the register @var{reg} if they use it.
12127
12128 It is an error to used this flag with the frame pointer or stack pointer.
12129 Use of this flag for other registers that have fixed pervasive roles in
12130 the machine's execution model will produce disastrous results.
12131
12132 A different sort of disaster will result from the use of this flag for
12133 a register in which function values may be returned.
12134
12135 This flag does not have a negative form, because it specifies a
12136 three-way choice.
12137
12138 @item -fpack-struct[=@var{n}]
12139 @opindex fpack-struct
12140 Without a value specified, pack all structure members together without
12141 holes.  When a value is specified (which must be a small power of two), pack
12142 structure members according to this value, representing the maximum
12143 alignment (that is, objects with default alignment requirements larger than
12144 this will be output potentially unaligned at the next fitting location.
12145
12146 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12147 code that is not binary compatible with code generated without that switch.
12148 Additionally, it makes the code suboptimal.
12149 Use it to conform to a non-default application binary interface.
12150
12151 @item -finstrument-functions
12152 @opindex finstrument-functions
12153 Generate instrumentation calls for entry and exit to functions.  Just
12154 after function entry and just before function exit, the following
12155 profiling functions will be called with the address of the current
12156 function and its call site.  (On some platforms,
12157 @code{__builtin_return_address} does not work beyond the current
12158 function, so the call site information may not be available to the
12159 profiling functions otherwise.)
12160
12161 @smallexample
12162 void __cyg_profile_func_enter (void *this_fn,
12163                                void *call_site);
12164 void __cyg_profile_func_exit  (void *this_fn,
12165                                void *call_site);
12166 @end smallexample
12167
12168 The first argument is the address of the start of the current function,
12169 which may be looked up exactly in the symbol table.
12170
12171 This instrumentation is also done for functions expanded inline in other
12172 functions.  The profiling calls will indicate where, conceptually, the
12173 inline function is entered and exited.  This means that addressable
12174 versions of such functions must be available.  If all your uses of a
12175 function are expanded inline, this may mean an additional expansion of
12176 code size.  If you use @samp{extern inline} in your C code, an
12177 addressable version of such functions must be provided.  (This is
12178 normally the case anyways, but if you get lucky and the optimizer always
12179 expands the functions inline, you might have gotten away without
12180 providing static copies.)
12181
12182 A function may be given the attribute @code{no_instrument_function}, in
12183 which case this instrumentation will not be done.  This can be used, for
12184 example, for the profiling functions listed above, high-priority
12185 interrupt routines, and any functions from which the profiling functions
12186 cannot safely be called (perhaps signal handlers, if the profiling
12187 routines generate output or allocate memory).
12188
12189 @item -fstack-check
12190 @opindex fstack-check
12191 Generate code to verify that you do not go beyond the boundary of the
12192 stack.  You should specify this flag if you are running in an
12193 environment with multiple threads, but only rarely need to specify it in
12194 a single-threaded environment since stack overflow is automatically
12195 detected on nearly all systems if there is only one stack.
12196
12197 Note that this switch does not actually cause checking to be done; the
12198 operating system must do that.  The switch causes generation of code
12199 to ensure that the operating system sees the stack being extended.
12200
12201 @item -fstack-limit-register=@var{reg}
12202 @itemx -fstack-limit-symbol=@var{sym}
12203 @itemx -fno-stack-limit
12204 @opindex fstack-limit-register
12205 @opindex fstack-limit-symbol
12206 @opindex fno-stack-limit
12207 Generate code to ensure that the stack does not grow beyond a certain value,
12208 either the value of a register or the address of a symbol.  If the stack
12209 would grow beyond the value, a signal is raised.  For most targets,
12210 the signal is raised before the stack overruns the boundary, so
12211 it is possible to catch the signal without taking special precautions.
12212
12213 For instance, if the stack starts at absolute address @samp{0x80000000}
12214 and grows downwards, you can use the flags
12215 @option{-fstack-limit-symbol=__stack_limit} and
12216 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12217 of 128KB@.  Note that this may only work with the GNU linker.
12218
12219 @cindex aliasing of parameters
12220 @cindex parameters, aliased
12221 @item -fargument-alias
12222 @itemx -fargument-noalias
12223 @itemx -fargument-noalias-global
12224 @opindex fargument-alias
12225 @opindex fargument-noalias
12226 @opindex fargument-noalias-global
12227 Specify the possible relationships among parameters and between
12228 parameters and global data.
12229
12230 @option{-fargument-alias} specifies that arguments (parameters) may
12231 alias each other and may alias global storage.@*
12232 @option{-fargument-noalias} specifies that arguments do not alias
12233 each other, but may alias global storage.@*
12234 @option{-fargument-noalias-global} specifies that arguments do not
12235 alias each other and do not alias global storage.
12236
12237 Each language will automatically use whatever option is required by
12238 the language standard.  You should not need to use these options yourself.
12239
12240 @item -fleading-underscore
12241 @opindex fleading-underscore
12242 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12243 change the way C symbols are represented in the object file.  One use
12244 is to help link with legacy assembly code.
12245
12246 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12247 generate code that is not binary compatible with code generated without that
12248 switch.  Use it to conform to a non-default application binary interface.
12249 Not all targets provide complete support for this switch.
12250
12251 @item -ftls-model=@var{model}
12252 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12253 The @var{model} argument should be one of @code{global-dynamic},
12254 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12255
12256 The default without @option{-fpic} is @code{initial-exec}; with
12257 @option{-fpic} the default is @code{global-dynamic}.
12258
12259 @item -fvisibility=@var{default|internal|hidden|protected}
12260 @opindex fvisibility
12261 Set the default ELF image symbol visibility to the specified option---all
12262 symbols will be marked with this unless overridden within the code.
12263 Using this feature can very substantially improve linking and
12264 load times of shared object libraries, produce more optimized
12265 code, provide near-perfect API export and prevent symbol clashes.
12266 It is @strong{strongly} recommended that you use this in any shared objects
12267 you distribute.
12268
12269 Despite the nomenclature, @code{default} always means public ie;
12270 available to be linked against from outside the shared object.
12271 @code{protected} and @code{internal} are pretty useless in real-world
12272 usage so the only other commonly used option will be @code{hidden}.
12273 The default if @option{-fvisibility} isn't specified is
12274 @code{default}, i.e., make every
12275 symbol public---this causes the same behavior as previous versions of
12276 GCC@.
12277
12278 A good explanation of the benefits offered by ensuring ELF
12279 symbols have the correct visibility is given by ``How To Write
12280 Shared Libraries'' by Ulrich Drepper (which can be found at
12281 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12282 solution made possible by this option to marking things hidden when
12283 the default is public is to make the default hidden and mark things
12284 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12285 and @code{__attribute__ ((visibility("default")))} instead of
12286 @code{__declspec(dllexport)} you get almost identical semantics with
12287 identical syntax.  This is a great boon to those working with
12288 cross-platform projects.
12289
12290 For those adding visibility support to existing code, you may find
12291 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12292 the declarations you wish to set visibility for with (for example)
12293 @samp{#pragma GCC visibility push(hidden)} and
12294 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12295 times.  Bear in mind that symbol visibility should be viewed @strong{as
12296 part of the API interface contract} and thus all new code should
12297 always specify visibility when it is not the default ie; declarations
12298 only for use within the local DSO should @strong{always} be marked explicitly
12299 as hidden as so to avoid PLT indirection overheads---making this
12300 abundantly clear also aids readability and self-documentation of the code.
12301 Note that due to ISO C++ specification requirements, operator new and
12302 operator delete must always be of default visibility.
12303
12304 An overview of these techniques, their benefits and how to use them
12305 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12306
12307 @end table
12308
12309 @c man end
12310
12311 @node Environment Variables
12312 @section Environment Variables Affecting GCC
12313 @cindex environment variables
12314
12315 @c man begin ENVIRONMENT
12316 This section describes several environment variables that affect how GCC
12317 operates.  Some of them work by specifying directories or prefixes to use
12318 when searching for various kinds of files.  Some are used to specify other
12319 aspects of the compilation environment.
12320
12321 Note that you can also specify places to search using options such as
12322 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12323 take precedence over places specified using environment variables, which
12324 in turn take precedence over those specified by the configuration of GCC@.
12325 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12326 GNU Compiler Collection (GCC) Internals}.
12327
12328 @table @env
12329 @item LANG
12330 @itemx LC_CTYPE
12331 @c @itemx LC_COLLATE
12332 @itemx LC_MESSAGES
12333 @c @itemx LC_MONETARY
12334 @c @itemx LC_NUMERIC
12335 @c @itemx LC_TIME
12336 @itemx LC_ALL
12337 @findex LANG
12338 @findex LC_CTYPE
12339 @c @findex LC_COLLATE
12340 @findex LC_MESSAGES
12341 @c @findex LC_MONETARY
12342 @c @findex LC_NUMERIC
12343 @c @findex LC_TIME
12344 @findex LC_ALL
12345 @cindex locale
12346 These environment variables control the way that GCC uses
12347 localization information that allow GCC to work with different
12348 national conventions.  GCC inspects the locale categories
12349 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12350 so.  These locale categories can be set to any value supported by your
12351 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12352 Kingdom encoded in UTF-8.
12353
12354 The @env{LC_CTYPE} environment variable specifies character
12355 classification.  GCC uses it to determine the character boundaries in
12356 a string; this is needed for some multibyte encodings that contain quote
12357 and escape characters that would otherwise be interpreted as a string
12358 end or escape.
12359
12360 The @env{LC_MESSAGES} environment variable specifies the language to
12361 use in diagnostic messages.
12362
12363 If the @env{LC_ALL} environment variable is set, it overrides the value
12364 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12365 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12366 environment variable.  If none of these variables are set, GCC
12367 defaults to traditional C English behavior.
12368
12369 @item TMPDIR
12370 @findex TMPDIR
12371 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12372 files.  GCC uses temporary files to hold the output of one stage of
12373 compilation which is to be used as input to the next stage: for example,
12374 the output of the preprocessor, which is the input to the compiler
12375 proper.
12376
12377 @item GCC_EXEC_PREFIX
12378 @findex GCC_EXEC_PREFIX
12379 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12380 names of the subprograms executed by the compiler.  No slash is added
12381 when this prefix is combined with the name of a subprogram, but you can
12382 specify a prefix that ends with a slash if you wish.
12383
12384 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12385 an appropriate prefix to use based on the pathname it was invoked with.
12386
12387 If GCC cannot find the subprogram using the specified prefix, it
12388 tries looking in the usual places for the subprogram.
12389
12390 The default value of @env{GCC_EXEC_PREFIX} is
12391 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12392 of @code{prefix} when you ran the @file{configure} script.
12393
12394 Other prefixes specified with @option{-B} take precedence over this prefix.
12395
12396 This prefix is also used for finding files such as @file{crt0.o} that are
12397 used for linking.
12398
12399 In addition, the prefix is used in an unusual way in finding the
12400 directories to search for header files.  For each of the standard
12401 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12402 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12403 replacing that beginning with the specified prefix to produce an
12404 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12405 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12406 These alternate directories are searched first; the standard directories
12407 come next.
12408
12409 @item COMPILER_PATH
12410 @findex COMPILER_PATH
12411 The value of @env{COMPILER_PATH} is a colon-separated list of
12412 directories, much like @env{PATH}.  GCC tries the directories thus
12413 specified when searching for subprograms, if it can't find the
12414 subprograms using @env{GCC_EXEC_PREFIX}.
12415
12416 @item LIBRARY_PATH
12417 @findex LIBRARY_PATH
12418 The value of @env{LIBRARY_PATH} is a colon-separated list of
12419 directories, much like @env{PATH}.  When configured as a native compiler,
12420 GCC tries the directories thus specified when searching for special
12421 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12422 using GCC also uses these directories when searching for ordinary
12423 libraries for the @option{-l} option (but directories specified with
12424 @option{-L} come first).
12425
12426 @item LANG
12427 @findex LANG
12428 @cindex locale definition
12429 This variable is used to pass locale information to the compiler.  One way in
12430 which this information is used is to determine the character set to be used
12431 when character literals, string literals and comments are parsed in C and C++.
12432 When the compiler is configured to allow multibyte characters,
12433 the following values for @env{LANG} are recognized:
12434
12435 @table @samp
12436 @item C-JIS
12437 Recognize JIS characters.
12438 @item C-SJIS
12439 Recognize SJIS characters.
12440 @item C-EUCJP
12441 Recognize EUCJP characters.
12442 @end table
12443
12444 If @env{LANG} is not defined, or if it has some other value, then the
12445 compiler will use mblen and mbtowc as defined by the default locale to
12446 recognize and translate multibyte characters.
12447 @end table
12448
12449 @noindent
12450 Some additional environments variables affect the behavior of the
12451 preprocessor.
12452
12453 @include cppenv.texi
12454
12455 @c man end
12456
12457 @node Precompiled Headers
12458 @section Using Precompiled Headers
12459 @cindex precompiled headers
12460 @cindex speed of compilation
12461
12462 Often large projects have many header files that are included in every
12463 source file.  The time the compiler takes to process these header files
12464 over and over again can account for nearly all of the time required to
12465 build the project.  To make builds faster, GCC allows users to
12466 `precompile' a header file; then, if builds can use the precompiled
12467 header file they will be much faster.
12468
12469 @strong{Caution:} There are a few known situations where GCC will
12470 crash when trying to use a precompiled header.  If you have trouble
12471 with a precompiled header, you should remove the precompiled header
12472 and compile without it.  In addition, please use GCC's on-line
12473 defect-tracking system to report any problems you encounter with
12474 precompiled headers.  @xref{Bugs}.
12475
12476 To create a precompiled header file, simply compile it as you would any
12477 other file, if necessary using the @option{-x} option to make the driver
12478 treat it as a C or C++ header file.  You will probably want to use a
12479 tool like @command{make} to keep the precompiled header up-to-date when
12480 the headers it contains change.
12481
12482 A precompiled header file will be searched for when @code{#include} is
12483 seen in the compilation.  As it searches for the included file
12484 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12485 compiler looks for a precompiled header in each directory just before it
12486 looks for the include file in that directory.  The name searched for is
12487 the name specified in the @code{#include} with @samp{.gch} appended.  If
12488 the precompiled header file can't be used, it is ignored.
12489
12490 For instance, if you have @code{#include "all.h"}, and you have
12491 @file{all.h.gch} in the same directory as @file{all.h}, then the
12492 precompiled header file will be used if possible, and the original
12493 header will be used otherwise.
12494
12495 Alternatively, you might decide to put the precompiled header file in a
12496 directory and use @option{-I} to ensure that directory is searched
12497 before (or instead of) the directory containing the original header.
12498 Then, if you want to check that the precompiled header file is always
12499 used, you can put a file of the same name as the original header in this
12500 directory containing an @code{#error} command.
12501
12502 This also works with @option{-include}.  So yet another way to use
12503 precompiled headers, good for projects not designed with precompiled
12504 header files in mind, is to simply take most of the header files used by
12505 a project, include them from another header file, precompile that header
12506 file, and @option{-include} the precompiled header.  If the header files
12507 have guards against multiple inclusion, they will be skipped because
12508 they've already been included (in the precompiled header).
12509
12510 If you need to precompile the same header file for different
12511 languages, targets, or compiler options, you can instead make a
12512 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12513 header in the directory, perhaps using @option{-o}.  It doesn't matter
12514 what you call the files in the directory, every precompiled header in
12515 the directory will be considered.  The first precompiled header
12516 encountered in the directory that is valid for this compilation will
12517 be used; they're searched in no particular order.
12518
12519 There are many other possibilities, limited only by your imagination,
12520 good sense, and the constraints of your build system.
12521
12522 A precompiled header file can be used only when these conditions apply:
12523
12524 @itemize
12525 @item
12526 Only one precompiled header can be used in a particular compilation.
12527
12528 @item
12529 A precompiled header can't be used once the first C token is seen.  You
12530 can have preprocessor directives before a precompiled header; you can
12531 even include a precompiled header from inside another header, so long as
12532 there are no C tokens before the @code{#include}.
12533
12534 @item
12535 The precompiled header file must be produced for the same language as
12536 the current compilation.  You can't use a C precompiled header for a C++
12537 compilation.
12538
12539 @item
12540 The precompiled header file must be produced by the same compiler
12541 version and configuration as the current compilation is using.
12542 The easiest way to guarantee this is to use the same compiler binary
12543 for creating and using precompiled headers.
12544
12545 @item
12546 Any macros defined before the precompiled header is included must
12547 either be defined in the same way as when the precompiled header was
12548 generated, or must not affect the precompiled header, which usually
12549 means that the they don't appear in the precompiled header at all.
12550
12551 The @option{-D} option is one way to define a macro before a
12552 precompiled header is included; using a @code{#define} can also do it.
12553 There are also some options that define macros implicitly, like
12554 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12555 defined this way.
12556
12557 @item If debugging information is output when using the precompiled
12558 header, using @option{-g} or similar, the same kind of debugging information
12559 must have been output when building the precompiled header.  However,
12560 a precompiled header built using @option{-g} can be used in a compilation
12561 when no debugging information is being output.
12562
12563 @item The same @option{-m} options must generally be used when building
12564 and using the precompiled header.  @xref{Submodel Options},
12565 for any cases where this rule is relaxed.
12566
12567 @item Each of the following options must be the same when building and using
12568 the precompiled header:
12569
12570 @gccoptlist{-fexceptions -funit-at-a-time}
12571
12572 @item
12573 Some other command-line options starting with @option{-f},
12574 @option{-p}, or @option{-O} must be defined in the same way as when
12575 the precompiled header was generated.  At present, it's not clear
12576 which options are safe to change and which are not; the safest choice
12577 is to use exactly the same options when generating and using the
12578 precompiled header.  The following are known to be safe:
12579
12580 @gccoptlist{-fpreprocessed -pedantic-errors}
12581
12582 @end itemize
12583
12584 For all of these except the last, the compiler will automatically
12585 ignore the precompiled header if the conditions aren't met.  If you
12586 find an option combination that doesn't work and doesn't cause the
12587 precompiled header to be ignored, please consider filing a bug report,
12588 see @ref{Bugs}.
12589
12590 If you do use differing options when generating and using the
12591 precompiled header, the actual behavior will be a mixture of the
12592 behavior for the options.  For instance, if you use @option{-g} to
12593 generate the precompiled header but not when using it, you may or may
12594 not get debugging information for routines in the precompiled header.
12595
12596 @node Running Protoize
12597 @section Running Protoize
12598
12599 The program @code{protoize} is an optional part of GCC@.  You can use
12600 it to add prototypes to a program, thus converting the program to ISO
12601 C in one respect.  The companion program @code{unprotoize} does the
12602 reverse: it removes argument types from any prototypes that are found.
12603
12604 When you run these programs, you must specify a set of source files as
12605 command line arguments.  The conversion programs start out by compiling
12606 these files to see what functions they define.  The information gathered
12607 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12608
12609 After scanning comes actual conversion.  The specified files are all
12610 eligible to be converted; any files they include (whether sources or
12611 just headers) are eligible as well.
12612
12613 But not all the eligible files are converted.  By default,
12614 @code{protoize} and @code{unprotoize} convert only source and header
12615 files in the current directory.  You can specify additional directories
12616 whose files should be converted with the @option{-d @var{directory}}
12617 option.  You can also specify particular files to exclude with the
12618 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12619 directory name matches one of the specified directory names, and its
12620 name within the directory has not been excluded.
12621
12622 Basic conversion with @code{protoize} consists of rewriting most
12623 function definitions and function declarations to specify the types of
12624 the arguments.  The only ones not rewritten are those for varargs
12625 functions.
12626
12627 @code{protoize} optionally inserts prototype declarations at the
12628 beginning of the source file, to make them available for any calls that
12629 precede the function's definition.  Or it can insert prototype
12630 declarations with block scope in the blocks where undeclared functions
12631 are called.
12632
12633 Basic conversion with @code{unprotoize} consists of rewriting most
12634 function declarations to remove any argument types, and rewriting
12635 function definitions to the old-style pre-ISO form.
12636
12637 Both conversion programs print a warning for any function declaration or
12638 definition that they can't convert.  You can suppress these warnings
12639 with @option{-q}.
12640
12641 The output from @code{protoize} or @code{unprotoize} replaces the
12642 original source file.  The original file is renamed to a name ending
12643 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12644 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12645 for DOS) file already exists, then the source file is simply discarded.
12646
12647 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12648 scan the program and collect information about the functions it uses.
12649 So neither of these programs will work until GCC is installed.
12650
12651 Here is a table of the options you can use with @code{protoize} and
12652 @code{unprotoize}.  Each option works with both programs unless
12653 otherwise stated.
12654
12655 @table @code
12656 @item -B @var{directory}
12657 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12658 usual directory (normally @file{/usr/local/lib}).  This file contains
12659 prototype information about standard system functions.  This option
12660 applies only to @code{protoize}.
12661
12662 @item -c @var{compilation-options}
12663 Use @var{compilation-options} as the options when running @command{gcc} to
12664 produce the @samp{.X} files.  The special option @option{-aux-info} is
12665 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12666
12667 Note that the compilation options must be given as a single argument to
12668 @code{protoize} or @code{unprotoize}.  If you want to specify several
12669 @command{gcc} options, you must quote the entire set of compilation options
12670 to make them a single word in the shell.
12671
12672 There are certain @command{gcc} arguments that you cannot use, because they
12673 would produce the wrong kind of output.  These include @option{-g},
12674 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12675 the @var{compilation-options}, they are ignored.
12676
12677 @item -C
12678 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12679 systems) instead of @samp{.c}.  This is convenient if you are converting
12680 a C program to C++.  This option applies only to @code{protoize}.
12681
12682 @item -g
12683 Add explicit global declarations.  This means inserting explicit
12684 declarations at the beginning of each source file for each function
12685 that is called in the file and was not declared.  These declarations
12686 precede the first function definition that contains a call to an
12687 undeclared function.  This option applies only to @code{protoize}.
12688
12689 @item -i @var{string}
12690 Indent old-style parameter declarations with the string @var{string}.
12691 This option applies only to @code{protoize}.
12692
12693 @code{unprotoize} converts prototyped function definitions to old-style
12694 function definitions, where the arguments are declared between the
12695 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12696 uses five spaces as the indentation.  If you want to indent with just
12697 one space instead, use @option{-i " "}.
12698
12699 @item -k
12700 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12701 is finished.
12702
12703 @item -l
12704 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12705 a prototype declaration for each function in each block which calls the
12706 function without any declaration.  This option applies only to
12707 @code{protoize}.
12708
12709 @item -n
12710 Make no real changes.  This mode just prints information about the conversions
12711 that would have been done without @option{-n}.
12712
12713 @item -N
12714 Make no @samp{.save} files.  The original files are simply deleted.
12715 Use this option with caution.
12716
12717 @item -p @var{program}
12718 Use the program @var{program} as the compiler.  Normally, the name
12719 @file{gcc} is used.
12720
12721 @item -q
12722 Work quietly.  Most warnings are suppressed.
12723
12724 @item -v
12725 Print the version number, just like @option{-v} for @command{gcc}.
12726 @end table
12727
12728 If you need special compiler options to compile one of your program's
12729 source files, then you should generate that file's @samp{.X} file
12730 specially, by running @command{gcc} on that source file with the
12731 appropriate options and the option @option{-aux-info}.  Then run
12732 @code{protoize} on the entire set of files.  @code{protoize} will use
12733 the existing @samp{.X} file because it is newer than the source file.
12734 For example:
12735
12736 @smallexample
12737 gcc -Dfoo=bar file1.c -aux-info file1.X
12738 protoize *.c
12739 @end smallexample
12740
12741 @noindent
12742 You need to include the special files along with the rest in the
12743 @code{protoize} command, even though their @samp{.X} files already
12744 exist, because otherwise they won't get converted.
12745
12746 @xref{Protoize Caveats}, for more information on how to use
12747 @code{protoize} successfully.