OSDN Git Service

PR other/7549
[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 This warning is enabled by @option{-Wall}.
2170
2171 @item -Wcomment
2172 @opindex Wcomment
2173 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2174 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2175 This warning is enabled by @option{-Wall}.
2176
2177 @item -Wfatal-errors
2178 @opindex Wfatal-errors
2179 This option causes the compiler to abort compilation on the first error
2180 occurred rather than trying to keep going and printing further error
2181 messages.
2182
2183 @item -Wformat
2184 @opindex Wformat
2185 @opindex ffreestanding
2186 @opindex fno-builtin
2187 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2188 the arguments supplied have types appropriate to the format string
2189 specified, and that the conversions specified in the format string make
2190 sense.  This includes standard functions, and others specified by format
2191 attributes (@pxref{Function Attributes}), in the @code{printf},
2192 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2193 not in the C standard) families (or other target-specific families).
2194 Which functions are checked without format attributes having been
2195 specified depends on the standard version selected, and such checks of
2196 functions without the attribute specified are disabled by
2197 @option{-ffreestanding} or @option{-fno-builtin}.
2198
2199 The formats are checked against the format features supported by GNU
2200 libc version 2.2.  These include all ISO C90 and C99 features, as well
2201 as features from the Single Unix Specification and some BSD and GNU
2202 extensions.  Other library implementations may not support all these
2203 features; GCC does not support warning about features that go beyond a
2204 particular library's limitations.  However, if @option{-pedantic} is used
2205 with @option{-Wformat}, warnings will be given about format features not
2206 in the selected standard version (but not for @code{strfmon} formats,
2207 since those are not in any version of the C standard).  @xref{C Dialect
2208 Options,,Options Controlling C Dialect}.
2209
2210 Since @option{-Wformat} also checks for null format arguments for
2211 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2212
2213 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2214 aspects of format checking, the options @option{-Wformat-y2k},
2215 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2216 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2217 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2218
2219 @item -Wformat-y2k
2220 @opindex Wformat-y2k
2221 If @option{-Wformat} is specified, also warn about @code{strftime}
2222 formats which may yield only a two-digit year.
2223
2224 @item -Wno-format-extra-args
2225 @opindex Wno-format-extra-args
2226 If @option{-Wformat} is specified, do not warn about excess arguments to a
2227 @code{printf} or @code{scanf} format function.  The C standard specifies
2228 that such arguments are ignored.
2229
2230 Where the unused arguments lie between used arguments that are
2231 specified with @samp{$} operand number specifications, normally
2232 warnings are still given, since the implementation could not know what
2233 type to pass to @code{va_arg} to skip the unused arguments.  However,
2234 in the case of @code{scanf} formats, this option will suppress the
2235 warning if the unused arguments are all pointers, since the Single
2236 Unix Specification says that such unused arguments are allowed.
2237
2238 @item -Wno-format-zero-length
2239 @opindex Wno-format-zero-length
2240 If @option{-Wformat} is specified, do not warn about zero-length formats.
2241 The C standard specifies that zero-length formats are allowed.
2242
2243 @item -Wformat-nonliteral
2244 @opindex Wformat-nonliteral
2245 If @option{-Wformat} is specified, also warn if the format string is not a
2246 string literal and so cannot be checked, unless the format function
2247 takes its format arguments as a @code{va_list}.
2248
2249 @item -Wformat-security
2250 @opindex Wformat-security
2251 If @option{-Wformat} is specified, also warn about uses of format
2252 functions that represent possible security problems.  At present, this
2253 warns about calls to @code{printf} and @code{scanf} functions where the
2254 format string is not a string literal and there are no format arguments,
2255 as in @code{printf (foo);}.  This may be a security hole if the format
2256 string came from untrusted input and contains @samp{%n}.  (This is
2257 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2258 in future warnings may be added to @option{-Wformat-security} that are not
2259 included in @option{-Wformat-nonliteral}.)
2260
2261 @item -Wformat=2
2262 @opindex Wformat=2
2263 Enable @option{-Wformat} plus format checks not included in
2264 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2265 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2266
2267 @item -Wnonnull
2268 @opindex Wnonnull
2269 Warn about passing a null pointer for arguments marked as
2270 requiring a non-null value by the @code{nonnull} function attribute.
2271
2272 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2273 can be disabled with the @option{-Wno-nonnull} option.
2274
2275 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2276 @opindex Winit-self
2277 Warn about uninitialized variables which are initialized with themselves.
2278 Note this option can only be used with the @option{-Wuninitialized} option,
2279 which in turn only works with @option{-O1} and above.
2280
2281 For example, GCC will warn about @code{i} being uninitialized in the
2282 following snippet only when @option{-Winit-self} has been specified:
2283 @smallexample
2284 @group
2285 int f()
2286 @{
2287   int i = i;
2288   return i;
2289 @}
2290 @end group
2291 @end smallexample
2292
2293 @item -Wimplicit-int
2294 @opindex Wimplicit-int
2295 Warn when a declaration does not specify a type.
2296 This warning is enabled by @option{-Wall}.
2297
2298 @item -Wimplicit-function-declaration
2299 @itemx -Werror-implicit-function-declaration
2300 @opindex Wimplicit-function-declaration
2301 @opindex Werror-implicit-function-declaration
2302 Give a warning (or error) whenever a function is used before being
2303 declared.  The form @option{-Wno-error-implicit-function-declaration}
2304 is not supported.
2305 This warning is enabled by @option{-Wall} (as a warning, not an error).
2306
2307 @item -Wimplicit
2308 @opindex Wimplicit
2309 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2310 This warning is enabled by @option{-Wall}.
2311
2312 @item -Wmain
2313 @opindex Wmain
2314 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2315 function with external linkage, returning int, taking either zero
2316 arguments, two, or three arguments of appropriate types.
2317 This warning is enabled by @option{-Wall}.
2318
2319 @item -Wmissing-braces
2320 @opindex Wmissing-braces
2321 Warn if an aggregate or union initializer is not fully bracketed.  In
2322 the following example, the initializer for @samp{a} is not fully
2323 bracketed, but that for @samp{b} is fully bracketed.
2324
2325 @smallexample
2326 int a[2][2] = @{ 0, 1, 2, 3 @};
2327 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2328 @end smallexample
2329
2330 This warning is enabled by @option{-Wall}.
2331
2332 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2333 @opindex Wmissing-include-dirs
2334 Warn if a user-supplied include directory does not exist.
2335
2336 @item -Wparentheses
2337 @opindex Wparentheses
2338 Warn if parentheses are omitted in certain contexts, such
2339 as when there is an assignment in a context where a truth value
2340 is expected, or when operators are nested whose precedence people
2341 often get confused about.  Only the warning for an assignment used as
2342 a truth value is supported when compiling C++; the other warnings are
2343 only supported when compiling C@.
2344
2345 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2346 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2347 interpretation from that of ordinary mathematical notation.
2348
2349 Also warn about constructions where there may be confusion to which
2350 @code{if} statement an @code{else} branch belongs.  Here is an example of
2351 such a case:
2352
2353 @smallexample
2354 @group
2355 @{
2356   if (a)
2357     if (b)
2358       foo ();
2359   else
2360     bar ();
2361 @}
2362 @end group
2363 @end smallexample
2364
2365 In C, every @code{else} branch belongs to the innermost possible @code{if}
2366 statement, which in this example is @code{if (b)}.  This is often not
2367 what the programmer expected, as illustrated in the above example by
2368 indentation the programmer chose.  When there is the potential for this
2369 confusion, GCC will issue a warning when this flag is specified.
2370 To eliminate the warning, add explicit braces around the innermost
2371 @code{if} statement so there is no way the @code{else} could belong to
2372 the enclosing @code{if}.  The resulting code would look like this:
2373
2374 @smallexample
2375 @group
2376 @{
2377   if (a)
2378     @{
2379       if (b)
2380         foo ();
2381       else
2382         bar ();
2383     @}
2384 @}
2385 @end group
2386 @end smallexample
2387
2388 This warning is enabled by @option{-Wall}.
2389
2390 @item -Wsequence-point
2391 @opindex Wsequence-point
2392 Warn about code that may have undefined semantics because of violations
2393 of sequence point rules in the C standard.
2394
2395 The C standard defines the order in which expressions in a C program are
2396 evaluated in terms of @dfn{sequence points}, which represent a partial
2397 ordering between the execution of parts of the program: those executed
2398 before the sequence point, and those executed after it.  These occur
2399 after the evaluation of a full expression (one which is not part of a
2400 larger expression), after the evaluation of the first operand of a
2401 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2402 function is called (but after the evaluation of its arguments and the
2403 expression denoting the called function), and in certain other places.
2404 Other than as expressed by the sequence point rules, the order of
2405 evaluation of subexpressions of an expression is not specified.  All
2406 these rules describe only a partial order rather than a total order,
2407 since, for example, if two functions are called within one expression
2408 with no sequence point between them, the order in which the functions
2409 are called is not specified.  However, the standards committee have
2410 ruled that function calls do not overlap.
2411
2412 It is not specified when between sequence points modifications to the
2413 values of objects take effect.  Programs whose behavior depends on this
2414 have undefined behavior; the C standard specifies that ``Between the
2415 previous and next sequence point an object shall have its stored value
2416 modified at most once by the evaluation of an expression.  Furthermore,
2417 the prior value shall be read only to determine the value to be
2418 stored.''.  If a program breaks these rules, the results on any
2419 particular implementation are entirely unpredictable.
2420
2421 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2422 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2423 diagnosed by this option, and it may give an occasional false positive
2424 result, but in general it has been found fairly effective at detecting
2425 this sort of problem in programs.
2426
2427 The present implementation of this option only works for C programs.  A
2428 future implementation may also work for C++ programs.
2429
2430 The C standard is worded confusingly, therefore there is some debate
2431 over the precise meaning of the sequence point rules in subtle cases.
2432 Links to discussions of the problem, including proposed formal
2433 definitions, may be found on the GCC readings page, at
2434 @w{@uref{http://gcc.gnu.org/readings.html}}.
2435
2436 This warning is enabled by @option{-Wall}.
2437
2438 @item -Wreturn-type
2439 @opindex Wreturn-type
2440 Warn whenever a function is defined with a return-type that defaults to
2441 @code{int}.  Also warn about any @code{return} statement with no
2442 return-value in a function whose return-type is not @code{void}.
2443
2444 For C, also warn if the return type of a function has a type qualifier
2445 such as @code{const}.  Such a type qualifier has no effect, since the
2446 value returned by a function is not an lvalue.  ISO C prohibits
2447 qualified @code{void} return types on function definitions, so such
2448 return types always receive a warning even without this option.
2449
2450 For C++, a function without return type always produces a diagnostic
2451 message, even when @option{-Wno-return-type} is specified.  The only
2452 exceptions are @samp{main} and functions defined in system headers.
2453
2454 This warning is enabled by @option{-Wall}.
2455
2456 @item -Wswitch
2457 @opindex Wswitch
2458 Warn whenever a @code{switch} statement has an index of enumerated type
2459 and lacks a @code{case} for one or more of the named codes of that
2460 enumeration.  (The presence of a @code{default} label prevents this
2461 warning.)  @code{case} labels outside the enumeration range also
2462 provoke warnings when this option is used.
2463 This warning is enabled by @option{-Wall}.
2464
2465 @item -Wswitch-default
2466 @opindex Wswitch-switch
2467 Warn whenever a @code{switch} statement does not have a @code{default}
2468 case.
2469
2470 @item -Wswitch-enum
2471 @opindex Wswitch-enum
2472 Warn whenever a @code{switch} statement has an index of enumerated type
2473 and lacks a @code{case} for one or more of the named codes of that
2474 enumeration.  @code{case} labels outside the enumeration range also
2475 provoke warnings when this option is used.
2476
2477 @item -Wtrigraphs
2478 @opindex Wtrigraphs
2479 Warn if any trigraphs are encountered that might change the meaning of
2480 the program (trigraphs within comments are not warned about).
2481 This warning is enabled by @option{-Wall}.
2482
2483 @item -Wunused-function
2484 @opindex Wunused-function
2485 Warn whenever a static function is declared but not defined or a
2486 non\-inline static function is unused.
2487 This warning is enabled by @option{-Wall}.
2488
2489 @item -Wunused-label
2490 @opindex Wunused-label
2491 Warn whenever a label is declared but not used.
2492 This warning is enabled by @option{-Wall}.
2493
2494 To suppress this warning use the @samp{unused} attribute
2495 (@pxref{Variable Attributes}).
2496
2497 @item -Wunused-parameter
2498 @opindex Wunused-parameter
2499 Warn whenever a function parameter is unused aside from its declaration.
2500
2501 To suppress this warning use the @samp{unused} attribute
2502 (@pxref{Variable Attributes}).
2503
2504 @item -Wunused-variable
2505 @opindex Wunused-variable
2506 Warn whenever a local variable or non-constant static variable is unused
2507 aside from its declaration
2508 This warning is enabled by @option{-Wall}.
2509
2510 To suppress this warning use the @samp{unused} attribute
2511 (@pxref{Variable Attributes}).
2512
2513 @item -Wunused-value
2514 @opindex Wunused-value
2515 Warn whenever a statement computes a result that is explicitly not used.
2516 This warning is enabled by @option{-Wall}.
2517
2518 To suppress this warning cast the expression to @samp{void}.
2519
2520 @item -Wunused
2521 @opindex Wunused
2522 All the above @option{-Wunused} options combined.
2523
2524 In order to get a warning about an unused function parameter, you must
2525 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2526 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2527
2528 @item -Wuninitialized
2529 @opindex Wuninitialized
2530 Warn if an automatic variable is used without first being initialized or
2531 if a variable may be clobbered by a @code{setjmp} call.
2532
2533 These warnings are possible only in optimizing compilation,
2534 because they require data flow information that is computed only
2535 when optimizing.  If you don't specify @option{-O}, you simply won't
2536 get these warnings.
2537
2538 If you want to warn about code which uses the uninitialized value of the
2539 variable in its own initializer, use the @option{-Winit-self} option.
2540
2541 These warnings occur only for variables that are candidates for
2542 register allocation.  Therefore, they do not occur for a variable that
2543 is declared @code{volatile}, or whose address is taken, or whose size
2544 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2545 structures, unions or arrays, even when they are in registers.
2546
2547 Note that there may be no warning about a variable that is used only
2548 to compute a value that itself is never used, because such
2549 computations may be deleted by data flow analysis before the warnings
2550 are printed.
2551
2552 These warnings are made optional because GCC is not smart
2553 enough to see all the reasons why the code might be correct
2554 despite appearing to have an error.  Here is one example of how
2555 this can happen:
2556
2557 @smallexample
2558 @group
2559 @{
2560   int x;
2561   switch (y)
2562     @{
2563     case 1: x = 1;
2564       break;
2565     case 2: x = 4;
2566       break;
2567     case 3: x = 5;
2568     @}
2569   foo (x);
2570 @}
2571 @end group
2572 @end smallexample
2573
2574 @noindent
2575 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2576 always initialized, but GCC doesn't know this.  Here is
2577 another common case:
2578
2579 @smallexample
2580 @{
2581   int save_y;
2582   if (change_y) save_y = y, y = new_y;
2583   @dots{}
2584   if (change_y) y = save_y;
2585 @}
2586 @end smallexample
2587
2588 @noindent
2589 This has no bug because @code{save_y} is used only if it is set.
2590
2591 @cindex @code{longjmp} warnings
2592 This option also warns when a non-volatile automatic variable might be
2593 changed by a call to @code{longjmp}.  These warnings as well are possible
2594 only in optimizing compilation.
2595
2596 The compiler sees only the calls to @code{setjmp}.  It cannot know
2597 where @code{longjmp} will be called; in fact, a signal handler could
2598 call it at any point in the code.  As a result, you may get a warning
2599 even when there is in fact no problem because @code{longjmp} cannot
2600 in fact be called at the place which would cause a problem.
2601
2602 Some spurious warnings can be avoided if you declare all the functions
2603 you use that never return as @code{noreturn}.  @xref{Function
2604 Attributes}.
2605
2606 This warning is enabled by @option{-Wall}.
2607
2608 @item -Wunknown-pragmas
2609 @opindex Wunknown-pragmas
2610 @cindex warning for unknown pragmas
2611 @cindex unknown pragmas, warning
2612 @cindex pragmas, warning of unknown
2613 Warn when a #pragma directive is encountered which is not understood by
2614 GCC@.  If this command line option is used, warnings will even be issued
2615 for unknown pragmas in system header files.  This is not the case if
2616 the warnings were only enabled by the @option{-Wall} command line option.
2617
2618 @item -Wstrict-aliasing
2619 @opindex Wstrict-aliasing
2620 This option is only active when @option{-fstrict-aliasing} is active.
2621 It warns about code which might break the strict aliasing rules that the
2622 compiler is using for optimization.  The warning does not catch all
2623 cases, but does attempt to catch the more common pitfalls.  It is
2624 included in @option{-Wall}.
2625
2626 @item -Wstrict-aliasing=2
2627 @opindex Wstrict-aliasing=2
2628 This option is only active when @option{-fstrict-aliasing} is active.
2629 It warns about all code which might break the strict aliasing rules that the
2630 compiler is using for optimization.  This warning catches all cases, but
2631 it will also give a warning for some ambiguous cases that are safe.
2632
2633 @item -Wall
2634 @opindex Wall
2635 All of the above @samp{-W} options combined.  This enables all the
2636 warnings about constructions that some users consider questionable, and
2637 that are easy to avoid (or modify to prevent the warning), even in
2638 conjunction with macros.  This also enables some language-specific
2639 warnings described in @ref{C++ Dialect Options} and
2640 @ref{Objective-C and Objective-C++ Dialect Options}.
2641 @end table
2642
2643 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2644 Some of them warn about constructions that users generally do not
2645 consider questionable, but which occasionally you might wish to check
2646 for; others warn about constructions that are necessary or hard to avoid
2647 in some cases, and there is no simple way to modify the code to suppress
2648 the warning.
2649
2650 @table @gcctabopt
2651 @item -Wextra
2652 @opindex W
2653 @opindex Wextra
2654 (This option used to be called @option{-W}.  The older name is still
2655 supported, but the newer name is more descriptive.)  Print extra warning
2656 messages for these events:
2657
2658 @itemize @bullet
2659 @item
2660 A function can return either with or without a value.  (Falling
2661 off the end of the function body is considered returning without
2662 a value.)  For example, this function would evoke such a
2663 warning:
2664
2665 @smallexample
2666 @group
2667 foo (a)
2668 @{
2669   if (a > 0)
2670     return a;
2671 @}
2672 @end group
2673 @end smallexample
2674
2675 @item
2676 An expression-statement or the left-hand side of a comma expression
2677 contains no side effects.
2678 To suppress the warning, cast the unused expression to void.
2679 For example, an expression such as @samp{x[i,j]} will cause a warning,
2680 but @samp{x[(void)i,j]} will not.
2681
2682 @item
2683 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2684
2685 @item
2686 Storage-class specifiers like @code{static} are not the first things in
2687 a declaration.  According to the C Standard, this usage is obsolescent.
2688
2689 @item
2690 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2691 arguments.
2692
2693 @item
2694 A comparison between signed and unsigned values could produce an
2695 incorrect result when the signed value is converted to unsigned.
2696 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2697
2698 @item
2699 An aggregate has an initializer which does not initialize all members.
2700 This warning can be independently controlled by
2701 @option{-Wmissing-field-initializers}.
2702
2703 @item
2704 A function parameter is declared without a type specifier in K&R-style
2705 functions:
2706
2707 @smallexample
2708 void foo(bar) @{ @}
2709 @end smallexample
2710
2711 @item
2712 An empty body occurs in an @samp{if} or @samp{else} statement.
2713
2714 @item
2715 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2716 @samp{>}, or @samp{>=}.
2717
2718 @item
2719 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2720
2721 @item
2722 Any of several floating-point events that often indicate errors, such as
2723 overflow, underflow, loss of precision, etc.
2724
2725 @item @r{(C++ only)}
2726 An enumerator and a non-enumerator both appear in a conditional expression.
2727
2728 @item @r{(C++ only)}
2729 A non-static reference or non-static @samp{const} member appears in a
2730 class without constructors.
2731
2732 @item @r{(C++ only)}
2733 Ambiguous virtual bases.
2734
2735 @item @r{(C++ only)}
2736 Subscripting an array which has been declared @samp{register}.
2737
2738 @item @r{(C++ only)}
2739 Taking the address of a variable which has been declared @samp{register}.
2740
2741 @item @r{(C++ only)}
2742 A base class is not initialized in a derived class' copy constructor.
2743 @end itemize
2744
2745 @item -Wno-div-by-zero
2746 @opindex Wno-div-by-zero
2747 @opindex Wdiv-by-zero
2748 Do not warn about compile-time integer division by zero.  Floating point
2749 division by zero is not warned about, as it can be a legitimate way of
2750 obtaining infinities and NaNs.
2751
2752 @item -Wsystem-headers
2753 @opindex Wsystem-headers
2754 @cindex warnings from system headers
2755 @cindex system headers, warnings from
2756 Print warning messages for constructs found in system header files.
2757 Warnings from system headers are normally suppressed, on the assumption
2758 that they usually do not indicate real problems and would only make the
2759 compiler output harder to read.  Using this command line option tells
2760 GCC to emit warnings from system headers as if they occurred in user
2761 code.  However, note that using @option{-Wall} in conjunction with this
2762 option will @emph{not} warn about unknown pragmas in system
2763 headers---for that, @option{-Wunknown-pragmas} must also be used.
2764
2765 @item -Wfloat-equal
2766 @opindex Wfloat-equal
2767 Warn if floating point values are used in equality comparisons.
2768
2769 The idea behind this is that sometimes it is convenient (for the
2770 programmer) to consider floating-point values as approximations to
2771 infinitely precise real numbers.  If you are doing this, then you need
2772 to compute (by analyzing the code, or in some other way) the maximum or
2773 likely maximum error that the computation introduces, and allow for it
2774 when performing comparisons (and when producing output, but that's a
2775 different problem).  In particular, instead of testing for equality, you
2776 would check to see whether the two values have ranges that overlap; and
2777 this is done with the relational operators, so equality comparisons are
2778 probably mistaken.
2779
2780 @item -Wtraditional @r{(C only)}
2781 @opindex Wtraditional
2782 Warn about certain constructs that behave differently in traditional and
2783 ISO C@.  Also warn about ISO C constructs that have no traditional C
2784 equivalent, and/or problematic constructs which should be avoided.
2785
2786 @itemize @bullet
2787 @item
2788 Macro parameters that appear within string literals in the macro body.
2789 In traditional C macro replacement takes place within string literals,
2790 but does not in ISO C@.
2791
2792 @item
2793 In traditional C, some preprocessor directives did not exist.
2794 Traditional preprocessors would only consider a line to be a directive
2795 if the @samp{#} appeared in column 1 on the line.  Therefore
2796 @option{-Wtraditional} warns about directives that traditional C
2797 understands but would ignore because the @samp{#} does not appear as the
2798 first character on the line.  It also suggests you hide directives like
2799 @samp{#pragma} not understood by traditional C by indenting them.  Some
2800 traditional implementations would not recognize @samp{#elif}, so it
2801 suggests avoiding it altogether.
2802
2803 @item
2804 A function-like macro that appears without arguments.
2805
2806 @item
2807 The unary plus operator.
2808
2809 @item
2810 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2811 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2812 constants.)  Note, these suffixes appear in macros defined in the system
2813 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2814 Use of these macros in user code might normally lead to spurious
2815 warnings, however GCC's integrated preprocessor has enough context to
2816 avoid warning in these cases.
2817
2818 @item
2819 A function declared external in one block and then used after the end of
2820 the block.
2821
2822 @item
2823 A @code{switch} statement has an operand of type @code{long}.
2824
2825 @item
2826 A non-@code{static} function declaration follows a @code{static} one.
2827 This construct is not accepted by some traditional C compilers.
2828
2829 @item
2830 The ISO type of an integer constant has a different width or
2831 signedness from its traditional type.  This warning is only issued if
2832 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2833 typically represent bit patterns, are not warned about.
2834
2835 @item
2836 Usage of ISO string concatenation is detected.
2837
2838 @item
2839 Initialization of automatic aggregates.
2840
2841 @item
2842 Identifier conflicts with labels.  Traditional C lacks a separate
2843 namespace for labels.
2844
2845 @item
2846 Initialization of unions.  If the initializer is zero, the warning is
2847 omitted.  This is done under the assumption that the zero initializer in
2848 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2849 initializer warnings and relies on default initialization to zero in the
2850 traditional C case.
2851
2852 @item
2853 Conversions by prototypes between fixed/floating point values and vice
2854 versa.  The absence of these prototypes when compiling with traditional
2855 C would cause serious problems.  This is a subset of the possible
2856 conversion warnings, for the full set use @option{-Wconversion}.
2857
2858 @item
2859 Use of ISO C style function definitions.  This warning intentionally is
2860 @emph{not} issued for prototype declarations or variadic functions
2861 because these ISO C features will appear in your code when using
2862 libiberty's traditional C compatibility macros, @code{PARAMS} and
2863 @code{VPARAMS}.  This warning is also bypassed for nested functions
2864 because that feature is already a GCC extension and thus not relevant to
2865 traditional C compatibility.
2866 @end itemize
2867
2868 @item -Wdeclaration-after-statement @r{(C only)}
2869 @opindex Wdeclaration-after-statement
2870 Warn when a declaration is found after a statement in a block.  This
2871 construct, known from C++, was introduced with ISO C99 and is by default
2872 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2873 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2874
2875 @item -Wundef
2876 @opindex Wundef
2877 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2878
2879 @item -Wendif-labels
2880 @opindex Wendif-labels
2881 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2882
2883 @item -Wshadow
2884 @opindex Wshadow
2885 Warn whenever a local variable shadows another local variable, parameter or
2886 global variable or whenever a built-in function is shadowed.
2887
2888 @item -Wlarger-than-@var{len}
2889 @opindex Wlarger-than
2890 Warn whenever an object of larger than @var{len} bytes is defined.
2891
2892 @item -Wpointer-arith
2893 @opindex Wpointer-arith
2894 Warn about anything that depends on the ``size of'' a function type or
2895 of @code{void}.  GNU C assigns these types a size of 1, for
2896 convenience in calculations with @code{void *} pointers and pointers
2897 to functions.
2898
2899 @item -Wbad-function-cast @r{(C only)}
2900 @opindex Wbad-function-cast
2901 Warn whenever a function call is cast to a non-matching type.
2902 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2903
2904 @item -Wcast-qual
2905 @opindex Wcast-qual
2906 Warn whenever a pointer is cast so as to remove a type qualifier from
2907 the target type.  For example, warn if a @code{const char *} is cast
2908 to an ordinary @code{char *}.
2909
2910 @item -Wcast-align
2911 @opindex Wcast-align
2912 Warn whenever a pointer is cast such that the required alignment of the
2913 target is increased.  For example, warn if a @code{char *} is cast to
2914 an @code{int *} on machines where integers can only be accessed at
2915 two- or four-byte boundaries.
2916
2917 @item -Wwrite-strings
2918 @opindex Wwrite-strings
2919 When compiling C, give string constants the type @code{const
2920 char[@var{length}]} so that
2921 copying the address of one into a non-@code{const} @code{char *}
2922 pointer will get a warning; when compiling C++, warn about the
2923 deprecated conversion from string constants to @code{char *}.
2924 These warnings will help you find at
2925 compile time code that can try to write into a string constant, but
2926 only if you have been very careful about using @code{const} in
2927 declarations and prototypes.  Otherwise, it will just be a nuisance;
2928 this is why we did not make @option{-Wall} request these warnings.
2929
2930 @item -Wconversion
2931 @opindex Wconversion
2932 Warn if a prototype causes a type conversion that is different from what
2933 would happen to the same argument in the absence of a prototype.  This
2934 includes conversions of fixed point to floating and vice versa, and
2935 conversions changing the width or signedness of a fixed point argument
2936 except when the same as the default promotion.
2937
2938 Also, warn if a negative integer constant expression is implicitly
2939 converted to an unsigned type.  For example, warn about the assignment
2940 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2941 casts like @code{(unsigned) -1}.
2942
2943 @item -Wsign-compare
2944 @opindex Wsign-compare
2945 @cindex warning for comparison of signed and unsigned values
2946 @cindex comparison of signed and unsigned values, warning
2947 @cindex signed and unsigned values, comparison warning
2948 Warn when a comparison between signed and unsigned values could produce
2949 an incorrect result when the signed value is converted to unsigned.
2950 This warning is also enabled by @option{-Wextra}; to get the other warnings
2951 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2952
2953 @item -Waggregate-return
2954 @opindex Waggregate-return
2955 Warn if any functions that return structures or unions are defined or
2956 called.  (In languages where you can return an array, this also elicits
2957 a warning.)
2958
2959 @item -Wstrict-prototypes @r{(C only)}
2960 @opindex Wstrict-prototypes
2961 Warn if a function is declared or defined without specifying the
2962 argument types.  (An old-style function definition is permitted without
2963 a warning if preceded by a declaration which specifies the argument
2964 types.)
2965
2966 @item -Wold-style-definition @r{(C only)}
2967 @opindex Wold-style-definition
2968 Warn if an old-style function definition is used.  A warning is given
2969 even if there is a previous prototype.
2970
2971 @item -Wmissing-prototypes @r{(C only)}
2972 @opindex Wmissing-prototypes
2973 Warn if a global function is defined without a previous prototype
2974 declaration.  This warning is issued even if the definition itself
2975 provides a prototype.  The aim is to detect global functions that fail
2976 to be declared in header files.
2977
2978 @item -Wmissing-declarations @r{(C only)}
2979 @opindex Wmissing-declarations
2980 Warn if a global function is defined without a previous declaration.
2981 Do so even if the definition itself provides a prototype.
2982 Use this option to detect global functions that are not declared in
2983 header files.
2984
2985 @item -Wmissing-field-initializers
2986 @opindex Wmissing-field-initializers
2987 @opindex W
2988 @opindex Wextra
2989 Warn if a structure's initializer has some fields missing.  For
2990 example, the following code would cause such a warning, because
2991 @code{x.h} is implicitly zero:
2992
2993 @smallexample
2994 struct s @{ int f, g, h; @};
2995 struct s x = @{ 3, 4 @};
2996 @end smallexample
2997
2998 This option does not warn about designated initializers, so the following
2999 modification would not trigger a warning:
3000
3001 @smallexample
3002 struct s @{ int f, g, h; @};
3003 struct s x = @{ .f = 3, .g = 4 @};
3004 @end smallexample
3005
3006 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3007 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3008
3009 @item -Wmissing-noreturn
3010 @opindex Wmissing-noreturn
3011 Warn about functions which might be candidates for attribute @code{noreturn}.
3012 Note these are only possible candidates, not absolute ones.  Care should
3013 be taken to manually verify functions actually do not ever return before
3014 adding the @code{noreturn} attribute, otherwise subtle code generation
3015 bugs could be introduced.  You will not get a warning for @code{main} in
3016 hosted C environments.
3017
3018 @item -Wmissing-format-attribute
3019 @opindex Wmissing-format-attribute
3020 @opindex Wformat
3021 If @option{-Wformat} is enabled, also warn about functions which might be
3022 candidates for @code{format} attributes.  Note these are only possible
3023 candidates, not absolute ones.  GCC will guess that @code{format}
3024 attributes might be appropriate for any function that calls a function
3025 like @code{vprintf} or @code{vscanf}, but this might not always be the
3026 case, and some functions for which @code{format} attributes are
3027 appropriate may not be detected.  This option has no effect unless
3028 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3029
3030 @item -Wno-multichar
3031 @opindex Wno-multichar
3032 @opindex Wmultichar
3033 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3034 Usually they indicate a typo in the user's code, as they have
3035 implementation-defined values, and should not be used in portable code.
3036
3037 @item -Wno-deprecated-declarations
3038 @opindex Wno-deprecated-declarations
3039 Do not warn about uses of functions, variables, and types marked as
3040 deprecated by using the @code{deprecated} attribute.
3041 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3042 @pxref{Type Attributes}.)
3043
3044 @item -Wpacked
3045 @opindex Wpacked
3046 Warn if a structure is given the packed attribute, but the packed
3047 attribute has no effect on the layout or size of the structure.
3048 Such structures may be mis-aligned for little benefit.  For
3049 instance, in this code, the variable @code{f.x} in @code{struct bar}
3050 will be misaligned even though @code{struct bar} does not itself
3051 have the packed attribute:
3052
3053 @smallexample
3054 @group
3055 struct foo @{
3056   int x;
3057   char a, b, c, d;
3058 @} __attribute__((packed));
3059 struct bar @{
3060   char z;
3061   struct foo f;
3062 @};
3063 @end group
3064 @end smallexample
3065
3066 @item -Wpadded
3067 @opindex Wpadded
3068 Warn if padding is included in a structure, either to align an element
3069 of the structure or to align the whole structure.  Sometimes when this
3070 happens it is possible to rearrange the fields of the structure to
3071 reduce the padding and so make the structure smaller.
3072
3073 @item -Wredundant-decls
3074 @opindex Wredundant-decls
3075 Warn if anything is declared more than once in the same scope, even in
3076 cases where multiple declaration is valid and changes nothing.
3077
3078 @item -Wnested-externs @r{(C only)}
3079 @opindex Wnested-externs
3080 Warn if an @code{extern} declaration is encountered within a function.
3081
3082 @item -Wunreachable-code
3083 @opindex Wunreachable-code
3084 Warn if the compiler detects that code will never be executed.
3085
3086 This option is intended to warn when the compiler detects that at
3087 least a whole line of source code will never be executed, because
3088 some condition is never satisfied or because it is after a
3089 procedure that never returns.
3090
3091 It is possible for this option to produce a warning even though there
3092 are circumstances under which part of the affected line can be executed,
3093 so care should be taken when removing apparently-unreachable code.
3094
3095 For instance, when a function is inlined, a warning may mean that the
3096 line is unreachable in only one inlined copy of the function.
3097
3098 This option is not made part of @option{-Wall} because in a debugging
3099 version of a program there is often substantial code which checks
3100 correct functioning of the program and is, hopefully, unreachable
3101 because the program does work.  Another common use of unreachable
3102 code is to provide behavior which is selectable at compile-time.
3103
3104 @item -Winline
3105 @opindex Winline
3106 Warn if a function can not be inlined and it was declared as inline.
3107 Even with this option, the compiler will not warn about failures to
3108 inline functions declared in system headers.
3109
3110 The compiler uses a variety of heuristics to determine whether or not
3111 to inline a function.  For example, the compiler takes into account
3112 the size of the function being inlined and the the amount of inlining
3113 that has already been done in the current function.  Therefore,
3114 seemingly insignificant changes in the source program can cause the
3115 warnings produced by @option{-Winline} to appear or disappear.
3116
3117 @item -Wno-invalid-offsetof @r{(C++ only)}
3118 @opindex Wno-invalid-offsetof
3119 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3120 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3121 to a non-POD type is undefined.  In existing C++ implementations,
3122 however, @samp{offsetof} typically gives meaningful results even when
3123 applied to certain kinds of non-POD types. (Such as a simple
3124 @samp{struct} that fails to be a POD type only by virtue of having a
3125 constructor.)  This flag is for users who are aware that they are
3126 writing nonportable code and who have deliberately chosen to ignore the
3127 warning about it.
3128
3129 The restrictions on @samp{offsetof} may be relaxed in a future version
3130 of the C++ standard.
3131
3132 @item -Winvalid-pch
3133 @opindex Winvalid-pch
3134 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3135 the search path but can't be used.
3136
3137 @item -Wlong-long
3138 @opindex Wlong-long
3139 @opindex Wno-long-long
3140 Warn if @samp{long long} type is used.  This is default.  To inhibit
3141 the warning messages, use @option{-Wno-long-long}.  Flags
3142 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3143 only when @option{-pedantic} flag is used.
3144
3145 @item -Wvariadic-macros
3146 @opindex Wvariadic-macros
3147 @opindex Wno-variadic-macros
3148 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3149 alternate syntax when in pedantic ISO C99 mode.  This is default.
3150 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3151
3152 @item -Wdisabled-optimization
3153 @opindex Wdisabled-optimization
3154 Warn if a requested optimization pass is disabled.  This warning does
3155 not generally indicate that there is anything wrong with your code; it
3156 merely indicates that GCC's optimizers were unable to handle the code
3157 effectively.  Often, the problem is that your code is too big or too
3158 complex; GCC will refuse to optimize programs when the optimization
3159 itself is likely to take inordinate amounts of time.
3160
3161 @item -Wno-pointer-sign
3162 @opindex Wno-pointer-sign
3163 Don't warn for pointer argument passing or assignment with different signedness.
3164 Only useful in the negative form since this warning is enabled by default.
3165 This option is only supported for C and Objective-C@.
3166
3167 @item -Werror
3168 @opindex Werror
3169 Make all warnings into errors.
3170 @end table
3171
3172 @node Debugging Options
3173 @section Options for Debugging Your Program or GCC
3174 @cindex options, debugging
3175 @cindex debugging information options
3176
3177 GCC has various special options that are used for debugging
3178 either your program or GCC:
3179
3180 @table @gcctabopt
3181 @item -g
3182 @opindex g
3183 Produce debugging information in the operating system's native format
3184 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3185 information.
3186
3187 On most systems that use stabs format, @option{-g} enables use of extra
3188 debugging information that only GDB can use; this extra information
3189 makes debugging work better in GDB but will probably make other debuggers
3190 crash or
3191 refuse to read the program.  If you want to control for certain whether
3192 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3193 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3194
3195 GCC allows you to use @option{-g} with
3196 @option{-O}.  The shortcuts taken by optimized code may occasionally
3197 produce surprising results: some variables you declared may not exist
3198 at all; flow of control may briefly move where you did not expect it;
3199 some statements may not be executed because they compute constant
3200 results or their values were already at hand; some statements may
3201 execute in different places because they were moved out of loops.
3202
3203 Nevertheless it proves possible to debug optimized output.  This makes
3204 it reasonable to use the optimizer for programs that might have bugs.
3205
3206 The following options are useful when GCC is generated with the
3207 capability for more than one debugging format.
3208
3209 @item -ggdb
3210 @opindex ggdb
3211 Produce debugging information for use by GDB@.  This means to use the
3212 most expressive format available (DWARF 2, stabs, or the native format
3213 if neither of those are supported), including GDB extensions if at all
3214 possible.
3215
3216 @item -gstabs
3217 @opindex gstabs
3218 Produce debugging information in stabs format (if that is supported),
3219 without GDB extensions.  This is the format used by DBX on most BSD
3220 systems.  On MIPS, Alpha and System V Release 4 systems this option
3221 produces stabs debugging output which is not understood by DBX or SDB@.
3222 On System V Release 4 systems this option requires the GNU assembler.
3223
3224 @item -feliminate-unused-debug-symbols
3225 @opindex feliminate-unused-debug-symbols
3226 Produce debugging information in stabs format (if that is supported),
3227 for only symbols that are actually used.
3228
3229 @item -gstabs+
3230 @opindex gstabs+
3231 Produce debugging information in stabs format (if that is supported),
3232 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3233 use of these extensions is likely to make other debuggers crash or
3234 refuse to read the program.
3235
3236 @item -gcoff
3237 @opindex gcoff
3238 Produce debugging information in COFF format (if that is supported).
3239 This is the format used by SDB on most System V systems prior to
3240 System V Release 4.
3241
3242 @item -gxcoff
3243 @opindex gxcoff
3244 Produce debugging information in XCOFF format (if that is supported).
3245 This is the format used by the DBX debugger on IBM RS/6000 systems.
3246
3247 @item -gxcoff+
3248 @opindex gxcoff+
3249 Produce debugging information in XCOFF format (if that is supported),
3250 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3251 use of these extensions is likely to make other debuggers crash or
3252 refuse to read the program, and may cause assemblers other than the GNU
3253 assembler (GAS) to fail with an error.
3254
3255 @item -gdwarf-2
3256 @opindex gdwarf-2
3257 Produce debugging information in DWARF version 2 format (if that is
3258 supported).  This is the format used by DBX on IRIX 6.  With this
3259 option, GCC uses features of DWARF version 3 when they are useful;
3260 version 3 is upward compatible with version 2, but may still cause
3261 problems for older debuggers.
3262
3263 @item -gvms
3264 @opindex gvms
3265 Produce debugging information in VMS debug format (if that is
3266 supported).  This is the format used by DEBUG on VMS systems.
3267
3268 @item -g@var{level}
3269 @itemx -ggdb@var{level}
3270 @itemx -gstabs@var{level}
3271 @itemx -gcoff@var{level}
3272 @itemx -gxcoff@var{level}
3273 @itemx -gvms@var{level}
3274 Request debugging information and also use @var{level} to specify how
3275 much information.  The default level is 2.
3276
3277 Level 1 produces minimal information, enough for making backtraces in
3278 parts of the program that you don't plan to debug.  This includes
3279 descriptions of functions and external variables, but no information
3280 about local variables and no line numbers.
3281
3282 Level 3 includes extra information, such as all the macro definitions
3283 present in the program.  Some debuggers support macro expansion when
3284 you use @option{-g3}.
3285
3286 @option{-gdwarf-2} does not accept a concatenated debug level, because
3287 GCC used to support an option @option{-gdwarf} that meant to generate
3288 debug information in version 1 of the DWARF format (which is very
3289 different from version 2), and it would have been too confusing.  That
3290 debug format is long obsolete, but the option cannot be changed now.
3291 Instead use an additional @option{-g@var{level}} option to change the
3292 debug level for DWARF2.
3293
3294 @item -feliminate-dwarf2-dups
3295 @opindex feliminate-dwarf2-dups
3296 Compress DWARF2 debugging information by eliminating duplicated
3297 information about each symbol.  This option only makes sense when
3298 generating DWARF2 debugging information with @option{-gdwarf-2}.
3299
3300 @cindex @command{prof}
3301 @item -p
3302 @opindex p
3303 Generate extra code to write profile information suitable for the
3304 analysis program @command{prof}.  You must use this option when compiling
3305 the source files you want data about, and you must also use it when
3306 linking.
3307
3308 @cindex @command{gprof}
3309 @item -pg
3310 @opindex pg
3311 Generate extra code to write profile information suitable for the
3312 analysis program @command{gprof}.  You must use this option when compiling
3313 the source files you want data about, and you must also use it when
3314 linking.
3315
3316 @item -Q
3317 @opindex Q
3318 Makes the compiler print out each function name as it is compiled, and
3319 print some statistics about each pass when it finishes.
3320
3321 @item -ftime-report
3322 @opindex ftime-report
3323 Makes the compiler print some statistics about the time consumed by each
3324 pass when it finishes.
3325
3326 @item -fmem-report
3327 @opindex fmem-report
3328 Makes the compiler print some statistics about permanent memory
3329 allocation when it finishes.
3330
3331 @item -fprofile-arcs
3332 @opindex fprofile-arcs
3333 Add code so that program flow @dfn{arcs} are instrumented.  During
3334 execution the program records how many times each branch and call is
3335 executed and how many times it is taken or returns.  When the compiled
3336 program exits it saves this data to a file called
3337 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3338 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3339 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3340 @var{auxname} is generated from the name of the output file, if
3341 explicitly specified and it is not the final executable, otherwise it is
3342 the basename of the source file.  In both cases any suffix is removed
3343 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3344 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3345
3346 @itemize
3347
3348 @item
3349 Compile the source files with @option{-fprofile-arcs} plus optimization
3350 and code generation options.  For test coverage analysis, use the
3351 additional @option{-ftest-coverage} option.  You do not need to profile
3352 every source file in a program.
3353
3354 @item
3355 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3356 (the latter implies the former).
3357
3358 @item
3359 Run the program on a representative workload to generate the arc profile
3360 information.  This may be repeated any number of times.  You can run
3361 concurrent instances of your program, and provided that the file system
3362 supports locking, the data files will be correctly updated.  Also
3363 @code{fork} calls are detected and correctly handled (double counting
3364 will not happen).
3365
3366 @item
3367 For profile-directed optimizations, compile the source files again with
3368 the same optimization and code generation options plus
3369 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3370 Control Optimization}).
3371
3372 @item
3373 For test coverage analysis, use @command{gcov} to produce human readable
3374 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3375 @command{gcov} documentation for further information.
3376
3377 @end itemize
3378
3379 With @option{-fprofile-arcs}, for each function of your program GCC
3380 creates a program flow graph, then finds a spanning tree for the graph.
3381 Only arcs that are not on the spanning tree have to be instrumented: the
3382 compiler adds code to count the number of times that these arcs are
3383 executed.  When an arc is the only exit or only entrance to a block, the
3384 instrumentation code can be added to the block; otherwise, a new basic
3385 block must be created to hold the instrumentation code.
3386
3387 @item -ftree-based-profiling
3388 @opindex ftree-based-profiling
3389 This option is used in addition to @option{-fprofile-arcs} or
3390 @option{-fbranch-probabilities} to control whether those optimizations
3391 are performed on a tree-based or rtl-based internal representation.
3392 If you use this option when compiling with @option{-fprofile-arcs},
3393 you must also use it when compiling later with @option{-fbranch-probabilities}.
3394 Currently the tree-based optimization is in an early stage of
3395 development, and this option is recommended only for those people
3396 working on improving it.
3397
3398 @need 2000
3399 @item -ftest-coverage
3400 @opindex ftest-coverage
3401 Produce a notes file that the @command{gcov} code-coverage utility
3402 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3403 show program coverage.  Each source file's note file is called
3404 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3405 above for a description of @var{auxname} and instructions on how to
3406 generate test coverage data.  Coverage data will match the source files
3407 more closely, if you do not optimize.
3408
3409 @item -d@var{letters}
3410 @item -fdump-rtl-@var{pass}
3411 @opindex d
3412 Says to make debugging dumps during compilation at times specified by
3413 @var{letters}.    This is used for debugging the RTL-based passes of the
3414 compiler.  The file names for most of the dumps are made by appending a
3415 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3416 from the name of the output file, if explicitly specified and it is not
3417 an executable, otherwise it is the basename of the source file.
3418
3419 Most debug dumps can be enabled either passing a letter to the @option{-d}
3420 option, or with a long @option{-fdump-rtl} switch; here are the possible
3421 letters for use in @var{letters} and @var{pass}, and their meanings:
3422
3423 @table @gcctabopt
3424 @item -dA
3425 @opindex dA
3426 Annotate the assembler output with miscellaneous debugging information.
3427
3428 @item -db
3429 @itemx -fdump-rtl-bp
3430 @opindex db
3431 @opindex fdump-rtl-bp
3432 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3433
3434 @item -dB
3435 @itemx -fdump-rtl-bbro
3436 @opindex dB
3437 @opindex fdump-rtl-bbro
3438 Dump after block reordering, to @file{@var{file}.30.bbro}.
3439
3440 @item -dc
3441 @itemx -fdump-rtl-combine
3442 @opindex dc
3443 @opindex fdump-rtl-combine
3444 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3445
3446 @item -dC
3447 @itemx -fdump-rtl-ce1
3448 @itemx -fdump-rtl-ce2
3449 @opindex dC
3450 @opindex fdump-rtl-ce1
3451 @opindex fdump-rtl-ce2
3452 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3453 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3454 and @option{-fdump-rtl-ce2} enable dumping after the second if
3455 conversion, to the file @file{@var{file}.18.ce2}.
3456
3457 @item -dd
3458 @itemx -fdump-rtl-btl
3459 @itemx -fdump-rtl-dbr
3460 @opindex dd
3461 @opindex fdump-rtl-btl
3462 @opindex fdump-rtl-dbr
3463 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3464 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3465 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3466 scheduling, to @file{@var{file}.36.dbr}.
3467
3468 @item -dD
3469 @opindex dD
3470 Dump all macro definitions, at the end of preprocessing, in addition to
3471 normal output.
3472
3473 @item -dE
3474 @itemx -fdump-rtl-ce3
3475 @opindex dE
3476 @opindex fdump-rtl-ce3
3477 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3478
3479 @item -df
3480 @itemx -fdump-rtl-cfg
3481 @itemx -fdump-rtl-life
3482 @opindex df
3483 @opindex fdump-rtl-cfg
3484 @opindex fdump-rtl-life
3485 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3486 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3487 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3488 to @file{@var{file}.16.life}.
3489
3490 @item -dg
3491 @itemx -fdump-rtl-greg
3492 @opindex dg
3493 @opindex fdump-rtl-greg
3494 Dump after global register allocation, to @file{@var{file}.23.greg}.
3495
3496 @item -dG
3497 @itemx -fdump-rtl-gcse
3498 @itemx -fdump-rtl-bypass
3499 @opindex dG
3500 @opindex fdump-rtl-gcse
3501 @opindex fdump-rtl-bypass
3502 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3503 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3504 enable dumping after jump bypassing and control flow optimizations, to
3505 @file{@var{file}.07.bypass}.
3506
3507 @item -dh
3508 @itemx -fdump-rtl-eh
3509 @opindex dh
3510 @opindex fdump-rtl-eh
3511 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3512
3513 @item -di
3514 @itemx -fdump-rtl-sibling
3515 @opindex di
3516 @opindex fdump-rtl-sibling
3517 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3518
3519 @item -dj
3520 @itemx -fdump-rtl-jump
3521 @opindex dj
3522 @opindex fdump-rtl-jump
3523 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3524
3525 @item -dk
3526 @itemx -fdump-rtl-stack
3527 @opindex dk
3528 @opindex fdump-rtl-stack
3529 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3530
3531 @item -dl
3532 @itemx -fdump-rtl-lreg
3533 @opindex dl
3534 @opindex fdump-rtl-lreg
3535 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3536
3537 @item -dL
3538 @itemx -fdump-rtl-loop
3539 @itemx -fdump-rtl-loop2
3540 @opindex dL
3541 @opindex fdump-rtl-loop
3542 @opindex fdump-rtl-loop2
3543 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3544 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3545 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3546 @file{@var{file}.13.loop2}.
3547
3548 @item -dm
3549 @itemx -fdump-rtl-sms
3550 @opindex dm
3551 @opindex fdump-rtl-sms
3552 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3553
3554 @item -dM
3555 @itemx -fdump-rtl-mach
3556 @opindex dM
3557 @opindex fdump-rtl-mach
3558 Dump after performing the machine dependent reorganization pass, to
3559 @file{@var{file}.35.mach}.
3560
3561 @item -dn
3562 @itemx -fdump-rtl-rnreg
3563 @opindex dn
3564 @opindex fdump-rtl-rnreg
3565 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3566
3567 @item -dN
3568 @itemx -fdump-rtl-regmove
3569 @opindex dN
3570 @opindex fdump-rtl-regmove
3571 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3572
3573 @item -do
3574 @itemx -fdump-rtl-postreload
3575 @opindex do
3576 @opindex fdump-rtl-postreload
3577 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3578
3579 @item -dr
3580 @itemx -fdump-rtl-expand
3581 @opindex dr
3582 @opindex fdump-rtl-expand
3583 Dump after RTL generation, to @file{@var{file}.00.expand}.
3584
3585 @item -dR
3586 @itemx -fdump-rtl-sched2
3587 @opindex dR
3588 @opindex fdump-rtl-sched2
3589 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3590
3591 @item -ds
3592 @itemx -fdump-rtl-cse
3593 @opindex ds
3594 @opindex fdump-rtl-cse
3595 Dump after CSE (including the jump optimization that sometimes follows
3596 CSE), to @file{@var{file}.04.cse}.
3597
3598 @item -dS
3599 @itemx -fdump-rtl-sched
3600 @opindex dS
3601 @opindex fdump-rtl-sched
3602 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3603
3604 @item -dt
3605 @itemx -fdump-rtl-cse2
3606 @opindex dt
3607 @opindex fdump-rtl-cse2
3608 Dump after the second CSE pass (including the jump optimization that
3609 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3610
3611 @item -dT
3612 @itemx -fdump-rtl-tracer
3613 @opindex dT
3614 @opindex fdump-rtl-tracer
3615 Dump after running tracer, to @file{@var{file}.12.tracer}.
3616
3617 @item -dV
3618 @itemx -fdump-rtl-vpt
3619 @itemx -fdump-rtl-vartrack
3620 @opindex dV
3621 @opindex fdump-rtl-vpt
3622 @opindex fdump-rtl-vartrack
3623 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3624 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3625 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3626 to @file{@var{file}.34.vartrack}.
3627
3628 @item -dw
3629 @itemx -fdump-rtl-flow2
3630 @opindex dw
3631 @opindex fdump-rtl-flow2
3632 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3633
3634 @item -dz
3635 @itemx -fdump-rtl-peephole2
3636 @opindex dz
3637 @opindex fdump-rtl-peephole2
3638 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3639
3640 @item -dZ
3641 @itemx -fdump-rtl-web
3642 @opindex dZ
3643 @opindex fdump-rtl-web
3644 Dump after live range splitting, to @file{@var{file}.14.web}.
3645
3646 @item -da
3647 @itemx -fdump-rtl-all
3648 @opindex da
3649 @opindex fdump-rtl-all
3650 Produce all the dumps listed above.
3651
3652 @item -dH
3653 @opindex dH
3654 Produce a core dump whenever an error occurs.
3655
3656 @item -dm
3657 @opindex dm
3658 Print statistics on memory usage, at the end of the run, to
3659 standard error.
3660
3661 @item -dp
3662 @opindex dp
3663 Annotate the assembler output with a comment indicating which
3664 pattern and alternative was used.  The length of each instruction is
3665 also printed.
3666
3667 @item -dP
3668 @opindex dP
3669 Dump the RTL in the assembler output as a comment before each instruction.
3670 Also turns on @option{-dp} annotation.
3671
3672 @item -dv
3673 @opindex dv
3674 For each of the other indicated dump files (either with @option{-d} or
3675 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3676 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3677
3678 @item -dx
3679 @opindex dx
3680 Just generate RTL for a function instead of compiling it.  Usually used
3681 with @samp{r} (@option{-fdump-rtl-expand}).
3682
3683 @item -dy
3684 @opindex dy
3685 Dump debugging information during parsing, to standard error.
3686 @end table
3687
3688 @item -fdump-unnumbered
3689 @opindex fdump-unnumbered
3690 When doing debugging dumps (see @option{-d} option above), suppress instruction
3691 numbers and line number note output.  This makes it more feasible to
3692 use diff on debugging dumps for compiler invocations with different
3693 options, in particular with and without @option{-g}.
3694
3695 @item -fdump-translation-unit @r{(C and C++ only)}
3696 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3697 @opindex fdump-translation-unit
3698 Dump a representation of the tree structure for the entire translation
3699 unit to a file.  The file name is made by appending @file{.tu} to the
3700 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3701 controls the details of the dump as described for the
3702 @option{-fdump-tree} options.
3703
3704 @item -fdump-class-hierarchy @r{(C++ only)}
3705 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3706 @opindex fdump-class-hierarchy
3707 Dump a representation of each class's hierarchy and virtual function
3708 table layout to a file.  The file name is made by appending @file{.class}
3709 to the source file name.  If the @samp{-@var{options}} form is used,
3710 @var{options} controls the details of the dump as described for the
3711 @option{-fdump-tree} options.
3712
3713 @item -fdump-ipa-@var{switch}
3714 @opindex fdump-ipa
3715 Control the dumping at various stages of inter-procedural analysis
3716 language tree to a file.  The file name is generated by appending a switch
3717 specific suffix to the source file name.  The following dumps are possible:
3718
3719 @table @samp
3720 @item all
3721 Enables all inter-procedural analysis dumps; currently the only produced
3722 dump is the @samp{cgraph} dump.
3723
3724 @item cgraph
3725 Dumps information about call-graph optimization, unused function removal,
3726 and inlining decisions.
3727 @end table
3728
3729 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3730 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3731 @opindex fdump-tree
3732 Control the dumping at various stages of processing the intermediate
3733 language tree to a file.  The file name is generated by appending a switch
3734 specific suffix to the source file name.  If the @samp{-@var{options}}
3735 form is used, @var{options} is a list of @samp{-} separated options that
3736 control the details of the dump.  Not all options are applicable to all
3737 dumps, those which are not meaningful will be ignored.  The following
3738 options are available
3739
3740 @table @samp
3741 @item address
3742 Print the address of each node.  Usually this is not meaningful as it
3743 changes according to the environment and source file.  Its primary use
3744 is for tying up a dump file with a debug environment.
3745 @item slim
3746 Inhibit dumping of members of a scope or body of a function merely
3747 because that scope has been reached.  Only dump such items when they
3748 are directly reachable by some other path.  When dumping pretty-printed
3749 trees, this option inhibits dumping the bodies of control structures.
3750 @item raw
3751 Print a raw representation of the tree.  By default, trees are
3752 pretty-printed into a C-like representation.
3753 @item details
3754 Enable more detailed dumps (not honored by every dump option).
3755 @item stats
3756 Enable dumping various statistics about the pass (not honored by every dump
3757 option).
3758 @item blocks
3759 Enable showing basic block boundaries (disabled in raw dumps).
3760 @item vops
3761 Enable showing virtual operands for every statement.
3762 @item lineno
3763 Enable showing line numbers for statements.
3764 @item uid
3765 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3766 @item all
3767 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3768 @end table
3769
3770 The following tree dumps are possible:
3771 @table @samp
3772
3773 @item original
3774 Dump before any tree based optimization, to @file{@var{file}.original}.
3775
3776 @item optimized
3777 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3778
3779 @item inlined
3780 Dump after function inlining, to @file{@var{file}.inlined}.
3781
3782 @item gimple
3783 @opindex fdump-tree-gimple
3784 Dump each function before and after the gimplification pass to a file.  The
3785 file name is made by appending @file{.gimple} to the source file name.
3786
3787 @item cfg
3788 @opindex fdump-tree-cfg
3789 Dump the control flow graph of each function to a file.  The file name is
3790 made by appending @file{.cfg} to the source file name.
3791
3792 @item vcg
3793 @opindex fdump-tree-vcg
3794 Dump the control flow graph of each function to a file in VCG format.  The
3795 file name is made by appending @file{.vcg} to the source file name.  Note
3796 that if the file contains more than one function, the generated file cannot
3797 be used directly by VCG@.  You will need to cut and paste each function's
3798 graph into its own separate file first.
3799
3800 @item ch
3801 @opindex fdump-tree-ch
3802 Dump each function after copying loop headers.  The file name is made by
3803 appending @file{.ch} to the source file name.
3804
3805 @item ssa
3806 @opindex fdump-tree-ssa
3807 Dump SSA related information to a file.  The file name is made by appending
3808 @file{.ssa} to the source file name.
3809
3810 @item alias
3811 @opindex fdump-tree-alias
3812 Dump aliasing information for each function.  The file name is made by
3813 appending @file{.alias} to the source file name.
3814
3815 @item ccp
3816 @opindex fdump-tree-ccp
3817 Dump each function after CCP@.  The file name is made by appending
3818 @file{.ccp} to the source file name.
3819
3820 @item pre
3821 @opindex fdump-tree-pre
3822 Dump trees after partial redundancy elimination.  The file name is made
3823 by appending @file{.pre} to the source file name.
3824
3825 @item fre
3826 @opindex fdump-tree-fre
3827 Dump trees after full redundancy elimination.  The file name is made
3828 by appending @file{.fre} to the source file name.
3829
3830 @item dce
3831 @opindex fdump-tree-dce
3832 Dump each function after dead code elimination.  The file name is made by
3833 appending @file{.dce} to the source file name.
3834
3835 @item mudflap
3836 @opindex fdump-tree-mudflap
3837 Dump each function after adding mudflap instrumentation.  The file name is
3838 made by appending @file{.mudflap} to the source file name.
3839
3840 @item sra
3841 @opindex fdump-tree-sra
3842 Dump each function after performing scalar replacement of aggregates.  The
3843 file name is made by appending @file{.sra} to the source file name.
3844
3845 @item dom
3846 @opindex fdump-tree-dom
3847 Dump each function after applying dominator tree optimizations.  The file
3848 name is made by appending @file{.dom} to the source file name.
3849
3850 @item dse
3851 @opindex fdump-tree-dse
3852 Dump each function after applying dead store elimination.  The file
3853 name is made by appending @file{.dse} to the source file name.
3854
3855 @item phiopt
3856 @opindex fdump-tree-phiopt
3857 Dump each function after optimizing PHI nodes into straightline code.  The file
3858 name is made by appending @file{.phiopt} to the source file name.
3859
3860 @item forwprop
3861 @opindex fdump-tree-forwprop
3862 Dump each function after forward propagating single use variables.  The file
3863 name is made by appending @file{.forwprop} to the source file name.
3864
3865 @item copyrename
3866 @opindex fdump-tree-copyrename
3867 Dump each function after applying the copy rename optimization.  The file
3868 name is made by appending @file{.copyrename} to the source file name.
3869
3870 @item nrv
3871 @opindex fdump-tree-nrv
3872 Dump each function after applying the named return value optimization on
3873 generic trees.  The file name is made by appending @file{.nrv} to the source
3874 file name.
3875
3876 @item vect
3877 @opindex fdump-tree-vect
3878 Dump each function after applying vectorization of loops.  The file name is
3879 made by appending @file{.vect} to the source file name.
3880
3881 @item all
3882 @opindex fdump-tree-all
3883 Enable all the available tree dumps with the flags provided in this option.
3884 @end table
3885
3886 @item -frandom-seed=@var{string}
3887 @opindex frandom-string
3888 This option provides a seed that GCC uses when it would otherwise use
3889 random numbers.  It is used to generate certain symbol names
3890 that have to be different in every compiled file.  It is also used to
3891 place unique stamps in coverage data files and the object files that
3892 produce them.  You can use the @option{-frandom-seed} option to produce
3893 reproducibly identical object files.
3894
3895 The @var{string} should be different for every file you compile.
3896
3897 @item -fsched-verbose=@var{n}
3898 @opindex fsched-verbose
3899 On targets that use instruction scheduling, this option controls the
3900 amount of debugging output the scheduler prints.  This information is
3901 written to standard error, unless @option{-dS} or @option{-dR} is
3902 specified, in which case it is output to the usual dump
3903 listing file, @file{.sched} or @file{.sched2} respectively.  However
3904 for @var{n} greater than nine, the output is always printed to standard
3905 error.
3906
3907 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3908 same information as @option{-dRS}.  For @var{n} greater than one, it
3909 also output basic block probabilities, detailed ready list information
3910 and unit/insn info.  For @var{n} greater than two, it includes RTL
3911 at abort point, control-flow and regions info.  And for @var{n} over
3912 four, @option{-fsched-verbose} also includes dependence info.
3913
3914 @item -save-temps
3915 @opindex save-temps
3916 Store the usual ``temporary'' intermediate files permanently; place them
3917 in the current directory and name them based on the source file.  Thus,
3918 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3919 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3920 preprocessed @file{foo.i} output file even though the compiler now
3921 normally uses an integrated preprocessor.
3922
3923 When used in combination with the @option{-x} command line option,
3924 @option{-save-temps} is sensible enough to avoid over writing an
3925 input source file with the same extension as an intermediate file.
3926 The corresponding intermediate file may be obtained by renaming the
3927 source file before using @option{-save-temps}.
3928
3929 @item -time
3930 @opindex time
3931 Report the CPU time taken by each subprocess in the compilation
3932 sequence.  For C source files, this is the compiler proper and assembler
3933 (plus the linker if linking is done).  The output looks like this:
3934
3935 @smallexample
3936 # cc1 0.12 0.01
3937 # as 0.00 0.01
3938 @end smallexample
3939
3940 The first number on each line is the ``user time'', that is time spent
3941 executing the program itself.  The second number is ``system time'',
3942 time spent executing operating system routines on behalf of the program.
3943 Both numbers are in seconds.
3944
3945 @item -fvar-tracking
3946 @opindex fvar-tracking
3947 Run variable tracking pass.  It computes where variables are stored at each
3948 position in code.  Better debugging information is then generated
3949 (if the debugging information format supports this information).
3950
3951 It is enabled by default when compiling with optimization (@option{-Os},
3952 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3953 the debug info format supports it.
3954
3955 @item -print-file-name=@var{library}
3956 @opindex print-file-name
3957 Print the full absolute name of the library file @var{library} that
3958 would be used when linking---and don't do anything else.  With this
3959 option, GCC does not compile or link anything; it just prints the
3960 file name.
3961
3962 @item -print-multi-directory
3963 @opindex print-multi-directory
3964 Print the directory name corresponding to the multilib selected by any
3965 other switches present in the command line.  This directory is supposed
3966 to exist in @env{GCC_EXEC_PREFIX}.
3967
3968 @item -print-multi-lib
3969 @opindex print-multi-lib
3970 Print the mapping from multilib directory names to compiler switches
3971 that enable them.  The directory name is separated from the switches by
3972 @samp{;}, and each switch starts with an @samp{@@} instead of the
3973 @samp{-}, without spaces between multiple switches.  This is supposed to
3974 ease shell-processing.
3975
3976 @item -print-prog-name=@var{program}
3977 @opindex print-prog-name
3978 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3979
3980 @item -print-libgcc-file-name
3981 @opindex print-libgcc-file-name
3982 Same as @option{-print-file-name=libgcc.a}.
3983
3984 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3985 but you do want to link with @file{libgcc.a}.  You can do
3986
3987 @smallexample
3988 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3989 @end smallexample
3990
3991 @item -print-search-dirs
3992 @opindex print-search-dirs
3993 Print the name of the configured installation directory and a list of
3994 program and library directories @command{gcc} will search---and don't do anything else.
3995
3996 This is useful when @command{gcc} prints the error message
3997 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3998 To resolve this you either need to put @file{cpp0} and the other compiler
3999 components where @command{gcc} expects to find them, or you can set the environment
4000 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4001 Don't forget the trailing @samp{/}.
4002 @xref{Environment Variables}.
4003
4004 @item -dumpmachine
4005 @opindex dumpmachine
4006 Print the compiler's target machine (for example,
4007 @samp{i686-pc-linux-gnu})---and don't do anything else.
4008
4009 @item -dumpversion
4010 @opindex dumpversion
4011 Print the compiler version (for example, @samp{3.0})---and don't do
4012 anything else.
4013
4014 @item -dumpspecs
4015 @opindex dumpspecs
4016 Print the compiler's built-in specs---and don't do anything else.  (This
4017 is used when GCC itself is being built.)  @xref{Spec Files}.
4018
4019 @item -feliminate-unused-debug-types
4020 @opindex feliminate-unused-debug-types
4021 Normally, when producing DWARF2 output, GCC will emit debugging
4022 information for all types declared in a compilation
4023 unit, regardless of whether or not they are actually used
4024 in that compilation unit.  Sometimes this is useful, such as
4025 if, in the debugger, you want to cast a value to a type that is
4026 not actually used in your program (but is declared).  More often,
4027 however, this results in a significant amount of wasted space.
4028 With this option, GCC will avoid producing debug symbol output
4029 for types that are nowhere used in the source file being compiled.
4030 @end table
4031
4032 @node Optimize Options
4033 @section Options That Control Optimization
4034 @cindex optimize options
4035 @cindex options, optimization
4036
4037 These options control various sorts of optimizations.
4038
4039 Without any optimization option, the compiler's goal is to reduce the
4040 cost of compilation and to make debugging produce the expected
4041 results.  Statements are independent: if you stop the program with a
4042 breakpoint between statements, you can then assign a new value to any
4043 variable or change the program counter to any other statement in the
4044 function and get exactly the results you would expect from the source
4045 code.
4046
4047 Turning on optimization flags makes the compiler attempt to improve
4048 the performance and/or code size at the expense of compilation time
4049 and possibly the ability to debug the program.
4050
4051 The compiler performs optimization based on the knowledge it has of
4052 the program.  Optimization levels @option{-O2} and above, in
4053 particular, enable @emph{unit-at-a-time} mode, which allows the
4054 compiler to consider information gained from later functions in
4055 the file when compiling a function.  Compiling multiple files at
4056 once to a single output file in @emph{unit-at-a-time} mode allows
4057 the compiler to use information gained from all of the files when
4058 compiling each of them.
4059
4060 Not all optimizations are controlled directly by a flag.  Only
4061 optimizations that have a flag are listed.
4062
4063 @table @gcctabopt
4064 @item -O
4065 @itemx -O1
4066 @opindex O
4067 @opindex O1
4068 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4069 more memory for a large function.
4070
4071 With @option{-O}, the compiler tries to reduce code size and execution
4072 time, without performing any optimizations that take a great deal of
4073 compilation time.
4074
4075 @option{-O} turns on the following optimization flags:
4076 @gccoptlist{-fdefer-pop @gol
4077 -fdelayed-branch @gol
4078 -fguess-branch-probability @gol
4079 -fcprop-registers @gol
4080 -floop-optimize @gol
4081 -fif-conversion @gol
4082 -fif-conversion2 @gol
4083 -ftree-ccp @gol
4084 -ftree-dce @gol
4085 -ftree-dom @gol
4086 -ftree-dse @gol
4087 -ftree-ter @gol
4088 -ftree-live_range_split @gol
4089 -ftree-sra @gol
4090 -ftree-copyrename @gol
4091 -ftree-fre @gol
4092 -ftree-ch @gol
4093 -fmerge-constants}
4094
4095 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4096 where doing so does not interfere with debugging.
4097
4098 @item -O2
4099 @opindex O2
4100 Optimize even more.  GCC performs nearly all supported optimizations
4101 that do not involve a space-speed tradeoff.  The compiler does not
4102 perform loop unrolling or function inlining when you specify @option{-O2}.
4103 As compared to @option{-O}, this option increases both compilation time
4104 and the performance of the generated code.
4105
4106 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4107 also turns on the following optimization flags:
4108 @gccoptlist{-fthread-jumps @gol
4109 -fcrossjumping @gol
4110 -foptimize-sibling-calls @gol
4111 -fcse-follow-jumps  -fcse-skip-blocks @gol
4112 -fgcse  -fgcse-lm  @gol
4113 -fexpensive-optimizations @gol
4114 -fstrength-reduce @gol
4115 -frerun-cse-after-loop  -frerun-loop-opt @gol
4116 -fcaller-saves @gol
4117 -fforce-mem @gol
4118 -fpeephole2 @gol
4119 -fschedule-insns  -fschedule-insns2 @gol
4120 -fsched-interblock  -fsched-spec @gol
4121 -fregmove @gol
4122 -fstrict-aliasing @gol
4123 -fdelete-null-pointer-checks @gol
4124 -freorder-blocks  -freorder-functions @gol
4125 -funit-at-a-time @gol
4126 -falign-functions  -falign-jumps @gol
4127 -falign-loops  -falign-labels @gol
4128 -ftree-pre}
4129
4130 Please note the warning under @option{-fgcse} about
4131 invoking @option{-O2} on programs that use computed gotos.
4132
4133 @item -O3
4134 @opindex O3
4135 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4136 @option{-O2} and also turns on the @option{-finline-functions},
4137 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4138
4139 @item -O0
4140 @opindex O0
4141 Do not optimize.  This is the default.
4142
4143 @item -Os
4144 @opindex Os
4145 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4146 do not typically increase code size.  It also performs further
4147 optimizations designed to reduce code size.
4148
4149 @option{-Os} disables the following optimization flags:
4150 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4151 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4152
4153 If you use multiple @option{-O} options, with or without level numbers,
4154 the last such option is the one that is effective.
4155 @end table
4156
4157 Options of the form @option{-f@var{flag}} specify machine-independent
4158 flags.  Most flags have both positive and negative forms; the negative
4159 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4160 below, only one of the forms is listed---the one you typically will
4161 use.  You can figure out the other form by either removing @samp{no-}
4162 or adding it.
4163
4164 The following options control specific optimizations.  They are either
4165 activated by @option{-O} options or are related to ones that are.  You
4166 can use the following flags in the rare cases when ``fine-tuning'' of
4167 optimizations to be performed is desired.
4168
4169 @table @gcctabopt
4170 @item -fno-default-inline
4171 @opindex fno-default-inline
4172 Do not make member functions inline by default merely because they are
4173 defined inside the class scope (C++ only).  Otherwise, when you specify
4174 @w{@option{-O}}, member functions defined inside class scope are compiled
4175 inline by default; i.e., you don't need to add @samp{inline} in front of
4176 the member function name.
4177
4178 @item -fno-defer-pop
4179 @opindex fno-defer-pop
4180 Always pop the arguments to each function call as soon as that function
4181 returns.  For machines which must pop arguments after a function call,
4182 the compiler normally lets arguments accumulate on the stack for several
4183 function calls and pops them all at once.
4184
4185 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186
4187 @item -fforce-mem
4188 @opindex fforce-mem
4189 Force memory operands to be copied into registers before doing
4190 arithmetic on them.  This produces better code by making all memory
4191 references potential common subexpressions.  When they are not common
4192 subexpressions, instruction combination should eliminate the separate
4193 register-load.
4194
4195 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4196
4197 @item -fforce-addr
4198 @opindex fforce-addr
4199 Force memory address constants to be copied into registers before
4200 doing arithmetic on them.  This may produce better code just as
4201 @option{-fforce-mem} may.
4202
4203 @item -fomit-frame-pointer
4204 @opindex fomit-frame-pointer
4205 Don't keep the frame pointer in a register for functions that
4206 don't need one.  This avoids the instructions to save, set up and
4207 restore frame pointers; it also makes an extra register available
4208 in many functions.  @strong{It also makes debugging impossible on
4209 some machines.}
4210
4211 On some machines, such as the VAX, this flag has no effect, because
4212 the standard calling sequence automatically handles the frame pointer
4213 and nothing is saved by pretending it doesn't exist.  The
4214 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4215 whether a target machine supports this flag.  @xref{Registers,,Register
4216 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4217
4218 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4219
4220 @item -foptimize-sibling-calls
4221 @opindex foptimize-sibling-calls
4222 Optimize sibling and tail recursive calls.
4223
4224 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4225
4226 @item -fno-inline
4227 @opindex fno-inline
4228 Don't pay attention to the @code{inline} keyword.  Normally this option
4229 is used to keep the compiler from expanding any functions inline.
4230 Note that if you are not optimizing, no functions can be expanded inline.
4231
4232 @item -finline-functions
4233 @opindex finline-functions
4234 Integrate all simple functions into their callers.  The compiler
4235 heuristically decides which functions are simple enough to be worth
4236 integrating in this way.
4237
4238 If all calls to a given function are integrated, and the function is
4239 declared @code{static}, then the function is normally not output as
4240 assembler code in its own right.
4241
4242 Enabled at level @option{-O3}.
4243
4244 @item -finline-limit=@var{n}
4245 @opindex finline-limit
4246 By default, GCC limits the size of functions that can be inlined.  This flag
4247 allows the control of this limit for functions that are explicitly marked as
4248 inline (i.e., marked with the inline keyword or defined within the class
4249 definition in c++).  @var{n} is the size of functions that can be inlined in
4250 number of pseudo instructions (not counting parameter handling).  The default
4251 value of @var{n} is 600.
4252 Increasing this value can result in more inlined code at
4253 the cost of compilation time and memory consumption.  Decreasing usually makes
4254 the compilation faster and less code will be inlined (which presumably
4255 means slower programs).  This option is particularly useful for programs that
4256 use inlining heavily such as those based on recursive templates with C++.
4257
4258 Inlining is actually controlled by a number of parameters, which may be
4259 specified individually by using @option{--param @var{name}=@var{value}}.
4260 The @option{-finline-limit=@var{n}} option sets some of these parameters
4261 as follows:
4262
4263 @table @gcctabopt
4264  @item max-inline-insns-single
4265   is set to @var{n}/2.
4266  @item max-inline-insns-auto
4267   is set to @var{n}/2.
4268  @item min-inline-insns
4269   is set to 130 or @var{n}/4, whichever is smaller.
4270  @item max-inline-insns-rtl
4271   is set to @var{n}.
4272 @end table
4273
4274 See below for a documentation of the individual
4275 parameters controlling inlining.
4276
4277 @emph{Note:} pseudo instruction represents, in this particular context, an
4278 abstract measurement of function's size.  In no way, it represents a count
4279 of assembly instructions and as such its exact meaning might change from one
4280 release to an another.
4281
4282 @item -fkeep-inline-functions
4283 @opindex fkeep-inline-functions
4284 In C, emit @code{static} functions that are declared @code{inline}
4285 into the object file, even if the function has been inlined into all
4286 of its callers.  This switch does not affect functions using the
4287 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4288 inline functions into the object file.
4289
4290 @item -fkeep-static-consts
4291 @opindex fkeep-static-consts
4292 Emit variables declared @code{static const} when optimization isn't turned
4293 on, even if the variables aren't referenced.
4294
4295 GCC enables this option by default.  If you want to force the compiler to
4296 check if the variable was referenced, regardless of whether or not
4297 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4298
4299 @item -fmerge-constants
4300 Attempt to merge identical constants (string constants and floating point
4301 constants) across compilation units.
4302
4303 This option is the default for optimized compilation if the assembler and
4304 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4305 behavior.
4306
4307 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4308
4309 @item -fmerge-all-constants
4310 Attempt to merge identical constants and identical variables.
4311
4312 This option implies @option{-fmerge-constants}.  In addition to
4313 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4314 arrays or initialized constant variables with integral or floating point
4315 types.  Languages like C or C++ require each non-automatic variable to
4316 have distinct location, so using this option will result in non-conforming
4317 behavior.
4318
4319 @item -fmodulo-sched
4320 @opindex fmodulo-sched
4321 Perform swing modulo scheduling immediately before the first scheduling
4322 pass.  This pass looks at innermost loops and reorders their
4323 instructions by overlapping different iterations.
4324
4325 @item -fno-branch-count-reg
4326 @opindex fno-branch-count-reg
4327 Do not use ``decrement and branch'' instructions on a count register,
4328 but instead generate a sequence of instructions that decrement a
4329 register, compare it against zero, then branch based upon the result.
4330 This option is only meaningful on architectures that support such
4331 instructions, which include x86, PowerPC, IA-64 and S/390.
4332
4333 The default is @option{-fbranch-count-reg}, enabled when
4334 @option{-fstrength-reduce} is enabled.
4335
4336 @item -fno-function-cse
4337 @opindex fno-function-cse
4338 Do not put function addresses in registers; make each instruction that
4339 calls a constant function contain the function's address explicitly.
4340
4341 This option results in less efficient code, but some strange hacks
4342 that alter the assembler output may be confused by the optimizations
4343 performed when this option is not used.
4344
4345 The default is @option{-ffunction-cse}
4346
4347 @item -fno-zero-initialized-in-bss
4348 @opindex fno-zero-initialized-in-bss
4349 If the target supports a BSS section, GCC by default puts variables that
4350 are initialized to zero into BSS@.  This can save space in the resulting
4351 code.
4352
4353 This option turns off this behavior because some programs explicitly
4354 rely on variables going to the data section.  E.g., so that the
4355 resulting executable can find the beginning of that section and/or make
4356 assumptions based on that.
4357
4358 The default is @option{-fzero-initialized-in-bss}.
4359
4360 @item -fbounds-check
4361 @opindex fbounds-check
4362 For front-ends that support it, generate additional code to check that
4363 indices used to access arrays are within the declared range.  This is
4364 currently only supported by the Java and Fortran front-ends, where
4365 this option defaults to true and false respectively.
4366
4367 @item -fmudflap -fmudflapth -fmudflapir
4368 @opindex fmudflap
4369 @opindex fmudflapth
4370 @opindex fmudflapir
4371 @cindex bounds checking
4372 @cindex mudflap
4373 For front-ends that support it (C and C++), instrument all risky
4374 pointer/array dereferencing operations, some standard library
4375 string/heap functions, and some other associated constructs with
4376 range/validity tests.  Modules so instrumented should be immune to
4377 buffer overflows, invalid heap use, and some other classes of C/C++
4378 programming errors.  The instrumentation relies on a separate runtime
4379 library (@file{libmudflap}), which will be linked into a program if
4380 @option{-fmudflap} is given at link time.  Run-time behavior of the
4381 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4382 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4383 for its options.
4384
4385 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4386 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4387 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4388 instrumentation should ignore pointer reads.  This produces less
4389 instrumentation (and therefore faster execution) and still provides
4390 some protection against outright memory corrupting writes, but allows
4391 erroneously read data to propagate within a program.
4392
4393 @item -fstrength-reduce
4394 @opindex fstrength-reduce
4395 Perform the optimizations of loop strength reduction and
4396 elimination of iteration variables.
4397
4398 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4399
4400 @item -fthread-jumps
4401 @opindex fthread-jumps
4402 Perform optimizations where we check to see if a jump branches to a
4403 location where another comparison subsumed by the first is found.  If
4404 so, the first branch is redirected to either the destination of the
4405 second branch or a point immediately following it, depending on whether
4406 the condition is known to be true or false.
4407
4408 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4409
4410 @item -fcse-follow-jumps
4411 @opindex fcse-follow-jumps
4412 In common subexpression elimination, scan through jump instructions
4413 when the target of the jump is not reached by any other path.  For
4414 example, when CSE encounters an @code{if} statement with an
4415 @code{else} clause, CSE will follow the jump when the condition
4416 tested is false.
4417
4418 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4419
4420 @item -fcse-skip-blocks
4421 @opindex fcse-skip-blocks
4422 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4423 follow jumps which conditionally skip over blocks.  When CSE
4424 encounters a simple @code{if} statement with no else clause,
4425 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4426 body of the @code{if}.
4427
4428 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4429
4430 @item -frerun-cse-after-loop
4431 @opindex frerun-cse-after-loop
4432 Re-run common subexpression elimination after loop optimizations has been
4433 performed.
4434
4435 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4436
4437 @item -frerun-loop-opt
4438 @opindex frerun-loop-opt
4439 Run the loop optimizer twice.
4440
4441 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4442
4443 @item -fgcse
4444 @opindex fgcse
4445 Perform a global common subexpression elimination pass.
4446 This pass also performs global constant and copy propagation.
4447
4448 @emph{Note:} When compiling a program using computed gotos, a GCC
4449 extension, you may get better runtime performance if you disable
4450 the global common subexpression elimination pass by adding
4451 @option{-fno-gcse} to the command line.
4452
4453 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4454
4455 @item -fgcse-lm
4456 @opindex fgcse-lm
4457 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4458 attempt to move loads which are only killed by stores into themselves.  This
4459 allows a loop containing a load/store sequence to be changed to a load outside
4460 the loop, and a copy/store within the loop.
4461
4462 Enabled by default when gcse is enabled.
4463
4464 @item -fgcse-sm
4465 @opindex fgcse-sm
4466 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4467 global common subexpression elimination.  This pass will attempt to move
4468 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4469 loops containing a load/store sequence can be changed to a load before
4470 the loop and a store after the loop.
4471
4472 Not enabled at any optimization level.
4473
4474 @item -fgcse-las
4475 @opindex fgcse-las
4476 When @option{-fgcse-las} is enabled, the global common subexpression
4477 elimination pass eliminates redundant loads that come after stores to the
4478 same memory location (both partial and full redundancies).
4479
4480 Not enabled at any optimization level.
4481
4482 @item -fgcse-after-reload
4483 @opindex fgcse-after-reload
4484 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4485 pass is performed after reload.  The purpose of this pass is to cleanup
4486 redundant spilling.
4487
4488 @item -floop-optimize
4489 @opindex floop-optimize
4490 Perform loop optimizations: move constant expressions out of loops, simplify
4491 exit test conditions and optionally do strength-reduction as well.
4492
4493 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4494
4495 @item -floop-optimize2
4496 @opindex floop-optimize2
4497 Perform loop optimizations using the new loop optimizer.  The optimizations
4498 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4499 by separate flags.
4500
4501 @item -fcrossjumping
4502 @opindex crossjumping
4503 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4504 resulting code may or may not perform better than without cross-jumping.
4505
4506 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4507
4508 @item -fif-conversion
4509 @opindex if-conversion
4510 Attempt to transform conditional jumps into branch-less equivalents.  This
4511 include use of conditional moves, min, max, set flags and abs instructions, and
4512 some tricks doable by standard arithmetics.  The use of conditional execution
4513 on chips where it is available is controlled by @code{if-conversion2}.
4514
4515 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4516
4517 @item -fif-conversion2
4518 @opindex if-conversion2
4519 Use conditional execution (where available) to transform conditional jumps into
4520 branch-less equivalents.
4521
4522 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4523
4524 @item -fdelete-null-pointer-checks
4525 @opindex fdelete-null-pointer-checks
4526 Use global dataflow analysis to identify and eliminate useless checks
4527 for null pointers.  The compiler assumes that dereferencing a null
4528 pointer would have halted the program.  If a pointer is checked after
4529 it has already been dereferenced, it cannot be null.
4530
4531 In some environments, this assumption is not true, and programs can
4532 safely dereference null pointers.  Use
4533 @option{-fno-delete-null-pointer-checks} to disable this optimization
4534 for programs which depend on that behavior.
4535
4536 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4537
4538 @item -fexpensive-optimizations
4539 @opindex fexpensive-optimizations
4540 Perform a number of minor optimizations that are relatively expensive.
4541
4542 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4543
4544 @item -foptimize-register-move
4545 @itemx -fregmove
4546 @opindex foptimize-register-move
4547 @opindex fregmove
4548 Attempt to reassign register numbers in move instructions and as
4549 operands of other simple instructions in order to maximize the amount of
4550 register tying.  This is especially helpful on machines with two-operand
4551 instructions.
4552
4553 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4554 optimization.
4555
4556 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4557
4558 @item -fdelayed-branch
4559 @opindex fdelayed-branch
4560 If supported for the target machine, attempt to reorder instructions
4561 to exploit instruction slots available after delayed branch
4562 instructions.
4563
4564 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4565
4566 @item -fschedule-insns
4567 @opindex fschedule-insns
4568 If supported for the target machine, attempt to reorder instructions to
4569 eliminate execution stalls due to required data being unavailable.  This
4570 helps machines that have slow floating point or memory load instructions
4571 by allowing other instructions to be issued until the result of the load
4572 or floating point instruction is required.
4573
4574 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4575
4576 @item -fschedule-insns2
4577 @opindex fschedule-insns2
4578 Similar to @option{-fschedule-insns}, but requests an additional pass of
4579 instruction scheduling after register allocation has been done.  This is
4580 especially useful on machines with a relatively small number of
4581 registers and where memory load instructions take more than one cycle.
4582
4583 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4584
4585 @item -fno-sched-interblock
4586 @opindex fno-sched-interblock
4587 Don't schedule instructions across basic blocks.  This is normally
4588 enabled by default when scheduling before register allocation, i.e.@:
4589 with @option{-fschedule-insns} or at @option{-O2} or higher.
4590
4591 @item -fno-sched-spec
4592 @opindex fno-sched-spec
4593 Don't allow speculative motion of non-load instructions.  This is normally
4594 enabled by default when scheduling before register allocation, i.e.@:
4595 with @option{-fschedule-insns} or at @option{-O2} or higher.
4596
4597 @item -fsched-spec-load
4598 @opindex fsched-spec-load
4599 Allow speculative motion of some load instructions.  This only makes
4600 sense when scheduling before register allocation, i.e.@: with
4601 @option{-fschedule-insns} or at @option{-O2} or higher.
4602
4603 @item -fsched-spec-load-dangerous
4604 @opindex fsched-spec-load-dangerous
4605 Allow speculative motion of more load instructions.  This only makes
4606 sense when scheduling before register allocation, i.e.@: with
4607 @option{-fschedule-insns} or at @option{-O2} or higher.
4608
4609 @item -fsched-stalled-insns=@var{n}
4610 @opindex fsched-stalled-insns
4611 Define how many insns (if any) can be moved prematurely from the queue
4612 of stalled insns into the ready list, during the second scheduling pass.
4613
4614 @item -fsched-stalled-insns-dep=@var{n}
4615 @opindex fsched-stalled-insns-dep
4616 Define how many insn groups (cycles) will be examined for a dependency
4617 on a stalled insn that is candidate for premature removal from the queue
4618 of stalled insns.  Has an effect only during the second scheduling pass,
4619 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4620
4621 @item -fsched2-use-superblocks
4622 @opindex fsched2-use-superblocks
4623 When scheduling after register allocation, do use superblock scheduling
4624 algorithm.  Superblock scheduling allows motion across basic block boundaries
4625 resulting on faster schedules.  This option is experimental, as not all machine
4626 descriptions used by GCC model the CPU closely enough to avoid unreliable
4627 results from the algorithm.
4628
4629 This only makes sense when scheduling after register allocation, i.e.@: with
4630 @option{-fschedule-insns2} or at @option{-O2} or higher.
4631
4632 @item -fsched2-use-traces
4633 @opindex fsched2-use-traces
4634 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4635 allocation and additionally perform code duplication in order to increase the
4636 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4637 trace formation.
4638
4639 This mode should produce faster but significantly longer programs.  Also
4640 without @option{-fbranch-probabilities} the traces constructed may not
4641 match the reality and hurt the performance.  This only makes
4642 sense when scheduling after register allocation, i.e.@: with
4643 @option{-fschedule-insns2} or at @option{-O2} or higher.
4644
4645 @item -freschedule-modulo-scheduled-loops
4646 @opindex fscheduling-in-modulo-scheduled-loops
4647 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4648 we may want to prevent the later scheduling passes from changing its schedule, we use this
4649 option to control that.
4650
4651 @item -fcaller-saves
4652 @opindex fcaller-saves
4653 Enable values to be allocated in registers that will be clobbered by
4654 function calls, by emitting extra instructions to save and restore the
4655 registers around such calls.  Such allocation is done only when it
4656 seems to result in better code than would otherwise be produced.
4657
4658 This option is always enabled by default on certain machines, usually
4659 those which have no call-preserved registers to use instead.
4660
4661 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4662
4663 @item -ftree-pre
4664 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4665 enabled by default at @option{-O2} and @option{-O3}.
4666
4667 @item -ftree-fre
4668 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4669 between FRE and PRE is that FRE only considers expressions
4670 that are computed on all paths leading to the redundant computation.
4671 This analysis faster than PRE, though it exposes fewer redundancies.
4672 This flag is enabled by default at @option{-O} and higher.
4673
4674 @item -ftree-ccp
4675 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4676 is enabled by default at @option{-O} and higher.
4677
4678 @item -ftree-dce
4679 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4680 default at @option{-O} and higher.
4681
4682 @item -ftree-dominator-opts
4683 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4684 default at @option{-O} and higher.
4685
4686 @item -ftree-ch
4687 Perform loop header copying on trees.  This is beneficial since it increases
4688 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4689 is enabled by default at @option{-O} and higher.  It is not enabled
4690 for @option{-Os}, since it usually increases code size.
4691
4692 @item -ftree-loop-optimize
4693 Perform loop optimizations on trees.  This flag is enabled by default
4694 at @option{-O} and higher.
4695
4696 @item -ftree-loop-linear
4697 Perform linear loop transformations on tree.  This flag can improve cache
4698 performance and allow further loop optimizations to take place.
4699
4700 @item -ftree-lim
4701 Perform loop invariant motion on trees.  This pass moves only invartiants that
4702 would be hard to handle on rtl level (function calls, operations that expand to
4703 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4704 operands of conditions that are invariant out of the loop, so that we can use
4705 just trivial invariantness analysis in loop unswitching.  The pass also includes
4706 store motion.
4707
4708 @item -fivcanon
4709 Create a canonical counter for number of iterations in the loop for that
4710 determining number of iterations requires complicated analysis.  Later
4711 optimizations then may determine the number easily.  Useful especially
4712 in connection with unrolling.
4713
4714 @item -fivopts
4715 Perform induction variable optimizations (strength reduction, induction
4716 variable merging and induction variable elimination) on trees.
4717
4718 @item -ftree-sra
4719 Perform scalar replacement of aggregates.  This pass replaces structure
4720 references with scalars to prevent committing structures to memory too
4721 early.  This flag is enabled by default at @option{-O} and higher.
4722
4723 @item -ftree-copyrename
4724 Perform copy renaming on trees.  This pass attempts to rename compiler
4725 temporaries to other variables at copy locations, usually resulting in
4726 variable names which more closely resemble the original variables.  This flag
4727 is enabled by default at @option{-O} and higher.
4728
4729 @item -ftree-ter
4730 Perform temporary expression replacement during the SSA->normal phase.  Single
4731 use/single def temporaries are replaced at their use location with their
4732 defining expression.  This results in non-GIMPLE code, but gives the expanders
4733 much more complex trees to work on resulting in better RTL generation.  This is
4734 enabled by default at @option{-O} and higher.
4735
4736 @item -ftree-lrs
4737 Perform live range splitting during the SSA->normal phase.  Distinct live
4738 ranges of a variable are split into unique variables, allowing for better
4739 optimization later.  This is enabled by default at @option{-O} and higher.
4740
4741 @item -ftree-vectorize
4742 Perform loop vectorization on trees.
4743
4744 @item -ftracer
4745 @opindex ftracer
4746 Perform tail duplication to enlarge superblock size.  This transformation
4747 simplifies the control flow of the function allowing other optimizations to do
4748 better job.
4749
4750 @item -funroll-loops
4751 @opindex funroll-loops
4752 Unroll loops whose number of iterations can be determined at compile
4753 time or upon entry to the loop.  @option{-funroll-loops} implies both
4754 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4755 option makes code larger, and may or may not make it run faster.
4756
4757 @item -funroll-all-loops
4758 @opindex funroll-all-loops
4759 Unroll all loops, even if their number of iterations is uncertain when
4760 the loop is entered.  This usually makes programs run more slowly.
4761 @option{-funroll-all-loops} implies the same options as
4762 @option{-funroll-loops},
4763
4764 @item -fsplit-ivs-in-unroller
4765 @opindex -fsplit-ivs-in-unroller
4766 Enables expressing of values of induction variables in later iterations
4767 of the unrolled loop using the value in the first iteration.  This breaks
4768 long dependency chains, thus improving efficiency of the scheduling passes
4769 (for best results, @option{-fweb} should be used as well).
4770
4771 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4772 same effect.  However in cases the loop body is more complicated than
4773 a single basic block, this is not reliable.  It also does not work at all
4774 on some of the architectures due to restrictions in the CSE pass.
4775
4776 This optimization is enabled by default.
4777
4778 @item -fvariable-expansion-in-unroller
4779 @opindex -fvariable-expansion-in-unroller
4780 With this option, the compiler will create multiple copies of some
4781 local variables when unrolling a loop which can result in superior code.
4782
4783 @item -fprefetch-loop-arrays
4784 @opindex fprefetch-loop-arrays
4785 If supported by the target machine, generate instructions to prefetch
4786 memory to improve the performance of loops that access large arrays.
4787
4788 These options may generate better or worse code; results are highly
4789 dependent on the structure of loops within the source code.
4790
4791 @item -fno-peephole
4792 @itemx -fno-peephole2
4793 @opindex fno-peephole
4794 @opindex fno-peephole2
4795 Disable any machine-specific peephole optimizations.  The difference
4796 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4797 are implemented in the compiler; some targets use one, some use the
4798 other, a few use both.
4799
4800 @option{-fpeephole} is enabled by default.
4801 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4802
4803 @item -fno-guess-branch-probability
4804 @opindex fno-guess-branch-probability
4805 Do not guess branch probabilities using heuristics.
4806
4807 GCC will use heuristics to guess branch probabilities if they are
4808 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4809 heuristics are based on the control flow graph.  If some branch probabilities
4810 are specified by @samp{__builtin_expect}, then the heuristics will be
4811 used to guess branch probabilities for the rest of the control flow graph,
4812 taking the @samp{__builtin_expect} info into account.  The interactions
4813 between the heuristics and @samp{__builtin_expect} can be complex, and in
4814 some cases, it may be useful to disable the heuristics so that the effects
4815 of @samp{__builtin_expect} are easier to understand.
4816
4817 The default is @option{-fguess-branch-probability} at levels
4818 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4819
4820 @item -freorder-blocks
4821 @opindex freorder-blocks
4822 Reorder basic blocks in the compiled function in order to reduce number of
4823 taken branches and improve code locality.
4824
4825 Enabled at levels @option{-O2}, @option{-O3}.
4826
4827 @item -freorder-blocks-and-partition
4828 @opindex freorder-blocks-and-partition
4829 In addition to reordering basic blocks in the compiled function, in order
4830 to reduce number of taken branches, partitions hot and cold basic blocks
4831 into separate sections of the assembly and .o files, to improve
4832 paging and cache locality performance.
4833
4834 This optimization is automatically turned off in the presence of
4835 exception handling, for linkonce sections, for functions with a user-defined
4836 section attribute and on any architecture that does not support named
4837 sections.
4838
4839 @item -freorder-functions
4840 @opindex freorder-functions
4841 Reorder basic blocks in the compiled function in order to reduce number of
4842 taken branches and improve code locality.  This is implemented by using special
4843 subsections @code{.text.hot} for most frequently executed functions and
4844 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4845 the linker so object file format must support named sections and linker must
4846 place them in a reasonable way.
4847
4848 Also profile feedback must be available in to make this option effective.  See
4849 @option{-fprofile-arcs} for details.
4850
4851 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4852
4853 @item -fstrict-aliasing
4854 @opindex fstrict-aliasing
4855 Allows the compiler to assume the strictest aliasing rules applicable to
4856 the language being compiled.  For C (and C++), this activates
4857 optimizations based on the type of expressions.  In particular, an
4858 object of one type is assumed never to reside at the same address as an
4859 object of a different type, unless the types are almost the same.  For
4860 example, an @code{unsigned int} can alias an @code{int}, but not a
4861 @code{void*} or a @code{double}.  A character type may alias any other
4862 type.
4863
4864 Pay special attention to code like this:
4865 @smallexample
4866 union a_union @{
4867   int i;
4868   double d;
4869 @};
4870
4871 int f() @{
4872   a_union t;
4873   t.d = 3.0;
4874   return t.i;
4875 @}
4876 @end smallexample
4877 The practice of reading from a different union member than the one most
4878 recently written to (called ``type-punning'') is common.  Even with
4879 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4880 is accessed through the union type.  So, the code above will work as
4881 expected.  However, this code might not:
4882 @smallexample
4883 int f() @{
4884   a_union t;
4885   int* ip;
4886   t.d = 3.0;
4887   ip = &t.i;
4888   return *ip;
4889 @}
4890 @end smallexample
4891
4892 Every language that wishes to perform language-specific alias analysis
4893 should define a function that computes, given an @code{tree}
4894 node, an alias set for the node.  Nodes in different alias sets are not
4895 allowed to alias.  For an example, see the C front-end function
4896 @code{c_get_alias_set}.
4897
4898 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4899
4900 @item -falign-functions
4901 @itemx -falign-functions=@var{n}
4902 @opindex falign-functions
4903 Align the start of functions to the next power-of-two greater than
4904 @var{n}, skipping up to @var{n} bytes.  For instance,
4905 @option{-falign-functions=32} aligns functions to the next 32-byte
4906 boundary, but @option{-falign-functions=24} would align to the next
4907 32-byte boundary only if this can be done by skipping 23 bytes or less.
4908
4909 @option{-fno-align-functions} and @option{-falign-functions=1} are
4910 equivalent and mean that functions will not be aligned.
4911
4912 Some assemblers only support this flag when @var{n} is a power of two;
4913 in that case, it is rounded up.
4914
4915 If @var{n} is not specified or is zero, use a machine-dependent default.
4916
4917 Enabled at levels @option{-O2}, @option{-O3}.
4918
4919 @item -falign-labels
4920 @itemx -falign-labels=@var{n}
4921 @opindex falign-labels
4922 Align all branch targets to a power-of-two boundary, skipping up to
4923 @var{n} bytes like @option{-falign-functions}.  This option can easily
4924 make code slower, because it must insert dummy operations for when the
4925 branch target is reached in the usual flow of the code.
4926
4927 @option{-fno-align-labels} and @option{-falign-labels=1} are
4928 equivalent and mean that labels will not be aligned.
4929
4930 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4931 are greater than this value, then their values are used instead.
4932
4933 If @var{n} is not specified or is zero, use a machine-dependent default
4934 which is very likely to be @samp{1}, meaning no alignment.
4935
4936 Enabled at levels @option{-O2}, @option{-O3}.
4937
4938 @item -falign-loops
4939 @itemx -falign-loops=@var{n}
4940 @opindex falign-loops
4941 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4942 like @option{-falign-functions}.  The hope is that the loop will be
4943 executed many times, which will make up for any execution of the dummy
4944 operations.
4945
4946 @option{-fno-align-loops} and @option{-falign-loops=1} are
4947 equivalent and mean that loops will not be aligned.
4948
4949 If @var{n} is not specified or is zero, use a machine-dependent default.
4950
4951 Enabled at levels @option{-O2}, @option{-O3}.
4952
4953 @item -falign-jumps
4954 @itemx -falign-jumps=@var{n}
4955 @opindex falign-jumps
4956 Align branch targets to a power-of-two boundary, for branch targets
4957 where the targets can only be reached by jumping, skipping up to @var{n}
4958 bytes like @option{-falign-functions}.  In this case, no dummy operations
4959 need be executed.
4960
4961 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4962 equivalent and mean that loops will not be aligned.
4963
4964 If @var{n} is not specified or is zero, use a machine-dependent default.
4965
4966 Enabled at levels @option{-O2}, @option{-O3}.
4967
4968 @item -funit-at-a-time
4969 @opindex funit-at-a-time
4970 Parse the whole compilation unit before starting to produce code.
4971 This allows some extra optimizations to take place but consumes
4972 more memory (in general).  There are some compatibility issues
4973 with @emph{unit-at-at-time} mode:
4974 @itemize @bullet
4975 @item
4976 enabling @emph{unit-at-a-time} mode may change the order
4977 in which functions, variables, and top-level @code{asm} statements
4978 are emitted, and will likely break code relying on some particular
4979 ordering.  The majority of such top-level @code{asm} statements,
4980 though, can be replaced by @code{section} attributes.
4981
4982 @item
4983 @emph{unit-at-a-time} mode removes unreferenced static variables
4984 and functions are removed.  This may result in undefined references
4985 when an @code{asm} statement refers directly to variables or functions
4986 that are otherwise unused.  In that case either the variable/function
4987 shall be listed as an operand of the @code{asm} statement operand or,
4988 in the case of top-level @code{asm} statements the attribute @code{used}
4989 shall be used on the declaration.
4990
4991 @item
4992 Static functions now can use non-standard passing conventions that
4993 may break @code{asm} statements calling functions directly.  Again,
4994 attribute @code{used} will prevent this behavior.
4995 @end itemize
4996
4997 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4998 but this scheme may not be supported by future releases of GCC@.
4999
5000 Enabled at levels @option{-O2}, @option{-O3}.
5001
5002 @item -fweb
5003 @opindex fweb
5004 Constructs webs as commonly used for register allocation purposes and assign
5005 each web individual pseudo register.  This allows the register allocation pass
5006 to operate on pseudos directly, but also strengthens several other optimization
5007 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5008 however, make debugging impossible, since variables will no longer stay in a
5009 ``home register''.
5010
5011 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5012 on targets where the default format for debugging information supports
5013 variable tracking.
5014
5015 @item -fno-cprop-registers
5016 @opindex fno-cprop-registers
5017 After register allocation and post-register allocation instruction splitting,
5018 we perform a copy-propagation pass to try to reduce scheduling dependencies
5019 and occasionally eliminate the copy.
5020
5021 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5022
5023 @item -fprofile-generate
5024 @opindex fprofile-generate
5025
5026 Enable options usually used for instrumenting application to produce
5027 profile useful for later recompilation with profile feedback based
5028 optimization.  You must use @option{-fprofile-generate} both when
5029 compiling and when linking your program.
5030
5031 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5032
5033 @item -fprofile-use
5034 @opindex fprofile-use
5035 Enable profile feedback directed optimizations, and optimizations
5036 generally profitable only with profile feedback available.
5037
5038 The following options are enabled: @code{-fbranch-probabilities},
5039 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5040
5041 @end table
5042
5043 The following options control compiler behavior regarding floating
5044 point arithmetic.  These options trade off between speed and
5045 correctness.  All must be specifically enabled.
5046
5047 @table @gcctabopt
5048 @item -ffloat-store
5049 @opindex ffloat-store
5050 Do not store floating point variables in registers, and inhibit other
5051 options that might change whether a floating point value is taken from a
5052 register or memory.
5053
5054 @cindex floating point precision
5055 This option prevents undesirable excess precision on machines such as
5056 the 68000 where the floating registers (of the 68881) keep more
5057 precision than a @code{double} is supposed to have.  Similarly for the
5058 x86 architecture.  For most programs, the excess precision does only
5059 good, but a few programs rely on the precise definition of IEEE floating
5060 point.  Use @option{-ffloat-store} for such programs, after modifying
5061 them to store all pertinent intermediate computations into variables.
5062
5063 @item -ffast-math
5064 @opindex ffast-math
5065 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5066 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5067 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5068
5069 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5070
5071 This option should never be turned on by any @option{-O} option since
5072 it can result in incorrect output for programs which depend on
5073 an exact implementation of IEEE or ISO rules/specifications for
5074 math functions.
5075
5076 @item -fno-math-errno
5077 @opindex fno-math-errno
5078 Do not set ERRNO after calling math functions that are executed
5079 with a single instruction, e.g., sqrt.  A program that relies on
5080 IEEE exceptions for math error handling may want to use this flag
5081 for speed while maintaining IEEE arithmetic compatibility.
5082
5083 This option should never be turned on by any @option{-O} option since
5084 it can result in incorrect output for programs which depend on
5085 an exact implementation of IEEE or ISO rules/specifications for
5086 math functions.
5087
5088 The default is @option{-fmath-errno}.
5089
5090 @item -funsafe-math-optimizations
5091 @opindex funsafe-math-optimizations
5092 Allow optimizations for floating-point arithmetic that (a) assume
5093 that arguments and results are valid and (b) may violate IEEE or
5094 ANSI standards.  When used at link-time, it may include libraries
5095 or startup files that change the default FPU control word or other
5096 similar optimizations.
5097
5098 This option should never be turned on by any @option{-O} option since
5099 it can result in incorrect output for programs which depend on
5100 an exact implementation of IEEE or ISO rules/specifications for
5101 math functions.
5102
5103 The default is @option{-fno-unsafe-math-optimizations}.
5104
5105 @item -ffinite-math-only
5106 @opindex ffinite-math-only
5107 Allow optimizations for floating-point arithmetic that assume
5108 that arguments and results are not NaNs or +-Infs.
5109
5110 This option should never be turned on by any @option{-O} option since
5111 it can result in incorrect output for programs which depend on
5112 an exact implementation of IEEE or ISO rules/specifications.
5113
5114 The default is @option{-fno-finite-math-only}.
5115
5116 @item -fno-trapping-math
5117 @opindex fno-trapping-math
5118 Compile code assuming that floating-point operations cannot generate
5119 user-visible traps.  These traps include division by zero, overflow,
5120 underflow, inexact result and invalid operation.  This option implies
5121 @option{-fno-signaling-nans}.  Setting this option may allow faster
5122 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5123
5124 This option should never be turned on by any @option{-O} option since
5125 it can result in incorrect output for programs which depend on
5126 an exact implementation of IEEE or ISO rules/specifications for
5127 math functions.
5128
5129 The default is @option{-ftrapping-math}.
5130
5131 @item -frounding-math
5132 @opindex frounding-math
5133 Disable transformations and optimizations that assume default floating
5134 point rounding behavior.  This is round-to-zero for all floating point
5135 to integer conversions, and round-to-nearest for all other arithmetic
5136 truncations.  This option should be specified for programs that change
5137 the FP rounding mode dynamically, or that may be executed with a
5138 non-default rounding mode.  This option disables constant folding of
5139 floating point expressions at compile-time (which may be affected by
5140 rounding mode) and arithmetic transformations that are unsafe in the
5141 presence of sign-dependent rounding modes.
5142
5143 The default is @option{-fno-rounding-math}.
5144
5145 This option is experimental and does not currently guarantee to
5146 disable all GCC optimizations that are affected by rounding mode.
5147 Future versions of GCC may provide finer control of this setting
5148 using C99's @code{FENV_ACCESS} pragma.  This command line option
5149 will be used to specify the default state for @code{FENV_ACCESS}.
5150
5151 @item -fsignaling-nans
5152 @opindex fsignaling-nans
5153 Compile code assuming that IEEE signaling NaNs may generate user-visible
5154 traps during floating-point operations.  Setting this option disables
5155 optimizations that may change the number of exceptions visible with
5156 signaling NaNs.  This option implies @option{-ftrapping-math}.
5157
5158 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5159 be defined.
5160
5161 The default is @option{-fno-signaling-nans}.
5162
5163 This option is experimental and does not currently guarantee to
5164 disable all GCC optimizations that affect signaling NaN behavior.
5165
5166 @item -fsingle-precision-constant
5167 @opindex fsingle-precision-constant
5168 Treat floating point constant as single precision constant instead of
5169 implicitly converting it to double precision constant.
5170
5171
5172 @end table
5173
5174 The following options control optimizations that may improve
5175 performance, but are not enabled by any @option{-O} options.  This
5176 section includes experimental options that may produce broken code.
5177
5178 @table @gcctabopt
5179 @item -fbranch-probabilities
5180 @opindex fbranch-probabilities
5181 After running a program compiled with @option{-fprofile-arcs}
5182 (@pxref{Debugging Options,, Options for Debugging Your Program or
5183 @command{gcc}}), you can compile it a second time using
5184 @option{-fbranch-probabilities}, to improve optimizations based on
5185 the number of times each branch was taken.  When the program
5186 compiled with @option{-fprofile-arcs} exits it saves arc execution
5187 counts to a file called @file{@var{sourcename}.gcda} for each source
5188 file  The information in this data file is very dependent on the
5189 structure of the generated code, so you must use the same source code
5190 and the same optimization options for both compilations.
5191
5192 With @option{-fbranch-probabilities}, GCC puts a
5193 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5194 These can be used to improve optimization.  Currently, they are only
5195 used in one place: in @file{reorg.c}, instead of guessing which path a
5196 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5197 exactly determine which path is taken more often.
5198
5199 @item -fprofile-values
5200 @opindex fprofile-values
5201 If combined with @option{-fprofile-arcs}, it adds code so that some
5202 data about values of expressions in the program is gathered.
5203
5204 With @option{-fbranch-probabilities}, it reads back the data gathered
5205 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5206 notes to instructions for their later usage in optimizations.
5207
5208 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5209
5210 @item -fvpt
5211 @opindex fvpt
5212 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5213 a code to gather information about values of expressions.
5214
5215 With @option{-fbranch-probabilities}, it reads back the data gathered
5216 and actually performs the optimizations based on them.
5217 Currently the optimizations include specialization of division operation
5218 using the knowledge about the value of the denominator.
5219
5220 @item -fspeculative-prefetching
5221 @opindex fspeculative-prefetching
5222 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5223 a code to gather information about addresses of memory references in the
5224 program.
5225
5226 With @option{-fbranch-probabilities}, it reads back the data gathered
5227 and issues prefetch instructions according to them.  In addition to the opportunities
5228 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5229 memory access patterns---for example accesses to the data stored in linked
5230 list whose elements are usually allocated sequentially.
5231
5232 In order to prevent issuing double prefetches, usage of
5233 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5234
5235 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5236
5237 @item -frename-registers
5238 @opindex frename-registers
5239 Attempt to avoid false dependencies in scheduled code by making use
5240 of registers left over after register allocation.  This optimization
5241 will most benefit processors with lots of registers.  Depending on the
5242 debug information format adopted by the target, however, it can
5243 make debugging impossible, since variables will no longer stay in
5244 a ``home register''.
5245
5246 Not enabled by default at any level because it has known bugs.
5247
5248 @item -ftracer
5249 @opindex ftracer
5250 Perform tail duplication to enlarge superblock size.  This transformation
5251 simplifies the control flow of the function allowing other optimizations to do
5252 better job.
5253
5254 Enabled with @option{-fprofile-use}.
5255
5256 @item -funroll-loops
5257 @opindex funroll-loops
5258 Unroll loops whose number of iterations can be determined at compile time or
5259 upon entry to the loop.  @option{-funroll-loops} implies
5260 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5261 (i.e.@: complete removal of loops with small constant number of iterations).
5262 This option makes code larger, and may or may not make it run faster.
5263
5264 Enabled with @option{-fprofile-use}.
5265
5266 @item -funroll-all-loops
5267 @opindex funroll-all-loops
5268 Unroll all loops, even if their number of iterations is uncertain when
5269 the loop is entered.  This usually makes programs run more slowly.
5270 @option{-funroll-all-loops} implies the same options as
5271 @option{-funroll-loops}.
5272
5273 @item -fpeel-loops
5274 @opindex fpeel-loops
5275 Peels the loops for that there is enough information that they do not
5276 roll much (from profile feedback).  It also turns on complete loop peeling
5277 (i.e.@: complete removal of loops with small constant number of iterations).
5278
5279 Enabled with @option{-fprofile-use}.
5280
5281 @item -fmove-loop-invariants
5282 @opindex fmove-loop-invariants
5283 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5284 at level @option{-O1}
5285
5286 @item -funswitch-loops
5287 @opindex funswitch-loops
5288 Move branches with loop invariant conditions out of the loop, with duplicates
5289 of the loop on both branches (modified according to result of the condition).
5290
5291 @item -fprefetch-loop-arrays
5292 @opindex fprefetch-loop-arrays
5293 If supported by the target machine, generate instructions to prefetch
5294 memory to improve the performance of loops that access large arrays.
5295
5296 Disabled at level @option{-Os}.
5297
5298 @item -ffunction-sections
5299 @itemx -fdata-sections
5300 @opindex ffunction-sections
5301 @opindex fdata-sections
5302 Place each function or data item into its own section in the output
5303 file if the target supports arbitrary sections.  The name of the
5304 function or the name of the data item determines the section's name
5305 in the output file.
5306
5307 Use these options on systems where the linker can perform optimizations
5308 to improve locality of reference in the instruction space.  Most systems
5309 using the ELF object format and SPARC processors running Solaris 2 have
5310 linkers with such optimizations.  AIX may have these optimizations in
5311 the future.
5312
5313 Only use these options when there are significant benefits from doing
5314 so.  When you specify these options, the assembler and linker will
5315 create larger object and executable files and will also be slower.
5316 You will not be able to use @code{gprof} on all systems if you
5317 specify this option and you may have problems with debugging if
5318 you specify both this option and @option{-g}.
5319
5320 @item -fbranch-target-load-optimize
5321 @opindex fbranch-target-load-optimize
5322 Perform branch target register load optimization before prologue / epilogue
5323 threading.
5324 The use of target registers can typically be exposed only during reload,
5325 thus hoisting loads out of loops and doing inter-block scheduling needs
5326 a separate optimization pass.
5327
5328 @item -fbranch-target-load-optimize2
5329 @opindex fbranch-target-load-optimize2
5330 Perform branch target register load optimization after prologue / epilogue
5331 threading.
5332
5333 @item -fbtr-bb-exclusive
5334 @opindex fbtr-bb-exclusive
5335 When performing branch target register load optimization, don't reuse
5336 branch target registers in within any basic block.
5337
5338 @item --param @var{name}=@var{value}
5339 @opindex param
5340 In some places, GCC uses various constants to control the amount of
5341 optimization that is done.  For example, GCC will not inline functions
5342 that contain more that a certain number of instructions.  You can
5343 control some of these constants on the command-line using the
5344 @option{--param} option.
5345
5346 The names of specific parameters, and the meaning of the values, are
5347 tied to the internals of the compiler, and are subject to change
5348 without notice in future releases.
5349
5350 In each case, the @var{value} is an integer.  The allowable choices for
5351 @var{name} are given in the following table:
5352
5353 @table @gcctabopt
5354 @item sra-max-structure-size
5355 The maximum structure size, in bytes, at which the scalar replacement
5356 of aggregates (SRA) optimization will perform block copies.  The
5357 default value, 0, implies that GCC will select the most appropriate
5358 size itself.
5359
5360 @item sra-field-structure-ratio
5361 The threshold ratio (as a percentage) between instantiated fields and
5362 the complete structure size.  We say that if the ratio of the number
5363 of bytes in instantiated fields to the number of bytes in the complete
5364 structure exceeds this parameter, then block copies are not used.  The
5365 default is 75.
5366
5367 @item max-crossjump-edges
5368 The maximum number of incoming edges to consider for crossjumping.
5369 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5370 the number of edges incoming to each block.  Increasing values mean
5371 more aggressive optimization, making the compile time increase with
5372 probably small improvement in executable size.
5373
5374 @item min-crossjump-insns
5375 The minimum number of instructions which must be matched at the end
5376 of two blocks before crossjumping will be performed on them.  This
5377 value is ignored in the case where all instructions in the block being
5378 crossjumped from are matched.  The default value is 5.
5379
5380 @item max-goto-duplication-insns
5381 The maximum number of instructions to duplicate to a block that jumps
5382 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5383 passes, GCC factors computed gotos early in the compilation process,
5384 and unfactors them as late as possible.  Only computed jumps at the
5385 end of a basic blocks with no more than max-goto-duplication-insns are
5386 unfactored.  The default value is 8.
5387
5388 @item max-delay-slot-insn-search
5389 The maximum number of instructions to consider when looking for an
5390 instruction to fill a delay slot.  If more than this arbitrary number of
5391 instructions is searched, the time savings from filling the delay slot
5392 will be minimal so stop searching.  Increasing values mean more
5393 aggressive optimization, making the compile time increase with probably
5394 small improvement in executable run time.
5395
5396 @item max-delay-slot-live-search
5397 When trying to fill delay slots, the maximum number of instructions to
5398 consider when searching for a block with valid live register
5399 information.  Increasing this arbitrarily chosen value means more
5400 aggressive optimization, increasing the compile time.  This parameter
5401 should be removed when the delay slot code is rewritten to maintain the
5402 control-flow graph.
5403
5404 @item max-gcse-memory
5405 The approximate maximum amount of memory that will be allocated in
5406 order to perform the global common subexpression elimination
5407 optimization.  If more memory than specified is required, the
5408 optimization will not be done.
5409
5410 @item max-gcse-passes
5411 The maximum number of passes of GCSE to run.  The default is 1.
5412
5413 @item max-pending-list-length
5414 The maximum number of pending dependencies scheduling will allow
5415 before flushing the current state and starting over.  Large functions
5416 with few branches or calls can create excessively large lists which
5417 needlessly consume memory and resources.
5418
5419 @item max-inline-insns-single
5420 Several parameters control the tree inliner used in gcc.
5421 This number sets the maximum number of instructions (counted in GCC's
5422 internal representation) in a single function that the tree inliner
5423 will consider for inlining.  This only affects functions declared
5424 inline and methods implemented in a class declaration (C++).
5425 The default value is 500.
5426
5427 @item max-inline-insns-auto
5428 When you use @option{-finline-functions} (included in @option{-O3}),
5429 a lot of functions that would otherwise not be considered for inlining
5430 by the compiler will be investigated.  To those functions, a different
5431 (more restrictive) limit compared to functions declared inline can
5432 be applied.
5433 The default value is 120.
5434
5435 @item large-function-insns
5436 The limit specifying really large functions.  For functions larger than this
5437 limit after inlining inlining is constrained by
5438 @option{--param large-function-growth}.  This parameter is useful primarily
5439 to avoid extreme compilation time caused by non-linear algorithms used by the
5440 backend.
5441 This parameter is ignored when @option{-funit-at-a-time} is not used.
5442 The default value is 3000.
5443
5444 @item large-function-growth
5445 Specifies maximal growth of large function caused by inlining in percents.
5446 This parameter is ignored when @option{-funit-at-a-time} is not used.
5447 The default value is 100 which limits large function growth to 2.0 times
5448 the original size.
5449
5450 @item inline-unit-growth
5451 Specifies maximal overall growth of the compilation unit caused by inlining.
5452 This parameter is ignored when @option{-funit-at-a-time} is not used.
5453 The default value is 50 which limits unit growth to 1.5 times the original
5454 size.
5455
5456 @item max-inline-insns-recursive
5457 @itemx max-inline-insns-recursive-auto
5458 Specifies maximum number of instructions out-of-line copy of self recursive inline
5459 function can grow into by performing recursive inlining.
5460
5461 For functions declared inline @option{--param max-inline-insns-recursive} is
5462 taken into acount.  For function not declared inline, recursive inlining
5463 happens only when @option{-finline-functions} (included in @option{-O3}) is
5464 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5465 default value is 500.
5466
5467 @item max-inline-recursive-depth
5468 @itemx max-inline-recursive-depth-auto
5469 Specifies maximum recursion depth used by the recursive inlining.
5470
5471 For functions declared inline @option{--param max-inline-recursive-depth} is
5472 taken into acount.  For function not declared inline, recursive inlining
5473 happens only when @option{-finline-functions} (included in @option{-O3}) is
5474 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5475 default value is 500.
5476
5477 @item max-unrolled-insns
5478 The maximum number of instructions that a loop should have if that loop
5479 is unrolled, and if the loop is unrolled, it determines how many times
5480 the loop code is unrolled.
5481
5482 @item max-average-unrolled-insns
5483 The maximum number of instructions biased by probabilities of their execution
5484 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5485 it determines how many times the loop code is unrolled.
5486
5487 @item max-unroll-times
5488 The maximum number of unrollings of a single loop.
5489
5490 @item max-peeled-insns
5491 The maximum number of instructions that a loop should have if that loop
5492 is peeled, and if the loop is peeled, it determines how many times
5493 the loop code is peeled.
5494
5495 @item max-peel-times
5496 The maximum number of peelings of a single loop.
5497
5498 @item max-completely-peeled-insns
5499 The maximum number of insns of a completely peeled loop.
5500
5501 @item max-completely-peel-times
5502 The maximum number of iterations of a loop to be suitable for complete peeling.
5503
5504 @item max-unswitch-insns
5505 The maximum number of insns of an unswitched loop.
5506
5507 @item max-unswitch-level
5508 The maximum number of branches unswitched in a single loop.
5509
5510 @item lim-expensive
5511 The minimum cost of an expensive expression in the loop invariant motion.
5512
5513 @item iv-consider-all-candidates-bound
5514 Bound on number of candidates for induction variables below that
5515 all candidates are considered for each use in induction variable
5516 optimizations.  Only the most relevant candidates are considered
5517 if there are more candidates, to avoid quadratic time complexity.
5518
5519 @item iv-max-considered-uses
5520 The induction variable optimizations give up on loops that contain more
5521 induction variable uses.
5522
5523 @item iv-always-prune-cand-set-bound
5524 If number of candidates in the set is smaller than this value,
5525 we always try to remove unnecessary ivs from the set during its
5526 optimization when a new iv is added to the set.
5527
5528 @item max-iterations-to-track
5529
5530 The maximum number of iterations of a loop the brute force algorithm
5531 for analysis of # of iterations of the loop tries to evaluate.
5532
5533 @item hot-bb-count-fraction
5534 Select fraction of the maximal count of repetitions of basic block in program
5535 given basic block needs to have to be considered hot.
5536
5537 @item hot-bb-frequency-fraction
5538 Select fraction of the maximal frequency of executions of basic block in
5539 function given basic block needs to have to be considered hot
5540
5541 @item tracer-dynamic-coverage
5542 @itemx tracer-dynamic-coverage-feedback
5543
5544 This value is used to limit superblock formation once the given percentage of
5545 executed instructions is covered.  This limits unnecessary code size
5546 expansion.
5547
5548 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5549 feedback is available.  The real profiles (as opposed to statically estimated
5550 ones) are much less balanced allowing the threshold to be larger value.
5551
5552 @item tracer-max-code-growth
5553 Stop tail duplication once code growth has reached given percentage.  This is
5554 rather hokey argument, as most of the duplicates will be eliminated later in
5555 cross jumping, so it may be set to much higher values than is the desired code
5556 growth.
5557
5558 @item tracer-min-branch-ratio
5559
5560 Stop reverse growth when the reverse probability of best edge is less than this
5561 threshold (in percent).
5562
5563 @item tracer-min-branch-ratio
5564 @itemx tracer-min-branch-ratio-feedback
5565
5566 Stop forward growth if the best edge do have probability lower than this
5567 threshold.
5568
5569 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5570 compilation for profile feedback and one for compilation without.  The value
5571 for compilation with profile feedback needs to be more conservative (higher) in
5572 order to make tracer effective.
5573
5574 @item max-cse-path-length
5575
5576 Maximum number of basic blocks on path that cse considers.  The default is 10.
5577
5578 @item global-var-threshold
5579
5580 Counts the number of function calls (@var{n}) and the number of
5581 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5582 single artificial variable will be created to represent all the
5583 call-clobbered variables at function call sites.  This artificial
5584 variable will then be made to alias every call-clobbered variable.
5585 (done as @code{int * size_t} on the host machine; beware overflow).
5586
5587 @item max-aliased-vops
5588
5589 Maximum number of virtual operands allowed to represent aliases
5590 before triggering the alias grouping heuristic.  Alias grouping
5591 reduces compile times and memory consumption needed for aliasing at
5592 the expense of precision loss in alias information.
5593
5594 @item ggc-min-expand
5595
5596 GCC uses a garbage collector to manage its own memory allocation.  This
5597 parameter specifies the minimum percentage by which the garbage
5598 collector's heap should be allowed to expand between collections.
5599 Tuning this may improve compilation speed; it has no effect on code
5600 generation.
5601
5602 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5603 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5604 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5605 GCC is not able to calculate RAM on a particular platform, the lower
5606 bound of 30% is used.  Setting this parameter and
5607 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5608 every opportunity.  This is extremely slow, but can be useful for
5609 debugging.
5610
5611 @item ggc-min-heapsize
5612
5613 Minimum size of the garbage collector's heap before it begins bothering
5614 to collect garbage.  The first collection occurs after the heap expands
5615 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5616 tuning this may improve compilation speed, and has no effect on code
5617 generation.
5618
5619 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5620 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5621 with a lower bound of 4096 (four megabytes) and an upper bound of
5622 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5623 particular platform, the lower bound is used.  Setting this parameter
5624 very large effectively disables garbage collection.  Setting this
5625 parameter and @option{ggc-min-expand} to zero causes a full collection
5626 to occur at every opportunity.
5627
5628 @item max-reload-search-insns
5629 The maximum number of instruction reload should look backward for equivalent
5630 register.  Increasing values mean more aggressive optimization, making the
5631 compile time increase with probably slightly better performance.  The default
5632 value is 100.
5633
5634 @item max-cselib-memory-location
5635 The maximum number of memory locations cselib should take into acount.
5636 Increasing values mean more aggressive optimization, making the compile time
5637 increase with probably slightly better performance.  The default value is 500.
5638
5639 @item reorder-blocks-duplicate
5640 @itemx reorder-blocks-duplicate-feedback
5641
5642 Used by basic block reordering pass to decide whether to use unconditional
5643 branch or duplicate the code on its destination.  Code is duplicated when its
5644 estimated size is smaller than this value multiplied by the estimated size of
5645 unconditional jump in the hot spots of the program.
5646
5647 The @option{reorder-block-duplicate-feedback} is used only when profile
5648 feedback is available and may be set to higher values than
5649 @option{reorder-block-duplicate} since information about the hot spots is more
5650 accurate.
5651
5652 @item max-sched-region-blocks
5653 The maximum number of blocks in a region to be considered for
5654 interblock scheduling.  The default value is 10.
5655
5656 @item max-sched-region-insns
5657 The maximum number of insns in a region to be considered for
5658 interblock scheduling.  The default value is 100.
5659
5660 @item max-last-value-rtl
5661
5662 The maximum size measured as number of RTLs that can be recorded in an expression
5663 in combiner for a pseudo register as last known value of that register.  The default
5664 is 10000.
5665
5666 @item integer-share-limit
5667 Small integer constants can use a shared data structure, reducing the
5668 compiler's memory usage and increasing its speed.  This sets the maximum
5669 value of a shared integer constant's.  The default value is 256.
5670
5671 @end table
5672 @end table
5673
5674 @node Preprocessor Options
5675 @section Options Controlling the Preprocessor
5676 @cindex preprocessor options
5677 @cindex options, preprocessor
5678
5679 These options control the C preprocessor, which is run on each C source
5680 file before actual compilation.
5681
5682 If you use the @option{-E} option, nothing is done except preprocessing.
5683 Some of these options make sense only together with @option{-E} because
5684 they cause the preprocessor output to be unsuitable for actual
5685 compilation.
5686
5687 @table @gcctabopt
5688 @opindex Wp
5689 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5690 and pass @var{option} directly through to the preprocessor.  If
5691 @var{option} contains commas, it is split into multiple options at the
5692 commas.  However, many options are modified, translated or interpreted
5693 by the compiler driver before being passed to the preprocessor, and
5694 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5695 interface is undocumented and subject to change, so whenever possible
5696 you should avoid using @option{-Wp} and let the driver handle the
5697 options instead.
5698
5699 @item -Xpreprocessor @var{option}
5700 @opindex preprocessor
5701 Pass @var{option} as an option to the preprocessor.  You can use this to
5702 supply system-specific preprocessor options which GCC does not know how to
5703 recognize.
5704
5705 If you want to pass an option that takes an argument, you must use
5706 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5707 @end table
5708
5709 @include cppopts.texi
5710
5711 @node Assembler Options
5712 @section Passing Options to the Assembler
5713
5714 @c prevent bad page break with this line
5715 You can pass options to the assembler.
5716
5717 @table @gcctabopt
5718 @item -Wa,@var{option}
5719 @opindex Wa
5720 Pass @var{option} as an option to the assembler.  If @var{option}
5721 contains commas, it is split into multiple options at the commas.
5722
5723 @item -Xassembler @var{option}
5724 @opindex Xassembler
5725 Pass @var{option} as an option to the assembler.  You can use this to
5726 supply system-specific assembler options which GCC does not know how to
5727 recognize.
5728
5729 If you want to pass an option that takes an argument, you must use
5730 @option{-Xassembler} twice, once for the option and once for the argument.
5731
5732 @end table
5733
5734 @node Link Options
5735 @section Options for Linking
5736 @cindex link options
5737 @cindex options, linking
5738
5739 These options come into play when the compiler links object files into
5740 an executable output file.  They are meaningless if the compiler is
5741 not doing a link step.
5742
5743 @table @gcctabopt
5744 @cindex file names
5745 @item @var{object-file-name}
5746 A file name that does not end in a special recognized suffix is
5747 considered to name an object file or library.  (Object files are
5748 distinguished from libraries by the linker according to the file
5749 contents.)  If linking is done, these object files are used as input
5750 to the linker.
5751
5752 @item -c
5753 @itemx -S
5754 @itemx -E
5755 @opindex c
5756 @opindex S
5757 @opindex E
5758 If any of these options is used, then the linker is not run, and
5759 object file names should not be used as arguments.  @xref{Overall
5760 Options}.
5761
5762 @cindex Libraries
5763 @item -l@var{library}
5764 @itemx -l @var{library}
5765 @opindex l
5766 Search the library named @var{library} when linking.  (The second
5767 alternative with the library as a separate argument is only for
5768 POSIX compliance and is not recommended.)
5769
5770 It makes a difference where in the command you write this option; the
5771 linker searches and processes libraries and object files in the order they
5772 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5773 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5774 to functions in @samp{z}, those functions may not be loaded.
5775
5776 The linker searches a standard list of directories for the library,
5777 which is actually a file named @file{lib@var{library}.a}.  The linker
5778 then uses this file as if it had been specified precisely by name.
5779
5780 The directories searched include several standard system directories
5781 plus any that you specify with @option{-L}.
5782
5783 Normally the files found this way are library files---archive files
5784 whose members are object files.  The linker handles an archive file by
5785 scanning through it for members which define symbols that have so far
5786 been referenced but not defined.  But if the file that is found is an
5787 ordinary object file, it is linked in the usual fashion.  The only
5788 difference between using an @option{-l} option and specifying a file name
5789 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5790 and searches several directories.
5791
5792 @item -lobjc
5793 @opindex lobjc
5794 You need this special case of the @option{-l} option in order to
5795 link an Objective-C or Objective-C++ program.
5796
5797 @item -nostartfiles
5798 @opindex nostartfiles
5799 Do not use the standard system startup files when linking.
5800 The standard system libraries are used normally, unless @option{-nostdlib}
5801 or @option{-nodefaultlibs} is used.
5802
5803 @item -nodefaultlibs
5804 @opindex nodefaultlibs
5805 Do not use the standard system libraries when linking.
5806 Only the libraries you specify will be passed to the linker.
5807 The standard startup files are used normally, unless @option{-nostartfiles}
5808 is used.  The compiler may generate calls to @code{memcmp},
5809 @code{memset}, @code{memcpy} and @code{memmove}.
5810 These entries are usually resolved by entries in
5811 libc.  These entry points should be supplied through some other
5812 mechanism when this option is specified.
5813
5814 @item -nostdlib
5815 @opindex nostdlib
5816 Do not use the standard system startup files or libraries when linking.
5817 No startup files and only the libraries you specify will be passed to
5818 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5819 @code{memcpy} and @code{memmove}.
5820 These entries are usually resolved by entries in
5821 libc.  These entry points should be supplied through some other
5822 mechanism when this option is specified.
5823
5824 @cindex @option{-lgcc}, use with @option{-nostdlib}
5825 @cindex @option{-nostdlib} and unresolved references
5826 @cindex unresolved references and @option{-nostdlib}
5827 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5828 @cindex @option{-nodefaultlibs} and unresolved references
5829 @cindex unresolved references and @option{-nodefaultlibs}
5830 One of the standard libraries bypassed by @option{-nostdlib} and
5831 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5832 that GCC uses to overcome shortcomings of particular machines, or special
5833 needs for some languages.
5834 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5835 Collection (GCC) Internals},
5836 for more discussion of @file{libgcc.a}.)
5837 In most cases, you need @file{libgcc.a} even when you want to avoid
5838 other standard libraries.  In other words, when you specify @option{-nostdlib}
5839 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5840 This ensures that you have no unresolved references to internal GCC
5841 library subroutines.  (For example, @samp{__main}, used to ensure C++
5842 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5843 GNU Compiler Collection (GCC) Internals}.)
5844
5845 @item -pie
5846 @opindex pie
5847 Produce a position independent executable on targets which support it.
5848 For predictable results, you must also specify the same set of options
5849 that were used to generate code (@option{-fpie}, @option{-fPIE},
5850 or model suboptions) when you specify this option.
5851
5852 @item -s
5853 @opindex s
5854 Remove all symbol table and relocation information from the executable.
5855
5856 @item -static
5857 @opindex static
5858 On systems that support dynamic linking, this prevents linking with the shared
5859 libraries.  On other systems, this option has no effect.
5860
5861 @item -shared
5862 @opindex shared
5863 Produce a shared object which can then be linked with other objects to
5864 form an executable.  Not all systems support this option.  For predictable
5865 results, you must also specify the same set of options that were used to
5866 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5867 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5868 needs to build supplementary stub code for constructors to work.  On
5869 multi-libbed systems, @samp{gcc -shared} must select the correct support
5870 libraries to link against.  Failing to supply the correct flags may lead
5871 to subtle defects.  Supplying them in cases where they are not necessary
5872 is innocuous.}
5873
5874 @item -shared-libgcc
5875 @itemx -static-libgcc
5876 @opindex shared-libgcc
5877 @opindex static-libgcc
5878 On systems that provide @file{libgcc} as a shared library, these options
5879 force the use of either the shared or static version respectively.
5880 If no shared version of @file{libgcc} was built when the compiler was
5881 configured, these options have no effect.
5882
5883 There are several situations in which an application should use the
5884 shared @file{libgcc} instead of the static version.  The most common
5885 of these is when the application wishes to throw and catch exceptions
5886 across different shared libraries.  In that case, each of the libraries
5887 as well as the application itself should use the shared @file{libgcc}.
5888
5889 Therefore, the G++ and GCJ drivers automatically add
5890 @option{-shared-libgcc} whenever you build a shared library or a main
5891 executable, because C++ and Java programs typically use exceptions, so
5892 this is the right thing to do.
5893
5894 If, instead, you use the GCC driver to create shared libraries, you may
5895 find that they will not always be linked with the shared @file{libgcc}.
5896 If GCC finds, at its configuration time, that you have a non-GNU linker
5897 or a GNU linker that does not support option @option{--eh-frame-hdr},
5898 it will link the shared version of @file{libgcc} into shared libraries
5899 by default.  Otherwise, it will take advantage of the linker and optimize
5900 away the linking with the shared version of @file{libgcc}, linking with
5901 the static version of libgcc by default.  This allows exceptions to
5902 propagate through such shared libraries, without incurring relocation
5903 costs at library load time.
5904
5905 However, if a library or main executable is supposed to throw or catch
5906 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5907 for the languages used in the program, or using the option
5908 @option{-shared-libgcc}, such that it is linked with the shared
5909 @file{libgcc}.
5910
5911 @item -symbolic
5912 @opindex symbolic
5913 Bind references to global symbols when building a shared object.  Warn
5914 about any unresolved references (unless overridden by the link editor
5915 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5916 this option.
5917
5918 @item -Xlinker @var{option}
5919 @opindex Xlinker
5920 Pass @var{option} as an option to the linker.  You can use this to
5921 supply system-specific linker options which GCC does not know how to
5922 recognize.
5923
5924 If you want to pass an option that takes an argument, you must use
5925 @option{-Xlinker} twice, once for the option and once for the argument.
5926 For example, to pass @option{-assert definitions}, you must write
5927 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5928 @option{-Xlinker "-assert definitions"}, because this passes the entire
5929 string as a single argument, which is not what the linker expects.
5930
5931 @item -Wl,@var{option}
5932 @opindex Wl
5933 Pass @var{option} as an option to the linker.  If @var{option} contains
5934 commas, it is split into multiple options at the commas.
5935
5936 @item -u @var{symbol}
5937 @opindex u
5938 Pretend the symbol @var{symbol} is undefined, to force linking of
5939 library modules to define it.  You can use @option{-u} multiple times with
5940 different symbols to force loading of additional library modules.
5941 @end table
5942
5943 @node Directory Options
5944 @section Options for Directory Search
5945 @cindex directory options
5946 @cindex options, directory search
5947 @cindex search path
5948
5949 These options specify directories to search for header files, for
5950 libraries and for parts of the compiler:
5951
5952 @table @gcctabopt
5953 @item -I@var{dir}
5954 @opindex I
5955 Add the directory @var{dir} to the head of the list of directories to be
5956 searched for header files.  This can be used to override a system header
5957 file, substituting your own version, since these directories are
5958 searched before the system header file directories.  However, you should
5959 not use this option to add directories that contain vendor-supplied
5960 system header files (use @option{-isystem} for that).  If you use more than
5961 one @option{-I} option, the directories are scanned in left-to-right
5962 order; the standard system directories come after.
5963
5964 If a standard system include directory, or a directory specified with
5965 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5966 option will be ignored.  The directory will still be searched but as a
5967 system directory at its normal position in the system include chain.
5968 This is to ensure that GCC's procedure to fix buggy system headers and
5969 the ordering for the include_next directive are not inadvertently changed.
5970 If you really need to change the search order for system directories,
5971 use the @option{-nostdinc} and/or @option{-isystem} options.
5972
5973 @item -iquote@var{dir}
5974 @opindex iquote
5975 Add the directory @var{dir} to the head of the list of directories to
5976 be searched for header files only for the case of @samp{#include
5977 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5978 otherwise just like @option{-I}.
5979
5980 @item -L@var{dir}
5981 @opindex L
5982 Add directory @var{dir} to the list of directories to be searched
5983 for @option{-l}.
5984
5985 @item -B@var{prefix}
5986 @opindex B
5987 This option specifies where to find the executables, libraries,
5988 include files, and data files of the compiler itself.
5989
5990 The compiler driver program runs one or more of the subprograms
5991 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5992 @var{prefix} as a prefix for each program it tries to run, both with and
5993 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5994
5995 For each subprogram to be run, the compiler driver first tries the
5996 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5997 was not specified, the driver tries two standard prefixes, which are
5998 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5999 those results in a file name that is found, the unmodified program
6000 name is searched for using the directories specified in your
6001 @env{PATH} environment variable.
6002
6003 The compiler will check to see if the path provided by the @option{-B}
6004 refers to a directory, and if necessary it will add a directory
6005 separator character at the end of the path.
6006
6007 @option{-B} prefixes that effectively specify directory names also apply
6008 to libraries in the linker, because the compiler translates these
6009 options into @option{-L} options for the linker.  They also apply to
6010 includes files in the preprocessor, because the compiler translates these
6011 options into @option{-isystem} options for the preprocessor.  In this case,
6012 the compiler appends @samp{include} to the prefix.
6013
6014 The run-time support file @file{libgcc.a} can also be searched for using
6015 the @option{-B} prefix, if needed.  If it is not found there, the two
6016 standard prefixes above are tried, and that is all.  The file is left
6017 out of the link if it is not found by those means.
6018
6019 Another way to specify a prefix much like the @option{-B} prefix is to use
6020 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6021 Variables}.
6022
6023 As a special kludge, if the path provided by @option{-B} is
6024 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6025 9, then it will be replaced by @file{[dir/]include}.  This is to help
6026 with boot-strapping the compiler.
6027
6028 @item -specs=@var{file}
6029 @opindex specs
6030 Process @var{file} after the compiler reads in the standard @file{specs}
6031 file, in order to override the defaults that the @file{gcc} driver
6032 program uses when determining what switches to pass to @file{cc1},
6033 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6034 @option{-specs=@var{file}} can be specified on the command line, and they
6035 are processed in order, from left to right.
6036
6037 @item -I-
6038 @opindex I-
6039 This option has been deprecated.  Please use @option{-iquote} instead for
6040 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6041 Any directories you specify with @option{-I} options before the @option{-I-}
6042 option are searched only for the case of @samp{#include "@var{file}"};
6043 they are not searched for @samp{#include <@var{file}>}.
6044
6045 If additional directories are specified with @option{-I} options after
6046 the @option{-I-}, these directories are searched for all @samp{#include}
6047 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6048 this way.)
6049
6050 In addition, the @option{-I-} option inhibits the use of the current
6051 directory (where the current input file came from) as the first search
6052 directory for @samp{#include "@var{file}"}.  There is no way to
6053 override this effect of @option{-I-}.  With @option{-I.} you can specify
6054 searching the directory which was current when the compiler was
6055 invoked.  That is not exactly the same as what the preprocessor does
6056 by default, but it is often satisfactory.
6057
6058 @option{-I-} does not inhibit the use of the standard system directories
6059 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6060 independent.
6061 @end table
6062
6063 @c man end
6064
6065 @node Spec Files
6066 @section Specifying subprocesses and the switches to pass to them
6067 @cindex Spec Files
6068
6069 @command{gcc} is a driver program.  It performs its job by invoking a
6070 sequence of other programs to do the work of compiling, assembling and
6071 linking.  GCC interprets its command-line parameters and uses these to
6072 deduce which programs it should invoke, and which command-line options
6073 it ought to place on their command lines.  This behavior is controlled
6074 by @dfn{spec strings}.  In most cases there is one spec string for each
6075 program that GCC can invoke, but a few programs have multiple spec
6076 strings to control their behavior.  The spec strings built into GCC can
6077 be overridden by using the @option{-specs=} command-line switch to specify
6078 a spec file.
6079
6080 @dfn{Spec files} are plaintext files that are used to construct spec
6081 strings.  They consist of a sequence of directives separated by blank
6082 lines.  The type of directive is determined by the first non-whitespace
6083 character on the line and it can be one of the following:
6084
6085 @table @code
6086 @item %@var{command}
6087 Issues a @var{command} to the spec file processor.  The commands that can
6088 appear here are:
6089
6090 @table @code
6091 @item %include <@var{file}>
6092 @cindex %include
6093 Search for @var{file} and insert its text at the current point in the
6094 specs file.
6095
6096 @item %include_noerr <@var{file}>
6097 @cindex %include_noerr
6098 Just like @samp{%include}, but do not generate an error message if the include
6099 file cannot be found.
6100
6101 @item %rename @var{old_name} @var{new_name}
6102 @cindex %rename
6103 Rename the spec string @var{old_name} to @var{new_name}.
6104
6105 @end table
6106
6107 @item *[@var{spec_name}]:
6108 This tells the compiler to create, override or delete the named spec
6109 string.  All lines after this directive up to the next directive or
6110 blank line are considered to be the text for the spec string.  If this
6111 results in an empty string then the spec will be deleted.  (Or, if the
6112 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6113 does not currently exist a new spec will be created.  If the spec does
6114 exist then its contents will be overridden by the text of this
6115 directive, unless the first character of that text is the @samp{+}
6116 character, in which case the text will be appended to the spec.
6117
6118 @item [@var{suffix}]:
6119 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6120 and up to the next directive or blank line are considered to make up the
6121 spec string for the indicated suffix.  When the compiler encounters an
6122 input file with the named suffix, it will processes the spec string in
6123 order to work out how to compile that file.  For example:
6124
6125 @smallexample
6126 .ZZ:
6127 z-compile -input %i
6128 @end smallexample
6129
6130 This says that any input file whose name ends in @samp{.ZZ} should be
6131 passed to the program @samp{z-compile}, which should be invoked with the
6132 command-line switch @option{-input} and with the result of performing the
6133 @samp{%i} substitution.  (See below.)
6134
6135 As an alternative to providing a spec string, the text that follows a
6136 suffix directive can be one of the following:
6137
6138 @table @code
6139 @item @@@var{language}
6140 This says that the suffix is an alias for a known @var{language}.  This is
6141 similar to using the @option{-x} command-line switch to GCC to specify a
6142 language explicitly.  For example:
6143
6144 @smallexample
6145 .ZZ:
6146 @@c++
6147 @end smallexample
6148
6149 Says that .ZZ files are, in fact, C++ source files.
6150
6151 @item #@var{name}
6152 This causes an error messages saying:
6153
6154 @smallexample
6155 @var{name} compiler not installed on this system.
6156 @end smallexample
6157 @end table
6158
6159 GCC already has an extensive list of suffixes built into it.
6160 This directive will add an entry to the end of the list of suffixes, but
6161 since the list is searched from the end backwards, it is effectively
6162 possible to override earlier entries using this technique.
6163
6164 @end table
6165
6166 GCC has the following spec strings built into it.  Spec files can
6167 override these strings or create their own.  Note that individual
6168 targets can also add their own spec strings to this list.
6169
6170 @smallexample
6171 asm          Options to pass to the assembler
6172 asm_final    Options to pass to the assembler post-processor
6173 cpp          Options to pass to the C preprocessor
6174 cc1          Options to pass to the C compiler
6175 cc1plus      Options to pass to the C++ compiler
6176 endfile      Object files to include at the end of the link
6177 link         Options to pass to the linker
6178 lib          Libraries to include on the command line to the linker
6179 libgcc       Decides which GCC support library to pass to the linker
6180 linker       Sets the name of the linker
6181 predefines   Defines to be passed to the C preprocessor
6182 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6183              by default
6184 startfile    Object files to include at the start of the link
6185 @end smallexample
6186
6187 Here is a small example of a spec file:
6188
6189 @smallexample
6190 %rename lib                 old_lib
6191
6192 *lib:
6193 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6194 @end smallexample
6195
6196 This example renames the spec called @samp{lib} to @samp{old_lib} and
6197 then overrides the previous definition of @samp{lib} with a new one.
6198 The new definition adds in some extra command-line options before
6199 including the text of the old definition.
6200
6201 @dfn{Spec strings} are a list of command-line options to be passed to their
6202 corresponding program.  In addition, the spec strings can contain
6203 @samp{%}-prefixed sequences to substitute variable text or to
6204 conditionally insert text into the command line.  Using these constructs
6205 it is possible to generate quite complex command lines.
6206
6207 Here is a table of all defined @samp{%}-sequences for spec
6208 strings.  Note that spaces are not generated automatically around the
6209 results of expanding these sequences.  Therefore you can concatenate them
6210 together or combine them with constant text in a single argument.
6211
6212 @table @code
6213 @item %%
6214 Substitute one @samp{%} into the program name or argument.
6215
6216 @item %i
6217 Substitute the name of the input file being processed.
6218
6219 @item %b
6220 Substitute the basename of the input file being processed.
6221 This is the substring up to (and not including) the last period
6222 and not including the directory.
6223
6224 @item %B
6225 This is the same as @samp{%b}, but include the file suffix (text after
6226 the last period).
6227
6228 @item %d
6229 Marks the argument containing or following the @samp{%d} as a
6230 temporary file name, so that that file will be deleted if GCC exits
6231 successfully.  Unlike @samp{%g}, this contributes no text to the
6232 argument.
6233
6234 @item %g@var{suffix}
6235 Substitute a file name that has suffix @var{suffix} and is chosen
6236 once per compilation, and mark the argument in the same way as
6237 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6238 name is now chosen in a way that is hard to predict even when previously
6239 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6240 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6241 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6242 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6243 was simply substituted with a file name chosen once per compilation,
6244 without regard to any appended suffix (which was therefore treated
6245 just like ordinary text), making such attacks more likely to succeed.
6246
6247 @item %u@var{suffix}
6248 Like @samp{%g}, but generates a new temporary file name even if
6249 @samp{%u@var{suffix}} was already seen.
6250
6251 @item %U@var{suffix}
6252 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6253 new one if there is no such last file name.  In the absence of any
6254 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6255 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6256 would involve the generation of two distinct file names, one
6257 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6258 simply substituted with a file name chosen for the previous @samp{%u},
6259 without regard to any appended suffix.
6260
6261 @item %j@var{suffix}
6262 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6263 writable, and if save-temps is off; otherwise, substitute the name
6264 of a temporary file, just like @samp{%u}.  This temporary file is not
6265 meant for communication between processes, but rather as a junk
6266 disposal mechanism.
6267
6268 @item %|@var{suffix}
6269 @itemx %m@var{suffix}
6270 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6271 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6272 all.  These are the two most common ways to instruct a program that it
6273 should read from standard input or write to standard output.  If you
6274 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6275 construct: see for example @file{f/lang-specs.h}.
6276
6277 @item %.@var{SUFFIX}
6278 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6279 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6280 terminated by the next space or %.
6281
6282 @item %w
6283 Marks the argument containing or following the @samp{%w} as the
6284 designated output file of this compilation.  This puts the argument
6285 into the sequence of arguments that @samp{%o} will substitute later.
6286
6287 @item %o
6288 Substitutes the names of all the output files, with spaces
6289 automatically placed around them.  You should write spaces
6290 around the @samp{%o} as well or the results are undefined.
6291 @samp{%o} is for use in the specs for running the linker.
6292 Input files whose names have no recognized suffix are not compiled
6293 at all, but they are included among the output files, so they will
6294 be linked.
6295
6296 @item %O
6297 Substitutes the suffix for object files.  Note that this is
6298 handled specially when it immediately follows @samp{%g, %u, or %U},
6299 because of the need for those to form complete file names.  The
6300 handling is such that @samp{%O} is treated exactly as if it had already
6301 been substituted, except that @samp{%g, %u, and %U} do not currently
6302 support additional @var{suffix} characters following @samp{%O} as they would
6303 following, for example, @samp{.o}.
6304
6305 @item %p
6306 Substitutes the standard macro predefinitions for the
6307 current target machine.  Use this when running @code{cpp}.
6308
6309 @item %P
6310 Like @samp{%p}, but puts @samp{__} before and after the name of each
6311 predefined macro, except for macros that start with @samp{__} or with
6312 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6313 C@.
6314
6315 @item %I
6316 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6317 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6318 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6319 as necessary.
6320
6321 @item %s
6322 Current argument is the name of a library or startup file of some sort.
6323 Search for that file in a standard list of directories and substitute
6324 the full name found.
6325
6326 @item %e@var{str}
6327 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6328 Use this when inconsistent options are detected.
6329
6330 @item %(@var{name})
6331 Substitute the contents of spec string @var{name} at this point.
6332
6333 @item %[@var{name}]
6334 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6335
6336 @item %x@{@var{option}@}
6337 Accumulate an option for @samp{%X}.
6338
6339 @item %X
6340 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6341 spec string.
6342
6343 @item %Y
6344 Output the accumulated assembler options specified by @option{-Wa}.
6345
6346 @item %Z
6347 Output the accumulated preprocessor options specified by @option{-Wp}.
6348
6349 @item %a
6350 Process the @code{asm} spec.  This is used to compute the
6351 switches to be passed to the assembler.
6352
6353 @item %A
6354 Process the @code{asm_final} spec.  This is a spec string for
6355 passing switches to an assembler post-processor, if such a program is
6356 needed.
6357
6358 @item %l
6359 Process the @code{link} spec.  This is the spec for computing the
6360 command line passed to the linker.  Typically it will make use of the
6361 @samp{%L %G %S %D and %E} sequences.
6362
6363 @item %D
6364 Dump out a @option{-L} option for each directory that GCC believes might
6365 contain startup files.  If the target supports multilibs then the
6366 current multilib directory will be prepended to each of these paths.
6367
6368 @item %M
6369 Output the multilib directory with directory separators replaced with
6370 @samp{_}.  If multilib directories are not set, or the multilib directory is
6371 @file{.} then this option emits nothing.
6372
6373 @item %L
6374 Process the @code{lib} spec.  This is a spec string for deciding which
6375 libraries should be included on the command line to the linker.
6376
6377 @item %G
6378 Process the @code{libgcc} spec.  This is a spec string for deciding
6379 which GCC support library should be included on the command line to the linker.
6380
6381 @item %S
6382 Process the @code{startfile} spec.  This is a spec for deciding which
6383 object files should be the first ones passed to the linker.  Typically
6384 this might be a file named @file{crt0.o}.
6385
6386 @item %E
6387 Process the @code{endfile} spec.  This is a spec string that specifies
6388 the last object files that will be passed to the linker.
6389
6390 @item %C
6391 Process the @code{cpp} spec.  This is used to construct the arguments
6392 to be passed to the C preprocessor.
6393
6394 @item %1
6395 Process the @code{cc1} spec.  This is used to construct the options to be
6396 passed to the actual C compiler (@samp{cc1}).
6397
6398 @item %2
6399 Process the @code{cc1plus} spec.  This is used to construct the options to be
6400 passed to the actual C++ compiler (@samp{cc1plus}).
6401
6402 @item %*
6403 Substitute the variable part of a matched option.  See below.
6404 Note that each comma in the substituted string is replaced by
6405 a single space.
6406
6407 @item %<@code{S}
6408 Remove all occurrences of @code{-S} from the command line.  Note---this
6409 command is position dependent.  @samp{%} commands in the spec string
6410 before this one will see @code{-S}, @samp{%} commands in the spec string
6411 after this one will not.
6412
6413 @item %:@var{function}(@var{args})
6414 Call the named function @var{function}, passing it @var{args}.
6415 @var{args} is first processed as a nested spec string, then split
6416 into an argument vector in the usual fashion.  The function returns
6417 a string which is processed as if it had appeared literally as part
6418 of the current spec.
6419
6420 The following built-in spec functions are provided:
6421
6422 @table @code
6423 @item @code{if-exists}
6424 The @code{if-exists} spec function takes one argument, an absolute
6425 pathname to a file.  If the file exists, @code{if-exists} returns the
6426 pathname.  Here is a small example of its usage:
6427
6428 @smallexample
6429 *startfile:
6430 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6431 @end smallexample
6432
6433 @item @code{if-exists-else}
6434 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6435 spec function, except that it takes two arguments.  The first argument is
6436 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6437 returns the pathname.  If it does not exist, it returns the second argument.
6438 This way, @code{if-exists-else} can be used to select one file or another,
6439 based on the existence of the first.  Here is a small example of its usage:
6440
6441 @smallexample
6442 *startfile:
6443 crt0%O%s %:if-exists(crti%O%s) \
6444 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6445 @end smallexample
6446
6447 @item @code{replace-outfile}
6448 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6449 first argument in the outfiles array and replaces it with the second argument.  Here
6450 is a small example of its usage:
6451
6452 @smallexample
6453 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6454 @end smallexample
6455
6456 @end table
6457
6458 @item %@{@code{S}@}
6459 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6460 If that switch was not specified, this substitutes nothing.  Note that
6461 the leading dash is omitted when specifying this option, and it is
6462 automatically inserted if the substitution is performed.  Thus the spec
6463 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6464 and would output the command line option @option{-foo}.
6465
6466 @item %W@{@code{S}@}
6467 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6468 deleted on failure.
6469
6470 @item %@{@code{S}*@}
6471 Substitutes all the switches specified to GCC whose names start
6472 with @code{-S}, but which also take an argument.  This is used for
6473 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6474 GCC considers @option{-o foo} as being
6475 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6476 text, including the space.  Thus two arguments would be generated.
6477
6478 @item %@{@code{S}*&@code{T}*@}
6479 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6480 (the order of @code{S} and @code{T} in the spec is not significant).
6481 There can be any number of ampersand-separated variables; for each the
6482 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6483
6484 @item %@{@code{S}:@code{X}@}
6485 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6486
6487 @item %@{!@code{S}:@code{X}@}
6488 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6489
6490 @item %@{@code{S}*:@code{X}@}
6491 Substitutes @code{X} if one or more switches whose names start with
6492 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6493 once, no matter how many such switches appeared.  However, if @code{%*}
6494 appears somewhere in @code{X}, then @code{X} will be substituted once
6495 for each matching switch, with the @code{%*} replaced by the part of
6496 that switch that matched the @code{*}.
6497
6498 @item %@{.@code{S}:@code{X}@}
6499 Substitutes @code{X}, if processing a file with suffix @code{S}.
6500
6501 @item %@{!.@code{S}:@code{X}@}
6502 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6503
6504 @item %@{@code{S}|@code{P}:@code{X}@}
6505 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6506 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6507 although they have a stronger binding than the @samp{|}.  If @code{%*}
6508 appears in @code{X}, all of the alternatives must be starred, and only
6509 the first matching alternative is substituted.
6510
6511 For example, a spec string like this:
6512
6513 @smallexample
6514 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6515 @end smallexample
6516
6517 will output the following command-line options from the following input
6518 command-line options:
6519
6520 @smallexample
6521 fred.c        -foo -baz
6522 jim.d         -bar -boggle
6523 -d fred.c     -foo -baz -boggle
6524 -d jim.d      -bar -baz -boggle
6525 @end smallexample
6526
6527 @item %@{S:X; T:Y; :D@}
6528
6529 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6530 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6531 be as many clauses as you need.  This may be combined with @code{.},
6532 @code{!}, @code{|}, and @code{*} as needed.
6533
6534
6535 @end table
6536
6537 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6538 construct may contain other nested @samp{%} constructs or spaces, or
6539 even newlines.  They are processed as usual, as described above.
6540 Trailing white space in @code{X} is ignored.  White space may also
6541 appear anywhere on the left side of the colon in these constructs,
6542 except between @code{.} or @code{*} and the corresponding word.
6543
6544 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6545 handled specifically in these constructs.  If another value of
6546 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6547 @option{-W} switch is found later in the command line, the earlier
6548 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6549 just one letter, which passes all matching options.
6550
6551 The character @samp{|} at the beginning of the predicate text is used to
6552 indicate that a command should be piped to the following command, but
6553 only if @option{-pipe} is specified.
6554
6555 It is built into GCC which switches take arguments and which do not.
6556 (You might think it would be useful to generalize this to allow each
6557 compiler's spec to say which switches take arguments.  But this cannot
6558 be done in a consistent fashion.  GCC cannot even decide which input
6559 files have been specified without knowing which switches take arguments,
6560 and it must know which input files to compile in order to tell which
6561 compilers to run).
6562
6563 GCC also knows implicitly that arguments starting in @option{-l} are to be
6564 treated as compiler output files, and passed to the linker in their
6565 proper position among the other output files.
6566
6567 @c man begin OPTIONS
6568
6569 @node Target Options
6570 @section Specifying Target Machine and Compiler Version
6571 @cindex target options
6572 @cindex cross compiling
6573 @cindex specifying machine version
6574 @cindex specifying compiler version and target machine
6575 @cindex compiler version, specifying
6576 @cindex target machine, specifying
6577
6578 The usual way to run GCC is to run the executable called @file{gcc}, or
6579 @file{<machine>-gcc} when cross-compiling, or
6580 @file{<machine>-gcc-<version>} to run a version other than the one that
6581 was installed last.  Sometimes this is inconvenient, so GCC provides
6582 options that will switch to another cross-compiler or version.
6583
6584 @table @gcctabopt
6585 @item -b @var{machine}
6586 @opindex b
6587 The argument @var{machine} specifies the target machine for compilation.
6588
6589 The value to use for @var{machine} is the same as was specified as the
6590 machine type when configuring GCC as a cross-compiler.  For
6591 example, if a cross-compiler was configured with @samp{configure
6592 i386v}, meaning to compile for an 80386 running System V, then you
6593 would specify @option{-b i386v} to run that cross compiler.
6594
6595 @item -V @var{version}
6596 @opindex V
6597 The argument @var{version} specifies which version of GCC to run.
6598 This is useful when multiple versions are installed.  For example,
6599 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6600 @end table
6601
6602 The @option{-V} and @option{-b} options work by running the
6603 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6604 use them if you can just run that directly.
6605
6606 @node Submodel Options
6607 @section Hardware Models and Configurations
6608 @cindex submodel options
6609 @cindex specifying hardware config
6610 @cindex hardware models and configurations, specifying
6611 @cindex machine dependent options
6612
6613 Earlier we discussed the standard option @option{-b} which chooses among
6614 different installed compilers for completely different target
6615 machines, such as VAX vs.@: 68000 vs.@: 80386.
6616
6617 In addition, each of these target machine types can have its own
6618 special options, starting with @samp{-m}, to choose among various
6619 hardware models or configurations---for example, 68010 vs 68020,
6620 floating coprocessor or none.  A single installed version of the
6621 compiler can compile for any model or configuration, according to the
6622 options specified.
6623
6624 Some configurations of the compiler also support additional special
6625 options, usually for compatibility with other compilers on the same
6626 platform.
6627
6628 These options are defined by the macro @code{TARGET_SWITCHES} in the
6629 machine description.  The default for the options is also defined by
6630 that macro, which enables you to change the defaults.
6631
6632 @c This list is ordered alphanumerically by subsection name.
6633 @c It should be the same order and spelling as these options are listed
6634 @c in Machine Dependent Options
6635
6636 @menu
6637 * ARC Options::
6638 * ARM Options::
6639 * AVR Options::
6640 * CRIS Options::
6641 * Darwin Options::
6642 * DEC Alpha Options::
6643 * DEC Alpha/VMS Options::
6644 * FRV Options::
6645 * H8/300 Options::
6646 * HPPA Options::
6647 * i386 and x86-64 Options::
6648 * IA-64 Options::
6649 * M32R/D Options::
6650 * M680x0 Options::
6651 * M68hc1x Options::
6652 * MCore Options::
6653 * MIPS Options::
6654 * MMIX Options::
6655 * MN10300 Options::
6656 * NS32K Options::
6657 * PDP-11 Options::
6658 * PowerPC Options::
6659 * RS/6000 and PowerPC Options::
6660 * S/390 and zSeries Options::
6661 * SH Options::
6662 * SPARC Options::
6663 * System V Options::
6664 * TMS320C3x/C4x Options::
6665 * V850 Options::
6666 * VAX Options::
6667 * x86-64 Options::
6668 * Xstormy16 Options::
6669 * Xtensa Options::
6670 * zSeries Options::
6671 @end menu
6672
6673 @node ARC Options
6674 @subsection ARC Options
6675 @cindex ARC Options
6676
6677 These options are defined for ARC implementations:
6678
6679 @table @gcctabopt
6680 @item -EL
6681 @opindex EL
6682 Compile code for little endian mode.  This is the default.
6683
6684 @item -EB
6685 @opindex EB
6686 Compile code for big endian mode.
6687
6688 @item -mmangle-cpu
6689 @opindex mmangle-cpu
6690 Prepend the name of the cpu to all public symbol names.
6691 In multiple-processor systems, there are many ARC variants with different
6692 instruction and register set characteristics.  This flag prevents code
6693 compiled for one cpu to be linked with code compiled for another.
6694 No facility exists for handling variants that are ``almost identical''.
6695 This is an all or nothing option.
6696
6697 @item -mcpu=@var{cpu}
6698 @opindex mcpu
6699 Compile code for ARC variant @var{cpu}.
6700 Which variants are supported depend on the configuration.
6701 All variants support @option{-mcpu=base}, this is the default.
6702
6703 @item -mtext=@var{text-section}
6704 @itemx -mdata=@var{data-section}
6705 @itemx -mrodata=@var{readonly-data-section}
6706 @opindex mtext
6707 @opindex mdata
6708 @opindex mrodata
6709 Put functions, data, and readonly data in @var{text-section},
6710 @var{data-section}, and @var{readonly-data-section} respectively
6711 by default.  This can be overridden with the @code{section} attribute.
6712 @xref{Variable Attributes}.
6713
6714 @end table
6715
6716 @node ARM Options
6717 @subsection ARM Options
6718 @cindex ARM options
6719
6720 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6721 architectures:
6722
6723 @table @gcctabopt
6724 @item -mabi=@var{name}
6725 @opindex mabi
6726 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6727 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6728
6729 @item -mapcs-frame
6730 @opindex mapcs-frame
6731 Generate a stack frame that is compliant with the ARM Procedure Call
6732 Standard for all functions, even if this is not strictly necessary for
6733 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6734 with this option will cause the stack frames not to be generated for
6735 leaf functions.  The default is @option{-mno-apcs-frame}.
6736
6737 @item -mapcs
6738 @opindex mapcs
6739 This is a synonym for @option{-mapcs-frame}.
6740
6741 @ignore
6742 @c not currently implemented
6743 @item -mapcs-stack-check
6744 @opindex mapcs-stack-check
6745 Generate code to check the amount of stack space available upon entry to
6746 every function (that actually uses some stack space).  If there is
6747 insufficient space available then either the function
6748 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6749 called, depending upon the amount of stack space required.  The run time
6750 system is required to provide these functions.  The default is
6751 @option{-mno-apcs-stack-check}, since this produces smaller code.
6752
6753 @c not currently implemented
6754 @item -mapcs-float
6755 @opindex mapcs-float
6756 Pass floating point arguments using the float point registers.  This is
6757 one of the variants of the APCS@.  This option is recommended if the
6758 target hardware has a floating point unit or if a lot of floating point
6759 arithmetic is going to be performed by the code.  The default is
6760 @option{-mno-apcs-float}, since integer only code is slightly increased in
6761 size if @option{-mapcs-float} is used.
6762
6763 @c not currently implemented
6764 @item -mapcs-reentrant
6765 @opindex mapcs-reentrant
6766 Generate reentrant, position independent code.  The default is
6767 @option{-mno-apcs-reentrant}.
6768 @end ignore
6769
6770 @item -mthumb-interwork
6771 @opindex mthumb-interwork
6772 Generate code which supports calling between the ARM and Thumb
6773 instruction sets.  Without this option the two instruction sets cannot
6774 be reliably used inside one program.  The default is
6775 @option{-mno-thumb-interwork}, since slightly larger code is generated
6776 when @option{-mthumb-interwork} is specified.
6777
6778 @item -mno-sched-prolog
6779 @opindex mno-sched-prolog
6780 Prevent the reordering of instructions in the function prolog, or the
6781 merging of those instruction with the instructions in the function's
6782 body.  This means that all functions will start with a recognizable set
6783 of instructions (or in fact one of a choice from a small set of
6784 different function prologues), and this information can be used to
6785 locate the start if functions inside an executable piece of code.  The
6786 default is @option{-msched-prolog}.
6787
6788 @item -mhard-float
6789 @opindex mhard-float
6790 Generate output containing floating point instructions.  This is the
6791 default.
6792
6793 @item -msoft-float
6794 @opindex msoft-float
6795 Generate output containing library calls for floating point.
6796 @strong{Warning:} the requisite libraries are not available for all ARM
6797 targets.  Normally the facilities of the machine's usual C compiler are
6798 used, but this cannot be done directly in cross-compilation.  You must make
6799 your own arrangements to provide suitable library functions for
6800 cross-compilation.
6801
6802 @option{-msoft-float} changes the calling convention in the output file;
6803 therefore, it is only useful if you compile @emph{all} of a program with
6804 this option.  In particular, you need to compile @file{libgcc.a}, the
6805 library that comes with GCC, with @option{-msoft-float} in order for
6806 this to work.
6807
6808 @item -mfloat-abi=@var{name}
6809 @opindex mfloat-abi
6810 Specifies which ABI to use for floating point values.  Permissible values
6811 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6812
6813 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6814 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6815 of floating point instructions, but still uses the soft-float calling
6816 conventions.
6817
6818 @item -mlittle-endian
6819 @opindex mlittle-endian
6820 Generate code for a processor running in little-endian mode.  This is
6821 the default for all standard configurations.
6822
6823 @item -mbig-endian
6824 @opindex mbig-endian
6825 Generate code for a processor running in big-endian mode; the default is
6826 to compile code for a little-endian processor.
6827
6828 @item -mwords-little-endian
6829 @opindex mwords-little-endian
6830 This option only applies when generating code for big-endian processors.
6831 Generate code for a little-endian word order but a big-endian byte
6832 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6833 option should only be used if you require compatibility with code for
6834 big-endian ARM processors generated by versions of the compiler prior to
6835 2.8.
6836
6837 @item -mcpu=@var{name}
6838 @opindex mcpu
6839 This specifies the name of the target ARM processor.  GCC uses this name
6840 to determine what kind of instructions it can emit when generating
6841 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6842 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6843 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6844 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6845 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6846 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6847 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6848 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6849 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6850 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6851 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6852 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6853 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6854 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6855 @samp{ep9312}.
6856
6857 @itemx -mtune=@var{name}
6858 @opindex mtune
6859 This option is very similar to the @option{-mcpu=} option, except that
6860 instead of specifying the actual target processor type, and hence
6861 restricting which instructions can be used, it specifies that GCC should
6862 tune the performance of the code as if the target were of the type
6863 specified in this option, but still choosing the instructions that it
6864 will generate based on the cpu specified by a @option{-mcpu=} option.
6865 For some ARM implementations better performance can be obtained by using
6866 this option.
6867
6868 @item -march=@var{name}
6869 @opindex march
6870 This specifies the name of the target ARM architecture.  GCC uses this
6871 name to determine what kind of instructions it can emit when generating
6872 assembly code.  This option can be used in conjunction with or instead
6873 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6874 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6875 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6876 @samp{iwmmxt}, @samp{ep9312}.
6877
6878 @item -mfpu=@var{name}
6879 @itemx -mfpe=@var{number}
6880 @itemx -mfp=@var{number}
6881 @opindex mfpu
6882 @opindex mfpe
6883 @opindex mfp
6884 This specifies what floating point hardware (or hardware emulation) is
6885 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6886 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6887 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6888 with older versions of GCC@.
6889
6890 If @option{-msoft-float} is specified this specifies the format of
6891 floating point values.
6892
6893 @item -mstructure-size-boundary=@var{n}
6894 @opindex mstructure-size-boundary
6895 The size of all structures and unions will be rounded up to a multiple
6896 of the number of bits set by this option.  Permissible values are 8, 32
6897 and 64.  The default value varies for different toolchains.  For the COFF
6898 targeted toolchain the default value is 8.  A value of 64 is only allowed
6899 if the underlying ABI supports it.
6900
6901 Specifying the larger number can produce faster, more efficient code, but
6902 can also increase the size of the program.  Different values are potentially
6903 incompatible.  Code compiled with one value cannot necessarily expect to
6904 work with code or libraries compiled with another value, if they exchange
6905 information using structures or unions.
6906
6907 @item -mabort-on-noreturn
6908 @opindex mabort-on-noreturn
6909 Generate a call to the function @code{abort} at the end of a
6910 @code{noreturn} function.  It will be executed if the function tries to
6911 return.
6912
6913 @item -mlong-calls
6914 @itemx -mno-long-calls
6915 @opindex mlong-calls
6916 @opindex mno-long-calls
6917 Tells the compiler to perform function calls by first loading the
6918 address of the function into a register and then performing a subroutine
6919 call on this register.  This switch is needed if the target function
6920 will lie outside of the 64 megabyte addressing range of the offset based
6921 version of subroutine call instruction.
6922
6923 Even if this switch is enabled, not all function calls will be turned
6924 into long calls.  The heuristic is that static functions, functions
6925 which have the @samp{short-call} attribute, functions that are inside
6926 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6927 definitions have already been compiled within the current compilation
6928 unit, will not be turned into long calls.  The exception to this rule is
6929 that weak function definitions, functions with the @samp{long-call}
6930 attribute or the @samp{section} attribute, and functions that are within
6931 the scope of a @samp{#pragma long_calls} directive, will always be
6932 turned into long calls.
6933
6934 This feature is not enabled by default.  Specifying
6935 @option{-mno-long-calls} will restore the default behavior, as will
6936 placing the function calls within the scope of a @samp{#pragma
6937 long_calls_off} directive.  Note these switches have no effect on how
6938 the compiler generates code to handle function calls via function
6939 pointers.
6940
6941 @item -mnop-fun-dllimport
6942 @opindex mnop-fun-dllimport
6943 Disable support for the @code{dllimport} attribute.
6944
6945 @item -msingle-pic-base
6946 @opindex msingle-pic-base
6947 Treat the register used for PIC addressing as read-only, rather than
6948 loading it in the prologue for each function.  The run-time system is
6949 responsible for initializing this register with an appropriate value
6950 before execution begins.
6951
6952 @item -mpic-register=@var{reg}
6953 @opindex mpic-register
6954 Specify the register to be used for PIC addressing.  The default is R10
6955 unless stack-checking is enabled, when R9 is used.
6956
6957 @item -mcirrus-fix-invalid-insns
6958 @opindex mcirrus-fix-invalid-insns
6959 @opindex mno-cirrus-fix-invalid-insns
6960 Insert NOPs into the instruction stream to in order to work around
6961 problems with invalid Maverick instruction combinations.  This option
6962 is only valid if the @option{-mcpu=ep9312} option has been used to
6963 enable generation of instructions for the Cirrus Maverick floating
6964 point co-processor.  This option is not enabled by default, since the
6965 problem is only present in older Maverick implementations.  The default
6966 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6967 switch.
6968
6969 @item -mpoke-function-name
6970 @opindex mpoke-function-name
6971 Write the name of each function into the text section, directly
6972 preceding the function prologue.  The generated code is similar to this:
6973
6974 @smallexample
6975      t0
6976          .ascii "arm_poke_function_name", 0
6977          .align
6978      t1
6979          .word 0xff000000 + (t1 - t0)
6980      arm_poke_function_name
6981          mov     ip, sp
6982          stmfd   sp!, @{fp, ip, lr, pc@}
6983          sub     fp, ip, #4
6984 @end smallexample
6985
6986 When performing a stack backtrace, code can inspect the value of
6987 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6988 location @code{pc - 12} and the top 8 bits are set, then we know that
6989 there is a function name embedded immediately preceding this location
6990 and has length @code{((pc[-3]) & 0xff000000)}.
6991
6992 @item -mthumb
6993 @opindex mthumb
6994 Generate code for the 16-bit Thumb instruction set.  The default is to
6995 use the 32-bit ARM instruction set.
6996
6997 @item -mtpcs-frame
6998 @opindex mtpcs-frame
6999 Generate a stack frame that is compliant with the Thumb Procedure Call
7000 Standard for all non-leaf functions.  (A leaf function is one that does
7001 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7002
7003 @item -mtpcs-leaf-frame
7004 @opindex mtpcs-leaf-frame
7005 Generate a stack frame that is compliant with the Thumb Procedure Call
7006 Standard for all leaf functions.  (A leaf function is one that does
7007 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7008
7009 @item -mcallee-super-interworking
7010 @opindex mcallee-super-interworking
7011 Gives all externally visible functions in the file being compiled an ARM
7012 instruction set header which switches to Thumb mode before executing the
7013 rest of the function.  This allows these functions to be called from
7014 non-interworking code.
7015
7016 @item -mcaller-super-interworking
7017 @opindex mcaller-super-interworking
7018 Allows calls via function pointers (including virtual functions) to
7019 execute correctly regardless of whether the target code has been
7020 compiled for interworking or not.  There is a small overhead in the cost
7021 of executing a function pointer if this option is enabled.
7022
7023 @end table
7024
7025 @node AVR Options
7026 @subsection AVR Options
7027 @cindex AVR Options
7028
7029 These options are defined for AVR implementations:
7030
7031 @table @gcctabopt
7032 @item -mmcu=@var{mcu}
7033 @opindex mmcu
7034 Specify ATMEL AVR instruction set or MCU type.
7035
7036 Instruction set avr1 is for the minimal AVR core, not supported by the C
7037 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7038 attiny11, attiny12, attiny15, attiny28).
7039
7040 Instruction set avr2 (default) is for the classic AVR core with up to
7041 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7042 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7043 at90c8534, at90s8535).
7044
7045 Instruction set avr3 is for the classic AVR core with up to 128K program
7046 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7047
7048 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7049 memory space (MCU types: atmega8, atmega83, atmega85).
7050
7051 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7052 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7053 atmega64, atmega128, at43usb355, at94k).
7054
7055 @item -msize
7056 @opindex msize
7057 Output instruction sizes to the asm file.
7058
7059 @item -minit-stack=@var{N}
7060 @opindex minit-stack
7061 Specify the initial stack address, which may be a symbol or numeric value,
7062 @samp{__stack} is the default.
7063
7064 @item -mno-interrupts
7065 @opindex mno-interrupts
7066 Generated code is not compatible with hardware interrupts.
7067 Code size will be smaller.
7068
7069 @item -mcall-prologues
7070 @opindex mcall-prologues
7071 Functions prologues/epilogues expanded as call to appropriate
7072 subroutines.  Code size will be smaller.
7073
7074 @item -mno-tablejump
7075 @opindex mno-tablejump
7076 Do not generate tablejump insns which sometimes increase code size.
7077
7078 @item -mtiny-stack
7079 @opindex mtiny-stack
7080 Change only the low 8 bits of the stack pointer.
7081
7082 @item -mint8
7083 @opindex mint8
7084 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7085 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7086 and long long will be 4 bytes.  Please note that this option does not
7087 comply to the C standards, but it will provide you with smaller code
7088 size.
7089 @end table
7090
7091 @node CRIS Options
7092 @subsection CRIS Options
7093 @cindex CRIS Options
7094
7095 These options are defined specifically for the CRIS ports.
7096
7097 @table @gcctabopt
7098 @item -march=@var{architecture-type}
7099 @itemx -mcpu=@var{architecture-type}
7100 @opindex march
7101 @opindex mcpu
7102 Generate code for the specified architecture.  The choices for
7103 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7104 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7105 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7106 @samp{v10}.
7107
7108 @item -mtune=@var{architecture-type}
7109 @opindex mtune
7110 Tune to @var{architecture-type} everything applicable about the generated
7111 code, except for the ABI and the set of available instructions.  The
7112 choices for @var{architecture-type} are the same as for
7113 @option{-march=@var{architecture-type}}.
7114
7115 @item -mmax-stack-frame=@var{n}
7116 @opindex mmax-stack-frame
7117 Warn when the stack frame of a function exceeds @var{n} bytes.
7118
7119 @item -melinux-stacksize=@var{n}
7120 @opindex melinux-stacksize
7121 Only available with the @samp{cris-axis-aout} target.  Arranges for
7122 indications in the program to the kernel loader that the stack of the
7123 program should be set to @var{n} bytes.
7124
7125 @item -metrax4
7126 @itemx -metrax100
7127 @opindex metrax4
7128 @opindex metrax100
7129 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7130 @option{-march=v3} and @option{-march=v8} respectively.
7131
7132 @item -mmul-bug-workaround
7133 @itemx -mno-mul-bug-workaround
7134 @opindex mmul-bug-workaround
7135 @opindex mno-mul-bug-workaround
7136 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7137 models where it applies.  This option is active by default.
7138
7139 @item -mpdebug
7140 @opindex mpdebug
7141 Enable CRIS-specific verbose debug-related information in the assembly
7142 code.  This option also has the effect to turn off the @samp{#NO_APP}
7143 formatted-code indicator to the assembler at the beginning of the
7144 assembly file.
7145
7146 @item -mcc-init
7147 @opindex mcc-init
7148 Do not use condition-code results from previous instruction; always emit
7149 compare and test instructions before use of condition codes.
7150
7151 @item -mno-side-effects
7152 @opindex mno-side-effects
7153 Do not emit instructions with side-effects in addressing modes other than
7154 post-increment.
7155
7156 @item -mstack-align
7157 @itemx -mno-stack-align
7158 @itemx -mdata-align
7159 @itemx -mno-data-align
7160 @itemx -mconst-align
7161 @itemx -mno-const-align
7162 @opindex mstack-align
7163 @opindex mno-stack-align
7164 @opindex mdata-align
7165 @opindex mno-data-align
7166 @opindex mconst-align
7167 @opindex mno-const-align
7168 These options (no-options) arranges (eliminate arrangements) for the
7169 stack-frame, individual data and constants to be aligned for the maximum
7170 single data access size for the chosen CPU model.  The default is to
7171 arrange for 32-bit alignment.  ABI details such as structure layout are
7172 not affected by these options.
7173
7174 @item -m32-bit
7175 @itemx -m16-bit
7176 @itemx -m8-bit
7177 @opindex m32-bit
7178 @opindex m16-bit
7179 @opindex m8-bit
7180 Similar to the stack- data- and const-align options above, these options
7181 arrange for stack-frame, writable data and constants to all be 32-bit,
7182 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7183
7184 @item -mno-prologue-epilogue
7185 @itemx -mprologue-epilogue
7186 @opindex mno-prologue-epilogue
7187 @opindex mprologue-epilogue
7188 With @option{-mno-prologue-epilogue}, the normal function prologue and
7189 epilogue that sets up the stack-frame are omitted and no return
7190 instructions or return sequences are generated in the code.  Use this
7191 option only together with visual inspection of the compiled code: no
7192 warnings or errors are generated when call-saved registers must be saved,
7193 or storage for local variable needs to be allocated.
7194
7195 @item -mno-gotplt
7196 @itemx -mgotplt
7197 @opindex mno-gotplt
7198 @opindex mgotplt
7199 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7200 instruction sequences that load addresses for functions from the PLT part
7201 of the GOT rather than (traditional on other architectures) calls to the
7202 PLT@.  The default is @option{-mgotplt}.
7203
7204 @item -maout
7205 @opindex maout
7206 Legacy no-op option only recognized with the cris-axis-aout target.
7207
7208 @item -melf
7209 @opindex melf
7210 Legacy no-op option only recognized with the cris-axis-elf and
7211 cris-axis-linux-gnu targets.
7212
7213 @item -melinux
7214 @opindex melinux
7215 Only recognized with the cris-axis-aout target, where it selects a
7216 GNU/linux-like multilib, include files and instruction set for
7217 @option{-march=v8}.
7218
7219 @item -mlinux
7220 @opindex mlinux
7221 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7222
7223 @item -sim
7224 @opindex sim
7225 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7226 to link with input-output functions from a simulator library.  Code,
7227 initialized data and zero-initialized data are allocated consecutively.
7228
7229 @item -sim2
7230 @opindex sim2
7231 Like @option{-sim}, but pass linker options to locate initialized data at
7232 0x40000000 and zero-initialized data at 0x80000000.
7233 @end table
7234
7235 @node Darwin Options
7236 @subsection Darwin Options
7237 @cindex Darwin options
7238
7239 These options are defined for all architectures running the Darwin operating
7240 system.
7241
7242 FSF GCC on Darwin does not create ``fat'' object files; it will create
7243 an object file for the single architecture that it was built to
7244 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7245 @option{-arch} options are used; it does so by running the compiler or
7246 linker multiple times and joining the results together with
7247 @file{lipo}.
7248
7249 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7250 @samp{i686}) is determined by the flags that specify the ISA
7251 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7252 @option{-force_cpusubtype_ALL} option can be used to override this.
7253
7254 The Darwin tools vary in their behaviour when presented with an ISA
7255 mismatch.  The assembler, @file{as}, will only permit instructions to
7256 be used that are valid for the subtype of the file it is generating,
7257 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7258 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7259 and print an error if asked to create a shared library with a less
7260 restrictive subtype than its input files (for instance, trying to put
7261 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7262 for executables, @file{ld}, will quietly give the executable the most
7263 restrictive subtype of any of its input files.
7264
7265 @table @gcctabopt
7266 @item -F@var{dir}
7267 @opindex F
7268 Add the framework directory @var{dir} to the head of the list of
7269 directories to be searched for header files.  These directories are
7270 interleaved with those specified by @option{-I} options and are
7271 scanned in a left-to-right order.
7272
7273 A framework directory is a directory with frameworks in it.  A
7274 framework is a directory with a @samp{"Headers"} and/or
7275 @samp{"PrivateHeaders"} directory contained directly in it that ends
7276 in @samp{".framework"}.  The name of a framework is the name of this
7277 directory excluding the @samp{".framework"}.  Headers associated with
7278 the framework are found in one of those two directories, with
7279 @samp{"Headers"} being searched first.  A subframework is a framework
7280 directory that is in a framework's @samp{"Frameworks"} directory.
7281 Includes of subframework headers can only appear in a header of a
7282 framework that contains the subframework, or in a sibling subframework
7283 header.  Two subframeworks are siblings if they occur in the same
7284 framework.  A subframework should not have the same name as a
7285 framework, a warning will be issued if this is violated.  Currently a
7286 subframework cannot have subframeworks, in the future, the mechanism
7287 may be extended to support this.  The standard frameworks can be found
7288 in @samp{"/System/Library/Frameworks"} and
7289 @samp{"/Library/Frameworks"}.  An example include looks like
7290 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7291 the name of the framework and header.h is found in the
7292 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7293
7294 @item -gused
7295 @opindex -gused
7296 Emit debugging information for symbols that are used.  For STABS
7297 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7298 This is by default ON@.
7299
7300 @item -gfull
7301 @opindex -gfull
7302 Emit debugging information for all symbols and types.
7303
7304 @item -mone-byte-bool
7305 @opindex -mone-byte-bool
7306 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7307 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7308 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7309 option has no effect on x86.
7310
7311 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7312 to generate code that is not binary compatible with code generated
7313 without that switch.  Using this switch may require recompiling all
7314 other modules in a program, including system libraries.  Use this
7315 switch to conform to a non-default data model.
7316
7317 @item -mfix-and-continue
7318 @itemx -ffix-and-continue
7319 @itemx -findirect-data
7320 @opindex mfix-and-continue
7321 @opindex ffix-and-continue
7322 @opindex findirect-data
7323 Generate code suitable for fast turn around development.  Needed to
7324 enable gdb to dynamically load @code{.o} files into already running
7325 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7326 are provided for backwards compatibility.
7327
7328 @item -all_load
7329 @opindex all_load
7330 Loads all members of static archive libraries.
7331 See man ld(1) for more information.
7332
7333 @item -arch_errors_fatal
7334 @opindex arch_errors_fatal
7335 Cause the errors having to do with files that have the wrong architecture
7336 to be fatal.
7337
7338 @item -bind_at_load
7339 @opindex bind_at_load
7340 Causes the output file to be marked such that the dynamic linker will
7341 bind all undefined references when the file is loaded or launched.
7342
7343 @item -bundle
7344 @opindex bundle
7345 Produce a Mach-o bundle format file.
7346 See man ld(1) for more information.
7347
7348 @item -bundle_loader @var{executable}
7349 @opindex bundle_loader
7350 This option specifies the @var{executable} that will be loading the build
7351 output file being linked.  See man ld(1) for more information.
7352
7353 @item -dynamiclib
7354 @opindex -dynamiclib
7355 When passed this option, GCC will produce a dynamic library instead of
7356 an executable when linking, using the Darwin @file{libtool} command.
7357
7358 @item -force_cpusubtype_ALL
7359 @opindex -force_cpusubtype_ALL
7360 This causes GCC's output file to have the @var{ALL} subtype, instead of
7361 one controlled by the @option{-mcpu} or @option{-march} option.
7362
7363 @item -allowable_client  @var{client_name}
7364 @itemx -client_name
7365 @itemx -compatibility_version
7366 @itemx -current_version
7367 @itemx -dead_strip
7368 @itemx -dependency-file
7369 @itemx -dylib_file
7370 @itemx -dylinker_install_name
7371 @itemx -dynamic
7372 @itemx -exported_symbols_list
7373 @itemx -filelist
7374 @itemx -flat_namespace
7375 @itemx -force_flat_namespace
7376 @itemx -headerpad_max_install_names
7377 @itemx -image_base
7378 @itemx -init
7379 @itemx -install_name
7380 @itemx -keep_private_externs
7381 @itemx -multi_module
7382 @itemx -multiply_defined
7383 @itemx -multiply_defined_unused
7384 @itemx -noall_load
7385 @itemx -no_dead_strip_inits_and_terms
7386 @itemx -nofixprebinding
7387 @itemx -nomultidefs
7388 @itemx -noprebind
7389 @itemx -noseglinkedit
7390 @itemx -pagezero_size
7391 @itemx -prebind
7392 @itemx -prebind_all_twolevel_modules
7393 @itemx -private_bundle
7394 @itemx -read_only_relocs
7395 @itemx -sectalign
7396 @itemx -sectobjectsymbols
7397 @itemx -whyload
7398 @itemx -seg1addr
7399 @itemx -sectcreate
7400 @itemx -sectobjectsymbols
7401 @itemx -sectorder
7402 @itemx -segaddr
7403 @itemx -segs_read_only_addr
7404 @itemx -segs_read_write_addr
7405 @itemx -seg_addr_table
7406 @itemx -seg_addr_table_filename
7407 @itemx -seglinkedit
7408 @itemx -segprot
7409 @itemx -segs_read_only_addr
7410 @itemx -segs_read_write_addr
7411 @itemx -single_module
7412 @itemx -static
7413 @itemx -sub_library
7414 @itemx -sub_umbrella
7415 @itemx -twolevel_namespace
7416 @itemx -umbrella
7417 @itemx -undefined
7418 @itemx -unexported_symbols_list
7419 @itemx -weak_reference_mismatches
7420 @itemx -whatsloaded
7421
7422 @opindex allowable_client
7423 @opindex client_name
7424 @opindex compatibility_version
7425 @opindex current_version
7426 @opindex dead_strip
7427 @opindex dependency-file
7428 @opindex dylib_file
7429 @opindex dylinker_install_name
7430 @opindex dynamic
7431 @opindex exported_symbols_list
7432 @opindex filelist
7433 @opindex flat_namespace
7434 @opindex force_flat_namespace
7435 @opindex headerpad_max_install_names
7436 @opindex image_base
7437 @opindex init
7438 @opindex install_name
7439 @opindex keep_private_externs
7440 @opindex multi_module
7441 @opindex multiply_defined
7442 @opindex multiply_defined_unused
7443 @opindex noall_load
7444 @opindex no_dead_strip_inits_and_terms
7445 @opindex nofixprebinding
7446 @opindex nomultidefs
7447 @opindex noprebind
7448 @opindex noseglinkedit
7449 @opindex pagezero_size
7450 @opindex prebind
7451 @opindex prebind_all_twolevel_modules
7452 @opindex private_bundle
7453 @opindex read_only_relocs
7454 @opindex sectalign
7455 @opindex sectobjectsymbols
7456 @opindex whyload
7457 @opindex seg1addr
7458 @opindex sectcreate
7459 @opindex sectobjectsymbols
7460 @opindex sectorder
7461 @opindex segaddr
7462 @opindex segs_read_only_addr
7463 @opindex segs_read_write_addr
7464 @opindex seg_addr_table
7465 @opindex seg_addr_table_filename
7466 @opindex seglinkedit
7467 @opindex segprot
7468 @opindex segs_read_only_addr
7469 @opindex segs_read_write_addr
7470 @opindex single_module
7471 @opindex static
7472 @opindex sub_library
7473 @opindex sub_umbrella
7474 @opindex twolevel_namespace
7475 @opindex umbrella
7476 @opindex undefined
7477 @opindex unexported_symbols_list
7478 @opindex weak_reference_mismatches
7479 @opindex whatsloaded
7480
7481 These options are passed to the Darwin linker.  The Darwin linker man page
7482 describes them in detail.
7483 @end table
7484
7485 @node DEC Alpha Options
7486 @subsection DEC Alpha Options
7487
7488 These @samp{-m} options are defined for the DEC Alpha implementations:
7489
7490 @table @gcctabopt
7491 @item -mno-soft-float
7492 @itemx -msoft-float
7493 @opindex mno-soft-float
7494 @opindex msoft-float
7495 Use (do not use) the hardware floating-point instructions for
7496 floating-point operations.  When @option{-msoft-float} is specified,
7497 functions in @file{libgcc.a} will be used to perform floating-point
7498 operations.  Unless they are replaced by routines that emulate the
7499 floating-point operations, or compiled in such a way as to call such
7500 emulations routines, these routines will issue floating-point
7501 operations.   If you are compiling for an Alpha without floating-point
7502 operations, you must ensure that the library is built so as not to call
7503 them.
7504
7505 Note that Alpha implementations without floating-point operations are
7506 required to have floating-point registers.
7507
7508 @item -mfp-reg
7509 @itemx -mno-fp-regs
7510 @opindex mfp-reg
7511 @opindex mno-fp-regs
7512 Generate code that uses (does not use) the floating-point register set.
7513 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7514 register set is not used, floating point operands are passed in integer
7515 registers as if they were integers and floating-point results are passed
7516 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7517 so any function with a floating-point argument or return value called by code
7518 compiled with @option{-mno-fp-regs} must also be compiled with that
7519 option.
7520
7521 A typical use of this option is building a kernel that does not use,
7522 and hence need not save and restore, any floating-point registers.
7523
7524 @item -mieee
7525 @opindex mieee
7526 The Alpha architecture implements floating-point hardware optimized for
7527 maximum performance.  It is mostly compliant with the IEEE floating
7528 point standard.  However, for full compliance, software assistance is
7529 required.  This option generates code fully IEEE compliant code
7530 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7531 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7532 defined during compilation.  The resulting code is less efficient but is
7533 able to correctly support denormalized numbers and exceptional IEEE
7534 values such as not-a-number and plus/minus infinity.  Other Alpha
7535 compilers call this option @option{-ieee_with_no_inexact}.
7536
7537 @item -mieee-with-inexact
7538 @opindex mieee-with-inexact
7539 This is like @option{-mieee} except the generated code also maintains
7540 the IEEE @var{inexact-flag}.  Turning on this option causes the
7541 generated code to implement fully-compliant IEEE math.  In addition to
7542 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7543 macro.  On some Alpha implementations the resulting code may execute
7544 significantly slower than the code generated by default.  Since there is
7545 very little code that depends on the @var{inexact-flag}, you should
7546 normally not specify this option.  Other Alpha compilers call this
7547 option @option{-ieee_with_inexact}.
7548
7549 @item -mfp-trap-mode=@var{trap-mode}
7550 @opindex mfp-trap-mode
7551 This option controls what floating-point related traps are enabled.
7552 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7553 The trap mode can be set to one of four values:
7554
7555 @table @samp
7556 @item n
7557 This is the default (normal) setting.  The only traps that are enabled
7558 are the ones that cannot be disabled in software (e.g., division by zero
7559 trap).
7560
7561 @item u
7562 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7563 as well.
7564
7565 @item su
7566 Like @samp{su}, but the instructions are marked to be safe for software
7567 completion (see Alpha architecture manual for details).
7568
7569 @item sui
7570 Like @samp{su}, but inexact traps are enabled as well.
7571 @end table
7572
7573 @item -mfp-rounding-mode=@var{rounding-mode}
7574 @opindex mfp-rounding-mode
7575 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7576 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7577 of:
7578
7579 @table @samp
7580 @item n
7581 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7582 the nearest machine number or towards the even machine number in case
7583 of a tie.
7584
7585 @item m
7586 Round towards minus infinity.
7587
7588 @item c
7589 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7590
7591 @item d
7592 Dynamic rounding mode.  A field in the floating point control register
7593 (@var{fpcr}, see Alpha architecture reference manual) controls the
7594 rounding mode in effect.  The C library initializes this register for
7595 rounding towards plus infinity.  Thus, unless your program modifies the
7596 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7597 @end table
7598
7599 @item -mtrap-precision=@var{trap-precision}
7600 @opindex mtrap-precision
7601 In the Alpha architecture, floating point traps are imprecise.  This
7602 means without software assistance it is impossible to recover from a
7603 floating trap and program execution normally needs to be terminated.
7604 GCC can generate code that can assist operating system trap handlers
7605 in determining the exact location that caused a floating point trap.
7606 Depending on the requirements of an application, different levels of
7607 precisions can be selected:
7608
7609 @table @samp
7610 @item p
7611 Program precision.  This option is the default and means a trap handler
7612 can only identify which program caused a floating point exception.
7613
7614 @item f
7615 Function precision.  The trap handler can determine the function that
7616 caused a floating point exception.
7617
7618 @item i
7619 Instruction precision.  The trap handler can determine the exact
7620 instruction that caused a floating point exception.
7621 @end table
7622
7623 Other Alpha compilers provide the equivalent options called
7624 @option{-scope_safe} and @option{-resumption_safe}.
7625
7626 @item -mieee-conformant
7627 @opindex mieee-conformant
7628 This option marks the generated code as IEEE conformant.  You must not
7629 use this option unless you also specify @option{-mtrap-precision=i} and either
7630 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7631 is to emit the line @samp{.eflag 48} in the function prologue of the
7632 generated assembly file.  Under DEC Unix, this has the effect that
7633 IEEE-conformant math library routines will be linked in.
7634
7635 @item -mbuild-constants
7636 @opindex mbuild-constants
7637 Normally GCC examines a 32- or 64-bit integer constant to
7638 see if it can construct it from smaller constants in two or three
7639 instructions.  If it cannot, it will output the constant as a literal and
7640 generate code to load it from the data segment at runtime.
7641
7642 Use this option to require GCC to construct @emph{all} integer constants
7643 using code, even if it takes more instructions (the maximum is six).
7644
7645 You would typically use this option to build a shared library dynamic
7646 loader.  Itself a shared library, it must relocate itself in memory
7647 before it can find the variables and constants in its own data segment.
7648
7649 @item -malpha-as
7650 @itemx -mgas
7651 @opindex malpha-as
7652 @opindex mgas
7653 Select whether to generate code to be assembled by the vendor-supplied
7654 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7655
7656 @item -mbwx
7657 @itemx -mno-bwx
7658 @itemx -mcix
7659 @itemx -mno-cix
7660 @itemx -mfix
7661 @itemx -mno-fix
7662 @itemx -mmax
7663 @itemx -mno-max
7664 @opindex mbwx
7665 @opindex mno-bwx
7666 @opindex mcix
7667 @opindex mno-cix
7668 @opindex mfix
7669 @opindex mno-fix
7670 @opindex mmax
7671 @opindex mno-max
7672 Indicate whether GCC should generate code to use the optional BWX,
7673 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7674 sets supported by the CPU type specified via @option{-mcpu=} option or that
7675 of the CPU on which GCC was built if none was specified.
7676
7677 @item -mfloat-vax
7678 @itemx -mfloat-ieee
7679 @opindex mfloat-vax
7680 @opindex mfloat-ieee
7681 Generate code that uses (does not use) VAX F and G floating point
7682 arithmetic instead of IEEE single and double precision.
7683
7684 @item -mexplicit-relocs
7685 @itemx -mno-explicit-relocs
7686 @opindex mexplicit-relocs
7687 @opindex mno-explicit-relocs
7688 Older Alpha assemblers provided no way to generate symbol relocations
7689 except via assembler macros.  Use of these macros does not allow
7690 optimal instruction scheduling.  GNU binutils as of version 2.12
7691 supports a new syntax that allows the compiler to explicitly mark
7692 which relocations should apply to which instructions.  This option
7693 is mostly useful for debugging, as GCC detects the capabilities of
7694 the assembler when it is built and sets the default accordingly.
7695
7696 @item -msmall-data
7697 @itemx -mlarge-data
7698 @opindex msmall-data
7699 @opindex mlarge-data
7700 When @option{-mexplicit-relocs} is in effect, static data is
7701 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7702 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7703 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7704 16-bit relocations off of the @code{$gp} register.  This limits the
7705 size of the small data area to 64KB, but allows the variables to be
7706 directly accessed via a single instruction.
7707
7708 The default is @option{-mlarge-data}.  With this option the data area
7709 is limited to just below 2GB@.  Programs that require more than 2GB of
7710 data must use @code{malloc} or @code{mmap} to allocate the data in the
7711 heap instead of in the program's data segment.
7712
7713 When generating code for shared libraries, @option{-fpic} implies
7714 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7715
7716 @item -msmall-text
7717 @itemx -mlarge-text
7718 @opindex msmall-text
7719 @opindex mlarge-text
7720 When @option{-msmall-text} is used, the compiler assumes that the
7721 code of the entire program (or shared library) fits in 4MB, and is
7722 thus reachable with a branch instruction.  When @option{-msmall-data}
7723 is used, the compiler can assume that all local symbols share the
7724 same @code{$gp} value, and thus reduce the number of instructions
7725 required for a function call from 4 to 1.
7726
7727 The default is @option{-mlarge-text}.
7728
7729 @item -mcpu=@var{cpu_type}
7730 @opindex mcpu
7731 Set the instruction set and instruction scheduling parameters for
7732 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7733 style name or the corresponding chip number.  GCC supports scheduling
7734 parameters for the EV4, EV5 and EV6 family of processors and will
7735 choose the default values for the instruction set from the processor
7736 you specify.  If you do not specify a processor type, GCC will default
7737 to the processor on which the compiler was built.
7738
7739 Supported values for @var{cpu_type} are
7740
7741 @table @samp
7742 @item ev4
7743 @itemx ev45
7744 @itemx 21064
7745 Schedules as an EV4 and has no instruction set extensions.
7746
7747 @item ev5
7748 @itemx 21164
7749 Schedules as an EV5 and has no instruction set extensions.
7750
7751 @item ev56
7752 @itemx 21164a
7753 Schedules as an EV5 and supports the BWX extension.
7754
7755 @item pca56
7756 @itemx 21164pc
7757 @itemx 21164PC
7758 Schedules as an EV5 and supports the BWX and MAX extensions.
7759
7760 @item ev6
7761 @itemx 21264
7762 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7763
7764 @item ev67
7765 @itemx 21264a
7766 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7767 @end table
7768
7769 @item -mtune=@var{cpu_type}
7770 @opindex mtune
7771 Set only the instruction scheduling parameters for machine type
7772 @var{cpu_type}.  The instruction set is not changed.
7773
7774 @item -mmemory-latency=@var{time}
7775 @opindex mmemory-latency
7776 Sets the latency the scheduler should assume for typical memory
7777 references as seen by the application.  This number is highly
7778 dependent on the memory access patterns used by the application
7779 and the size of the external cache on the machine.
7780
7781 Valid options for @var{time} are
7782
7783 @table @samp
7784 @item @var{number}
7785 A decimal number representing clock cycles.
7786
7787 @item L1
7788 @itemx L2
7789 @itemx L3
7790 @itemx main
7791 The compiler contains estimates of the number of clock cycles for
7792 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7793 (also called Dcache, Scache, and Bcache), as well as to main memory.
7794 Note that L3 is only valid for EV5.
7795
7796 @end table
7797 @end table
7798
7799 @node DEC Alpha/VMS Options
7800 @subsection DEC Alpha/VMS Options
7801
7802 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7803
7804 @table @gcctabopt
7805 @item -mvms-return-codes
7806 @opindex mvms-return-codes
7807 Return VMS condition codes from main.  The default is to return POSIX
7808 style condition (e.g.@ error) codes.
7809 @end table
7810
7811 @node FRV Options
7812 @subsection FRV Options
7813 @cindex FRV Options
7814
7815 @table @gcctabopt
7816 @item -mgpr-32
7817 @opindex mgpr-32
7818
7819 Only use the first 32 general purpose registers.
7820
7821 @item -mgpr-64
7822 @opindex mgpr-64
7823
7824 Use all 64 general purpose registers.
7825
7826 @item -mfpr-32
7827 @opindex mfpr-32
7828
7829 Use only the first 32 floating point registers.
7830
7831 @item -mfpr-64
7832 @opindex mfpr-64
7833
7834 Use all 64 floating point registers
7835
7836 @item -mhard-float
7837 @opindex mhard-float
7838
7839 Use hardware instructions for floating point operations.
7840
7841 @item -msoft-float
7842 @opindex msoft-float
7843
7844 Use library routines for floating point operations.
7845
7846 @item -malloc-cc
7847 @opindex malloc-cc
7848
7849 Dynamically allocate condition code registers.
7850
7851 @item -mfixed-cc
7852 @opindex mfixed-cc
7853
7854 Do not try to dynamically allocate condition code registers, only
7855 use @code{icc0} and @code{fcc0}.
7856
7857 @item -mdword
7858 @opindex mdword
7859
7860 Change ABI to use double word insns.
7861
7862 @item -mno-dword
7863 @opindex mno-dword
7864
7865 Do not use double word instructions.
7866
7867 @item -mdouble
7868 @opindex mdouble
7869
7870 Use floating point double instructions.
7871
7872 @item -mno-double
7873 @opindex mno-double
7874
7875 Do not use floating point double instructions.
7876
7877 @item -mmedia
7878 @opindex mmedia
7879
7880 Use media instructions.
7881
7882 @item -mno-media
7883 @opindex mno-media
7884
7885 Do not use media instructions.
7886
7887 @item -mmuladd
7888 @opindex mmuladd
7889
7890 Use multiply and add/subtract instructions.
7891
7892 @item -mno-muladd
7893 @opindex mno-muladd
7894
7895 Do not use multiply and add/subtract instructions.
7896
7897 @item -mfdpic
7898 @opindex mfdpic
7899
7900 Select the FDPIC ABI, that uses function descriptors to represent
7901 pointers to functions.  Without any PIC/PIE-related options, it
7902 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7903 assumes GOT entries and small data are within a 12-bit range from the
7904 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7905 are computed with 32 bits.
7906
7907 @item -minline-plt
7908 @opindex minline-plt
7909
7910 Enable inlining of PLT entries in function calls to functions that are
7911 not known to bind locally.  It has no effect without @option{-mfdpic}.
7912 It's enabled by default if optimizing for speed and compiling for
7913 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7914 optimization option such as @option{-O3} or above is present in the
7915 command line.
7916
7917 @item -mTLS
7918 @opindex TLS
7919
7920 Assume a large TLS segment when generating thread-local code.
7921
7922 @item -mtls
7923 @opindex tls
7924
7925 Do not assume a large TLS segment when generating thread-local code.
7926
7927 @item -mgprel-ro
7928 @opindex mgprel-ro
7929
7930 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7931 that is known to be in read-only sections.  It's enabled by default,
7932 except for @option{-fpic} or @option{-fpie}: even though it may help
7933 make the global offset table smaller, it trades 1 instruction for 4.
7934 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7935 one of which may be shared by multiple symbols, and it avoids the need
7936 for a GOT entry for the referenced symbol, so it's more likely to be a
7937 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7938
7939 @item -multilib-library-pic
7940 @opindex multilib-library-pic
7941
7942 Link with the (library, not FD) pic libraries.  It's implied by
7943 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7944 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7945 it explicitly.
7946
7947 @item -mlinked-fp
7948 @opindex mlinked-fp
7949
7950 Follow the EABI requirement of always creating a frame pointer whenever
7951 a stack frame is allocated.  This option is enabled by default and can
7952 be disabled with @option{-mno-linked-fp}.
7953
7954 @item -mlong-calls
7955 @opindex mlong-calls
7956
7957 Use indirect addressing to call functions outside the current
7958 compilation unit.  This allows the functions to be placed anywhere
7959 within the 32-bit address space.
7960
7961 @item -malign-labels
7962 @opindex malign-labels
7963
7964 Try to align labels to an 8-byte boundary by inserting nops into the
7965 previous packet.  This option only has an effect when VLIW packing
7966 is enabled.  It doesn't create new packets; it merely adds nops to
7967 existing ones.
7968
7969 @item -mlibrary-pic
7970 @opindex mlibrary-pic
7971
7972 Generate position-independent EABI code.
7973
7974 @item -macc-4
7975 @opindex macc-4
7976
7977 Use only the first four media accumulator registers.
7978
7979 @item -macc-8
7980 @opindex macc-8
7981
7982 Use all eight media accumulator registers.
7983
7984 @item -mpack
7985 @opindex mpack
7986
7987 Pack VLIW instructions.
7988
7989 @item -mno-pack
7990 @opindex mno-pack
7991
7992 Do not pack VLIW instructions.
7993
7994 @item -mno-eflags
7995 @opindex mno-eflags
7996
7997 Do not mark ABI switches in e_flags.
7998
7999 @item -mcond-move
8000 @opindex mcond-move
8001
8002 Enable the use of conditional-move instructions (default).
8003
8004 This switch is mainly for debugging the compiler and will likely be removed
8005 in a future version.
8006
8007 @item -mno-cond-move
8008 @opindex mno-cond-move
8009
8010 Disable the use of conditional-move instructions.
8011
8012 This switch is mainly for debugging the compiler and will likely be removed
8013 in a future version.
8014
8015 @item -mscc
8016 @opindex mscc
8017
8018 Enable the use of conditional set instructions (default).
8019
8020 This switch is mainly for debugging the compiler and will likely be removed
8021 in a future version.
8022
8023 @item -mno-scc
8024 @opindex mno-scc
8025
8026 Disable the use of conditional set instructions.
8027
8028 This switch is mainly for debugging the compiler and will likely be removed
8029 in a future version.
8030
8031 @item -mcond-exec
8032 @opindex mcond-exec
8033
8034 Enable the use of conditional execution (default).
8035
8036 This switch is mainly for debugging the compiler and will likely be removed
8037 in a future version.
8038
8039 @item -mno-cond-exec
8040 @opindex mno-cond-exec
8041
8042 Disable the use of conditional execution.
8043
8044 This switch is mainly for debugging the compiler and will likely be removed
8045 in a future version.
8046
8047 @item -mvliw-branch
8048 @opindex mvliw-branch
8049
8050 Run a pass to pack branches into VLIW instructions (default).
8051
8052 This switch is mainly for debugging the compiler and will likely be removed
8053 in a future version.
8054
8055 @item -mno-vliw-branch
8056 @opindex mno-vliw-branch
8057
8058 Do not run a pass to pack branches into VLIW instructions.
8059
8060 This switch is mainly for debugging the compiler and will likely be removed
8061 in a future version.
8062
8063 @item -mmulti-cond-exec
8064 @opindex mmulti-cond-exec
8065
8066 Enable optimization of @code{&&} and @code{||} in conditional execution
8067 (default).
8068
8069 This switch is mainly for debugging the compiler and will likely be removed
8070 in a future version.
8071
8072 @item -mno-multi-cond-exec
8073 @opindex mno-multi-cond-exec
8074
8075 Disable optimization of @code{&&} and @code{||} in conditional execution.
8076
8077 This switch is mainly for debugging the compiler and will likely be removed
8078 in a future version.
8079
8080 @item -mnested-cond-exec
8081 @opindex mnested-cond-exec
8082
8083 Enable nested conditional execution optimizations (default).
8084
8085 This switch is mainly for debugging the compiler and will likely be removed
8086 in a future version.
8087
8088 @item -mno-nested-cond-exec
8089 @opindex mno-nested-cond-exec
8090
8091 Disable nested conditional execution optimizations.
8092
8093 This switch is mainly for debugging the compiler and will likely be removed
8094 in a future version.
8095
8096 @item -mtomcat-stats
8097 @opindex mtomcat-stats
8098
8099 Cause gas to print out tomcat statistics.
8100
8101 @item -mcpu=@var{cpu}
8102 @opindex mcpu
8103
8104 Select the processor type for which to generate code.  Possible values are
8105 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8106 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8107
8108 @end table
8109
8110 @node H8/300 Options
8111 @subsection H8/300 Options
8112
8113 These @samp{-m} options are defined for the H8/300 implementations:
8114
8115 @table @gcctabopt
8116 @item -mrelax
8117 @opindex mrelax
8118 Shorten some address references at link time, when possible; uses the
8119 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8120 ld, Using ld}, for a fuller description.
8121
8122 @item -mh
8123 @opindex mh
8124 Generate code for the H8/300H@.
8125
8126 @item -ms
8127 @opindex ms
8128 Generate code for the H8S@.
8129
8130 @item -mn
8131 @opindex mn
8132 Generate code for the H8S and H8/300H in the normal mode.  This switch
8133 must be used either with @option{-mh} or @option{-ms}.
8134
8135 @item -ms2600
8136 @opindex ms2600
8137 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8138
8139 @item -mint32
8140 @opindex mint32
8141 Make @code{int} data 32 bits by default.
8142
8143 @item -malign-300
8144 @opindex malign-300
8145 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8146 The default for the H8/300H and H8S is to align longs and floats on 4
8147 byte boundaries.
8148 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8149 This option has no effect on the H8/300.
8150 @end table
8151
8152 @node HPPA Options
8153 @subsection HPPA Options
8154 @cindex HPPA Options
8155
8156 These @samp{-m} options are defined for the HPPA family of computers:
8157
8158 @table @gcctabopt
8159 @item -march=@var{architecture-type}
8160 @opindex march
8161 Generate code for the specified architecture.  The choices for
8162 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8163 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8164 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8165 architecture option for your machine.  Code compiled for lower numbered
8166 architectures will run on higher numbered architectures, but not the
8167 other way around.
8168
8169 @item -mpa-risc-1-0
8170 @itemx -mpa-risc-1-1
8171 @itemx -mpa-risc-2-0
8172 @opindex mpa-risc-1-0
8173 @opindex mpa-risc-1-1
8174 @opindex mpa-risc-2-0
8175 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8176
8177 @item -mbig-switch
8178 @opindex mbig-switch
8179 Generate code suitable for big switch tables.  Use this option only if
8180 the assembler/linker complain about out of range branches within a switch
8181 table.
8182
8183 @item -mjump-in-delay
8184 @opindex mjump-in-delay
8185 Fill delay slots of function calls with unconditional jump instructions
8186 by modifying the return pointer for the function call to be the target
8187 of the conditional jump.
8188
8189 @item -mdisable-fpregs
8190 @opindex mdisable-fpregs
8191 Prevent floating point registers from being used in any manner.  This is
8192 necessary for compiling kernels which perform lazy context switching of
8193 floating point registers.  If you use this option and attempt to perform
8194 floating point operations, the compiler will abort.
8195
8196 @item -mdisable-indexing
8197 @opindex mdisable-indexing
8198 Prevent the compiler from using indexing address modes.  This avoids some
8199 rather obscure problems when compiling MIG generated code under MACH@.
8200
8201 @item -mno-space-regs
8202 @opindex mno-space-regs
8203 Generate code that assumes the target has no space registers.  This allows
8204 GCC to generate faster indirect calls and use unscaled index address modes.
8205
8206 Such code is suitable for level 0 PA systems and kernels.
8207
8208 @item -mfast-indirect-calls
8209 @opindex mfast-indirect-calls
8210 Generate code that assumes calls never cross space boundaries.  This
8211 allows GCC to emit code which performs faster indirect calls.
8212
8213 This option will not work in the presence of shared libraries or nested
8214 functions.
8215
8216 @item -mfixed-range=@var{register-range}
8217 @opindex mfixed-range
8218 Generate code treating the given register range as fixed registers.
8219 A fixed register is one that the register allocator can not use.  This is
8220 useful when compiling kernel code.  A register range is specified as
8221 two registers separated by a dash.  Multiple register ranges can be
8222 specified separated by a comma.
8223
8224 @item -mlong-load-store
8225 @opindex mlong-load-store
8226 Generate 3-instruction load and store sequences as sometimes required by
8227 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8228 the HP compilers.
8229
8230 @item -mportable-runtime
8231 @opindex mportable-runtime
8232 Use the portable calling conventions proposed by HP for ELF systems.
8233
8234 @item -mgas
8235 @opindex mgas
8236 Enable the use of assembler directives only GAS understands.
8237
8238 @item -mschedule=@var{cpu-type}
8239 @opindex mschedule
8240 Schedule code according to the constraints for the machine type
8241 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8242 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8243 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8244 proper scheduling option for your machine.  The default scheduling is
8245 @samp{8000}.
8246
8247 @item -mlinker-opt
8248 @opindex mlinker-opt
8249 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8250 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8251 linkers in which they give bogus error messages when linking some programs.
8252
8253 @item -msoft-float
8254 @opindex msoft-float
8255 Generate output containing library calls for floating point.
8256 @strong{Warning:} the requisite libraries are not available for all HPPA
8257 targets.  Normally the facilities of the machine's usual C compiler are
8258 used, but this cannot be done directly in cross-compilation.  You must make
8259 your own arrangements to provide suitable library functions for
8260 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8261 does provide software floating point support.
8262
8263 @option{-msoft-float} changes the calling convention in the output file;
8264 therefore, it is only useful if you compile @emph{all} of a program with
8265 this option.  In particular, you need to compile @file{libgcc.a}, the
8266 library that comes with GCC, with @option{-msoft-float} in order for
8267 this to work.
8268
8269 @item -msio
8270 @opindex msio
8271 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8272 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8273 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8274 options are available under HP-UX and HI-UX@.
8275
8276 @item -mgnu-ld
8277 @opindex gnu-ld
8278 Use GNU ld specific options.  This passes @option{-shared} to ld when
8279 building a shared library.  It is the default when GCC is configured,
8280 explicitly or implicitly, with the GNU linker.  This option does not
8281 have any affect on which ld is called, it only changes what parameters
8282 are passed to that ld.  The ld that is called is determined by the
8283 @option{--with-ld} configure option, GCC's program search path, and
8284 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8285 using @samp{which `gcc -print-prog-name=ld`}.
8286
8287 @item -mhp-ld
8288 @opindex hp-ld
8289 Use HP ld specific options.  This passes @option{-b} to ld when building
8290 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8291 links.  It is the default when GCC is configured, explicitly or
8292 implicitly, with the HP linker.  This option does not have any affect on
8293 which ld is called, it only changes what parameters are passed to that
8294 ld.  The ld that is called is determined by the @option{--with-ld}
8295 configure option, GCC's program search path, and finally by the user's
8296 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8297 `gcc -print-prog-name=ld`}.
8298
8299 @item -mlong-calls
8300 @opindex mno-long-calls
8301 Generate code that uses long call sequences.  This ensures that a call
8302 is always able to reach linker generated stubs.  The default is to generate
8303 long calls only when the distance from the call site to the beginning
8304 of the function or translation unit, as the case may be, exceeds a
8305 predefined limit set by the branch type being used.  The limits for
8306 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8307 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8308 240,000 bytes.
8309
8310 Distances are measured from the beginning of functions when using the
8311 @option{-ffunction-sections} option, or when using the @option{-mgas}
8312 and @option{-mno-portable-runtime} options together under HP-UX with
8313 the SOM linker.
8314
8315 It is normally not desirable to use this option as it will degrade
8316 performance.  However, it may be useful in large applications,
8317 particularly when partial linking is used to build the application.
8318
8319 The types of long calls used depends on the capabilities of the
8320 assembler and linker, and the type of code being generated.  The
8321 impact on systems that support long absolute calls, and long pic
8322 symbol-difference or pc-relative calls should be relatively small.
8323 However, an indirect call is used on 32-bit ELF systems in pic code
8324 and it is quite long.
8325
8326 @item -munix=@var{unix-std}
8327 @opindex march
8328 Generate compiler predefines and select a startfile for the specified
8329 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8330 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8331 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8332 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8333 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8334 and later.
8335
8336 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8337 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8338 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8339 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8340 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8341 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8342
8343 It is @emph{important} to note that this option changes the interfaces
8344 for various library routines.  It also affects the operational behavior
8345 of the C library.  Thus, @emph{extreme} care is needed in using this
8346 option.
8347
8348 Library code that is intended to operate with more than one UNIX
8349 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8350 as appropriate.  Most GNU software doesn't provide this capability.
8351
8352 @item -nolibdld
8353 @opindex nolibdld
8354 Suppress the generation of link options to search libdld.sl when the
8355 @option{-static} option is specified on HP-UX 10 and later.
8356
8357 @item -static
8358 @opindex static
8359 The HP-UX implementation of setlocale in libc has a dependency on
8360 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8361 when the @option{-static} option is specified, special link options
8362 are needed to resolve this dependency.
8363
8364 On HP-UX 10 and later, the GCC driver adds the necessary options to
8365 link with libdld.sl when the @option{-static} option is specified.
8366 This causes the resulting binary to be dynamic.  On the 64-bit port,
8367 the linkers generate dynamic binaries by default in any case.  The
8368 @option{-nolibdld} option can be used to prevent the GCC driver from
8369 adding these link options.
8370
8371 @item -threads
8372 @opindex threads
8373 Add support for multithreading with the @dfn{dce thread} library
8374 under HP-UX@.  This option sets flags for both the preprocessor and
8375 linker.
8376 @end table
8377
8378 @node i386 and x86-64 Options
8379 @subsection Intel 386 and AMD x86-64 Options
8380 @cindex i386 Options
8381 @cindex x86-64 Options
8382 @cindex Intel 386 Options
8383 @cindex AMD x86-64 Options
8384
8385 These @samp{-m} options are defined for the i386 and x86-64 family of
8386 computers:
8387
8388 @table @gcctabopt
8389 @item -mtune=@var{cpu-type}
8390 @opindex mtune
8391 Tune to @var{cpu-type} everything applicable about the generated code, except
8392 for the ABI and the set of available instructions.  The choices for
8393 @var{cpu-type} are:
8394 @table @emph
8395 @item i386
8396 Original Intel's i386 CPU@.
8397 @item i486
8398 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8399 @item i586, pentium
8400 Intel Pentium CPU with no MMX support.
8401 @item pentium-mmx
8402 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8403 @item i686, pentiumpro
8404 Intel PentiumPro CPU@.
8405 @item pentium2
8406 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8407 @item pentium3, pentium3m
8408 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8409 support.
8410 @item pentium-m
8411 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8412 support.  Used by Centrino notebooks.
8413 @item pentium4, pentium4m
8414 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8415 @item prescott
8416 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8417 set support.
8418 @item nocona
8419 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8420 SSE2 and SSE3 instruction set support.
8421 @item k6
8422 AMD K6 CPU with MMX instruction set support.
8423 @item k6-2, k6-3
8424 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8425 @item athlon, athlon-tbird
8426 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8427 support.
8428 @item athlon-4, athlon-xp, athlon-mp
8429 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8430 instruction set support.
8431 @item k8, opteron, athlon64, athlon-fx
8432 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8433 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8434 @item winchip-c6
8435 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8436 set support.
8437 @item winchip2
8438 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8439 instruction set support.
8440 @item c3
8441 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8442 implemented for this chip.)
8443 @item c3-2
8444 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8445 implemented for this chip.)
8446 @end table
8447
8448 While picking a specific @var{cpu-type} will schedule things appropriately
8449 for that particular chip, the compiler will not generate any code that
8450 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8451 being used.
8452
8453 @item -march=@var{cpu-type}
8454 @opindex march
8455 Generate instructions for the machine type @var{cpu-type}.  The choices
8456 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8457 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8458
8459 @item -mcpu=@var{cpu-type}
8460 @opindex mcpu
8461 A deprecated synonym for @option{-mtune}.
8462
8463 @item -m386
8464 @itemx -m486
8465 @itemx -mpentium
8466 @itemx -mpentiumpro
8467 @opindex m386
8468 @opindex m486
8469 @opindex mpentium
8470 @opindex mpentiumpro
8471 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8472 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8473 These synonyms are deprecated.
8474
8475 @item -mfpmath=@var{unit}
8476 @opindex march
8477 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8478 for @var{unit} are:
8479
8480 @table @samp
8481 @item 387
8482 Use the standard 387 floating point coprocessor present majority of chips and
8483 emulated otherwise.  Code compiled with this option will run almost everywhere.
8484 The temporary results are computed in 80bit precision instead of precision
8485 specified by the type resulting in slightly different results compared to most
8486 of other chips.  See @option{-ffloat-store} for more detailed description.
8487
8488 This is the default choice for i386 compiler.
8489
8490 @item sse
8491 Use scalar floating point instructions present in the SSE instruction set.
8492 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8493 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8494 instruction set supports only single precision arithmetics, thus the double and
8495 extended precision arithmetics is still done using 387.  Later version, present
8496 only in Pentium4 and the future AMD x86-64 chips supports double precision
8497 arithmetics too.
8498
8499 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8500 or @option{-msse2} switches to enable SSE extensions and make this option
8501 effective.  For the x86-64 compiler, these extensions are enabled by default.
8502
8503 The resulting code should be considerably faster in the majority of cases and avoid
8504 the numerical instability problems of 387 code, but may break some existing
8505 code that expects temporaries to be 80bit.
8506
8507 This is the default choice for the x86-64 compiler.
8508
8509 @item sse,387
8510 Attempt to utilize both instruction sets at once.  This effectively double the
8511 amount of available registers and on chips with separate execution units for
8512 387 and SSE the execution resources too.  Use this option with care, as it is
8513 still experimental, because the GCC register allocator does not model separate
8514 functional units well resulting in instable performance.
8515 @end table
8516
8517 @item -masm=@var{dialect}
8518 @opindex masm=@var{dialect}
8519 Output asm instructions using selected @var{dialect}.  Supported choices are
8520 @samp{intel} or @samp{att} (the default one).
8521
8522 @item -mieee-fp
8523 @itemx -mno-ieee-fp
8524 @opindex mieee-fp
8525 @opindex mno-ieee-fp
8526 Control whether or not the compiler uses IEEE floating point
8527 comparisons.  These handle correctly the case where the result of a
8528 comparison is unordered.
8529
8530 @item -msoft-float
8531 @opindex msoft-float
8532 Generate output containing library calls for floating point.
8533 @strong{Warning:} the requisite libraries are not part of GCC@.
8534 Normally the facilities of the machine's usual C compiler are used, but
8535 this can't be done directly in cross-compilation.  You must make your
8536 own arrangements to provide suitable library functions for
8537 cross-compilation.
8538
8539 On machines where a function returns floating point results in the 80387
8540 register stack, some floating point opcodes may be emitted even if
8541 @option{-msoft-float} is used.
8542
8543 @item -mno-fp-ret-in-387
8544 @opindex mno-fp-ret-in-387
8545 Do not use the FPU registers for return values of functions.
8546
8547 The usual calling convention has functions return values of types
8548 @code{float} and @code{double} in an FPU register, even if there
8549 is no FPU@.  The idea is that the operating system should emulate
8550 an FPU@.
8551
8552 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8553 in ordinary CPU registers instead.
8554
8555 @item -mno-fancy-math-387
8556 @opindex mno-fancy-math-387
8557 Some 387 emulators do not support the @code{sin}, @code{cos} and
8558 @code{sqrt} instructions for the 387.  Specify this option to avoid
8559 generating those instructions.  This option is the default on FreeBSD,
8560 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8561 indicates that the target cpu will always have an FPU and so the
8562 instruction will not need emulation.  As of revision 2.6.1, these
8563 instructions are not generated unless you also use the
8564 @option{-funsafe-math-optimizations} switch.
8565
8566 @item -malign-double
8567 @itemx -mno-align-double
8568 @opindex malign-double
8569 @opindex mno-align-double
8570 Control whether GCC aligns @code{double}, @code{long double}, and
8571 @code{long long} variables on a two word boundary or a one word
8572 boundary.  Aligning @code{double} variables on a two word boundary will
8573 produce code that runs somewhat faster on a @samp{Pentium} at the
8574 expense of more memory.
8575
8576 @strong{Warning:} if you use the @option{-malign-double} switch,
8577 structures containing the above types will be aligned differently than
8578 the published application binary interface specifications for the 386
8579 and will not be binary compatible with structures in code compiled
8580 without that switch.
8581
8582 @item -m96bit-long-double
8583 @itemx -m128bit-long-double
8584 @opindex m96bit-long-double
8585 @opindex m128bit-long-double
8586 These switches control the size of @code{long double} type.  The i386
8587 application binary interface specifies the size to be 96 bits,
8588 so @option{-m96bit-long-double} is the default in 32 bit mode.
8589
8590 Modern architectures (Pentium and newer) would prefer @code{long double}
8591 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8592 conforming to the ABI, this would not be possible.  So specifying a
8593 @option{-m128bit-long-double} will align @code{long double}
8594 to a 16 byte boundary by padding the @code{long double} with an additional
8595 32 bit zero.
8596
8597 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8598 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8599
8600 Notice that neither of these options enable any extra precision over the x87
8601 standard of 80 bits for a @code{long double}.
8602
8603 @strong{Warning:} if you override the default value for your target ABI, the
8604 structures and arrays containing @code{long double} variables will change
8605 their size as well as function calling convention for function taking
8606 @code{long double} will be modified.  Hence they will not be binary
8607 compatible with arrays or structures in code compiled without that switch.
8608
8609
8610 @item -msvr3-shlib
8611 @itemx -mno-svr3-shlib
8612 @opindex msvr3-shlib
8613 @opindex mno-svr3-shlib
8614 Control whether GCC places uninitialized local variables into the
8615 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8616 into @code{bss}.  These options are meaningful only on System V Release 3.
8617
8618 @item -mrtd
8619 @opindex mrtd
8620 Use a different function-calling convention, in which functions that
8621 take a fixed number of arguments return with the @code{ret} @var{num}
8622 instruction, which pops their arguments while returning.  This saves one
8623 instruction in the caller since there is no need to pop the arguments
8624 there.
8625
8626 You can specify that an individual function is called with this calling
8627 sequence with the function attribute @samp{stdcall}.  You can also
8628 override the @option{-mrtd} option by using the function attribute
8629 @samp{cdecl}.  @xref{Function Attributes}.
8630
8631 @strong{Warning:} this calling convention is incompatible with the one
8632 normally used on Unix, so you cannot use it if you need to call
8633 libraries compiled with the Unix compiler.
8634
8635 Also, you must provide function prototypes for all functions that
8636 take variable numbers of arguments (including @code{printf});
8637 otherwise incorrect code will be generated for calls to those
8638 functions.
8639
8640 In addition, seriously incorrect code will result if you call a
8641 function with too many arguments.  (Normally, extra arguments are
8642 harmlessly ignored.)
8643
8644 @item -mregparm=@var{num}
8645 @opindex mregparm
8646 Control how many registers are used to pass integer arguments.  By
8647 default, no registers are used to pass arguments, and at most 3
8648 registers can be used.  You can control this behavior for a specific
8649 function by using the function attribute @samp{regparm}.
8650 @xref{Function Attributes}.
8651
8652 @strong{Warning:} if you use this switch, and
8653 @var{num} is nonzero, then you must build all modules with the same
8654 value, including any libraries.  This includes the system libraries and
8655 startup modules.
8656
8657 @item -mpreferred-stack-boundary=@var{num}
8658 @opindex mpreferred-stack-boundary
8659 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8660 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8661 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8662 size (@option{-Os}), in which case the default is the minimum correct
8663 alignment (4 bytes for x86, and 8 bytes for x86-64).
8664
8665 On Pentium and PentiumPro, @code{double} and @code{long double} values
8666 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8667 suffer significant run time performance penalties.  On Pentium III, the
8668 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8669 penalties if it is not 16 byte aligned.
8670
8671 To ensure proper alignment of this values on the stack, the stack boundary
8672 must be as aligned as that required by any value stored on the stack.
8673 Further, every function must be generated such that it keeps the stack
8674 aligned.  Thus calling a function compiled with a higher preferred
8675 stack boundary from a function compiled with a lower preferred stack
8676 boundary will most likely misalign the stack.  It is recommended that
8677 libraries that use callbacks always use the default setting.
8678
8679 This extra alignment does consume extra stack space, and generally
8680 increases code size.  Code that is sensitive to stack space usage, such
8681 as embedded systems and operating system kernels, may want to reduce the
8682 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8683
8684 @item -mmmx
8685 @itemx -mno-mmx
8686 @item -msse
8687 @itemx -mno-sse
8688 @item -msse2
8689 @itemx -mno-sse2
8690 @item -msse3
8691 @itemx -mno-sse3
8692 @item -m3dnow
8693 @itemx -mno-3dnow
8694 @opindex mmmx
8695 @opindex mno-mmx
8696 @opindex msse
8697 @opindex mno-sse
8698 @opindex m3dnow
8699 @opindex mno-3dnow
8700 These switches enable or disable the use of built-in functions that allow
8701 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8702 instruction set.
8703
8704 @xref{X86 Built-in Functions}, for details of the functions enabled
8705 and disabled by these switches.
8706
8707 To have SSE/SSE2 instructions generated automatically from floating-point
8708 code, see @option{-mfpmath=sse}.
8709
8710 @item -mpush-args
8711 @itemx -mno-push-args
8712 @opindex mpush-args
8713 @opindex mno-push-args
8714 Use PUSH operations to store outgoing parameters.  This method is shorter
8715 and usually equally fast as method using SUB/MOV operations and is enabled
8716 by default.  In some cases disabling it may improve performance because of
8717 improved scheduling and reduced dependencies.
8718
8719 @item -maccumulate-outgoing-args
8720 @opindex maccumulate-outgoing-args
8721 If enabled, the maximum amount of space required for outgoing arguments will be
8722 computed in the function prologue.  This is faster on most modern CPUs
8723 because of reduced dependencies, improved scheduling and reduced stack usage
8724 when preferred stack boundary is not equal to 2.  The drawback is a notable
8725 increase in code size.  This switch implies @option{-mno-push-args}.
8726
8727 @item -mthreads
8728 @opindex mthreads
8729 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8730 on thread-safe exception handling must compile and link all code with the
8731 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8732 @option{-D_MT}; when linking, it links in a special thread helper library
8733 @option{-lmingwthrd} which cleans up per thread exception handling data.
8734
8735 @item -mno-align-stringops
8736 @opindex mno-align-stringops
8737 Do not align destination of inlined string operations.  This switch reduces
8738 code size and improves performance in case the destination is already aligned,
8739 but GCC doesn't know about it.
8740
8741 @item -minline-all-stringops
8742 @opindex minline-all-stringops
8743 By default GCC inlines string operations only when destination is known to be
8744 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8745 size, but may improve performance of code that depends on fast memcpy, strlen
8746 and memset for short lengths.
8747
8748 @item -momit-leaf-frame-pointer
8749 @opindex momit-leaf-frame-pointer
8750 Don't keep the frame pointer in a register for leaf functions.  This
8751 avoids the instructions to save, set up and restore frame pointers and
8752 makes an extra register available in leaf functions.  The option
8753 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8754 which might make debugging harder.
8755
8756 @item -mtls-direct-seg-refs
8757 @itemx -mno-tls-direct-seg-refs
8758 @opindex mtls-direct-seg-refs
8759 Controls whether TLS variables may be accessed with offsets from the
8760 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8761 or whether the thread base pointer must be added.  Whether or not this
8762 is legal depends on the operating system, and whether it maps the
8763 segment to cover the entire TLS area.
8764
8765 For systems that use GNU libc, the default is on.
8766 @end table
8767
8768 These @samp{-m} switches are supported in addition to the above
8769 on AMD x86-64 processors in 64-bit environments.
8770
8771 @table @gcctabopt
8772 @item -m32
8773 @itemx -m64
8774 @opindex m32
8775 @opindex m64
8776 Generate code for a 32-bit or 64-bit environment.
8777 The 32-bit environment sets int, long and pointer to 32 bits and
8778 generates code that runs on any i386 system.
8779 The 64-bit environment sets int to 32 bits and long and pointer
8780 to 64 bits and generates code for AMD's x86-64 architecture.
8781
8782 @item -mno-red-zone
8783 @opindex no-red-zone
8784 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8785 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8786 stack pointer that will not be modified by signal or interrupt handlers
8787 and therefore can be used for temporary data without adjusting the stack
8788 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8789
8790 @item -mcmodel=small
8791 @opindex mcmodel=small
8792 Generate code for the small code model: the program and its symbols must
8793 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8794 Programs can be statically or dynamically linked.  This is the default
8795 code model.
8796
8797 @item -mcmodel=kernel
8798 @opindex mcmodel=kernel
8799 Generate code for the kernel code model.  The kernel runs in the
8800 negative 2 GB of the address space.
8801 This model has to be used for Linux kernel code.
8802
8803 @item -mcmodel=medium
8804 @opindex mcmodel=medium
8805 Generate code for the medium model: The program is linked in the lower 2
8806 GB of the address space but symbols can be located anywhere in the
8807 address space.  Programs can be statically or dynamically linked, but
8808 building of shared libraries are not supported with the medium model.
8809
8810 @item -mcmodel=large
8811 @opindex mcmodel=large
8812 Generate code for the large model: This model makes no assumptions
8813 about addresses and sizes of sections.  Currently GCC does not implement
8814 this model.
8815 @end table
8816
8817 @node IA-64 Options
8818 @subsection IA-64 Options
8819 @cindex IA-64 Options
8820
8821 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8822
8823 @table @gcctabopt
8824 @item -mbig-endian
8825 @opindex mbig-endian
8826 Generate code for a big endian target.  This is the default for HP-UX@.
8827
8828 @item -mlittle-endian
8829 @opindex mlittle-endian
8830 Generate code for a little endian target.  This is the default for AIX5
8831 and GNU/Linux.
8832
8833 @item -mgnu-as
8834 @itemx -mno-gnu-as
8835 @opindex mgnu-as
8836 @opindex mno-gnu-as
8837 Generate (or don't) code for the GNU assembler.  This is the default.
8838 @c Also, this is the default if the configure option @option{--with-gnu-as}
8839 @c is used.
8840
8841 @item -mgnu-ld
8842 @itemx -mno-gnu-ld
8843 @opindex mgnu-ld
8844 @opindex mno-gnu-ld
8845 Generate (or don't) code for the GNU linker.  This is the default.
8846 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8847 @c is used.
8848
8849 @item -mno-pic
8850 @opindex mno-pic
8851 Generate code that does not use a global pointer register.  The result
8852 is not position independent code, and violates the IA-64 ABI@.
8853
8854 @item -mvolatile-asm-stop
8855 @itemx -mno-volatile-asm-stop
8856 @opindex mvolatile-asm-stop
8857 @opindex mno-volatile-asm-stop
8858 Generate (or don't) a stop bit immediately before and after volatile asm
8859 statements.
8860
8861 @item -mb-step
8862 @opindex mb-step
8863 Generate code that works around Itanium B step errata.
8864
8865 @item -mregister-names
8866 @itemx -mno-register-names
8867 @opindex mregister-names
8868 @opindex mno-register-names
8869 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8870 the stacked registers.  This may make assembler output more readable.
8871
8872 @item -mno-sdata
8873 @itemx -msdata
8874 @opindex mno-sdata
8875 @opindex msdata
8876 Disable (or enable) optimizations that use the small data section.  This may
8877 be useful for working around optimizer bugs.
8878
8879 @item -mconstant-gp
8880 @opindex mconstant-gp
8881 Generate code that uses a single constant global pointer value.  This is
8882 useful when compiling kernel code.
8883
8884 @item -mauto-pic
8885 @opindex mauto-pic
8886 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8887 This is useful when compiling firmware code.
8888
8889 @item -minline-float-divide-min-latency
8890 @opindex minline-float-divide-min-latency
8891 Generate code for inline divides of floating point values
8892 using the minimum latency algorithm.
8893
8894 @item -minline-float-divide-max-throughput
8895 @opindex minline-float-divide-max-throughput
8896 Generate code for inline divides of floating point values
8897 using the maximum throughput algorithm.
8898
8899 @item -minline-int-divide-min-latency
8900 @opindex minline-int-divide-min-latency
8901 Generate code for inline divides of integer values
8902 using the minimum latency algorithm.
8903
8904 @item -minline-int-divide-max-throughput
8905 @opindex minline-int-divide-max-throughput
8906 Generate code for inline divides of integer values
8907 using the maximum throughput algorithm.
8908
8909 @item -minline-sqrt-min-latency
8910 @opindex minline-sqrt-min-latency
8911 Generate code for inline square roots
8912 using the minimum latency algorithm.
8913
8914 @item -minline-sqrt-max-throughput
8915 @opindex minline-sqrt-max-throughput
8916 Generate code for inline square roots
8917 using the maximum throughput algorithm.
8918
8919 @item -mno-dwarf2-asm
8920 @itemx -mdwarf2-asm
8921 @opindex mno-dwarf2-asm
8922 @opindex mdwarf2-asm
8923 Don't (or do) generate assembler code for the DWARF2 line number debugging
8924 info.  This may be useful when not using the GNU assembler.
8925
8926 @item -mearly-stop-bits
8927 @itemx -mno-early-stop-bits
8928 @opindex mearly-stop-bits
8929 @opindex mno-early-stop-bits
8930 Allow stop bits to be placed earlier than immediately preceding the
8931 instruction that triggered the stop bit.  This can improve instruction
8932 scheduling, but does not always do so.
8933
8934 @item -mfixed-range=@var{register-range}
8935 @opindex mfixed-range
8936 Generate code treating the given register range as fixed registers.
8937 A fixed register is one that the register allocator can not use.  This is
8938 useful when compiling kernel code.  A register range is specified as
8939 two registers separated by a dash.  Multiple register ranges can be
8940 specified separated by a comma.
8941
8942 @item -mtls-size=@var{tls-size}
8943 @opindex mtls-size
8944 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
8945 64.
8946
8947 @item -mtune-arch=@var{cpu-type}
8948 @opindex mtune-arch
8949 Tune the instruction scheduling for a particular CPU, Valid values are
8950 itanium, itanium1, merced, itanium2, and mckinley.
8951
8952 @item -mt
8953 @itemx -pthread
8954 @opindex mt
8955 @opindex pthread
8956 Add support for multithreading using the POSIX threads library.  This
8957 option sets flags for both the preprocessor and linker.  It does
8958 not affect the thread safety of object code produced by the compiler or
8959 that of libraries supplied with it.  These are HP-UX specific flags.
8960
8961 @item -milp32
8962 @itemx -mlp64
8963 @opindex milp32
8964 @opindex mlp64
8965 Generate code for a 32-bit or 64-bit environment.
8966 The 32-bit environment sets int, long and pointer to 32 bits.
8967 The 64-bit environment sets int to 32 bits and long and pointer
8968 to 64 bits.  These are HP-UX specific flags.
8969
8970 @end table
8971
8972 @node M32R/D Options
8973 @subsection M32R/D Options
8974 @cindex M32R/D options
8975
8976 These @option{-m} options are defined for Renesas M32R/D architectures:
8977
8978 @table @gcctabopt
8979 @item -m32r2
8980 @opindex m32r2
8981 Generate code for the M32R/2@.
8982
8983 @item -m32rx
8984 @opindex m32rx
8985 Generate code for the M32R/X@.
8986
8987 @item -m32r
8988 @opindex m32r
8989 Generate code for the M32R@.  This is the default.
8990
8991 @item -mmodel=small
8992 @opindex mmodel=small
8993 Assume all objects live in the lower 16MB of memory (so that their addresses
8994 can be loaded with the @code{ld24} instruction), and assume all subroutines
8995 are reachable with the @code{bl} instruction.
8996 This is the default.
8997
8998 The addressability of a particular object can be set with the
8999 @code{model} attribute.
9000
9001 @item -mmodel=medium
9002 @opindex mmodel=medium
9003 Assume objects may be anywhere in the 32-bit address space (the compiler
9004 will generate @code{seth/add3} instructions to load their addresses), and
9005 assume all subroutines are reachable with the @code{bl} instruction.
9006
9007 @item -mmodel=large
9008 @opindex mmodel=large
9009 Assume objects may be anywhere in the 32-bit address space (the compiler
9010 will generate @code{seth/add3} instructions to load their addresses), and
9011 assume subroutines may not be reachable with the @code{bl} instruction
9012 (the compiler will generate the much slower @code{seth/add3/jl}
9013 instruction sequence).
9014
9015 @item -msdata=none
9016 @opindex msdata=none
9017 Disable use of the small data area.  Variables will be put into
9018 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9019 @code{section} attribute has been specified).
9020 This is the default.
9021
9022 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9023 Objects may be explicitly put in the small data area with the
9024 @code{section} attribute using one of these sections.
9025
9026 @item -msdata=sdata
9027 @opindex msdata=sdata
9028 Put small global and static data in the small data area, but do not
9029 generate special code to reference them.
9030
9031 @item -msdata=use
9032 @opindex msdata=use
9033 Put small global and static data in the small data area, and generate
9034 special instructions to reference them.
9035
9036 @item -G @var{num}
9037 @opindex G
9038 @cindex smaller data references
9039 Put global and static objects less than or equal to @var{num} bytes
9040 into the small data or bss sections instead of the normal data or bss
9041 sections.  The default value of @var{num} is 8.
9042 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9043 for this option to have any effect.
9044
9045 All modules should be compiled with the same @option{-G @var{num}} value.
9046 Compiling with different values of @var{num} may or may not work; if it
9047 doesn't the linker will give an error message---incorrect code will not be
9048 generated.
9049
9050 @item -mdebug
9051 @opindex mdebug
9052 Makes the M32R specific code in the compiler display some statistics
9053 that might help in debugging programs.
9054
9055 @item -malign-loops
9056 @opindex malign-loops
9057 Align all loops to a 32-byte boundary.
9058
9059 @item -mno-align-loops
9060 @opindex mno-align-loops
9061 Do not enforce a 32-byte alignment for loops.  This is the default.
9062
9063 @item -missue-rate=@var{number}
9064 @opindex missue-rate=@var{number}
9065 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9066 or 2.
9067
9068 @item -mbranch-cost=@var{number}
9069 @opindex mbranch-cost=@var{number}
9070 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9071 preferred over conditional code, if it is 2, then the opposite will
9072 apply.
9073
9074 @item -mflush-trap=@var{number}
9075 @opindex mflush-trap=@var{number}
9076 Specifies the trap number to use to flush the cache.  The default is
9077 12.  Valid numbers are between 0 and 15 inclusive.
9078
9079 @item -mno-flush-trap
9080 @opindex mno-flush-trap
9081 Specifies that the cache cannot be flushed by using a trap.
9082
9083 @item -mflush-func=@var{name}
9084 @opindex mflush-func=@var{name}
9085 Specifies the name of the operating system function to call to flush
9086 the cache.  The default is @emph{_flush_cache}, but a function call
9087 will only be used if a trap is not available.
9088
9089 @item -mno-flush-func
9090 @opindex mno-flush-func
9091 Indicates that there is no OS function for flushing the cache.
9092
9093 @end table
9094
9095 @node M680x0 Options
9096 @subsection M680x0 Options
9097 @cindex M680x0 options
9098
9099 These are the @samp{-m} options defined for the 68000 series.  The default
9100 values for these options depends on which style of 68000 was selected when
9101 the compiler was configured; the defaults for the most common choices are
9102 given below.
9103
9104 @table @gcctabopt
9105 @item -m68000
9106 @itemx -mc68000
9107 @opindex m68000
9108 @opindex mc68000
9109 Generate output for a 68000.  This is the default
9110 when the compiler is configured for 68000-based systems.
9111
9112 Use this option for microcontrollers with a 68000 or EC000 core,
9113 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9114
9115 @item -m68020
9116 @itemx -mc68020
9117 @opindex m68020
9118 @opindex mc68020
9119 Generate output for a 68020.  This is the default
9120 when the compiler is configured for 68020-based systems.
9121
9122 @item -m68881
9123 @opindex m68881
9124 Generate output containing 68881 instructions for floating point.
9125 This is the default for most 68020 systems unless @option{--nfp} was
9126 specified when the compiler was configured.
9127
9128 @item -m68030
9129 @opindex m68030
9130 Generate output for a 68030.  This is the default when the compiler is
9131 configured for 68030-based systems.
9132
9133 @item -m68040
9134 @opindex m68040
9135 Generate output for a 68040.  This is the default when the compiler is
9136 configured for 68040-based systems.
9137
9138 This option inhibits the use of 68881/68882 instructions that have to be
9139 emulated by software on the 68040.  Use this option if your 68040 does not
9140 have code to emulate those instructions.
9141
9142 @item -m68060
9143 @opindex m68060
9144 Generate output for a 68060.  This is the default when the compiler is
9145 configured for 68060-based systems.
9146
9147 This option inhibits the use of 68020 and 68881/68882 instructions that
9148 have to be emulated by software on the 68060.  Use this option if your 68060
9149 does not have code to emulate those instructions.
9150
9151 @item -mcpu32
9152 @opindex mcpu32
9153 Generate output for a CPU32.  This is the default
9154 when the compiler is configured for CPU32-based systems.
9155
9156 Use this option for microcontrollers with a
9157 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9158 68336, 68340, 68341, 68349 and 68360.
9159
9160 @item -m5200
9161 @opindex m5200
9162 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9163 when the compiler is configured for 520X-based systems.
9164
9165 Use this option for microcontroller with a 5200 core, including
9166 the MCF5202, MCF5203, MCF5204 and MCF5202.
9167
9168
9169 @item -m68020-40
9170 @opindex m68020-40
9171 Generate output for a 68040, without using any of the new instructions.
9172 This results in code which can run relatively efficiently on either a
9173 68020/68881 or a 68030 or a 68040.  The generated code does use the
9174 68881 instructions that are emulated on the 68040.
9175
9176 @item -m68020-60
9177 @opindex m68020-60
9178 Generate output for a 68060, without using any of the new instructions.
9179 This results in code which can run relatively efficiently on either a
9180 68020/68881 or a 68030 or a 68040.  The generated code does use the
9181 68881 instructions that are emulated on the 68060.
9182
9183 @item -msoft-float
9184 @opindex msoft-float
9185 Generate output containing library calls for floating point.
9186 @strong{Warning:} the requisite libraries are not available for all m68k
9187 targets.  Normally the facilities of the machine's usual C compiler are
9188 used, but this can't be done directly in cross-compilation.  You must
9189 make your own arrangements to provide suitable library functions for
9190 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9191 @samp{m68k-*-coff} do provide software floating point support.
9192
9193 @item -mshort
9194 @opindex mshort
9195 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9196 Additionally, parameters passed on the stack are also aligned to a
9197 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9198
9199 @item -mnobitfield
9200 @opindex mnobitfield
9201 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9202 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9203
9204 @item -mbitfield
9205 @opindex mbitfield
9206 Do use the bit-field instructions.  The @option{-m68020} option implies
9207 @option{-mbitfield}.  This is the default if you use a configuration
9208 designed for a 68020.
9209
9210 @item -mrtd
9211 @opindex mrtd
9212 Use a different function-calling convention, in which functions
9213 that take a fixed number of arguments return with the @code{rtd}
9214 instruction, which pops their arguments while returning.  This
9215 saves one instruction in the caller since there is no need to pop
9216 the arguments there.
9217
9218 This calling convention is incompatible with the one normally
9219 used on Unix, so you cannot use it if you need to call libraries
9220 compiled with the Unix compiler.
9221
9222 Also, you must provide function prototypes for all functions that
9223 take variable numbers of arguments (including @code{printf});
9224 otherwise incorrect code will be generated for calls to those
9225 functions.
9226
9227 In addition, seriously incorrect code will result if you call a
9228 function with too many arguments.  (Normally, extra arguments are
9229 harmlessly ignored.)
9230
9231 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9232 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9233
9234 @item -malign-int
9235 @itemx -mno-align-int
9236 @opindex malign-int
9237 @opindex mno-align-int
9238 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9239 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9240 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9241 Aligning variables on 32-bit boundaries produces code that runs somewhat
9242 faster on processors with 32-bit busses at the expense of more memory.
9243
9244 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9245 align structures containing the above types  differently than
9246 most published application binary interface specifications for the m68k.
9247
9248 @item -mpcrel
9249 @opindex mpcrel
9250 Use the pc-relative addressing mode of the 68000 directly, instead of
9251 using a global offset table.  At present, this option implies @option{-fpic},
9252 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9253 not presently supported with @option{-mpcrel}, though this could be supported for
9254 68020 and higher processors.
9255
9256 @item -mno-strict-align
9257 @itemx -mstrict-align
9258 @opindex mno-strict-align
9259 @opindex mstrict-align
9260 Do not (do) assume that unaligned memory references will be handled by
9261 the system.
9262
9263 @item -msep-data
9264 Generate code that allows the data segment to be located in a different
9265 area of memory from the text segment.  This allows for execute in place in
9266 an environment without virtual memory management.  This option implies
9267 @option{-fPIC}.
9268
9269 @item -mno-sep-data
9270 Generate code that assumes that the data segment follows the text segment.
9271 This is the default.
9272
9273 @item -mid-shared-library
9274 Generate code that supports shared libraries via the library ID method.
9275 This allows for execute in place and shared libraries in an environment
9276 without virtual memory management.  This option implies @option{-fPIC}.
9277
9278 @item -mno-id-shared-library
9279 Generate code that doesn't assume ID based shared libraries are being used.
9280 This is the default.
9281
9282 @item -mshared-library-id=n
9283 Specified the identification number of the ID based shared library being
9284 compiled.  Specifying a value of 0 will generate more compact code, specifying
9285 other values will force the allocation of that number to the current
9286 library but is no more space or time efficient than omitting this option.
9287
9288 @end table
9289
9290 @node M68hc1x Options
9291 @subsection M68hc1x Options
9292 @cindex M68hc1x options
9293
9294 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9295 microcontrollers.  The default values for these options depends on
9296 which style of microcontroller was selected when the compiler was configured;
9297 the defaults for the most common choices are given below.
9298
9299 @table @gcctabopt
9300 @item -m6811
9301 @itemx -m68hc11
9302 @opindex m6811
9303 @opindex m68hc11
9304 Generate output for a 68HC11.  This is the default
9305 when the compiler is configured for 68HC11-based systems.
9306
9307 @item -m6812
9308 @itemx -m68hc12
9309 @opindex m6812
9310 @opindex m68hc12
9311 Generate output for a 68HC12.  This is the default
9312 when the compiler is configured for 68HC12-based systems.
9313
9314 @item -m68S12
9315 @itemx -m68hcs12
9316 @opindex m68S12
9317 @opindex m68hcs12
9318 Generate output for a 68HCS12.
9319
9320 @item -mauto-incdec
9321 @opindex mauto-incdec
9322 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9323 addressing modes.
9324
9325 @item -minmax
9326 @itemx -nominmax
9327 @opindex minmax
9328 @opindex mnominmax
9329 Enable the use of 68HC12 min and max instructions.
9330
9331 @item -mlong-calls
9332 @itemx -mno-long-calls
9333 @opindex mlong-calls
9334 @opindex mno-long-calls
9335 Treat all calls as being far away (near).  If calls are assumed to be
9336 far away, the compiler will use the @code{call} instruction to
9337 call a function and the @code{rtc} instruction for returning.
9338
9339 @item -mshort
9340 @opindex mshort
9341 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9342
9343 @item -msoft-reg-count=@var{count}
9344 @opindex msoft-reg-count
9345 Specify the number of pseudo-soft registers which are used for the
9346 code generation.  The maximum number is 32.  Using more pseudo-soft
9347 register may or may not result in better code depending on the program.
9348 The default is 4 for 68HC11 and 2 for 68HC12.
9349
9350 @end table
9351
9352 @node MCore Options
9353 @subsection MCore Options
9354 @cindex MCore options
9355
9356 These are the @samp{-m} options defined for the Motorola M*Core
9357 processors.
9358
9359 @table @gcctabopt
9360
9361 @item -mhardlit
9362 @itemx -mno-hardlit
9363 @opindex mhardlit
9364 @opindex mno-hardlit
9365 Inline constants into the code stream if it can be done in two
9366 instructions or less.
9367
9368 @item -mdiv
9369 @itemx -mno-div
9370 @opindex mdiv
9371 @opindex mno-div
9372 Use the divide instruction.  (Enabled by default).
9373
9374 @item -mrelax-immediate
9375 @itemx -mno-relax-immediate
9376 @opindex mrelax-immediate
9377 @opindex mno-relax-immediate
9378 Allow arbitrary sized immediates in bit operations.
9379
9380 @item -mwide-bitfields
9381 @itemx -mno-wide-bitfields
9382 @opindex mwide-bitfields
9383 @opindex mno-wide-bitfields
9384 Always treat bit-fields as int-sized.
9385
9386 @item -m4byte-functions
9387 @itemx -mno-4byte-functions
9388 @opindex m4byte-functions
9389 @opindex mno-4byte-functions
9390 Force all functions to be aligned to a four byte boundary.
9391
9392 @item -mcallgraph-data
9393 @itemx -mno-callgraph-data
9394 @opindex mcallgraph-data
9395 @opindex mno-callgraph-data
9396 Emit callgraph information.
9397
9398 @item -mslow-bytes
9399 @itemx -mno-slow-bytes
9400 @opindex mslow-bytes
9401 @opindex mno-slow-bytes
9402 Prefer word access when reading byte quantities.
9403
9404 @item -mlittle-endian
9405 @itemx -mbig-endian
9406 @opindex mlittle-endian
9407 @opindex mbig-endian
9408 Generate code for a little endian target.
9409
9410 @item -m210
9411 @itemx -m340
9412 @opindex m210
9413 @opindex m340
9414 Generate code for the 210 processor.
9415 @end table
9416
9417 @node MIPS Options
9418 @subsection MIPS Options
9419 @cindex MIPS options
9420
9421 @table @gcctabopt
9422
9423 @item -EB
9424 @opindex EB
9425 Generate big-endian code.
9426
9427 @item -EL
9428 @opindex EL
9429 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9430 configurations.
9431
9432 @item -march=@var{arch}
9433 @opindex march
9434 Generate code that will run on @var{arch}, which can be the name of a
9435 generic MIPS ISA, or the name of a particular processor.
9436 The ISA names are:
9437 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9438 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9439 The processor names are:
9440 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9441 @samp{m4k},
9442 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9443 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9444 @samp{rm9000},
9445 @samp{orion},
9446 @samp{sb1},
9447 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9448 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9449 The special value @samp{from-abi} selects the
9450 most compatible architecture for the selected ABI (that is,
9451 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9452
9453 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9454 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9455 @samp{vr} may be written @samp{r}.
9456
9457 GCC defines two macros based on the value of this option.  The first
9458 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9459 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9460 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9461 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9462 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9463
9464 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9465 above.  In other words, it will have the full prefix and will not
9466 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9467 the macro names the resolved architecture (either @samp{"mips1"} or
9468 @samp{"mips3"}).  It names the default architecture when no
9469 @option{-march} option is given.
9470
9471 @item -mtune=@var{arch}
9472 @opindex mtune
9473 Optimize for @var{arch}.  Among other things, this option controls
9474 the way instructions are scheduled, and the perceived cost of arithmetic
9475 operations.  The list of @var{arch} values is the same as for
9476 @option{-march}.
9477
9478 When this option is not used, GCC will optimize for the processor
9479 specified by @option{-march}.  By using @option{-march} and
9480 @option{-mtune} together, it is possible to generate code that will
9481 run on a family of processors, but optimize the code for one
9482 particular member of that family.
9483
9484 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9485 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9486 @samp{-march} ones described above.
9487
9488 @item -mips1
9489 @opindex mips1
9490 Equivalent to @samp{-march=mips1}.
9491
9492 @item -mips2
9493 @opindex mips2
9494 Equivalent to @samp{-march=mips2}.
9495
9496 @item -mips3
9497 @opindex mips3
9498 Equivalent to @samp{-march=mips3}.
9499
9500 @item -mips4
9501 @opindex mips4
9502 Equivalent to @samp{-march=mips4}.
9503
9504 @item -mips32
9505 @opindex mips32
9506 Equivalent to @samp{-march=mips32}.
9507
9508 @item -mips32r2
9509 @opindex mips32r2
9510 Equivalent to @samp{-march=mips32r2}.
9511
9512 @item -mips64
9513 @opindex mips64
9514 Equivalent to @samp{-march=mips64}.
9515
9516 @item -mips16
9517 @itemx -mno-mips16
9518 @opindex mips16
9519 @opindex mno-mips16
9520 Use (do not use) the MIPS16 ISA@.
9521
9522 @item -mabi=32
9523 @itemx -mabi=o64
9524 @itemx -mabi=n32
9525 @itemx -mabi=64
9526 @itemx -mabi=eabi
9527 @opindex mabi=32
9528 @opindex mabi=o64
9529 @opindex mabi=n32
9530 @opindex mabi=64
9531 @opindex mabi=eabi
9532 Generate code for the given ABI@.
9533
9534 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9535 generates 64-bit code when you select a 64-bit architecture, but you
9536 can use @option{-mgp32} to get 32-bit code instead.
9537
9538 For information about the O64 ABI, see
9539 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9540
9541 @item -mabicalls
9542 @itemx -mno-abicalls
9543 @opindex mabicalls
9544 @opindex mno-abicalls
9545 Generate (do not generate) SVR4-style position-independent code.
9546 @option{-mabicalls} is the default for SVR4-based systems.
9547
9548 @item -mxgot
9549 @itemx -mno-xgot
9550 @opindex mxgot
9551 @opindex mno-xgot
9552 Lift (do not lift) the usual restrictions on the size of the global
9553 offset table.
9554
9555 GCC normally uses a single instruction to load values from the GOT@.
9556 While this is relatively efficient, it will only work if the GOT
9557 is smaller than about 64k.  Anything larger will cause the linker
9558 to report an error such as:
9559
9560 @cindex relocation truncated to fit (MIPS)
9561 @smallexample
9562 relocation truncated to fit: R_MIPS_GOT16 foobar
9563 @end smallexample
9564
9565 If this happens, you should recompile your code with @option{-mxgot}.
9566 It should then work with very large GOTs, although it will also be
9567 less efficient, since it will take three instructions to fetch the
9568 value of a global symbol.
9569
9570 Note that some linkers can create multiple GOTs.  If you have such a
9571 linker, you should only need to use @option{-mxgot} when a single object
9572 file accesses more than 64k's worth of GOT entries.  Very few do.
9573
9574 These options have no effect unless GCC is generating position
9575 independent code.
9576
9577 @item -mgp32
9578 @opindex mgp32
9579 Assume that general-purpose registers are 32 bits wide.
9580
9581 @item -mgp64
9582 @opindex mgp64
9583 Assume that general-purpose registers are 64 bits wide.
9584
9585 @item -mfp32
9586 @opindex mfp32
9587 Assume that floating-point registers are 32 bits wide.
9588
9589 @item -mfp64
9590 @opindex mfp64
9591 Assume that floating-point registers are 64 bits wide.
9592
9593 @item -mhard-float
9594 @opindex mhard-float
9595 Use floating-point coprocessor instructions.
9596
9597 @item -msoft-float
9598 @opindex msoft-float
9599 Do not use floating-point coprocessor instructions.  Implement
9600 floating-point calculations using library calls instead.
9601
9602 @item -msingle-float
9603 @opindex msingle-float
9604 Assume that the floating-point coprocessor only supports single-precision
9605 operations.
9606
9607 @itemx -mdouble-float
9608 @opindex mdouble-float
9609 Assume that the floating-point coprocessor supports double-precision
9610 operations.  This is the default.
9611
9612 @itemx -mpaired-single
9613 @itemx -mno-paired-single
9614 @opindex mpaired-single
9615 @opindex mno-paired-single
9616 Use (do not use) paired-single floating-point instructions.
9617 @xref{MIPS Paired-Single Support}.  This option can only be used
9618 when generating 64-bit code and requires hardware floating-point
9619 support to be enabled.
9620
9621 @itemx -mips3d
9622 @itemx -mno-mips3d
9623 @opindex mips3d
9624 @opindex mno-mips3d
9625 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9626 The option @option{-mips3d} implies @option{-mpaired-single}.
9627
9628 @item -mint64
9629 @opindex mint64
9630 Force @code{int} and @code{long} types to be 64 bits wide.  See
9631 @option{-mlong32} for an explanation of the default and the way
9632 that the pointer size is determined.
9633
9634 This option has been deprecated and will be removed in a future release.
9635
9636 @item -mlong64
9637 @opindex mlong64
9638 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9639 an explanation of the default and the way that the pointer size is
9640 determined.
9641
9642 @item -mlong32
9643 @opindex mlong32
9644 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9645
9646 The default size of @code{int}s, @code{long}s and pointers depends on
9647 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9648 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9649 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9650 or the same size as integer registers, whichever is smaller.
9651
9652 @item -G @var{num}
9653 @opindex G
9654 @cindex smaller data references (MIPS)
9655 @cindex gp-relative references (MIPS)
9656 Put global and static items less than or equal to @var{num} bytes into
9657 the small data or bss section instead of the normal data or bss section.
9658 This allows the data to be accessed using a single instruction.
9659
9660 All modules should be compiled with the same @option{-G @var{num}}
9661 value.
9662
9663 @item -membedded-data
9664 @itemx -mno-embedded-data
9665 @opindex membedded-data
9666 @opindex mno-embedded-data
9667 Allocate variables to the read-only data section first if possible, then
9668 next in the small data section if possible, otherwise in data.  This gives
9669 slightly slower code than the default, but reduces the amount of RAM required
9670 when executing, and thus may be preferred for some embedded systems.
9671
9672 @item -muninit-const-in-rodata
9673 @itemx -mno-uninit-const-in-rodata
9674 @opindex muninit-const-in-rodata
9675 @opindex mno-uninit-const-in-rodata
9676 Put uninitialized @code{const} variables in the read-only data section.
9677 This option is only meaningful in conjunction with @option{-membedded-data}.
9678
9679 @item -msplit-addresses
9680 @itemx -mno-split-addresses
9681 @opindex msplit-addresses
9682 @opindex mno-split-addresses
9683 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9684 relocation operators.  This option has been superceded by
9685 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9686
9687 @item -mexplicit-relocs
9688 @itemx -mno-explicit-relocs
9689 @opindex mexplicit-relocs
9690 @opindex mno-explicit-relocs
9691 Use (do not use) assembler relocation operators when dealing with symbolic
9692 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9693 is to use assembler macros instead.
9694
9695 @option{-mexplicit-relocs} is the default if GCC was configured
9696 to use an assembler that supports relocation operators.
9697
9698 @item -mcheck-zero-division
9699 @itemx -mno-check-zero-division
9700 @opindex mcheck-zero-division
9701 @opindex mno-check-zero-division
9702 Trap (do not trap) on integer division by zero.  The default is
9703 @option{-mcheck-zero-division}.
9704
9705 @item -mdivide-traps
9706 @itemx -mdivide-breaks
9707 @opindex mdivide-traps
9708 @opindex mdivide-breaks
9709 MIPS systems check for division by zero by generating either a
9710 conditional trap or a break instruction.  Using traps results in
9711 smaller code, but is only supported on MIPS II and later.  Also, some
9712 versions of the Linux kernel have a bug that prevents trap from
9713 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9714 allow conditional traps on architectures that support them and
9715 @option{-mdivide-breaks} to force the use of breaks.
9716
9717 The default is usually @option{-mdivide-traps}, but this can be
9718 overridden at configure time using @option{--with-divide=breaks}.
9719 Divide-by-zero checks can be completely disabled using
9720 @option{-mno-check-zero-division}.
9721
9722 @item -mmemcpy
9723 @itemx -mno-memcpy
9724 @opindex mmemcpy
9725 @opindex mno-memcpy
9726 Force (do not force) the use of @code{memcpy()} for non-trivial block
9727 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9728 most constant-sized copies.
9729
9730 @item -mlong-calls
9731 @itemx -mno-long-calls
9732 @opindex mlong-calls
9733 @opindex mno-long-calls
9734 Disable (do not disable) use of the @code{jal} instruction.  Calling
9735 functions using @code{jal} is more efficient but requires the caller
9736 and callee to be in the same 256 megabyte segment.
9737
9738 This option has no effect on abicalls code.  The default is
9739 @option{-mno-long-calls}.
9740
9741 @item -mmad
9742 @itemx -mno-mad
9743 @opindex mmad
9744 @opindex mno-mad
9745 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9746 instructions, as provided by the R4650 ISA@.
9747
9748 @item -mfused-madd
9749 @itemx -mno-fused-madd
9750 @opindex mfused-madd
9751 @opindex mno-fused-madd
9752 Enable (disable) use of the floating point multiply-accumulate
9753 instructions, when they are available.  The default is
9754 @option{-mfused-madd}.
9755
9756 When multiply-accumulate instructions are used, the intermediate
9757 product is calculated to infinite precision and is not subject to
9758 the FCSR Flush to Zero bit.  This may be undesirable in some
9759 circumstances.
9760
9761 @item -nocpp
9762 @opindex nocpp
9763 Tell the MIPS assembler to not run its preprocessor over user
9764 assembler files (with a @samp{.s} suffix) when assembling them.
9765
9766 @item -mfix-r4000
9767 @itemx -mno-fix-r4000
9768 @opindex mfix-r4000
9769 @opindex mno-fix-r4000
9770 Work around certain R4000 CPU errata:
9771 @itemize @minus
9772 @item
9773 A double-word or a variable shift may give an incorrect result if executed
9774 immediately after starting an integer division.
9775 @item
9776 A double-word or a variable shift may give an incorrect result if executed
9777 while an integer multiplication is in progress.
9778 @item
9779 An integer division may give an incorrect result if started in a delay slot
9780 of a taken branch or a jump.
9781 @end itemize
9782
9783 @item -mfix-r4400
9784 @itemx -mno-fix-r4400
9785 @opindex mfix-r4400
9786 @opindex mno-fix-r4400
9787 Work around certain R4400 CPU errata:
9788 @itemize @minus
9789 @item
9790 A double-word or a variable shift may give an incorrect result if executed
9791 immediately after starting an integer division.
9792 @end itemize
9793
9794 @item -mfix-vr4120
9795 @itemx -mno-fix-vr4120
9796 @opindex mfix-vr4120
9797 Work around certain VR4120 errata:
9798 @itemize @minus
9799 @item
9800 @code{dmultu} does not always produce the correct result.
9801 @item
9802 @code{div} and @code{ddiv} do not always produce the correct result if one
9803 of the operands is negative.
9804 @end itemize
9805 The workarounds for the division errata rely on special functions in
9806 @file{libgcc.a}.  At present, these functions are only provided by
9807 the @code{mips64vr*-elf} configurations.
9808
9809 Other VR4120 errata require a nop to be inserted between certain pairs of
9810 instructions.  These errata are handled by the assembler, not by GCC itself.
9811
9812 @item -mfix-sb1
9813 @itemx -mno-fix-sb1
9814 @opindex mfix-sb1
9815 Work around certain SB-1 CPU core errata.
9816 (This flag currently works around the SB-1 revision 2
9817 ``F1'' and ``F2'' floating point errata.)
9818
9819 @item -mflush-func=@var{func}
9820 @itemx -mno-flush-func
9821 @opindex mflush-func
9822 Specifies the function to call to flush the I and D caches, or to not
9823 call any such function.  If called, the function must take the same
9824 arguments as the common @code{_flush_func()}, that is, the address of the
9825 memory range for which the cache is being flushed, the size of the
9826 memory range, and the number 3 (to flush both caches).  The default
9827 depends on the target GCC was configured for, but commonly is either
9828 @samp{_flush_func} or @samp{__cpu_flush}.
9829
9830 @item -mbranch-likely
9831 @itemx -mno-branch-likely
9832 @opindex mbranch-likely
9833 @opindex mno-branch-likely
9834 Enable or disable use of Branch Likely instructions, regardless of the
9835 default for the selected architecture.  By default, Branch Likely
9836 instructions may be generated if they are supported by the selected
9837 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9838 and processors which implement those architectures; for those, Branch
9839 Likely instructions will not be generated by default because the MIPS32
9840 and MIPS64 architectures specifically deprecate their use.
9841
9842 @item -mfp-exceptions
9843 @itemx -mno-fp-exceptions
9844 @opindex mfp-exceptions
9845 Specifies whether FP exceptions are enabled.  This affects how we schedule
9846 FP instructions for some processors.  The default is that FP exceptions are
9847 enabled.
9848
9849 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9850 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9851 FP pipe.
9852
9853 @item -mvr4130-align
9854 @itemx -mno-vr4130-align
9855 @opindex mvr4130-align
9856 The VR4130 pipeline is two-way superscalar, but can only issue two
9857 instructions together if the first one is 8-byte aligned.  When this
9858 option is enabled, GCC will align pairs of instructions that it
9859 thinks should execute in parallel.
9860
9861 This option only has an effect when optimizing for the VR4130.
9862 It normally makes code faster, but at the expense of making it bigger.
9863 It is enabled by default at optimization level @option{-O3}.
9864 @end table
9865
9866 @node MMIX Options
9867 @subsection MMIX Options
9868 @cindex MMIX Options
9869
9870 These options are defined for the MMIX:
9871
9872 @table @gcctabopt
9873 @item -mlibfuncs
9874 @itemx -mno-libfuncs
9875 @opindex mlibfuncs
9876 @opindex mno-libfuncs
9877 Specify that intrinsic library functions are being compiled, passing all
9878 values in registers, no matter the size.
9879
9880 @item -mepsilon
9881 @itemx -mno-epsilon
9882 @opindex mepsilon
9883 @opindex mno-epsilon
9884 Generate floating-point comparison instructions that compare with respect
9885 to the @code{rE} epsilon register.
9886
9887 @item -mabi=mmixware
9888 @itemx -mabi=gnu
9889 @opindex mabi-mmixware
9890 @opindex mabi=gnu
9891 Generate code that passes function parameters and return values that (in
9892 the called function) are seen as registers @code{$0} and up, as opposed to
9893 the GNU ABI which uses global registers @code{$231} and up.
9894
9895 @item -mzero-extend
9896 @itemx -mno-zero-extend
9897 @opindex mzero-extend
9898 @opindex mno-zero-extend
9899 When reading data from memory in sizes shorter than 64 bits, use (do not
9900 use) zero-extending load instructions by default, rather than
9901 sign-extending ones.
9902
9903 @item -mknuthdiv
9904 @itemx -mno-knuthdiv
9905 @opindex mknuthdiv
9906 @opindex mno-knuthdiv
9907 Make the result of a division yielding a remainder have the same sign as
9908 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9909 remainder follows the sign of the dividend.  Both methods are
9910 arithmetically valid, the latter being almost exclusively used.
9911
9912 @item -mtoplevel-symbols
9913 @itemx -mno-toplevel-symbols
9914 @opindex mtoplevel-symbols
9915 @opindex mno-toplevel-symbols
9916 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9917 code can be used with the @code{PREFIX} assembly directive.
9918
9919 @item -melf
9920 @opindex melf
9921 Generate an executable in the ELF format, rather than the default
9922 @samp{mmo} format used by the @command{mmix} simulator.
9923
9924 @item -mbranch-predict
9925 @itemx -mno-branch-predict
9926 @opindex mbranch-predict
9927 @opindex mno-branch-predict
9928 Use (do not use) the probable-branch instructions, when static branch
9929 prediction indicates a probable branch.
9930
9931 @item -mbase-addresses
9932 @itemx -mno-base-addresses
9933 @opindex mbase-addresses
9934 @opindex mno-base-addresses
9935 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9936 base address automatically generates a request (handled by the assembler
9937 and the linker) for a constant to be set up in a global register.  The
9938 register is used for one or more base address requests within the range 0
9939 to 255 from the value held in the register.  The generally leads to short
9940 and fast code, but the number of different data items that can be
9941 addressed is limited.  This means that a program that uses lots of static
9942 data may require @option{-mno-base-addresses}.
9943
9944 @item -msingle-exit
9945 @itemx -mno-single-exit
9946 @opindex msingle-exit
9947 @opindex mno-single-exit
9948 Force (do not force) generated code to have a single exit point in each
9949 function.
9950 @end table
9951
9952 @node MN10300 Options
9953 @subsection MN10300 Options
9954 @cindex MN10300 options
9955
9956 These @option{-m} options are defined for Matsushita MN10300 architectures:
9957
9958 @table @gcctabopt
9959 @item -mmult-bug
9960 @opindex mmult-bug
9961 Generate code to avoid bugs in the multiply instructions for the MN10300
9962 processors.  This is the default.
9963
9964 @item -mno-mult-bug
9965 @opindex mno-mult-bug
9966 Do not generate code to avoid bugs in the multiply instructions for the
9967 MN10300 processors.
9968
9969 @item -mam33
9970 @opindex mam33
9971 Generate code which uses features specific to the AM33 processor.
9972
9973 @item -mno-am33
9974 @opindex mno-am33
9975 Do not generate code which uses features specific to the AM33 processor.  This
9976 is the default.
9977
9978 @item -mno-crt0
9979 @opindex mno-crt0
9980 Do not link in the C run-time initialization object file.
9981
9982 @item -mrelax
9983 @opindex mrelax
9984 Indicate to the linker that it should perform a relaxation optimization pass
9985 to shorten branches, calls and absolute memory addresses.  This option only
9986 has an effect when used on the command line for the final link step.
9987
9988 This option makes symbolic debugging impossible.
9989 @end table
9990
9991 @node NS32K Options
9992 @subsection NS32K Options
9993 @cindex NS32K options
9994
9995 These are the @samp{-m} options defined for the 32000 series.  The default
9996 values for these options depends on which style of 32000 was selected when
9997 the compiler was configured; the defaults for the most common choices are
9998 given below.
9999
10000 @table @gcctabopt
10001 @item -m32032
10002 @itemx -m32032
10003 @opindex m32032
10004 @opindex m32032
10005 Generate output for a 32032.  This is the default
10006 when the compiler is configured for 32032 and 32016 based systems.
10007
10008 @item -m32332
10009 @itemx -m32332
10010 @opindex m32332
10011 @opindex m32332
10012 Generate output for a 32332.  This is the default
10013 when the compiler is configured for 32332-based systems.
10014
10015 @item -m32532
10016 @itemx -m32532
10017 @opindex m32532
10018 @opindex m32532
10019 Generate output for a 32532.  This is the default
10020 when the compiler is configured for 32532-based systems.
10021
10022 @item -m32081
10023 @opindex m32081
10024 Generate output containing 32081 instructions for floating point.
10025 This is the default for all systems.
10026
10027 @item -m32381
10028 @opindex m32381
10029 Generate output containing 32381 instructions for floating point.  This
10030 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10031 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10032
10033 @item -mmulti-add
10034 @opindex mmulti-add
10035 Try and generate multiply-add floating point instructions @code{polyF}
10036 and @code{dotF}.  This option is only available if the @option{-m32381}
10037 option is in effect.  Using these instructions requires changes to
10038 register allocation which generally has a negative impact on
10039 performance.  This option should only be enabled when compiling code
10040 particularly likely to make heavy use of multiply-add instructions.
10041
10042 @item -mnomulti-add
10043 @opindex mnomulti-add
10044 Do not try and generate multiply-add floating point instructions
10045 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10046
10047 @item -msoft-float
10048 @opindex msoft-float
10049 Generate output containing library calls for floating point.
10050 @strong{Warning:} the requisite libraries may not be available.
10051
10052 @item -mieee-compare
10053 @itemx -mno-ieee-compare
10054 @opindex mieee-compare
10055 @opindex mno-ieee-compare
10056 Control whether or not the compiler uses IEEE floating point
10057 comparisons.  These handle correctly the case where the result of a
10058 comparison is unordered.
10059 @strong{Warning:} the requisite kernel support may not be available.
10060
10061 @item -mnobitfield
10062 @opindex mnobitfield
10063 Do not use the bit-field instructions.  On some machines it is faster to
10064 use shifting and masking operations.  This is the default for the pc532.
10065
10066 @item -mbitfield
10067 @opindex mbitfield
10068 Do use the bit-field instructions.  This is the default for all platforms
10069 except the pc532.
10070
10071 @item -mrtd
10072 @opindex mrtd
10073 Use a different function-calling convention, in which functions
10074 that take a fixed number of arguments return pop their
10075 arguments on return with the @code{ret} instruction.
10076
10077 This calling convention is incompatible with the one normally
10078 used on Unix, so you cannot use it if you need to call libraries
10079 compiled with the Unix compiler.
10080
10081 Also, you must provide function prototypes for all functions that
10082 take variable numbers of arguments (including @code{printf});
10083 otherwise incorrect code will be generated for calls to those
10084 functions.
10085
10086 In addition, seriously incorrect code will result if you call a
10087 function with too many arguments.  (Normally, extra arguments are
10088 harmlessly ignored.)
10089
10090 This option takes its name from the 680x0 @code{rtd} instruction.
10091
10092
10093 @item -mregparam
10094 @opindex mregparam
10095 Use a different function-calling convention where the first two arguments
10096 are passed in registers.
10097
10098 This calling convention is incompatible with the one normally
10099 used on Unix, so you cannot use it if you need to call libraries
10100 compiled with the Unix compiler.
10101
10102 @item -mnoregparam
10103 @opindex mnoregparam
10104 Do not pass any arguments in registers.  This is the default for all
10105 targets.
10106
10107 @item -msb
10108 @opindex msb
10109 It is OK to use the sb as an index register which is always loaded with
10110 zero.  This is the default for the pc532-netbsd target.
10111
10112 @item -mnosb
10113 @opindex mnosb
10114 The sb register is not available for use or has not been initialized to
10115 zero by the run time system.  This is the default for all targets except
10116 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10117 @option{-fpic} is set.
10118
10119 @item -mhimem
10120 @opindex mhimem
10121 Many ns32000 series addressing modes use displacements of up to 512MB@.
10122 If an address is above 512MB then displacements from zero can not be used.
10123 This option causes code to be generated which can be loaded above 512MB@.
10124 This may be useful for operating systems or ROM code.
10125
10126 @item -mnohimem
10127 @opindex mnohimem
10128 Assume code will be loaded in the first 512MB of virtual address space.
10129 This is the default for all platforms.
10130
10131 @end table
10132
10133 @node PDP-11 Options
10134 @subsection PDP-11 Options
10135 @cindex PDP-11 Options
10136
10137 These options are defined for the PDP-11:
10138
10139 @table @gcctabopt
10140 @item -mfpu
10141 @opindex mfpu
10142 Use hardware FPP floating point.  This is the default.  (FIS floating
10143 point on the PDP-11/40 is not supported.)
10144
10145 @item -msoft-float
10146 @opindex msoft-float
10147 Do not use hardware floating point.
10148
10149 @item -mac0
10150 @opindex mac0
10151 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10152
10153 @item -mno-ac0
10154 @opindex mno-ac0
10155 Return floating-point results in memory.  This is the default.
10156
10157 @item -m40
10158 @opindex m40
10159 Generate code for a PDP-11/40.
10160
10161 @item -m45
10162 @opindex m45
10163 Generate code for a PDP-11/45.  This is the default.
10164
10165 @item -m10
10166 @opindex m10
10167 Generate code for a PDP-11/10.
10168
10169 @item -mbcopy-builtin
10170 @opindex bcopy-builtin
10171 Use inline @code{movmemhi} patterns for copying memory.  This is the
10172 default.
10173
10174 @item -mbcopy
10175 @opindex mbcopy
10176 Do not use inline @code{movmemhi} patterns for copying memory.
10177
10178 @item -mint16
10179 @itemx -mno-int32
10180 @opindex mint16
10181 @opindex mno-int32
10182 Use 16-bit @code{int}.  This is the default.
10183
10184 @item -mint32
10185 @itemx -mno-int16
10186 @opindex mint32
10187 @opindex mno-int16
10188 Use 32-bit @code{int}.
10189
10190 @item -mfloat64
10191 @itemx -mno-float32
10192 @opindex mfloat64
10193 @opindex mno-float32
10194 Use 64-bit @code{float}.  This is the default.
10195
10196 @item -mfloat32
10197 @itemx -mno-float64
10198 @opindex mfloat32
10199 @opindex mno-float64
10200 Use 32-bit @code{float}.
10201
10202 @item -mabshi
10203 @opindex mabshi
10204 Use @code{abshi2} pattern.  This is the default.
10205
10206 @item -mno-abshi
10207 @opindex mno-abshi
10208 Do not use @code{abshi2} pattern.
10209
10210 @item -mbranch-expensive
10211 @opindex mbranch-expensive
10212 Pretend that branches are expensive.  This is for experimenting with
10213 code generation only.
10214
10215 @item -mbranch-cheap
10216 @opindex mbranch-cheap
10217 Do not pretend that branches are expensive.  This is the default.
10218
10219 @item -msplit
10220 @opindex msplit
10221 Generate code for a system with split I&D@.
10222
10223 @item -mno-split
10224 @opindex mno-split
10225 Generate code for a system without split I&D@.  This is the default.
10226
10227 @item -munix-asm
10228 @opindex munix-asm
10229 Use Unix assembler syntax.  This is the default when configured for
10230 @samp{pdp11-*-bsd}.
10231
10232 @item -mdec-asm
10233 @opindex mdec-asm
10234 Use DEC assembler syntax.  This is the default when configured for any
10235 PDP-11 target other than @samp{pdp11-*-bsd}.
10236 @end table
10237
10238 @node PowerPC Options
10239 @subsection PowerPC Options
10240 @cindex PowerPC options
10241
10242 These are listed under @xref{RS/6000 and PowerPC Options}.
10243
10244 @node RS/6000 and PowerPC Options
10245 @subsection IBM RS/6000 and PowerPC Options
10246 @cindex RS/6000 and PowerPC Options
10247 @cindex IBM RS/6000 and PowerPC Options
10248
10249 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10250 @table @gcctabopt
10251 @item -mpower
10252 @itemx -mno-power
10253 @itemx -mpower2
10254 @itemx -mno-power2
10255 @itemx -mpowerpc
10256 @itemx -mno-powerpc
10257 @itemx -mpowerpc-gpopt
10258 @itemx -mno-powerpc-gpopt
10259 @itemx -mpowerpc-gfxopt
10260 @itemx -mno-powerpc-gfxopt
10261 @itemx -mpowerpc64
10262 @itemx -mno-powerpc64
10263 @opindex mpower
10264 @opindex mno-power
10265 @opindex mpower2
10266 @opindex mno-power2
10267 @opindex mpowerpc
10268 @opindex mno-powerpc
10269 @opindex mpowerpc-gpopt
10270 @opindex mno-powerpc-gpopt
10271 @opindex mpowerpc-gfxopt
10272 @opindex mno-powerpc-gfxopt
10273 @opindex mpowerpc64
10274 @opindex mno-powerpc64
10275 GCC supports two related instruction set architectures for the
10276 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10277 instructions supported by the @samp{rios} chip set used in the original
10278 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10279 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10280 the IBM 4xx microprocessors.
10281
10282 Neither architecture is a subset of the other.  However there is a
10283 large common subset of instructions supported by both.  An MQ
10284 register is included in processors supporting the POWER architecture.
10285
10286 You use these options to specify which instructions are available on the
10287 processor you are using.  The default value of these options is
10288 determined when configuring GCC@.  Specifying the
10289 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10290 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10291 rather than the options listed above.
10292
10293 The @option{-mpower} option allows GCC to generate instructions that
10294 are found only in the POWER architecture and to use the MQ register.
10295 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10296 to generate instructions that are present in the POWER2 architecture but
10297 not the original POWER architecture.
10298
10299 The @option{-mpowerpc} option allows GCC to generate instructions that
10300 are found only in the 32-bit subset of the PowerPC architecture.
10301 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10302 GCC to use the optional PowerPC architecture instructions in the
10303 General Purpose group, including floating-point square root.  Specifying
10304 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10305 use the optional PowerPC architecture instructions in the Graphics
10306 group, including floating-point select.
10307
10308 The @option{-mpowerpc64} option allows GCC to generate the additional
10309 64-bit instructions that are found in the full PowerPC64 architecture
10310 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10311 @option{-mno-powerpc64}.
10312
10313 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10314 will use only the instructions in the common subset of both
10315 architectures plus some special AIX common-mode calls, and will not use
10316 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10317 permits GCC to use any instruction from either architecture and to
10318 allow use of the MQ register; specify this for the Motorola MPC601.
10319
10320 @item -mnew-mnemonics
10321 @itemx -mold-mnemonics
10322 @opindex mnew-mnemonics
10323 @opindex mold-mnemonics
10324 Select which mnemonics to use in the generated assembler code.  With
10325 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10326 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10327 assembler mnemonics defined for the POWER architecture.  Instructions
10328 defined in only one architecture have only one mnemonic; GCC uses that
10329 mnemonic irrespective of which of these options is specified.
10330
10331 GCC defaults to the mnemonics appropriate for the architecture in
10332 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10333 value of these option.  Unless you are building a cross-compiler, you
10334 should normally not specify either @option{-mnew-mnemonics} or
10335 @option{-mold-mnemonics}, but should instead accept the default.
10336
10337 @item -mcpu=@var{cpu_type}
10338 @opindex mcpu
10339 Set architecture type, register usage, choice of mnemonics, and
10340 instruction scheduling parameters for machine type @var{cpu_type}.
10341 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10342 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10343 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10344 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10345 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10346 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10347 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10348 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10349 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10350
10351 @option{-mcpu=common} selects a completely generic processor.  Code
10352 generated under this option will run on any POWER or PowerPC processor.
10353 GCC will use only the instructions in the common subset of both
10354 architectures, and will not use the MQ register.  GCC assumes a generic
10355 processor model for scheduling purposes.
10356
10357 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10358 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10359 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10360 types, with an appropriate, generic processor model assumed for
10361 scheduling purposes.
10362
10363 The other options specify a specific processor.  Code generated under
10364 those options will run best on that processor, and may not run at all on
10365 others.
10366
10367 The @option{-mcpu} options automatically enable or disable the
10368 following options: @option{-maltivec}, @option{-mhard-float},
10369 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10370 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10371 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10372 @option{-mstring}.  The particular options set for any particular CPU
10373 will vary between compiler versions, depending on what setting seems
10374 to produce optimal code for that CPU; it doesn't necessarily reflect
10375 the actual hardware's capabilities.  If you wish to set an individual
10376 option to a particular value, you may specify it after the
10377 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10378
10379 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10380 not enabled or disabled by the @option{-mcpu} option at present, since
10381 AIX does not have full support for these options.  You may still
10382 enable or disable them individually if you're sure it'll work in your
10383 environment.
10384
10385 @item -mtune=@var{cpu_type}
10386 @opindex mtune
10387 Set the instruction scheduling parameters for machine type
10388 @var{cpu_type}, but do not set the architecture type, register usage, or
10389 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10390 values for @var{cpu_type} are used for @option{-mtune} as for
10391 @option{-mcpu}.  If both are specified, the code generated will use the
10392 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10393 scheduling parameters set by @option{-mtune}.
10394
10395 @item -maltivec
10396 @itemx -mno-altivec
10397 @opindex maltivec
10398 @opindex mno-altivec
10399 Generate code that uses (does not use) AltiVec instructions, and also
10400 enable the use of built-in functions that allow more direct access to
10401 the AltiVec instruction set.  You may also need to set
10402 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10403 enhancements.
10404
10405 @item -mabi=spe
10406 @opindex mabi=spe
10407 Extend the current ABI with SPE ABI extensions.  This does not change
10408 the default ABI, instead it adds the SPE ABI extensions to the current
10409 ABI@.
10410
10411 @item -mabi=no-spe
10412 @opindex mabi=no-spe
10413 Disable Booke SPE ABI extensions for the current ABI@.
10414
10415 @item -misel=@var{yes/no}
10416 @itemx -misel
10417 @opindex misel
10418 This switch enables or disables the generation of ISEL instructions.
10419
10420 @item -mspe=@var{yes/no}
10421 @itemx -mspe
10422 @opindex mspe
10423 This switch enables or disables the generation of SPE simd
10424 instructions.
10425
10426 @item -mfloat-gprs=@var{yes/single/double/no}
10427 @itemx -mfloat-gprs
10428 @opindex mfloat-gprs
10429 This switch enables or disables the generation of floating point
10430 operations on the general purpose registers for architectures that
10431 support it.
10432
10433 The argument @var{yes} or @var{single} enables the use of
10434 single-precision floating point operations.
10435
10436 The argument @var{double} enables the use of single and
10437 double-precision floating point operations.
10438
10439 The argument @var{no} disables floating point operations on the
10440 general purpose registers.
10441
10442 This option is currently only available on the MPC854x.
10443
10444 @item -m32
10445 @itemx -m64
10446 @opindex m32
10447 @opindex m64
10448 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10449 targets (including GNU/Linux).  The 32-bit environment sets int, long
10450 and pointer to 32 bits and generates code that runs on any PowerPC
10451 variant.  The 64-bit environment sets int to 32 bits and long and
10452 pointer to 64 bits, and generates code for PowerPC64, as for
10453 @option{-mpowerpc64}.
10454
10455 @item -mfull-toc
10456 @itemx -mno-fp-in-toc
10457 @itemx -mno-sum-in-toc
10458 @itemx -mminimal-toc
10459 @opindex mfull-toc
10460 @opindex mno-fp-in-toc
10461 @opindex mno-sum-in-toc
10462 @opindex mminimal-toc
10463 Modify generation of the TOC (Table Of Contents), which is created for
10464 every executable file.  The @option{-mfull-toc} option is selected by
10465 default.  In that case, GCC will allocate at least one TOC entry for
10466 each unique non-automatic variable reference in your program.  GCC
10467 will also place floating-point constants in the TOC@.  However, only
10468 16,384 entries are available in the TOC@.
10469
10470 If you receive a linker error message that saying you have overflowed
10471 the available TOC space, you can reduce the amount of TOC space used
10472 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10473 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10474 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10475 generate code to calculate the sum of an address and a constant at
10476 run-time instead of putting that sum into the TOC@.  You may specify one
10477 or both of these options.  Each causes GCC to produce very slightly
10478 slower and larger code at the expense of conserving TOC space.
10479
10480 If you still run out of space in the TOC even when you specify both of
10481 these options, specify @option{-mminimal-toc} instead.  This option causes
10482 GCC to make only one TOC entry for every file.  When you specify this
10483 option, GCC will produce code that is slower and larger but which
10484 uses extremely little TOC space.  You may wish to use this option
10485 only on files that contain less frequently executed code.
10486
10487 @item -maix64
10488 @itemx -maix32
10489 @opindex maix64
10490 @opindex maix32
10491 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10492 @code{long} type, and the infrastructure needed to support them.
10493 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10494 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10495 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10496
10497 @item -mxl-call
10498 @itemx -mno-xl-call
10499 @opindex mxl-call
10500 @opindex mno-xl-call
10501 On AIX, pass floating-point arguments to prototyped functions beyond the
10502 register save area (RSA) on the stack in addition to argument FPRs.  The
10503 AIX calling convention was extended but not initially documented to
10504 handle an obscure K&R C case of calling a function that takes the
10505 address of its arguments with fewer arguments than declared.  AIX XL
10506 compilers access floating point arguments which do not fit in the
10507 RSA from the stack when a subroutine is compiled without
10508 optimization.  Because always storing floating-point arguments on the
10509 stack is inefficient and rarely needed, this option is not enabled by
10510 default and only is necessary when calling subroutines compiled by AIX
10511 XL compilers without optimization.
10512
10513 @item -mpe
10514 @opindex mpe
10515 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10516 application written to use message passing with special startup code to
10517 enable the application to run.  The system must have PE installed in the
10518 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10519 must be overridden with the @option{-specs=} option to specify the
10520 appropriate directory location.  The Parallel Environment does not
10521 support threads, so the @option{-mpe} option and the @option{-pthread}
10522 option are incompatible.
10523
10524 @item -malign-natural
10525 @itemx -malign-power
10526 @opindex malign-natural
10527 @opindex malign-power
10528 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10529 @option{-malign-natural} overrides the ABI-defined alignment of larger
10530 types, such as floating-point doubles, on their natural size-based boundary.
10531 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10532 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10533
10534 @item -msoft-float
10535 @itemx -mhard-float
10536 @opindex msoft-float
10537 @opindex mhard-float
10538 Generate code that does not use (uses) the floating-point register set.
10539 Software floating point emulation is provided if you use the
10540 @option{-msoft-float} option, and pass the option to GCC when linking.
10541
10542 @item -mmultiple
10543 @itemx -mno-multiple
10544 @opindex mmultiple
10545 @opindex mno-multiple
10546 Generate code that uses (does not use) the load multiple word
10547 instructions and the store multiple word instructions.  These
10548 instructions are generated by default on POWER systems, and not
10549 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10550 endian PowerPC systems, since those instructions do not work when the
10551 processor is in little endian mode.  The exceptions are PPC740 and
10552 PPC750 which permit the instructions usage in little endian mode.
10553
10554 @item -mstring
10555 @itemx -mno-string
10556 @opindex mstring
10557 @opindex mno-string
10558 Generate code that uses (does not use) the load string instructions
10559 and the store string word instructions to save multiple registers and
10560 do small block moves.  These instructions are generated by default on
10561 POWER systems, and not generated on PowerPC systems.  Do not use
10562 @option{-mstring} on little endian PowerPC systems, since those
10563 instructions do not work when the processor is in little endian mode.
10564 The exceptions are PPC740 and PPC750 which permit the instructions
10565 usage in little endian mode.
10566
10567 @item -mupdate
10568 @itemx -mno-update
10569 @opindex mupdate
10570 @opindex mno-update
10571 Generate code that uses (does not use) the load or store instructions
10572 that update the base register to the address of the calculated memory
10573 location.  These instructions are generated by default.  If you use
10574 @option{-mno-update}, there is a small window between the time that the
10575 stack pointer is updated and the address of the previous frame is
10576 stored, which means code that walks the stack frame across interrupts or
10577 signals may get corrupted data.
10578
10579 @item -mfused-madd
10580 @itemx -mno-fused-madd
10581 @opindex mfused-madd
10582 @opindex mno-fused-madd
10583 Generate code that uses (does not use) the floating point multiply and
10584 accumulate instructions.  These instructions are generated by default if
10585 hardware floating is used.
10586
10587 @item -mno-bit-align
10588 @itemx -mbit-align
10589 @opindex mno-bit-align
10590 @opindex mbit-align
10591 On System V.4 and embedded PowerPC systems do not (do) force structures
10592 and unions that contain bit-fields to be aligned to the base type of the
10593 bit-field.
10594
10595 For example, by default a structure containing nothing but 8
10596 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10597 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10598 the structure would be aligned to a 1 byte boundary and be one byte in
10599 size.
10600
10601 @item -mno-strict-align
10602 @itemx -mstrict-align
10603 @opindex mno-strict-align
10604 @opindex mstrict-align
10605 On System V.4 and embedded PowerPC systems do not (do) assume that
10606 unaligned memory references will be handled by the system.
10607
10608 @item -mrelocatable
10609 @itemx -mno-relocatable
10610 @opindex mrelocatable
10611 @opindex mno-relocatable
10612 On embedded PowerPC systems generate code that allows (does not allow)
10613 the program to be relocated to a different address at runtime.  If you
10614 use @option{-mrelocatable} on any module, all objects linked together must
10615 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10616
10617 @item -mrelocatable-lib
10618 @itemx -mno-relocatable-lib
10619 @opindex mrelocatable-lib
10620 @opindex mno-relocatable-lib
10621 On embedded PowerPC systems generate code that allows (does not allow)
10622 the program to be relocated to a different address at runtime.  Modules
10623 compiled with @option{-mrelocatable-lib} can be linked with either modules
10624 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10625 with modules compiled with the @option{-mrelocatable} options.
10626
10627 @item -mno-toc
10628 @itemx -mtoc
10629 @opindex mno-toc
10630 @opindex mtoc
10631 On System V.4 and embedded PowerPC systems do not (do) assume that
10632 register 2 contains a pointer to a global area pointing to the addresses
10633 used in the program.
10634
10635 @item -mlittle
10636 @itemx -mlittle-endian
10637 @opindex mlittle
10638 @opindex mlittle-endian
10639 On System V.4 and embedded PowerPC systems compile code for the
10640 processor in little endian mode.  The @option{-mlittle-endian} option is
10641 the same as @option{-mlittle}.
10642
10643 @item -mbig
10644 @itemx -mbig-endian
10645 @opindex mbig
10646 @opindex mbig-endian
10647 On System V.4 and embedded PowerPC systems compile code for the
10648 processor in big endian mode.  The @option{-mbig-endian} option is
10649 the same as @option{-mbig}.
10650
10651 @item -mdynamic-no-pic
10652 @opindex mdynamic-no-pic
10653 On Darwin and Mac OS X systems, compile code so that it is not
10654 relocatable, but that its external references are relocatable.  The
10655 resulting code is suitable for applications, but not shared
10656 libraries.
10657
10658 @item -mprioritize-restricted-insns=@var{priority}
10659 @opindex mprioritize-restricted-insns
10660 This option controls the priority that is assigned to
10661 dispatch-slot restricted instructions during the second scheduling
10662 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10663 @var{no/highest/second-highest} priority to dispatch slot restricted
10664 instructions.
10665
10666 @item -msched-costly-dep=@var{dependence_type}
10667 @opindex msched-costly-dep
10668 This option controls which dependences are considered costly
10669 by the target during instruction scheduling.  The argument
10670 @var{dependence_type} takes one of the following values:
10671 @var{no}: no dependence is costly,
10672 @var{all}: all dependences are costly,
10673 @var{true_store_to_load}: a true dependence from store to load is costly,
10674 @var{store_to_load}: any dependence from store to load is costly,
10675 @var{number}: any dependence which latency >= @var{number} is costly.
10676
10677 @item -minsert-sched-nops=@var{scheme}
10678 @opindex minsert-sched-nops
10679 This option controls which nop insertion scheme will be used during
10680 the second scheduling pass.  The argument @var{scheme} takes one of the
10681 following values:
10682 @var{no}: Don't insert nops.
10683 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10684 according to the scheduler's grouping.
10685 @var{regroup_exact}: Insert nops to force costly dependent insns into
10686 separate groups.  Insert exactly as many nops as needed to force an insn
10687 to a new group, according to the estimated processor grouping.
10688 @var{number}: Insert nops to force costly dependent insns into
10689 separate groups.  Insert @var{number} nops to force an insn to a new group.
10690
10691 @item -mcall-sysv
10692 @opindex mcall-sysv
10693 On System V.4 and embedded PowerPC systems compile code using calling
10694 conventions that adheres to the March 1995 draft of the System V
10695 Application Binary Interface, PowerPC processor supplement.  This is the
10696 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10697
10698 @item -mcall-sysv-eabi
10699 @opindex mcall-sysv-eabi
10700 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10701
10702 @item -mcall-sysv-noeabi
10703 @opindex mcall-sysv-noeabi
10704 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10705
10706 @item -mcall-solaris
10707 @opindex mcall-solaris
10708 On System V.4 and embedded PowerPC systems compile code for the Solaris
10709 operating system.
10710
10711 @item -mcall-linux
10712 @opindex mcall-linux
10713 On System V.4 and embedded PowerPC systems compile code for the
10714 Linux-based GNU system.
10715
10716 @item -mcall-gnu
10717 @opindex mcall-gnu
10718 On System V.4 and embedded PowerPC systems compile code for the
10719 Hurd-based GNU system.
10720
10721 @item -mcall-netbsd
10722 @opindex mcall-netbsd
10723 On System V.4 and embedded PowerPC systems compile code for the
10724 NetBSD operating system.
10725
10726 @item -maix-struct-return
10727 @opindex maix-struct-return
10728 Return all structures in memory (as specified by the AIX ABI)@.
10729
10730 @item -msvr4-struct-return
10731 @opindex msvr4-struct-return
10732 Return structures smaller than 8 bytes in registers (as specified by the
10733 SVR4 ABI)@.
10734
10735 @item -mabi=altivec
10736 @opindex mabi=altivec
10737 Extend the current ABI with AltiVec ABI extensions.  This does not
10738 change the default ABI, instead it adds the AltiVec ABI extensions to
10739 the current ABI@.
10740
10741 @item -mabi=no-altivec
10742 @opindex mabi=no-altivec
10743 Disable AltiVec ABI extensions for the current ABI@.
10744
10745 @item -mprototype
10746 @itemx -mno-prototype
10747 @opindex mprototype
10748 @opindex mno-prototype
10749 On System V.4 and embedded PowerPC systems assume that all calls to
10750 variable argument functions are properly prototyped.  Otherwise, the
10751 compiler must insert an instruction before every non prototyped call to
10752 set or clear bit 6 of the condition code register (@var{CR}) to
10753 indicate whether floating point values were passed in the floating point
10754 registers in case the function takes a variable arguments.  With
10755 @option{-mprototype}, only calls to prototyped variable argument functions
10756 will set or clear the bit.
10757
10758 @item -msim
10759 @opindex msim
10760 On embedded PowerPC systems, assume that the startup module is called
10761 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10762 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10763 configurations.
10764
10765 @item -mmvme
10766 @opindex mmvme
10767 On embedded PowerPC systems, assume that the startup module is called
10768 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10769 @file{libc.a}.
10770
10771 @item -mads
10772 @opindex mads
10773 On embedded PowerPC systems, assume that the startup module is called
10774 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10775 @file{libc.a}.
10776
10777 @item -myellowknife
10778 @opindex myellowknife
10779 On embedded PowerPC systems, assume that the startup module is called
10780 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10781 @file{libc.a}.
10782
10783 @item -mvxworks
10784 @opindex mvxworks
10785 On System V.4 and embedded PowerPC systems, specify that you are
10786 compiling for a VxWorks system.
10787
10788 @item -mwindiss
10789 @opindex mwindiss
10790 Specify that you are compiling for the WindISS simulation environment.
10791
10792 @item -memb
10793 @opindex memb
10794 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10795 header to indicate that @samp{eabi} extended relocations are used.
10796
10797 @item -meabi
10798 @itemx -mno-eabi
10799 @opindex meabi
10800 @opindex mno-eabi
10801 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10802 Embedded Applications Binary Interface (eabi) which is a set of
10803 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10804 means that the stack is aligned to an 8 byte boundary, a function
10805 @code{__eabi} is called to from @code{main} to set up the eabi
10806 environment, and the @option{-msdata} option can use both @code{r2} and
10807 @code{r13} to point to two separate small data areas.  Selecting
10808 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10809 do not call an initialization function from @code{main}, and the
10810 @option{-msdata} option will only use @code{r13} to point to a single
10811 small data area.  The @option{-meabi} option is on by default if you
10812 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10813
10814 @item -msdata=eabi
10815 @opindex msdata=eabi
10816 On System V.4 and embedded PowerPC systems, put small initialized
10817 @code{const} global and static data in the @samp{.sdata2} section, which
10818 is pointed to by register @code{r2}.  Put small initialized
10819 non-@code{const} global and static data in the @samp{.sdata} section,
10820 which is pointed to by register @code{r13}.  Put small uninitialized
10821 global and static data in the @samp{.sbss} section, which is adjacent to
10822 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10823 incompatible with the @option{-mrelocatable} option.  The
10824 @option{-msdata=eabi} option also sets the @option{-memb} option.
10825
10826 @item -msdata=sysv
10827 @opindex msdata=sysv
10828 On System V.4 and embedded PowerPC systems, put small global and static
10829 data in the @samp{.sdata} section, which is pointed to by register
10830 @code{r13}.  Put small uninitialized global and static data in the
10831 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10832 The @option{-msdata=sysv} option is incompatible with the
10833 @option{-mrelocatable} option.
10834
10835 @item -msdata=default
10836 @itemx -msdata
10837 @opindex msdata=default
10838 @opindex msdata
10839 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10840 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10841 same as @option{-msdata=sysv}.
10842
10843 @item -msdata-data
10844 @opindex msdata-data
10845 On System V.4 and embedded PowerPC systems, put small global and static
10846 data in the @samp{.sdata} section.  Put small uninitialized global and
10847 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10848 to address small data however.  This is the default behavior unless
10849 other @option{-msdata} options are used.
10850
10851 @item -msdata=none
10852 @itemx -mno-sdata
10853 @opindex msdata=none
10854 @opindex mno-sdata
10855 On embedded PowerPC systems, put all initialized global and static data
10856 in the @samp{.data} section, and all uninitialized data in the
10857 @samp{.bss} section.
10858
10859 @item -G @var{num}
10860 @opindex G
10861 @cindex smaller data references (PowerPC)
10862 @cindex .sdata/.sdata2 references (PowerPC)
10863 On embedded PowerPC systems, put global and static items less than or
10864 equal to @var{num} bytes into the small data or bss sections instead of
10865 the normal data or bss section.  By default, @var{num} is 8.  The
10866 @option{-G @var{num}} switch is also passed to the linker.
10867 All modules should be compiled with the same @option{-G @var{num}} value.
10868
10869 @item -mregnames
10870 @itemx -mno-regnames
10871 @opindex mregnames
10872 @opindex mno-regnames
10873 On System V.4 and embedded PowerPC systems do (do not) emit register
10874 names in the assembly language output using symbolic forms.
10875
10876 @item -mlongcall
10877 @itemx -mno-longcall
10878 @opindex mlongcall
10879 @opindex mno-longcall
10880 Default to making all function calls indirectly, using a register, so
10881 that functions which reside further than 32 megabytes (33,554,432
10882 bytes) from the current location can be called.  This setting can be
10883 overridden by the @code{shortcall} function attribute, or by
10884 @code{#pragma longcall(0)}.
10885
10886 Some linkers are capable of detecting out-of-range calls and generating
10887 glue code on the fly.  On these systems, long calls are unnecessary and
10888 generate slower code.  As of this writing, the AIX linker can do this,
10889 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10890 to the GNU linker for 32-bit PowerPC systems as well.
10891
10892 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10893 callee, L42'', plus a ``branch island'' (glue code).  The two target
10894 addresses represent the callee and the ``branch island''.  The
10895 Darwin/PPC linker will prefer the first address and generate a ``bl
10896 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10897 otherwise, the linker will generate ``bl L42'' to call the ``branch
10898 island''.  The ``branch island'' is appended to the body of the
10899 calling function; it computes the full 32-bit address of the callee
10900 and jumps to it.
10901
10902 On Mach-O (Darwin) systems, this option directs the compiler emit to
10903 the glue for every direct call, and the Darwin linker decides whether
10904 to use or discard it.
10905
10906 In the future, we may cause GCC to ignore all longcall specifications
10907 when the linker is known to generate glue.
10908
10909 @item -pthread
10910 @opindex pthread
10911 Adds support for multithreading with the @dfn{pthreads} library.
10912 This option sets flags for both the preprocessor and linker.
10913
10914 @end table
10915
10916 @node S/390 and zSeries Options
10917 @subsection S/390 and zSeries Options
10918 @cindex S/390 and zSeries Options
10919
10920 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10921
10922 @table @gcctabopt
10923 @item -mhard-float
10924 @itemx -msoft-float
10925 @opindex mhard-float
10926 @opindex msoft-float
10927 Use (do not use) the hardware floating-point instructions and registers
10928 for floating-point operations.  When @option{-msoft-float} is specified,
10929 functions in @file{libgcc.a} will be used to perform floating-point
10930 operations.  When @option{-mhard-float} is specified, the compiler
10931 generates IEEE floating-point instructions.  This is the default.
10932
10933 @item -mbackchain
10934 @itemx -mno-backchain
10935 @opindex mbackchain
10936 @opindex mno-backchain
10937 Store (do not store) the address of the caller's frame as backchain pointer
10938 into the callee's stack frame.
10939 A backchain may be needed to allow debugging using tools that do not understand
10940 DWARF-2 call frame information.
10941 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
10942 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
10943 the backchain is placed into the topmost word of the 96/160 byte register
10944 save area.
10945
10946 In general, code compiled with @option{-mbackchain} is call-compatible with
10947 code compiled with @option{-mmo-backchain}; however, use of the backchain
10948 for debugging purposes usually requires that the whole binary is built with
10949 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
10950 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10951 to build a linux kernel use @option{-msoft-float}.
10952
10953 The default is to not maintain the backchain.
10954
10955 @item -mpacked-stack
10956 @item -mno-packed-stack
10957 @opindex mpacked-stack
10958 @opindex mno-packed-stack
10959 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
10960 specified, the compiler uses the all fields of the 96/160 byte register save
10961 area only for their default purpose; unused fields still take up stack space.
10962 When @option{-mpacked-stack} is specified, register save slots are densely
10963 packed at the top of the register save area; unused space is reused for other
10964 purposes, allowing for more efficient use of the available stack space.
10965 However, when @option{-mbackchain} is also in effect, the topmost word of
10966 the save area is always used to store the backchain, and the return address
10967 register is always saved two words below the backchain.
10968
10969 As long as the stack frame backchain is not used, code generated with
10970 @option{-mpacked-stack} is call-compatible with code generated with
10971 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
10972 S/390 or zSeries generated code that uses the stack frame backchain at run
10973 time, not just for debugging purposes.  Such code is not call-compatible
10974 with code compiled with @option{-mpacked-stack}.  Also, note that the
10975 combination of @option{-mbackchain},
10976 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10977 to build a linux kernel use @option{-msoft-float}.
10978
10979 The default is to not use the packed stack layout.
10980
10981 @item -msmall-exec
10982 @itemx -mno-small-exec
10983 @opindex msmall-exec
10984 @opindex mno-small-exec
10985 Generate (or do not generate) code using the @code{bras} instruction
10986 to do subroutine calls.
10987 This only works reliably if the total executable size does not
10988 exceed 64k.  The default is to use the @code{basr} instruction instead,
10989 which does not have this limitation.
10990
10991 @item -m64
10992 @itemx -m31
10993 @opindex m64
10994 @opindex m31
10995 When @option{-m31} is specified, generate code compliant to the
10996 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10997 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10998 particular to generate 64-bit instructions.  For the @samp{s390}
10999 targets, the default is @option{-m31}, while the @samp{s390x}
11000 targets default to @option{-m64}.
11001
11002 @item -mzarch
11003 @itemx -mesa
11004 @opindex mzarch
11005 @opindex mesa
11006 When @option{-mzarch} is specified, generate code using the
11007 instructions available on z/Architecture.
11008 When @option{-mesa} is specified, generate code using the
11009 instructions available on ESA/390.  Note that @option{-mesa} is
11010 not possible with @option{-m64}.
11011 When generating code compliant to the GNU/Linux for S/390 ABI,
11012 the default is @option{-mesa}.  When generating code compliant
11013 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11014
11015 @item -mmvcle
11016 @itemx -mno-mvcle
11017 @opindex mmvcle
11018 @opindex mno-mvcle
11019 Generate (or do not generate) code using the @code{mvcle} instruction
11020 to perform block moves.  When @option{-mno-mvcle} is specified,
11021 use a @code{mvc} loop instead.  This is the default.
11022
11023 @item -mdebug
11024 @itemx -mno-debug
11025 @opindex mdebug
11026 @opindex mno-debug
11027 Print (or do not print) additional debug information when compiling.
11028 The default is to not print debug information.
11029
11030 @item -march=@var{cpu-type}
11031 @opindex march
11032 Generate code that will run on @var{cpu-type}, which is the name of a system
11033 representing a certain processor type.  Possible values for
11034 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11035 When generating code using the instructions available on z/Architecture,
11036 the default is @option{-march=z900}.  Otherwise, the default is
11037 @option{-march=g5}.
11038
11039 @item -mtune=@var{cpu-type}
11040 @opindex mtune
11041 Tune to @var{cpu-type} everything applicable about the generated code,
11042 except for the ABI and the set of available instructions.
11043 The list of @var{cpu-type} values is the same as for @option{-march}.
11044 The default is the value used for @option{-march}.
11045
11046 @item -mtpf-trace
11047 @itemx -mno-tpf-trace
11048 @opindex mtpf-trace
11049 @opindex mno-tpf-trace
11050 Generate code that adds (does not add) in TPF OS specific branches to trace
11051 routines in the operating system.  This option is off by default, even
11052 when compiling for the TPF OS@.
11053
11054 @item -mfused-madd
11055 @itemx -mno-fused-madd
11056 @opindex mfused-madd
11057 @opindex mno-fused-madd
11058 Generate code that uses (does not use) the floating point multiply and
11059 accumulate instructions.  These instructions are generated by default if
11060 hardware floating point is used.
11061
11062 @item -mwarn-framesize=@var{framesize}
11063 @opindex mwarn-framesize
11064 Emit a warning if the current function exceeds the given frame size.  Because
11065 this is a compile time check it doesn't need to be a real problem when the program
11066 runs.  It is intended to identify functions which most probably cause
11067 a stack overflow.  It is useful to be used in an environment with limited stack
11068 size e.g.@: the linux kernel.
11069
11070 @item -mwarn-dynamicstack
11071 @opindex mwarn-dynamicstack
11072 Emit a warning if the function calls alloca or uses dynamically
11073 sized arrays.  This is generally a bad idea with a limited stack size.
11074
11075 @item -mstack-guard=@var{stack-guard}
11076 @item -mstack-size=@var{stack-size}
11077 @opindex mstack-guard
11078 @opindex mstack-size
11079 These arguments always have to be used in conjunction.  If they are present the s390
11080 back end emits additional instructions in the function prologue which trigger a trap
11081 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11082 (remember that the stack on s390 grows downward).  These options are intended to
11083 be used to help debugging stack overflow problems.  The additionally emitted code
11084 cause only little overhead and hence can also be used in production like systems
11085 without greater performance degradation.  The given values have to be exact
11086 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11087 In order to be efficient the extra code makes the assumption that the stack starts
11088 at an address aligned to the value given by @var{stack-size}.
11089 @end table
11090
11091 @node SH Options
11092 @subsection SH Options
11093
11094 These @samp{-m} options are defined for the SH implementations:
11095
11096 @table @gcctabopt
11097 @item -m1
11098 @opindex m1
11099 Generate code for the SH1.
11100
11101 @item -m2
11102 @opindex m2
11103 Generate code for the SH2.
11104
11105 @item -m2e
11106 Generate code for the SH2e.
11107
11108 @item -m3
11109 @opindex m3
11110 Generate code for the SH3.
11111
11112 @item -m3e
11113 @opindex m3e
11114 Generate code for the SH3e.
11115
11116 @item -m4-nofpu
11117 @opindex m4-nofpu
11118 Generate code for the SH4 without a floating-point unit.
11119
11120 @item -m4-single-only
11121 @opindex m4-single-only
11122 Generate code for the SH4 with a floating-point unit that only
11123 supports single-precision arithmetic.
11124
11125 @item -m4-single
11126 @opindex m4-single
11127 Generate code for the SH4 assuming the floating-point unit is in
11128 single-precision mode by default.
11129
11130 @item -m4
11131 @opindex m4
11132 Generate code for the SH4.
11133
11134 @item -m4a-nofpu
11135 @opindex m4a-nofpu
11136 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11137 floating-point unit is not used.
11138
11139 @item -m4a-single-only
11140 @opindex m4a-single-only
11141 Generate code for the SH4a, in such a way that no double-precision
11142 floating point operations are used.
11143
11144 @item -m4a-single
11145 @opindex m4a-single
11146 Generate code for the SH4a assuming the floating-point unit is in
11147 single-precision mode by default.
11148
11149 @item -m4a
11150 @opindex m4a
11151 Generate code for the SH4a.
11152
11153 @item -m4al
11154 @opindex m4al
11155 Same as @option{-m4a-nofpu}, except that it implicitly passes
11156 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11157 instructions at the moment.
11158
11159 @item -mb
11160 @opindex mb
11161 Compile code for the processor in big endian mode.
11162
11163 @item -ml
11164 @opindex ml
11165 Compile code for the processor in little endian mode.
11166
11167 @item -mdalign
11168 @opindex mdalign
11169 Align doubles at 64-bit boundaries.  Note that this changes the calling
11170 conventions, and thus some functions from the standard C library will
11171 not work unless you recompile it first with @option{-mdalign}.
11172
11173 @item -mrelax
11174 @opindex mrelax
11175 Shorten some address references at link time, when possible; uses the
11176 linker option @option{-relax}.
11177
11178 @item -mbigtable
11179 @opindex mbigtable
11180 Use 32-bit offsets in @code{switch} tables.  The default is to use
11181 16-bit offsets.
11182
11183 @item -mfmovd
11184 @opindex mfmovd
11185 Enable the use of the instruction @code{fmovd}.
11186
11187 @item -mhitachi
11188 @opindex mhitachi
11189 Comply with the calling conventions defined by Renesas.
11190
11191 @item -mrenesas
11192 @opindex mhitachi
11193 Comply with the calling conventions defined by Renesas.
11194
11195 @item -mno-renesas
11196 @opindex mhitachi
11197 Comply with the calling conventions defined for GCC before the Renesas
11198 conventions were available.  This option is the default for all
11199 targets of the SH toolchain except for @samp{sh-symbianelf}.
11200
11201 @item -mnomacsave
11202 @opindex mnomacsave
11203 Mark the @code{MAC} register as call-clobbered, even if
11204 @option{-mhitachi} is given.
11205
11206 @item -mieee
11207 @opindex mieee
11208 Increase IEEE-compliance of floating-point code.
11209
11210 @item -misize
11211 @opindex misize
11212 Dump instruction size and location in the assembly code.
11213
11214 @item -mpadstruct
11215 @opindex mpadstruct
11216 This option is deprecated.  It pads structures to multiple of 4 bytes,
11217 which is incompatible with the SH ABI@.
11218
11219 @item -mspace
11220 @opindex mspace
11221 Optimize for space instead of speed.  Implied by @option{-Os}.
11222
11223 @item -mprefergot
11224 @opindex mprefergot
11225 When generating position-independent code, emit function calls using
11226 the Global Offset Table instead of the Procedure Linkage Table.
11227
11228 @item -musermode
11229 @opindex musermode
11230 Generate a library function call to invalidate instruction cache
11231 entries, after fixing up a trampoline.  This library function call
11232 doesn't assume it can write to the whole memory address space.  This
11233 is the default when the target is @code{sh-*-linux*}.
11234 @end table
11235
11236 @node SPARC Options
11237 @subsection SPARC Options
11238 @cindex SPARC options
11239
11240 These @samp{-m} options are supported on the SPARC:
11241
11242 @table @gcctabopt
11243 @item -mno-app-regs
11244 @itemx -mapp-regs
11245 @opindex mno-app-regs
11246 @opindex mapp-regs
11247 Specify @option{-mapp-regs} to generate output using the global registers
11248 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11249 is the default.
11250
11251 To be fully SVR4 ABI compliant at the cost of some performance loss,
11252 specify @option{-mno-app-regs}.  You should compile libraries and system
11253 software with this option.
11254
11255 @item -mfpu
11256 @itemx -mhard-float
11257 @opindex mfpu
11258 @opindex mhard-float
11259 Generate output containing floating point instructions.  This is the
11260 default.
11261
11262 @item -mno-fpu
11263 @itemx -msoft-float
11264 @opindex mno-fpu
11265 @opindex msoft-float
11266 Generate output containing library calls for floating point.
11267 @strong{Warning:} the requisite libraries are not available for all SPARC
11268 targets.  Normally the facilities of the machine's usual C compiler are
11269 used, but this cannot be done directly in cross-compilation.  You must make
11270 your own arrangements to provide suitable library functions for
11271 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11272 @samp{sparclite-*-*} do provide software floating point support.
11273
11274 @option{-msoft-float} changes the calling convention in the output file;
11275 therefore, it is only useful if you compile @emph{all} of a program with
11276 this option.  In particular, you need to compile @file{libgcc.a}, the
11277 library that comes with GCC, with @option{-msoft-float} in order for
11278 this to work.
11279
11280 @item -mhard-quad-float
11281 @opindex mhard-quad-float
11282 Generate output containing quad-word (long double) floating point
11283 instructions.
11284
11285 @item -msoft-quad-float
11286 @opindex msoft-quad-float
11287 Generate output containing library calls for quad-word (long double)
11288 floating point instructions.  The functions called are those specified
11289 in the SPARC ABI@.  This is the default.
11290
11291 As of this writing, there are no SPARC implementations that have hardware
11292 support for the quad-word floating point instructions.  They all invoke
11293 a trap handler for one of these instructions, and then the trap handler
11294 emulates the effect of the instruction.  Because of the trap handler overhead,
11295 this is much slower than calling the ABI library routines.  Thus the
11296 @option{-msoft-quad-float} option is the default.
11297
11298 @item -mno-unaligned-doubles
11299 @itemx -munaligned-doubles
11300 @opindex mno-unaligned-doubles
11301 @opindex munaligned-doubles
11302 Assume that doubles have 8 byte alignment.  This is the default.
11303
11304 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11305 alignment only if they are contained in another type, or if they have an
11306 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11307 Specifying this option avoids some rare compatibility problems with code
11308 generated by other compilers.  It is not the default because it results
11309 in a performance loss, especially for floating point code.
11310
11311 @item -mno-faster-structs
11312 @itemx -mfaster-structs
11313 @opindex mno-faster-structs
11314 @opindex mfaster-structs
11315 With @option{-mfaster-structs}, the compiler assumes that structures
11316 should have 8 byte alignment.  This enables the use of pairs of
11317 @code{ldd} and @code{std} instructions for copies in structure
11318 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11319 However, the use of this changed alignment directly violates the SPARC
11320 ABI@.  Thus, it's intended only for use on targets where the developer
11321 acknowledges that their resulting code will not be directly in line with
11322 the rules of the ABI@.
11323
11324 @item -mimpure-text
11325 @opindex mimpure-text
11326 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11327 the compiler to not pass @option{-z text} to the linker when linking a
11328 shared object.  Using this option, you can link position-dependent
11329 code into a shared object.
11330
11331 @option{-mimpure-text} suppresses the ``relocations remain against
11332 allocatable but non-writable sections'' linker error message.
11333 However, the necessary relocations will trigger copy-on-write, and the
11334 shared object is not actually shared across processes.  Instead of
11335 using @option{-mimpure-text}, you should compile all source code with
11336 @option{-fpic} or @option{-fPIC}.
11337
11338 This option is only available on SunOS and Solaris.
11339
11340 @item -mcpu=@var{cpu_type}
11341 @opindex mcpu
11342 Set the instruction set, register set, and instruction scheduling parameters
11343 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11344 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11345 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11346 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11347 @samp{ultrasparc3}.
11348
11349 Default instruction scheduling parameters are used for values that select
11350 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11351 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11352
11353 Here is a list of each supported architecture and their supported
11354 implementations.
11355
11356 @smallexample
11357     v7:             cypress
11358     v8:             supersparc, hypersparc
11359     sparclite:      f930, f934, sparclite86x
11360     sparclet:       tsc701
11361     v9:             ultrasparc, ultrasparc3
11362 @end smallexample
11363
11364 By default (unless configured otherwise), GCC generates code for the V7
11365 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11366 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11367 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11368 SPARCStation 1, 2, IPX etc.
11369
11370 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11371 architecture.  The only difference from V7 code is that the compiler emits
11372 the integer multiply and integer divide instructions which exist in SPARC-V8
11373 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11374 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11375 2000 series.
11376
11377 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11378 the SPARC architecture.  This adds the integer multiply, integer divide step
11379 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11380 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11381 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11382 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11383 MB86934 chip, which is the more recent SPARClite with FPU@.
11384
11385 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11386 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11387 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11388 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11389 optimizes it for the TEMIC SPARClet chip.
11390
11391 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11392 architecture.  This adds 64-bit integer and floating-point move instructions,
11393 3 additional floating-point condition code registers and conditional move
11394 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11395 optimizes it for the Sun UltraSPARC I/II chips.  With
11396 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11397 Sun UltraSPARC III chip.
11398
11399 @item -mtune=@var{cpu_type}
11400 @opindex mtune
11401 Set the instruction scheduling parameters for machine type
11402 @var{cpu_type}, but do not set the instruction set or register set that the
11403 option @option{-mcpu=@var{cpu_type}} would.
11404
11405 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11406 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11407 that select a particular cpu implementation.  Those are @samp{cypress},
11408 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11409 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11410 @samp{ultrasparc3}.
11411
11412 @item -mv8plus
11413 @itemx -mno-v8plus
11414 @opindex mv8plus
11415 @opindex mno-v8plus
11416 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11417 difference from the V8 ABI is that the global and out registers are
11418 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11419 mode for all SPARC-V9 processors.
11420
11421 @item -mvis
11422 @itemx -mno-vis
11423 @opindex mvis
11424 @opindex mno-vis
11425 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11426 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11427 @end table
11428
11429 These @samp{-m} options are supported in addition to the above
11430 on SPARC-V9 processors in 64-bit environments:
11431
11432 @table @gcctabopt
11433 @item -mlittle-endian
11434 @opindex mlittle-endian
11435 Generate code for a processor running in little-endian mode.  It is only
11436 available for a few configurations and most notably not on Solaris.
11437
11438 @item -m32
11439 @itemx -m64
11440 @opindex m32
11441 @opindex m64
11442 Generate code for a 32-bit or 64-bit environment.
11443 The 32-bit environment sets int, long and pointer to 32 bits.
11444 The 64-bit environment sets int to 32 bits and long and pointer
11445 to 64 bits.
11446
11447 @item -mcmodel=medlow
11448 @opindex mcmodel=medlow
11449 Generate code for the Medium/Low code model: 64-bit addresses, programs
11450 must be linked in the low 32 bits of memory.  Programs can be statically
11451 or dynamically linked.
11452
11453 @item -mcmodel=medmid
11454 @opindex mcmodel=medmid
11455 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11456 must be linked in the low 44 bits of memory, the text and data segments must
11457 be less than 2GB in size and the data segment must be located within 2GB of
11458 the text segment.
11459
11460 @item -mcmodel=medany
11461 @opindex mcmodel=medany
11462 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11463 may be linked anywhere in memory, the text and data segments must be less
11464 than 2GB in size and the data segment must be located within 2GB of the
11465 text segment.
11466
11467 @item -mcmodel=embmedany
11468 @opindex mcmodel=embmedany
11469 Generate code for the Medium/Anywhere code model for embedded systems:
11470 64-bit addresses, the text and data segments must be less than 2GB in
11471 size, both starting anywhere in memory (determined at link time).  The
11472 global register %g4 points to the base of the data segment.  Programs
11473 are statically linked and PIC is not supported.
11474
11475 @item -mstack-bias
11476 @itemx -mno-stack-bias
11477 @opindex mstack-bias
11478 @opindex mno-stack-bias
11479 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11480 frame pointer if present, are offset by @minus{}2047 which must be added back
11481 when making stack frame references.  This is the default in 64-bit mode.
11482 Otherwise, assume no such offset is present.
11483 @end table
11484
11485 These switches are supported in addition to the above on Solaris:
11486
11487 @table @gcctabopt
11488 @item -threads
11489 @opindex threads
11490 Add support for multithreading using the Solaris threads library.  This
11491 option sets flags for both the preprocessor and linker.  This option does
11492 not affect the thread safety of object code produced by the compiler or
11493 that of libraries supplied with it.
11494
11495 @item -pthreads
11496 @opindex pthreads
11497 Add support for multithreading using the POSIX threads library.  This
11498 option sets flags for both the preprocessor and linker.  This option does
11499 not affect the thread safety of object code produced  by the compiler or
11500 that of libraries supplied with it.
11501 @end table
11502
11503 @node System V Options
11504 @subsection Options for System V
11505
11506 These additional options are available on System V Release 4 for
11507 compatibility with other compilers on those systems:
11508
11509 @table @gcctabopt
11510 @item -G
11511 @opindex G
11512 Create a shared object.
11513 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11514
11515 @item -Qy
11516 @opindex Qy
11517 Identify the versions of each tool used by the compiler, in a
11518 @code{.ident} assembler directive in the output.
11519
11520 @item -Qn
11521 @opindex Qn
11522 Refrain from adding @code{.ident} directives to the output file (this is
11523 the default).
11524
11525 @item -YP,@var{dirs}
11526 @opindex YP
11527 Search the directories @var{dirs}, and no others, for libraries
11528 specified with @option{-l}.
11529
11530 @item -Ym,@var{dir}
11531 @opindex Ym
11532 Look in the directory @var{dir} to find the M4 preprocessor.
11533 The assembler uses this option.
11534 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11535 @c the generic assembler that comes with Solaris takes just -Ym.
11536 @end table
11537
11538 @node TMS320C3x/C4x Options
11539 @subsection TMS320C3x/C4x Options
11540 @cindex TMS320C3x/C4x Options
11541
11542 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11543
11544 @table @gcctabopt
11545
11546 @item -mcpu=@var{cpu_type}
11547 @opindex mcpu
11548 Set the instruction set, register set, and instruction scheduling
11549 parameters for machine type @var{cpu_type}.  Supported values for
11550 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11551 @samp{c44}.  The default is @samp{c40} to generate code for the
11552 TMS320C40.
11553
11554 @item -mbig-memory
11555 @itemx -mbig
11556 @itemx -msmall-memory
11557 @itemx -msmall
11558 @opindex mbig-memory
11559 @opindex mbig
11560 @opindex msmall-memory
11561 @opindex msmall
11562 Generates code for the big or small memory model.  The small memory
11563 model assumed that all data fits into one 64K word page.  At run-time
11564 the data page (DP) register must be set to point to the 64K page
11565 containing the .bss and .data program sections.  The big memory model is
11566 the default and requires reloading of the DP register for every direct
11567 memory access.
11568
11569 @item -mbk
11570 @itemx -mno-bk
11571 @opindex mbk
11572 @opindex mno-bk
11573 Allow (disallow) allocation of general integer operands into the block
11574 count register BK@.
11575
11576 @item -mdb
11577 @itemx -mno-db
11578 @opindex mdb
11579 @opindex mno-db
11580 Enable (disable) generation of code using decrement and branch,
11581 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11582 on the safe side, this is disabled for the C3x, since the maximum
11583 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11584 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11585 that it can utilize the decrement and branch instruction, but will give
11586 up if there is more than one memory reference in the loop.  Thus a loop
11587 where the loop counter is decremented can generate slightly more
11588 efficient code, in cases where the RPTB instruction cannot be utilized.
11589
11590 @item -mdp-isr-reload
11591 @itemx -mparanoid
11592 @opindex mdp-isr-reload
11593 @opindex mparanoid
11594 Force the DP register to be saved on entry to an interrupt service
11595 routine (ISR), reloaded to point to the data section, and restored on
11596 exit from the ISR@.  This should not be required unless someone has
11597 violated the small memory model by modifying the DP register, say within
11598 an object library.
11599
11600 @item -mmpyi
11601 @itemx -mno-mpyi
11602 @opindex mmpyi
11603 @opindex mno-mpyi
11604 For the C3x use the 24-bit MPYI instruction for integer multiplies
11605 instead of a library call to guarantee 32-bit results.  Note that if one
11606 of the operands is a constant, then the multiplication will be performed
11607 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11608 then squaring operations are performed inline instead of a library call.
11609
11610 @item -mfast-fix
11611 @itemx -mno-fast-fix
11612 @opindex mfast-fix
11613 @opindex mno-fast-fix
11614 The C3x/C4x FIX instruction to convert a floating point value to an
11615 integer value chooses the nearest integer less than or equal to the
11616 floating point value rather than to the nearest integer.  Thus if the
11617 floating point number is negative, the result will be incorrectly
11618 truncated an additional code is necessary to detect and correct this
11619 case.  This option can be used to disable generation of the additional
11620 code required to correct the result.
11621
11622 @item -mrptb
11623 @itemx -mno-rptb
11624 @opindex mrptb
11625 @opindex mno-rptb
11626 Enable (disable) generation of repeat block sequences using the RPTB
11627 instruction for zero overhead looping.  The RPTB construct is only used
11628 for innermost loops that do not call functions or jump across the loop
11629 boundaries.  There is no advantage having nested RPTB loops due to the
11630 overhead required to save and restore the RC, RS, and RE registers.
11631 This is enabled by default with @option{-O2}.
11632
11633 @item -mrpts=@var{count}
11634 @itemx -mno-rpts
11635 @opindex mrpts
11636 @opindex mno-rpts
11637 Enable (disable) the use of the single instruction repeat instruction
11638 RPTS@.  If a repeat block contains a single instruction, and the loop
11639 count can be guaranteed to be less than the value @var{count}, GCC will
11640 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11641 then a RPTS will be emitted even if the loop count cannot be determined
11642 at compile time.  Note that the repeated instruction following RPTS does
11643 not have to be reloaded from memory each iteration, thus freeing up the
11644 CPU buses for operands.  However, since interrupts are blocked by this
11645 instruction, it is disabled by default.
11646
11647 @item -mloop-unsigned
11648 @itemx -mno-loop-unsigned
11649 @opindex mloop-unsigned
11650 @opindex mno-loop-unsigned
11651 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11652 is @math{2^{31} + 1} since these instructions test if the iteration count is
11653 negative to terminate the loop.  If the iteration count is unsigned
11654 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11655 exceeded.  This switch allows an unsigned iteration count.
11656
11657 @item -mti
11658 @opindex mti
11659 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11660 with.  This also enforces compatibility with the API employed by the TI
11661 C3x C compiler.  For example, long doubles are passed as structures
11662 rather than in floating point registers.
11663
11664 @item -mregparm
11665 @itemx -mmemparm
11666 @opindex mregparm
11667 @opindex mmemparm
11668 Generate code that uses registers (stack) for passing arguments to functions.
11669 By default, arguments are passed in registers where possible rather
11670 than by pushing arguments on to the stack.
11671
11672 @item -mparallel-insns
11673 @itemx -mno-parallel-insns
11674 @opindex mparallel-insns
11675 @opindex mno-parallel-insns
11676 Allow the generation of parallel instructions.  This is enabled by
11677 default with @option{-O2}.
11678
11679 @item -mparallel-mpy
11680 @itemx -mno-parallel-mpy
11681 @opindex mparallel-mpy
11682 @opindex mno-parallel-mpy
11683 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11684 provided @option{-mparallel-insns} is also specified.  These instructions have
11685 tight register constraints which can pessimize the code generation
11686 of large functions.
11687
11688 @end table
11689
11690 @node V850 Options
11691 @subsection V850 Options
11692 @cindex V850 Options
11693
11694 These @samp{-m} options are defined for V850 implementations:
11695
11696 @table @gcctabopt
11697 @item -mlong-calls
11698 @itemx -mno-long-calls
11699 @opindex mlong-calls
11700 @opindex mno-long-calls
11701 Treat all calls as being far away (near).  If calls are assumed to be
11702 far away, the compiler will always load the functions address up into a
11703 register, and call indirect through the pointer.
11704
11705 @item -mno-ep
11706 @itemx -mep
11707 @opindex mno-ep
11708 @opindex mep
11709 Do not optimize (do optimize) basic blocks that use the same index
11710 pointer 4 or more times to copy pointer into the @code{ep} register, and
11711 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11712 option is on by default if you optimize.
11713
11714 @item -mno-prolog-function
11715 @itemx -mprolog-function
11716 @opindex mno-prolog-function
11717 @opindex mprolog-function
11718 Do not use (do use) external functions to save and restore registers
11719 at the prologue and epilogue of a function.  The external functions
11720 are slower, but use less code space if more than one function saves
11721 the same number of registers.  The @option{-mprolog-function} option
11722 is on by default if you optimize.
11723
11724 @item -mspace
11725 @opindex mspace
11726 Try to make the code as small as possible.  At present, this just turns
11727 on the @option{-mep} and @option{-mprolog-function} options.
11728
11729 @item -mtda=@var{n}
11730 @opindex mtda
11731 Put static or global variables whose size is @var{n} bytes or less into
11732 the tiny data area that register @code{ep} points to.  The tiny data
11733 area can hold up to 256 bytes in total (128 bytes for byte references).
11734
11735 @item -msda=@var{n}
11736 @opindex msda
11737 Put static or global variables whose size is @var{n} bytes or less into
11738 the small data area that register @code{gp} points to.  The small data
11739 area can hold up to 64 kilobytes.
11740
11741 @item -mzda=@var{n}
11742 @opindex mzda
11743 Put static or global variables whose size is @var{n} bytes or less into
11744 the first 32 kilobytes of memory.
11745
11746 @item -mv850
11747 @opindex mv850
11748 Specify that the target processor is the V850.
11749
11750 @item -mbig-switch
11751 @opindex mbig-switch
11752 Generate code suitable for big switch tables.  Use this option only if
11753 the assembler/linker complain about out of range branches within a switch
11754 table.
11755
11756 @item -mapp-regs
11757 @opindex mapp-regs
11758 This option will cause r2 and r5 to be used in the code generated by
11759 the compiler.  This setting is the default.
11760
11761 @item -mno-app-regs
11762 @opindex mno-app-regs
11763 This option will cause r2 and r5 to be treated as fixed registers.
11764
11765 @item -mv850e1
11766 @opindex mv850e1
11767 Specify that the target processor is the V850E1.  The preprocessor
11768 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11769 this option is used.
11770
11771 @item -mv850e
11772 @opindex mv850e
11773 Specify that the target processor is the V850E@.  The preprocessor
11774 constant @samp{__v850e__} will be defined if this option is used.
11775
11776 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11777 are defined then a default target processor will be chosen and the
11778 relevant @samp{__v850*__} preprocessor constant will be defined.
11779
11780 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11781 defined, regardless of which processor variant is the target.
11782
11783 @item -mdisable-callt
11784 @opindex mdisable-callt
11785 This option will suppress generation of the CALLT instruction for the
11786 v850e and v850e1 flavors of the v850 architecture.  The default is
11787 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11788
11789 @end table
11790
11791 @node VAX Options
11792 @subsection VAX Options
11793 @cindex VAX options
11794
11795 These @samp{-m} options are defined for the VAX:
11796
11797 @table @gcctabopt
11798 @item -munix
11799 @opindex munix
11800 Do not output certain jump instructions (@code{aobleq} and so on)
11801 that the Unix assembler for the VAX cannot handle across long
11802 ranges.
11803
11804 @item -mgnu
11805 @opindex mgnu
11806 Do output those jump instructions, on the assumption that you
11807 will assemble with the GNU assembler.
11808
11809 @item -mg
11810 @opindex mg
11811 Output code for g-format floating point numbers instead of d-format.
11812 @end table
11813
11814 @node x86-64 Options
11815 @subsection x86-64 Options
11816 @cindex x86-64 options
11817
11818 These are listed under @xref{i386 and x86-64 Options}.
11819
11820 @node Xstormy16 Options
11821 @subsection Xstormy16 Options
11822 @cindex Xstormy16 Options
11823
11824 These options are defined for Xstormy16:
11825
11826 @table @gcctabopt
11827 @item -msim
11828 @opindex msim
11829 Choose startup files and linker script suitable for the simulator.
11830 @end table
11831
11832 @node Xtensa Options
11833 @subsection Xtensa Options
11834 @cindex Xtensa Options
11835
11836 These options are supported for Xtensa targets:
11837
11838 @table @gcctabopt
11839 @item -mconst16
11840 @itemx -mno-const16
11841 @opindex mconst16
11842 @opindex mno-const16
11843 Enable or disable use of @code{CONST16} instructions for loading
11844 constant values.  The @code{CONST16} instruction is currently not a
11845 standard option from Tensilica.  When enabled, @code{CONST16}
11846 instructions are always used in place of the standard @code{L32R}
11847 instructions.  The use of @code{CONST16} is enabled by default only if
11848 the @code{L32R} instruction is not available.
11849
11850 @item -mfused-madd
11851 @itemx -mno-fused-madd
11852 @opindex mfused-madd
11853 @opindex mno-fused-madd
11854 Enable or disable use of fused multiply/add and multiply/subtract
11855 instructions in the floating-point option.  This has no effect if the
11856 floating-point option is not also enabled.  Disabling fused multiply/add
11857 and multiply/subtract instructions forces the compiler to use separate
11858 instructions for the multiply and add/subtract operations.  This may be
11859 desirable in some cases where strict IEEE 754-compliant results are
11860 required: the fused multiply add/subtract instructions do not round the
11861 intermediate result, thereby producing results with @emph{more} bits of
11862 precision than specified by the IEEE standard.  Disabling fused multiply
11863 add/subtract instructions also ensures that the program output is not
11864 sensitive to the compiler's ability to combine multiply and add/subtract
11865 operations.
11866
11867 @item -mtext-section-literals
11868 @itemx -mno-text-section-literals
11869 @opindex mtext-section-literals
11870 @opindex mno-text-section-literals
11871 Control the treatment of literal pools.  The default is
11872 @option{-mno-text-section-literals}, which places literals in a separate
11873 section in the output file.  This allows the literal pool to be placed
11874 in a data RAM/ROM, and it also allows the linker to combine literal
11875 pools from separate object files to remove redundant literals and
11876 improve code size.  With @option{-mtext-section-literals}, the literals
11877 are interspersed in the text section in order to keep them as close as
11878 possible to their references.  This may be necessary for large assembly
11879 files.
11880
11881 @item -mtarget-align
11882 @itemx -mno-target-align
11883 @opindex mtarget-align
11884 @opindex mno-target-align
11885 When this option is enabled, GCC instructs the assembler to
11886 automatically align instructions to reduce branch penalties at the
11887 expense of some code density.  The assembler attempts to widen density
11888 instructions to align branch targets and the instructions following call
11889 instructions.  If there are not enough preceding safe density
11890 instructions to align a target, no widening will be performed.  The
11891 default is @option{-mtarget-align}.  These options do not affect the
11892 treatment of auto-aligned instructions like @code{LOOP}, which the
11893 assembler will always align, either by widening density instructions or
11894 by inserting no-op instructions.
11895
11896 @item -mlongcalls
11897 @itemx -mno-longcalls
11898 @opindex mlongcalls
11899 @opindex mno-longcalls
11900 When this option is enabled, GCC instructs the assembler to translate
11901 direct calls to indirect calls unless it can determine that the target
11902 of a direct call is in the range allowed by the call instruction.  This
11903 translation typically occurs for calls to functions in other source
11904 files.  Specifically, the assembler translates a direct @code{CALL}
11905 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11906 The default is @option{-mno-longcalls}.  This option should be used in
11907 programs where the call target can potentially be out of range.  This
11908 option is implemented in the assembler, not the compiler, so the
11909 assembly code generated by GCC will still show direct call
11910 instructions---look at the disassembled object code to see the actual
11911 instructions.  Note that the assembler will use an indirect call for
11912 every cross-file call, not just those that really will be out of range.
11913 @end table
11914
11915 @node zSeries Options
11916 @subsection zSeries Options
11917 @cindex zSeries options
11918
11919 These are listed under @xref{S/390 and zSeries Options}.
11920
11921 @node Code Gen Options
11922 @section Options for Code Generation Conventions
11923 @cindex code generation conventions
11924 @cindex options, code generation
11925 @cindex run-time options
11926
11927 These machine-independent options control the interface conventions
11928 used in code generation.
11929
11930 Most of them have both positive and negative forms; the negative form
11931 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11932 one of the forms is listed---the one which is not the default.  You
11933 can figure out the other form by either removing @samp{no-} or adding
11934 it.
11935
11936 @table @gcctabopt
11937 @item -fbounds-check
11938 @opindex fbounds-check
11939 For front-ends that support it, generate additional code to check that
11940 indices used to access arrays are within the declared range.  This is
11941 currently only supported by the Java and Fortran 77 front-ends, where
11942 this option defaults to true and false respectively.
11943
11944 @item -ftrapv
11945 @opindex ftrapv
11946 This option generates traps for signed overflow on addition, subtraction,
11947 multiplication operations.
11948
11949 @item -fwrapv
11950 @opindex fwrapv
11951 This option instructs the compiler to assume that signed arithmetic
11952 overflow of addition, subtraction and multiplication wraps around
11953 using twos-complement representation.  This flag enables some optimizations
11954 and disables other.  This option is enabled by default for the Java
11955 front-end, as required by the Java language specification.
11956
11957 @item -fexceptions
11958 @opindex fexceptions
11959 Enable exception handling.  Generates extra code needed to propagate
11960 exceptions.  For some targets, this implies GCC will generate frame
11961 unwind information for all functions, which can produce significant data
11962 size overhead, although it does not affect execution.  If you do not
11963 specify this option, GCC will enable it by default for languages like
11964 C++ which normally require exception handling, and disable it for
11965 languages like C that do not normally require it.  However, you may need
11966 to enable this option when compiling C code that needs to interoperate
11967 properly with exception handlers written in C++.  You may also wish to
11968 disable this option if you are compiling older C++ programs that don't
11969 use exception handling.
11970
11971 @item -fnon-call-exceptions
11972 @opindex fnon-call-exceptions
11973 Generate code that allows trapping instructions to throw exceptions.
11974 Note that this requires platform-specific runtime support that does
11975 not exist everywhere.  Moreover, it only allows @emph{trapping}
11976 instructions to throw exceptions, i.e.@: memory references or floating
11977 point instructions.  It does not allow exceptions to be thrown from
11978 arbitrary signal handlers such as @code{SIGALRM}.
11979
11980 @item -funwind-tables
11981 @opindex funwind-tables
11982 Similar to @option{-fexceptions}, except that it will just generate any needed
11983 static data, but will not affect the generated code in any other way.
11984 You will normally not enable this option; instead, a language processor
11985 that needs this handling would enable it on your behalf.
11986
11987 @item -fasynchronous-unwind-tables
11988 @opindex fasynchronous-unwind-tables
11989 Generate unwind table in dwarf2 format, if supported by target machine.  The
11990 table is exact at each instruction boundary, so it can be used for stack
11991 unwinding from asynchronous events (such as debugger or garbage collector).
11992
11993 @item -fpcc-struct-return
11994 @opindex fpcc-struct-return
11995 Return ``short'' @code{struct} and @code{union} values in memory like
11996 longer ones, rather than in registers.  This convention is less
11997 efficient, but it has the advantage of allowing intercallability between
11998 GCC-compiled files and files compiled with other compilers, particularly
11999 the Portable C Compiler (pcc).
12000
12001 The precise convention for returning structures in memory depends
12002 on the target configuration macros.
12003
12004 Short structures and unions are those whose size and alignment match
12005 that of some integer type.
12006
12007 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12008 switch is not binary compatible with code compiled with the
12009 @option{-freg-struct-return} switch.
12010 Use it to conform to a non-default application binary interface.
12011
12012 @item -freg-struct-return
12013 @opindex freg-struct-return
12014 Return @code{struct} and @code{union} values in registers when possible.
12015 This is more efficient for small structures than
12016 @option{-fpcc-struct-return}.
12017
12018 If you specify neither @option{-fpcc-struct-return} nor
12019 @option{-freg-struct-return}, GCC defaults to whichever convention is
12020 standard for the target.  If there is no standard convention, GCC
12021 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12022 the principal compiler.  In those cases, we can choose the standard, and
12023 we chose the more efficient register return alternative.
12024
12025 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12026 switch is not binary compatible with code compiled with the
12027 @option{-fpcc-struct-return} switch.
12028 Use it to conform to a non-default application binary interface.
12029
12030 @item -fshort-enums
12031 @opindex fshort-enums
12032 Allocate to an @code{enum} type only as many bytes as it needs for the
12033 declared range of possible values.  Specifically, the @code{enum} type
12034 will be equivalent to the smallest integer type which has enough room.
12035
12036 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12037 code that is not binary compatible with code generated without that switch.
12038 Use it to conform to a non-default application binary interface.
12039
12040 @item -fshort-double
12041 @opindex fshort-double
12042 Use the same size for @code{double} as for @code{float}.
12043
12044 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12045 code that is not binary compatible with code generated without that switch.
12046 Use it to conform to a non-default application binary interface.
12047
12048 @item -fshort-wchar
12049 @opindex fshort-wchar
12050 Override the underlying type for @samp{wchar_t} to be @samp{short
12051 unsigned int} instead of the default for the target.  This option is
12052 useful for building programs to run under WINE@.
12053
12054 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12055 code that is not binary compatible with code generated without that switch.
12056 Use it to conform to a non-default application binary interface.
12057
12058 @item -fshared-data
12059 @opindex fshared-data
12060 Requests that the data and non-@code{const} variables of this
12061 compilation be shared data rather than private data.  The distinction
12062 makes sense only on certain operating systems, where shared data is
12063 shared between processes running the same program, while private data
12064 exists in one copy per process.
12065
12066 @item -fno-common
12067 @opindex fno-common
12068 In C, allocate even uninitialized global variables in the data section of the
12069 object file, rather than generating them as common blocks.  This has the
12070 effect that if the same variable is declared (without @code{extern}) in
12071 two different compilations, you will get an error when you link them.
12072 The only reason this might be useful is if you wish to verify that the
12073 program will work on other systems which always work this way.
12074
12075 @item -fno-ident
12076 @opindex fno-ident
12077 Ignore the @samp{#ident} directive.
12078
12079 @item -finhibit-size-directive
12080 @opindex finhibit-size-directive
12081 Don't output a @code{.size} assembler directive, or anything else that
12082 would cause trouble if the function is split in the middle, and the
12083 two halves are placed at locations far apart in memory.  This option is
12084 used when compiling @file{crtstuff.c}; you should not need to use it
12085 for anything else.
12086
12087 @item -fverbose-asm
12088 @opindex fverbose-asm
12089 Put extra commentary information in the generated assembly code to
12090 make it more readable.  This option is generally only of use to those
12091 who actually need to read the generated assembly code (perhaps while
12092 debugging the compiler itself).
12093
12094 @option{-fno-verbose-asm}, the default, causes the
12095 extra information to be omitted and is useful when comparing two assembler
12096 files.
12097
12098 @item -fpic
12099 @opindex fpic
12100 @cindex global offset table
12101 @cindex PIC
12102 Generate position-independent code (PIC) suitable for use in a shared
12103 library, if supported for the target machine.  Such code accesses all
12104 constant addresses through a global offset table (GOT)@.  The dynamic
12105 loader resolves the GOT entries when the program starts (the dynamic
12106 loader is not part of GCC; it is part of the operating system).  If
12107 the GOT size for the linked executable exceeds a machine-specific
12108 maximum size, you get an error message from the linker indicating that
12109 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12110 instead.  (These maximums are 8k on the SPARC and 32k
12111 on the m68k and RS/6000.  The 386 has no such limit.)
12112
12113 Position-independent code requires special support, and therefore works
12114 only on certain machines.  For the 386, GCC supports PIC for System V
12115 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12116 position-independent.
12117
12118 @item -fPIC
12119 @opindex fPIC
12120 If supported for the target machine, emit position-independent code,
12121 suitable for dynamic linking and avoiding any limit on the size of the
12122 global offset table.  This option makes a difference on the m68k,
12123 PowerPC and SPARC@.
12124
12125 Position-independent code requires special support, and therefore works
12126 only on certain machines.
12127
12128 @item -fpie
12129 @itemx -fPIE
12130 @opindex fpie
12131 @opindex fPIE
12132 These options are similar to @option{-fpic} and @option{-fPIC}, but
12133 generated position independent code can be only linked into executables.
12134 Usually these options are used when @option{-pie} GCC option will be
12135 used during linking.
12136
12137 @item -ffixed-@var{reg}
12138 @opindex ffixed
12139 Treat the register named @var{reg} as a fixed register; generated code
12140 should never refer to it (except perhaps as a stack pointer, frame
12141 pointer or in some other fixed role).
12142
12143 @var{reg} must be the name of a register.  The register names accepted
12144 are machine-specific and are defined in the @code{REGISTER_NAMES}
12145 macro in the machine description macro file.
12146
12147 This flag does not have a negative form, because it specifies a
12148 three-way choice.
12149
12150 @item -fcall-used-@var{reg}
12151 @opindex fcall-used
12152 Treat the register named @var{reg} as an allocable register that is
12153 clobbered by function calls.  It may be allocated for temporaries or
12154 variables that do not live across a call.  Functions compiled this way
12155 will not save and restore the register @var{reg}.
12156
12157 It is an error to used this flag with the frame pointer or stack pointer.
12158 Use of this flag for other registers that have fixed pervasive roles in
12159 the machine's execution model will produce disastrous results.
12160
12161 This flag does not have a negative form, because it specifies a
12162 three-way choice.
12163
12164 @item -fcall-saved-@var{reg}
12165 @opindex fcall-saved
12166 Treat the register named @var{reg} as an allocable register saved by
12167 functions.  It may be allocated even for temporaries or variables that
12168 live across a call.  Functions compiled this way will save and restore
12169 the register @var{reg} if they use it.
12170
12171 It is an error to used this flag with the frame pointer or stack pointer.
12172 Use of this flag for other registers that have fixed pervasive roles in
12173 the machine's execution model will produce disastrous results.
12174
12175 A different sort of disaster will result from the use of this flag for
12176 a register in which function values may be returned.
12177
12178 This flag does not have a negative form, because it specifies a
12179 three-way choice.
12180
12181 @item -fpack-struct[=@var{n}]
12182 @opindex fpack-struct
12183 Without a value specified, pack all structure members together without
12184 holes.  When a value is specified (which must be a small power of two), pack
12185 structure members according to this value, representing the maximum
12186 alignment (that is, objects with default alignment requirements larger than
12187 this will be output potentially unaligned at the next fitting location.
12188
12189 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12190 code that is not binary compatible with code generated without that switch.
12191 Additionally, it makes the code suboptimal.
12192 Use it to conform to a non-default application binary interface.
12193
12194 @item -finstrument-functions
12195 @opindex finstrument-functions
12196 Generate instrumentation calls for entry and exit to functions.  Just
12197 after function entry and just before function exit, the following
12198 profiling functions will be called with the address of the current
12199 function and its call site.  (On some platforms,
12200 @code{__builtin_return_address} does not work beyond the current
12201 function, so the call site information may not be available to the
12202 profiling functions otherwise.)
12203
12204 @smallexample
12205 void __cyg_profile_func_enter (void *this_fn,
12206                                void *call_site);
12207 void __cyg_profile_func_exit  (void *this_fn,
12208                                void *call_site);
12209 @end smallexample
12210
12211 The first argument is the address of the start of the current function,
12212 which may be looked up exactly in the symbol table.
12213
12214 This instrumentation is also done for functions expanded inline in other
12215 functions.  The profiling calls will indicate where, conceptually, the
12216 inline function is entered and exited.  This means that addressable
12217 versions of such functions must be available.  If all your uses of a
12218 function are expanded inline, this may mean an additional expansion of
12219 code size.  If you use @samp{extern inline} in your C code, an
12220 addressable version of such functions must be provided.  (This is
12221 normally the case anyways, but if you get lucky and the optimizer always
12222 expands the functions inline, you might have gotten away without
12223 providing static copies.)
12224
12225 A function may be given the attribute @code{no_instrument_function}, in
12226 which case this instrumentation will not be done.  This can be used, for
12227 example, for the profiling functions listed above, high-priority
12228 interrupt routines, and any functions from which the profiling functions
12229 cannot safely be called (perhaps signal handlers, if the profiling
12230 routines generate output or allocate memory).
12231
12232 @item -fstack-check
12233 @opindex fstack-check
12234 Generate code to verify that you do not go beyond the boundary of the
12235 stack.  You should specify this flag if you are running in an
12236 environment with multiple threads, but only rarely need to specify it in
12237 a single-threaded environment since stack overflow is automatically
12238 detected on nearly all systems if there is only one stack.
12239
12240 Note that this switch does not actually cause checking to be done; the
12241 operating system must do that.  The switch causes generation of code
12242 to ensure that the operating system sees the stack being extended.
12243
12244 @item -fstack-limit-register=@var{reg}
12245 @itemx -fstack-limit-symbol=@var{sym}
12246 @itemx -fno-stack-limit
12247 @opindex fstack-limit-register
12248 @opindex fstack-limit-symbol
12249 @opindex fno-stack-limit
12250 Generate code to ensure that the stack does not grow beyond a certain value,
12251 either the value of a register or the address of a symbol.  If the stack
12252 would grow beyond the value, a signal is raised.  For most targets,
12253 the signal is raised before the stack overruns the boundary, so
12254 it is possible to catch the signal without taking special precautions.
12255
12256 For instance, if the stack starts at absolute address @samp{0x80000000}
12257 and grows downwards, you can use the flags
12258 @option{-fstack-limit-symbol=__stack_limit} and
12259 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12260 of 128KB@.  Note that this may only work with the GNU linker.
12261
12262 @cindex aliasing of parameters
12263 @cindex parameters, aliased
12264 @item -fargument-alias
12265 @itemx -fargument-noalias
12266 @itemx -fargument-noalias-global
12267 @opindex fargument-alias
12268 @opindex fargument-noalias
12269 @opindex fargument-noalias-global
12270 Specify the possible relationships among parameters and between
12271 parameters and global data.
12272
12273 @option{-fargument-alias} specifies that arguments (parameters) may
12274 alias each other and may alias global storage.@*
12275 @option{-fargument-noalias} specifies that arguments do not alias
12276 each other, but may alias global storage.@*
12277 @option{-fargument-noalias-global} specifies that arguments do not
12278 alias each other and do not alias global storage.
12279
12280 Each language will automatically use whatever option is required by
12281 the language standard.  You should not need to use these options yourself.
12282
12283 @item -fleading-underscore
12284 @opindex fleading-underscore
12285 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12286 change the way C symbols are represented in the object file.  One use
12287 is to help link with legacy assembly code.
12288
12289 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12290 generate code that is not binary compatible with code generated without that
12291 switch.  Use it to conform to a non-default application binary interface.
12292 Not all targets provide complete support for this switch.
12293
12294 @item -ftls-model=@var{model}
12295 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12296 The @var{model} argument should be one of @code{global-dynamic},
12297 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12298
12299 The default without @option{-fpic} is @code{initial-exec}; with
12300 @option{-fpic} the default is @code{global-dynamic}.
12301
12302 @item -fvisibility=@var{default|internal|hidden|protected}
12303 @opindex fvisibility
12304 Set the default ELF image symbol visibility to the specified option---all
12305 symbols will be marked with this unless overridden within the code.
12306 Using this feature can very substantially improve linking and
12307 load times of shared object libraries, produce more optimized
12308 code, provide near-perfect API export and prevent symbol clashes.
12309 It is @strong{strongly} recommended that you use this in any shared objects
12310 you distribute.
12311
12312 Despite the nomenclature, @code{default} always means public ie;
12313 available to be linked against from outside the shared object.
12314 @code{protected} and @code{internal} are pretty useless in real-world
12315 usage so the only other commonly used option will be @code{hidden}.
12316 The default if @option{-fvisibility} isn't specified is
12317 @code{default}, i.e., make every
12318 symbol public---this causes the same behavior as previous versions of
12319 GCC@.
12320
12321 A good explanation of the benefits offered by ensuring ELF
12322 symbols have the correct visibility is given by ``How To Write
12323 Shared Libraries'' by Ulrich Drepper (which can be found at
12324 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12325 solution made possible by this option to marking things hidden when
12326 the default is public is to make the default hidden and mark things
12327 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12328 and @code{__attribute__ ((visibility("default")))} instead of
12329 @code{__declspec(dllexport)} you get almost identical semantics with
12330 identical syntax.  This is a great boon to those working with
12331 cross-platform projects.
12332
12333 For those adding visibility support to existing code, you may find
12334 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12335 the declarations you wish to set visibility for with (for example)
12336 @samp{#pragma GCC visibility push(hidden)} and
12337 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12338 times.  Bear in mind that symbol visibility should be viewed @strong{as
12339 part of the API interface contract} and thus all new code should
12340 always specify visibility when it is not the default ie; declarations
12341 only for use within the local DSO should @strong{always} be marked explicitly
12342 as hidden as so to avoid PLT indirection overheads---making this
12343 abundantly clear also aids readability and self-documentation of the code.
12344 Note that due to ISO C++ specification requirements, operator new and
12345 operator delete must always be of default visibility.
12346
12347 An overview of these techniques, their benefits and how to use them
12348 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12349
12350 @end table
12351
12352 @c man end
12353
12354 @node Environment Variables
12355 @section Environment Variables Affecting GCC
12356 @cindex environment variables
12357
12358 @c man begin ENVIRONMENT
12359 This section describes several environment variables that affect how GCC
12360 operates.  Some of them work by specifying directories or prefixes to use
12361 when searching for various kinds of files.  Some are used to specify other
12362 aspects of the compilation environment.
12363
12364 Note that you can also specify places to search using options such as
12365 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12366 take precedence over places specified using environment variables, which
12367 in turn take precedence over those specified by the configuration of GCC@.
12368 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12369 GNU Compiler Collection (GCC) Internals}.
12370
12371 @table @env
12372 @item LANG
12373 @itemx LC_CTYPE
12374 @c @itemx LC_COLLATE
12375 @itemx LC_MESSAGES
12376 @c @itemx LC_MONETARY
12377 @c @itemx LC_NUMERIC
12378 @c @itemx LC_TIME
12379 @itemx LC_ALL
12380 @findex LANG
12381 @findex LC_CTYPE
12382 @c @findex LC_COLLATE
12383 @findex LC_MESSAGES
12384 @c @findex LC_MONETARY
12385 @c @findex LC_NUMERIC
12386 @c @findex LC_TIME
12387 @findex LC_ALL
12388 @cindex locale
12389 These environment variables control the way that GCC uses
12390 localization information that allow GCC to work with different
12391 national conventions.  GCC inspects the locale categories
12392 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12393 so.  These locale categories can be set to any value supported by your
12394 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12395 Kingdom encoded in UTF-8.
12396
12397 The @env{LC_CTYPE} environment variable specifies character
12398 classification.  GCC uses it to determine the character boundaries in
12399 a string; this is needed for some multibyte encodings that contain quote
12400 and escape characters that would otherwise be interpreted as a string
12401 end or escape.
12402
12403 The @env{LC_MESSAGES} environment variable specifies the language to
12404 use in diagnostic messages.
12405
12406 If the @env{LC_ALL} environment variable is set, it overrides the value
12407 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12408 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12409 environment variable.  If none of these variables are set, GCC
12410 defaults to traditional C English behavior.
12411
12412 @item TMPDIR
12413 @findex TMPDIR
12414 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12415 files.  GCC uses temporary files to hold the output of one stage of
12416 compilation which is to be used as input to the next stage: for example,
12417 the output of the preprocessor, which is the input to the compiler
12418 proper.
12419
12420 @item GCC_EXEC_PREFIX
12421 @findex GCC_EXEC_PREFIX
12422 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12423 names of the subprograms executed by the compiler.  No slash is added
12424 when this prefix is combined with the name of a subprogram, but you can
12425 specify a prefix that ends with a slash if you wish.
12426
12427 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12428 an appropriate prefix to use based on the pathname it was invoked with.
12429
12430 If GCC cannot find the subprogram using the specified prefix, it
12431 tries looking in the usual places for the subprogram.
12432
12433 The default value of @env{GCC_EXEC_PREFIX} is
12434 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12435 of @code{prefix} when you ran the @file{configure} script.
12436
12437 Other prefixes specified with @option{-B} take precedence over this prefix.
12438
12439 This prefix is also used for finding files such as @file{crt0.o} that are
12440 used for linking.
12441
12442 In addition, the prefix is used in an unusual way in finding the
12443 directories to search for header files.  For each of the standard
12444 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12445 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12446 replacing that beginning with the specified prefix to produce an
12447 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12448 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12449 These alternate directories are searched first; the standard directories
12450 come next.
12451
12452 @item COMPILER_PATH
12453 @findex COMPILER_PATH
12454 The value of @env{COMPILER_PATH} is a colon-separated list of
12455 directories, much like @env{PATH}.  GCC tries the directories thus
12456 specified when searching for subprograms, if it can't find the
12457 subprograms using @env{GCC_EXEC_PREFIX}.
12458
12459 @item LIBRARY_PATH
12460 @findex LIBRARY_PATH
12461 The value of @env{LIBRARY_PATH} is a colon-separated list of
12462 directories, much like @env{PATH}.  When configured as a native compiler,
12463 GCC tries the directories thus specified when searching for special
12464 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12465 using GCC also uses these directories when searching for ordinary
12466 libraries for the @option{-l} option (but directories specified with
12467 @option{-L} come first).
12468
12469 @item LANG
12470 @findex LANG
12471 @cindex locale definition
12472 This variable is used to pass locale information to the compiler.  One way in
12473 which this information is used is to determine the character set to be used
12474 when character literals, string literals and comments are parsed in C and C++.
12475 When the compiler is configured to allow multibyte characters,
12476 the following values for @env{LANG} are recognized:
12477
12478 @table @samp
12479 @item C-JIS
12480 Recognize JIS characters.
12481 @item C-SJIS
12482 Recognize SJIS characters.
12483 @item C-EUCJP
12484 Recognize EUCJP characters.
12485 @end table
12486
12487 If @env{LANG} is not defined, or if it has some other value, then the
12488 compiler will use mblen and mbtowc as defined by the default locale to
12489 recognize and translate multibyte characters.
12490 @end table
12491
12492 @noindent
12493 Some additional environments variables affect the behavior of the
12494 preprocessor.
12495
12496 @include cppenv.texi
12497
12498 @c man end
12499
12500 @node Precompiled Headers
12501 @section Using Precompiled Headers
12502 @cindex precompiled headers
12503 @cindex speed of compilation
12504
12505 Often large projects have many header files that are included in every
12506 source file.  The time the compiler takes to process these header files
12507 over and over again can account for nearly all of the time required to
12508 build the project.  To make builds faster, GCC allows users to
12509 `precompile' a header file; then, if builds can use the precompiled
12510 header file they will be much faster.
12511
12512 @strong{Caution:} There are a few known situations where GCC will
12513 crash when trying to use a precompiled header.  If you have trouble
12514 with a precompiled header, you should remove the precompiled header
12515 and compile without it.  In addition, please use GCC's on-line
12516 defect-tracking system to report any problems you encounter with
12517 precompiled headers.  @xref{Bugs}.
12518
12519 To create a precompiled header file, simply compile it as you would any
12520 other file, if necessary using the @option{-x} option to make the driver
12521 treat it as a C or C++ header file.  You will probably want to use a
12522 tool like @command{make} to keep the precompiled header up-to-date when
12523 the headers it contains change.
12524
12525 A precompiled header file will be searched for when @code{#include} is
12526 seen in the compilation.  As it searches for the included file
12527 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12528 compiler looks for a precompiled header in each directory just before it
12529 looks for the include file in that directory.  The name searched for is
12530 the name specified in the @code{#include} with @samp{.gch} appended.  If
12531 the precompiled header file can't be used, it is ignored.
12532
12533 For instance, if you have @code{#include "all.h"}, and you have
12534 @file{all.h.gch} in the same directory as @file{all.h}, then the
12535 precompiled header file will be used if possible, and the original
12536 header will be used otherwise.
12537
12538 Alternatively, you might decide to put the precompiled header file in a
12539 directory and use @option{-I} to ensure that directory is searched
12540 before (or instead of) the directory containing the original header.
12541 Then, if you want to check that the precompiled header file is always
12542 used, you can put a file of the same name as the original header in this
12543 directory containing an @code{#error} command.
12544
12545 This also works with @option{-include}.  So yet another way to use
12546 precompiled headers, good for projects not designed with precompiled
12547 header files in mind, is to simply take most of the header files used by
12548 a project, include them from another header file, precompile that header
12549 file, and @option{-include} the precompiled header.  If the header files
12550 have guards against multiple inclusion, they will be skipped because
12551 they've already been included (in the precompiled header).
12552
12553 If you need to precompile the same header file for different
12554 languages, targets, or compiler options, you can instead make a
12555 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12556 header in the directory, perhaps using @option{-o}.  It doesn't matter
12557 what you call the files in the directory, every precompiled header in
12558 the directory will be considered.  The first precompiled header
12559 encountered in the directory that is valid for this compilation will
12560 be used; they're searched in no particular order.
12561
12562 There are many other possibilities, limited only by your imagination,
12563 good sense, and the constraints of your build system.
12564
12565 A precompiled header file can be used only when these conditions apply:
12566
12567 @itemize
12568 @item
12569 Only one precompiled header can be used in a particular compilation.
12570
12571 @item
12572 A precompiled header can't be used once the first C token is seen.  You
12573 can have preprocessor directives before a precompiled header; you can
12574 even include a precompiled header from inside another header, so long as
12575 there are no C tokens before the @code{#include}.
12576
12577 @item
12578 The precompiled header file must be produced for the same language as
12579 the current compilation.  You can't use a C precompiled header for a C++
12580 compilation.
12581
12582 @item
12583 The precompiled header file must be produced by the same compiler
12584 version and configuration as the current compilation is using.
12585 The easiest way to guarantee this is to use the same compiler binary
12586 for creating and using precompiled headers.
12587
12588 @item
12589 Any macros defined before the precompiled header is included must
12590 either be defined in the same way as when the precompiled header was
12591 generated, or must not affect the precompiled header, which usually
12592 means that the they don't appear in the precompiled header at all.
12593
12594 The @option{-D} option is one way to define a macro before a
12595 precompiled header is included; using a @code{#define} can also do it.
12596 There are also some options that define macros implicitly, like
12597 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12598 defined this way.
12599
12600 @item If debugging information is output when using the precompiled
12601 header, using @option{-g} or similar, the same kind of debugging information
12602 must have been output when building the precompiled header.  However,
12603 a precompiled header built using @option{-g} can be used in a compilation
12604 when no debugging information is being output.
12605
12606 @item The same @option{-m} options must generally be used when building
12607 and using the precompiled header.  @xref{Submodel Options},
12608 for any cases where this rule is relaxed.
12609
12610 @item Each of the following options must be the same when building and using
12611 the precompiled header:
12612
12613 @gccoptlist{-fexceptions -funit-at-a-time}
12614
12615 @item
12616 Some other command-line options starting with @option{-f},
12617 @option{-p}, or @option{-O} must be defined in the same way as when
12618 the precompiled header was generated.  At present, it's not clear
12619 which options are safe to change and which are not; the safest choice
12620 is to use exactly the same options when generating and using the
12621 precompiled header.  The following are known to be safe:
12622
12623 @gccoptlist{-fpreprocessed -pedantic-errors}
12624
12625 @end itemize
12626
12627 For all of these except the last, the compiler will automatically
12628 ignore the precompiled header if the conditions aren't met.  If you
12629 find an option combination that doesn't work and doesn't cause the
12630 precompiled header to be ignored, please consider filing a bug report,
12631 see @ref{Bugs}.
12632
12633 If you do use differing options when generating and using the
12634 precompiled header, the actual behavior will be a mixture of the
12635 behavior for the options.  For instance, if you use @option{-g} to
12636 generate the precompiled header but not when using it, you may or may
12637 not get debugging information for routines in the precompiled header.
12638
12639 @node Running Protoize
12640 @section Running Protoize
12641
12642 The program @code{protoize} is an optional part of GCC@.  You can use
12643 it to add prototypes to a program, thus converting the program to ISO
12644 C in one respect.  The companion program @code{unprotoize} does the
12645 reverse: it removes argument types from any prototypes that are found.
12646
12647 When you run these programs, you must specify a set of source files as
12648 command line arguments.  The conversion programs start out by compiling
12649 these files to see what functions they define.  The information gathered
12650 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12651
12652 After scanning comes actual conversion.  The specified files are all
12653 eligible to be converted; any files they include (whether sources or
12654 just headers) are eligible as well.
12655
12656 But not all the eligible files are converted.  By default,
12657 @code{protoize} and @code{unprotoize} convert only source and header
12658 files in the current directory.  You can specify additional directories
12659 whose files should be converted with the @option{-d @var{directory}}
12660 option.  You can also specify particular files to exclude with the
12661 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12662 directory name matches one of the specified directory names, and its
12663 name within the directory has not been excluded.
12664
12665 Basic conversion with @code{protoize} consists of rewriting most
12666 function definitions and function declarations to specify the types of
12667 the arguments.  The only ones not rewritten are those for varargs
12668 functions.
12669
12670 @code{protoize} optionally inserts prototype declarations at the
12671 beginning of the source file, to make them available for any calls that
12672 precede the function's definition.  Or it can insert prototype
12673 declarations with block scope in the blocks where undeclared functions
12674 are called.
12675
12676 Basic conversion with @code{unprotoize} consists of rewriting most
12677 function declarations to remove any argument types, and rewriting
12678 function definitions to the old-style pre-ISO form.
12679
12680 Both conversion programs print a warning for any function declaration or
12681 definition that they can't convert.  You can suppress these warnings
12682 with @option{-q}.
12683
12684 The output from @code{protoize} or @code{unprotoize} replaces the
12685 original source file.  The original file is renamed to a name ending
12686 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12687 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12688 for DOS) file already exists, then the source file is simply discarded.
12689
12690 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12691 scan the program and collect information about the functions it uses.
12692 So neither of these programs will work until GCC is installed.
12693
12694 Here is a table of the options you can use with @code{protoize} and
12695 @code{unprotoize}.  Each option works with both programs unless
12696 otherwise stated.
12697
12698 @table @code
12699 @item -B @var{directory}
12700 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12701 usual directory (normally @file{/usr/local/lib}).  This file contains
12702 prototype information about standard system functions.  This option
12703 applies only to @code{protoize}.
12704
12705 @item -c @var{compilation-options}
12706 Use @var{compilation-options} as the options when running @command{gcc} to
12707 produce the @samp{.X} files.  The special option @option{-aux-info} is
12708 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12709
12710 Note that the compilation options must be given as a single argument to
12711 @code{protoize} or @code{unprotoize}.  If you want to specify several
12712 @command{gcc} options, you must quote the entire set of compilation options
12713 to make them a single word in the shell.
12714
12715 There are certain @command{gcc} arguments that you cannot use, because they
12716 would produce the wrong kind of output.  These include @option{-g},
12717 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12718 the @var{compilation-options}, they are ignored.
12719
12720 @item -C
12721 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12722 systems) instead of @samp{.c}.  This is convenient if you are converting
12723 a C program to C++.  This option applies only to @code{protoize}.
12724
12725 @item -g
12726 Add explicit global declarations.  This means inserting explicit
12727 declarations at the beginning of each source file for each function
12728 that is called in the file and was not declared.  These declarations
12729 precede the first function definition that contains a call to an
12730 undeclared function.  This option applies only to @code{protoize}.
12731
12732 @item -i @var{string}
12733 Indent old-style parameter declarations with the string @var{string}.
12734 This option applies only to @code{protoize}.
12735
12736 @code{unprotoize} converts prototyped function definitions to old-style
12737 function definitions, where the arguments are declared between the
12738 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12739 uses five spaces as the indentation.  If you want to indent with just
12740 one space instead, use @option{-i " "}.
12741
12742 @item -k
12743 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12744 is finished.
12745
12746 @item -l
12747 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12748 a prototype declaration for each function in each block which calls the
12749 function without any declaration.  This option applies only to
12750 @code{protoize}.
12751
12752 @item -n
12753 Make no real changes.  This mode just prints information about the conversions
12754 that would have been done without @option{-n}.
12755
12756 @item -N
12757 Make no @samp{.save} files.  The original files are simply deleted.
12758 Use this option with caution.
12759
12760 @item -p @var{program}
12761 Use the program @var{program} as the compiler.  Normally, the name
12762 @file{gcc} is used.
12763
12764 @item -q
12765 Work quietly.  Most warnings are suppressed.
12766
12767 @item -v
12768 Print the version number, just like @option{-v} for @command{gcc}.
12769 @end table
12770
12771 If you need special compiler options to compile one of your program's
12772 source files, then you should generate that file's @samp{.X} file
12773 specially, by running @command{gcc} on that source file with the
12774 appropriate options and the option @option{-aux-info}.  Then run
12775 @code{protoize} on the entire set of files.  @code{protoize} will use
12776 the existing @samp{.X} file because it is newer than the source file.
12777 For example:
12778
12779 @smallexample
12780 gcc -Dfoo=bar file1.c -aux-info file1.X
12781 protoize *.c
12782 @end smallexample
12783
12784 @noindent
12785 You need to include the special files along with the rest in the
12786 @code{protoize} command, even though their @samp{.X} files already
12787 exist, because otherwise they won't get converted.
12788
12789 @xref{Protoize Caveats}, for more information on how to use
12790 @code{protoize} successfully.