OSDN Git Service

2004-09-02 Daniel Berlin <dberlin@dberlin.org>
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
147
148 @c man begin OPTIONS
149
150 @node Option Summary
151 @section Option Summary
152
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
155
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
206
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
240
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement}
246
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-all @gol
253 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
254 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
255 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
257 -fdump-tree-ch @gol
258 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-nrv -fdump-tree-vect @gol
267 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
269 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
270 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
271 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
272 -ftest-coverage  -ftime-report -fvar-tracking @gol
273 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
274 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
275 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
276 -print-multi-directory  -print-multi-lib @gol
277 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
278 -save-temps  -time}
279
280 @item Optimization Options
281 @xref{Optimize Options,,Options that Control Optimization}.
282 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
283 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
284 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
285 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
286 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
287 -fcaller-saves  -fcprop-registers @gol
288 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
289 -fdelayed-branch  -fdelete-null-pointer-checks @gol
290 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
291 -fforce-addr  -fforce-mem  -ffunction-sections @gol
292 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
293 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
294 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
295 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
296 -fmodulo-sched -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
297 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
298 -fno-function-cse  -fno-guess-branch-probability @gol
299 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
300 -funsafe-math-optimizations  -ffinite-math-only @gol
301 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
302 -fomit-frame-pointer  -foptimize-register-move @gol
303 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
304 -fprofile-generate -fprofile-use @gol
305 -freduce-all-givs  -fregmove  -frename-registers @gol
306 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
307 -frerun-cse-after-loop  -frerun-loop-opt @gol
308 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
309 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
310 -fsched-spec-load-dangerous  @gol
311 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
312 -fsched2-use-superblocks @gol
313 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
314 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
315 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
316 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
317 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
318 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
319 -ftree-loop-im -ftree-loop-ivcanon @gol
320 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
321 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
322 --param @var{name}=@var{value}
323 -O  -O0  -O1  -O2  -O3  -Os}
324
325 @item Preprocessor Options
326 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
327 @gccoptlist{-A@var{question}=@var{answer} @gol
328 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
329 -C  -dD  -dI  -dM  -dN @gol
330 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
331 -idirafter @var{dir} @gol
332 -include @var{file}  -imacros @var{file} @gol
333 -iprefix @var{file}  -iwithprefix @var{dir} @gol
334 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
335 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
336 -P  -fworking-directory  -remap @gol
337 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
338 -Xpreprocessor @var{option}}
339
340 @item Assembler Option
341 @xref{Assembler Options,,Passing Options to the Assembler}.
342 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
343
344 @item Linker Options
345 @xref{Link Options,,Options for Linking}.
346 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
347 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
348 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
349 -Wl,@var{option}  -Xlinker @var{option} @gol
350 -u @var{symbol}}
351
352 @item Directory Options
353 @xref{Directory Options,,Options for Directory Search}.
354 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
355
356 @item Target Options
357 @c I wrote this xref this way to avoid overfull hbox. -- rms
358 @xref{Target Options}.
359 @gccoptlist{-V @var{version}  -b @var{machine}}
360
361 @item Machine Dependent Options
362 @xref{Submodel Options,,Hardware Models and Configurations}.
363 @c This list is ordered alphanumerically by subsection name.
364 @c Try and put the significant identifier (CPU or system) first,
365 @c so users have a clue at guessing where the ones they want will be.
366
367 @emph{ARC Options}
368 @gccoptlist{-EB  -EL @gol
369 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
370 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
371
372 @emph{ARM Options}
373 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
374 -mabi=@var{name} @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
381 -mthumb-interwork  -mno-thumb-interwork @gol
382 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
383 -mstructure-size-boundary=@var{n} @gol
384 -mabort-on-noreturn @gol
385 -mlong-calls  -mno-long-calls @gol
386 -msingle-pic-base  -mno-single-pic-base @gol
387 -mpic-register=@var{reg} @gol
388 -mnop-fun-dllimport @gol
389 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
390 -mpoke-function-name @gol
391 -mthumb  -marm @gol
392 -mtpcs-frame  -mtpcs-leaf-frame @gol
393 -mcaller-super-interworking  -mcallee-super-interworking}
394
395 @emph{AVR Options}
396 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
397 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
398
399 @emph{CRIS Options}
400 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
401 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
402 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
403 -mstack-align  -mdata-align  -mconst-align @gol
404 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
405 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
406 -mmul-bug-workaround  -mno-mul-bug-workaround}
407
408 @emph{Darwin Options}
409 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
410 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
411 -client_name  -compatibility_version  -current_version @gol
412 -dead_strip @gol
413 -dependency-file  -dylib_file  -dylinker_install_name @gol
414 -dynamic  -dynamiclib  -exported_symbols_list @gol
415 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
416 -force_flat_namespace  -headerpad_max_install_names @gol
417 -image_base  -init  -install_name  -keep_private_externs @gol
418 -multi_module  -multiply_defined  -multiply_defined_unused @gol
419 -noall_load   -no_dead_strip_inits_and_terms @gol
420 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
421 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
422 -private_bundle  -read_only_relocs  -sectalign @gol
423 -sectobjectsymbols  -whyload  -seg1addr @gol
424 -sectcreate  -sectobjectsymbols  -sectorder @gol
425 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
426 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
427 -single_module  -static  -sub_library  -sub_umbrella @gol
428 -twolevel_namespace  -umbrella  -undefined @gol
429 -unexported_symbols_list  -weak_reference_mismatches @gol
430 -whatsloaded -F -gused -gfull -mone-byte-bool}
431
432 @emph{DEC Alpha Options}
433 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
434 -mieee  -mieee-with-inexact  -mieee-conformant @gol
435 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
436 -mtrap-precision=@var{mode}  -mbuild-constants @gol
437 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
438 -mbwx  -mmax  -mfix  -mcix @gol
439 -mfloat-vax  -mfloat-ieee @gol
440 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
441 -msmall-text  -mlarge-text @gol
442 -mmemory-latency=@var{time}}
443
444 @emph{DEC Alpha/VMS Options}
445 @gccoptlist{-mvms-return-codes}
446
447 @emph{FRV Options}
448 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
449 -mhard-float  -msoft-float @gol
450 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
451 -mdouble  -mno-double @gol
452 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
453 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic -mlinked-fp @gol
454 -mlibrary-pic  -macc-4 -macc-8 @gol
455 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
456 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
457 -mvliw-branch  -mno-vliw-branch @gol
458 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
459 -mno-nested-cond-exec  -mtomcat-stats @gol
460 -mcpu=@var{cpu}}
461
462 @emph{H8/300 Options}
463 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
464
465 @emph{HPPA Options}
466 @gccoptlist{-march=@var{architecture-type} @gol
467 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
468 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
469 -mfixed-range=@var{register-range} @gol
470 -mjump-in-delay -mlinker-opt -mlong-calls @gol
471 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
472 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
473 -mno-jump-in-delay  -mno-long-load-store @gol
474 -mno-portable-runtime  -mno-soft-float @gol
475 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
476 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
477 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
478 -munix=@var{unix-std}  -nolibdld  -static  -threads}
479
480 @emph{i386 and x86-64 Options}
481 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
482 -mfpmath=@var{unit} @gol
483 -masm=@var{dialect}  -mno-fancy-math-387 @gol
484 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
485 -mno-wide-multiply  -mrtd  -malign-double @gol
486 -mpreferred-stack-boundary=@var{num} @gol
487 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
488 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
489 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
490 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
491 -mno-red-zone -mno-tls-direct-seg-refs @gol
492 -mcmodel=@var{code-model} @gol
493 -m32  -m64}
494
495 @emph{IA-64 Options}
496 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
497 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
498 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
499 -minline-float-divide-max-throughput @gol
500 -minline-int-divide-min-latency @gol
501 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
502 -mfixed-range=@var{register-range}}
503
504 @emph{M32R/D Options}
505 @gccoptlist{-m32r2 -m32rx -m32r @gol
506 -mdebug @gol
507 -malign-loops -mno-align-loops @gol
508 -missue-rate=@var{number} @gol
509 -mbranch-cost=@var{number} @gol
510 -mmodel=@var{code-size-model-type} @gol
511 -msdata=@var{sdata-type} @gol
512 -mno-flush-func -mflush-func=@var{name} @gol
513 -mno-flush-trap -mflush-trap=@var{number} @gol
514 -G @var{num}}
515
516 @emph{M680x0 Options}
517 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
518 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
519 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
520 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
521 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
522
523 @emph{M68hc1x Options}
524 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
525 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
526 -msoft-reg-count=@var{count}}
527
528 @emph{MCore Options}
529 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
530 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
531 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
532 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
533 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
534
535 @emph{MIPS Options}
536 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
537 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
538 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
539 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
540 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
541 -mpaired-single  -mips3d @gol
542 -mint64  -mlong64  -mlong32 @gol
543 -G@var{num}  -membedded-data  -mno-embedded-data @gol
544 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
545 -msplit-addresses  -mno-split-addresses  @gol
546 -mexplicit-relocs  -mno-explicit-relocs  @gol
547 -mcheck-zero-division  -mno-check-zero-division @gol
548 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
549 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
550 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
551 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
552 -mflush-func=@var{func}  -mno-flush-func @gol
553 -mbranch-likely  -mno-branch-likely @gol
554 -mfp-exceptions -mno-fp-exceptions @gol
555 -mvr4130-align -mno-vr4130-align}
556
557 @emph{MMIX Options}
558 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
559 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
560 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
561 -mno-base-addresses  -msingle-exit  -mno-single-exit}
562
563 @emph{MN10300 Options}
564 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
565 -mam33  -mno-am33 @gol
566 -mam33-2  -mno-am33-2 @gol
567 -mno-crt0  -mrelax}
568
569 @emph{NS32K Options}
570 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
571 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
572 -mregparam  -mnoregparam  -msb  -mnosb @gol
573 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
574
575 @emph{PDP-11 Options}
576 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
577 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
578 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
579 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
580 -mbranch-expensive  -mbranch-cheap @gol
581 -msplit  -mno-split  -munix-asm  -mdec-asm}
582
583 @emph{PowerPC Options}
584 See RS/6000 and PowerPC Options.
585
586 @emph{RS/6000 and PowerPC Options}
587 @gccoptlist{-mcpu=@var{cpu-type} @gol
588 -mtune=@var{cpu-type} @gol
589 -mpower  -mno-power  -mpower2  -mno-power2 @gol
590 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
591 -maltivec  -mno-altivec @gol
592 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
593 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
594 -mnew-mnemonics  -mold-mnemonics @gol
595 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
596 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
597 -malign-power  -malign-natural @gol
598 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
599 -mstring  -mno-string  -mupdate  -mno-update @gol
600 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
601 -mstrict-align  -mno-strict-align  -mrelocatable @gol
602 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
603 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
604 -mdynamic-no-pic @gol
605 -mprioritize-restricted-insns=@var{priority} @gol
606 -msched-costly-dep=@var{dependence_type} @gol
607 -minsert-sched-nops=@var{scheme} @gol
608 -mcall-sysv  -mcall-netbsd @gol
609 -maix-struct-return  -msvr4-struct-return @gol
610 -mabi=altivec  -mabi=no-altivec @gol
611 -mabi=spe  -mabi=no-spe @gol
612 -misel=yes  -misel=no @gol
613 -mspe=yes  -mspe=no @gol
614 -mfloat-gprs=yes  -mfloat-gprs=no @gol
615 -mprototype  -mno-prototype @gol
616 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
617 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
618
619 @emph{S/390 and zSeries Options}
620 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
621 -mhard-float  -msoft-float  -mbackchain  -mno-backchain -mkernel-backchain @gol
622 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
623 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
624 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
625 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
626
627 @emph{SH Options}
628 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
629 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
630 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
631 -m5-64media  -m5-64media-nofpu @gol
632 -m5-32media  -m5-32media-nofpu @gol
633 -m5-compact  -m5-compact-nofpu @gol
634 -mb  -ml  -mdalign  -mrelax @gol
635 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
636 -mieee  -misize  -mpadstruct  -mspace @gol
637 -mprefergot  -musermode}
638
639 @emph{SPARC Options}
640 @gccoptlist{-mcpu=@var{cpu-type} @gol
641 -mtune=@var{cpu-type} @gol
642 -mcmodel=@var{code-model} @gol
643 -m32  -m64  -mapp-regs  -mno-app-regs @gol
644 -mfaster-structs  -mno-faster-structs @gol
645 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
646 -mhard-quad-float  -msoft-quad-float @gol
647 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
648 -mstack-bias  -mno-stack-bias @gol
649 -munaligned-doubles  -mno-unaligned-doubles @gol
650 -mv8plus  -mno-v8plus  -mvis  -mno-vis
651 -threads -pthreads}
652
653 @emph{System V Options}
654 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
655
656 @emph{TMS320C3x/C4x Options}
657 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
658 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
659 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
660 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
661
662 @emph{V850 Options}
663 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
664 -mprolog-function  -mno-prolog-function  -mspace @gol
665 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
666 -mapp-regs  -mno-app-regs @gol
667 -mdisable-callt  -mno-disable-callt @gol
668 -mv850e1 @gol
669 -mv850e @gol
670 -mv850  -mbig-switch}
671
672 @emph{VAX Options}
673 @gccoptlist{-mg  -mgnu  -munix}
674
675 @emph{x86-64 Options}
676 See i386 and x86-64 Options.
677
678 @emph{Xstormy16 Options}
679 @gccoptlist{-msim}
680
681 @emph{Xtensa Options}
682 @gccoptlist{-mconst16 -mno-const16 @gol
683 -mfused-madd  -mno-fused-madd @gol
684 -mtext-section-literals  -mno-text-section-literals @gol
685 -mtarget-align  -mno-target-align @gol
686 -mlongcalls  -mno-longcalls}
687
688 @emph{zSeries Options}
689 See S/390 and zSeries Options.
690
691 @item Code Generation Options
692 @xref{Code Gen Options,,Options for Code Generation Conventions}.
693 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
694 -ffixed-@var{reg}  -fexceptions @gol
695 -fnon-call-exceptions  -funwind-tables @gol
696 -fasynchronous-unwind-tables @gol
697 -finhibit-size-directive  -finstrument-functions @gol
698 -fno-common  -fno-ident @gol
699 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
700 -freg-struct-return  -fshared-data  -fshort-enums @gol
701 -fshort-double  -fshort-wchar @gol
702 -fverbose-asm  -fpack-struct  -fstack-check @gol
703 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
704 -fargument-alias  -fargument-noalias @gol
705 -fargument-noalias-global  -fleading-underscore @gol
706 -ftls-model=@var{model} @gol
707 -ftrapv  -fwrapv  -fbounds-check @gol
708 -fvisibility}
709 @end table
710
711 @menu
712 * Overall Options::     Controlling the kind of output:
713                         an executable, object files, assembler files,
714                         or preprocessed source.
715 * C Dialect Options::   Controlling the variant of C language compiled.
716 * C++ Dialect Options:: Variations on C++.
717 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
718                         and Objective-C++.
719 * Language Independent Options:: Controlling how diagnostics should be
720                         formatted.
721 * Warning Options::     How picky should the compiler be?
722 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
723 * Optimize Options::    How much optimization?
724 * Preprocessor Options:: Controlling header files and macro definitions.
725                          Also, getting dependency information for Make.
726 * Assembler Options::   Passing options to the assembler.
727 * Link Options::        Specifying libraries and so on.
728 * Directory Options::   Where to find header files and libraries.
729                         Where to find the compiler executable files.
730 * Spec Files::          How to pass switches to sub-processes.
731 * Target Options::      Running a cross-compiler, or an old version of GCC.
732 @end menu
733
734 @node Overall Options
735 @section Options Controlling the Kind of Output
736
737 Compilation can involve up to four stages: preprocessing, compilation
738 proper, assembly and linking, always in that order.  GCC is capable of
739 preprocessing and compiling several files either into several
740 assembler input files, or into one assembler input file; then each
741 assembler input file produces an object file, and linking combines all
742 the object files (those newly compiled, and those specified as input)
743 into an executable file.
744
745 @cindex file name suffix
746 For any given input file, the file name suffix determines what kind of
747 compilation is done:
748
749 @table @gcctabopt
750 @item @var{file}.c
751 C source code which must be preprocessed.
752
753 @item @var{file}.i
754 C source code which should not be preprocessed.
755
756 @item @var{file}.ii
757 C++ source code which should not be preprocessed.
758
759 @item @var{file}.m
760 Objective-C source code.  Note that you must link with the @file{libobjc}
761 library to make an Objective-C program work.
762
763 @item @var{file}.mi
764 Objective-C source code which should not be preprocessed.
765
766 @item @var{file}.mm
767 @itemx @var{file}.M
768 Objective-C++ source code.  Note that you must link with the @file{libobjc}
769 library to make an Objective-C++ program work.  Note that @samp{.M} refers
770 to a literal capital M@.
771
772 @item @var{file}.mii
773 Objective-C++ source code which should not be preprocessed.
774
775 @item @var{file}.h
776 C, C++, Objective-C or Objective-C++ header file to be turned into a
777 precompiled header.
778
779 @item @var{file}.cc
780 @itemx @var{file}.cp
781 @itemx @var{file}.cxx
782 @itemx @var{file}.cpp
783 @itemx @var{file}.CPP
784 @itemx @var{file}.c++
785 @itemx @var{file}.C
786 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
787 the last two letters must both be literally @samp{x}.  Likewise,
788 @samp{.C} refers to a literal capital C@.
789
790 @item @var{file}.hh
791 @itemx @var{file}.H
792 C++ header file to be turned into a precompiled header.
793
794 @item @var{file}.f
795 @itemx @var{file}.for
796 @itemx @var{file}.FOR
797 Fortran source code which should not be preprocessed.
798
799 @item @var{file}.F
800 @itemx @var{file}.fpp
801 @itemx @var{file}.FPP
802 Fortran source code which must be preprocessed (with the traditional
803 preprocessor).
804
805 @item @var{file}.r
806 Fortran source code which must be preprocessed with a RATFOR
807 preprocessor (not included with GCC)@.
808
809 @item @var{file}.f90
810 @itemx @var{file}.f95
811 Fortran 90/95 source code which should not be preprocessed.
812
813 @c FIXME: Descriptions of Java file types.
814 @c @var{file}.java
815 @c @var{file}.class
816 @c @var{file}.zip
817 @c @var{file}.jar
818
819 @item @var{file}.ads
820 Ada source code file which contains a library unit declaration (a
821 declaration of a package, subprogram, or generic, or a generic
822 instantiation), or a library unit renaming declaration (a package,
823 generic, or subprogram renaming declaration).  Such files are also
824 called @dfn{specs}.
825
826 @itemx @var{file}.adb
827 Ada source code file containing a library unit body (a subprogram or
828 package body).  Such files are also called @dfn{bodies}.
829
830 @c GCC also knows about some suffixes for languages not yet included:
831 @c Pascal:
832 @c @var{file}.p
833 @c @var{file}.pas
834
835 @item @var{file}.s
836 Assembler code.
837
838 @item @var{file}.S
839 Assembler code which must be preprocessed.
840
841 @item @var{other}
842 An object file to be fed straight into linking.
843 Any file name with no recognized suffix is treated this way.
844 @end table
845
846 @opindex x
847 You can specify the input language explicitly with the @option{-x} option:
848
849 @table @gcctabopt
850 @item -x @var{language}
851 Specify explicitly the @var{language} for the following input files
852 (rather than letting the compiler choose a default based on the file
853 name suffix).  This option applies to all following input files until
854 the next @option{-x} option.  Possible values for @var{language} are:
855 @smallexample
856 c  c-header  c-cpp-output
857 c++  c++-header  c++-cpp-output
858 objective-c  objective-c-header  objective-c-cpp-output
859 objective-c++ objective-c++-header objective-c++-cpp-output
860 assembler  assembler-with-cpp
861 ada
862 f77  f77-cpp-input  ratfor
863 f95
864 java
865 treelang
866 @end smallexample
867
868 @item -x none
869 Turn off any specification of a language, so that subsequent files are
870 handled according to their file name suffixes (as they are if @option{-x}
871 has not been used at all).
872
873 @item -pass-exit-codes
874 @opindex pass-exit-codes
875 Normally the @command{gcc} program will exit with the code of 1 if any
876 phase of the compiler returns a non-success return code.  If you specify
877 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
878 numerically highest error produced by any phase that returned an error
879 indication.
880 @end table
881
882 If you only want some of the stages of compilation, you can use
883 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
884 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
885 @command{gcc} is to stop.  Note that some combinations (for example,
886 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
887
888 @table @gcctabopt
889 @item -c
890 @opindex c
891 Compile or assemble the source files, but do not link.  The linking
892 stage simply is not done.  The ultimate output is in the form of an
893 object file for each source file.
894
895 By default, the object file name for a source file is made by replacing
896 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
897
898 Unrecognized input files, not requiring compilation or assembly, are
899 ignored.
900
901 @item -S
902 @opindex S
903 Stop after the stage of compilation proper; do not assemble.  The output
904 is in the form of an assembler code file for each non-assembler input
905 file specified.
906
907 By default, the assembler file name for a source file is made by
908 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
909
910 Input files that don't require compilation are ignored.
911
912 @item -E
913 @opindex E
914 Stop after the preprocessing stage; do not run the compiler proper.  The
915 output is in the form of preprocessed source code, which is sent to the
916 standard output.
917
918 Input files which don't require preprocessing are ignored.
919
920 @cindex output file option
921 @item -o @var{file}
922 @opindex o
923 Place output in file @var{file}.  This applies regardless to whatever
924 sort of output is being produced, whether it be an executable file,
925 an object file, an assembler file or preprocessed C code.
926
927 If @option{-o} is not specified, the default is to put an executable
928 file in @file{a.out}, the object file for
929 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
930 assembler file in @file{@var{source}.s}, a precompiled header file in
931 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
932 standard output.
933
934 @item -v
935 @opindex v
936 Print (on standard error output) the commands executed to run the stages
937 of compilation.  Also print the version number of the compiler driver
938 program and of the preprocessor and the compiler proper.
939
940 @item -###
941 @opindex ###
942 Like @option{-v} except the commands are not executed and all command
943 arguments are quoted.  This is useful for shell scripts to capture the
944 driver-generated command lines.
945
946 @item -pipe
947 @opindex pipe
948 Use pipes rather than temporary files for communication between the
949 various stages of compilation.  This fails to work on some systems where
950 the assembler is unable to read from a pipe; but the GNU assembler has
951 no trouble.
952
953 @item -combine
954 @opindex combine
955 If you are compiling multiple source files, this option tells the driver
956 to pass all the source files to the compiler at once (for those
957 languages for which the compiler can handle this).  This will allow
958 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
959 language for which this is supported is C.  If you pass source files for
960 multiple languages to the driver, using this option, the driver will invoke
961 the compiler(s) that support IMA once each, passing each compiler all the
962 source files appropriate for it.  For those languages that do not support
963 IMA this option will be ignored, and the compiler will be invoked once for
964 each source file in that language.  If you use this option in conjunction
965 with -save-temps, the compiler will generate multiple pre-processed files
966 (one for each source file), but only one (combined) .o or .s file.
967
968 @item --help
969 @opindex help
970 Print (on the standard output) a description of the command line options
971 understood by @command{gcc}.  If the @option{-v} option is also specified
972 then @option{--help} will also be passed on to the various processes
973 invoked by @command{gcc}, so that they can display the command line options
974 they accept.  If the @option{-Wextra} option is also specified then command
975 line options which have no documentation associated with them will also
976 be displayed.
977
978 @item --target-help
979 @opindex target-help
980 Print (on the standard output) a description of target specific command
981 line options for each tool.
982
983 @item --version
984 @opindex version
985 Display the version number and copyrights of the invoked GCC.
986 @end table
987
988 @node Invoking G++
989 @section Compiling C++ Programs
990
991 @cindex suffixes for C++ source
992 @cindex C++ source file suffixes
993 C++ source files conventionally use one of the suffixes @samp{.C},
994 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
995 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
996 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
997 files with these names and compiles them as C++ programs even if you
998 call the compiler the same way as for compiling C programs (usually
999 with the name @command{gcc}).
1000
1001 @findex g++
1002 @findex c++
1003 However, C++ programs often require class libraries as well as a
1004 compiler that understands the C++ language---and under some
1005 circumstances, you might want to compile programs or header files from
1006 standard input, or otherwise without a suffix that flags them as C++
1007 programs.  You might also like to precompile a C header file with a
1008 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1009 program that calls GCC with the default language set to C++, and
1010 automatically specifies linking against the C++ library.  On many
1011 systems, @command{g++} is also installed with the name @command{c++}.
1012
1013 @cindex invoking @command{g++}
1014 When you compile C++ programs, you may specify many of the same
1015 command-line options that you use for compiling programs in any
1016 language; or command-line options meaningful for C and related
1017 languages; or options that are meaningful only for C++ programs.
1018 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1019 explanations of options for languages related to C@.
1020 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1021 explanations of options that are meaningful only for C++ programs.
1022
1023 @node C Dialect Options
1024 @section Options Controlling C Dialect
1025 @cindex dialect options
1026 @cindex language dialect options
1027 @cindex options, dialect
1028
1029 The following options control the dialect of C (or languages derived
1030 from C, such as C++, Objective-C and Objective-C++) that the compiler
1031 accepts:
1032
1033 @table @gcctabopt
1034 @cindex ANSI support
1035 @cindex ISO support
1036 @item -ansi
1037 @opindex ansi
1038 In C mode, support all ISO C90 programs.  In C++ mode,
1039 remove GNU extensions that conflict with ISO C++.
1040
1041 This turns off certain features of GCC that are incompatible with ISO
1042 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1043 such as the @code{asm} and @code{typeof} keywords, and
1044 predefined macros such as @code{unix} and @code{vax} that identify the
1045 type of system you are using.  It also enables the undesirable and
1046 rarely used ISO trigraph feature.  For the C compiler,
1047 it disables recognition of C++ style @samp{//} comments as well as
1048 the @code{inline} keyword.
1049
1050 The alternate keywords @code{__asm__}, @code{__extension__},
1051 @code{__inline__} and @code{__typeof__} continue to work despite
1052 @option{-ansi}.  You would not want to use them in an ISO C program, of
1053 course, but it is useful to put them in header files that might be included
1054 in compilations done with @option{-ansi}.  Alternate predefined macros
1055 such as @code{__unix__} and @code{__vax__} are also available, with or
1056 without @option{-ansi}.
1057
1058 The @option{-ansi} option does not cause non-ISO programs to be
1059 rejected gratuitously.  For that, @option{-pedantic} is required in
1060 addition to @option{-ansi}.  @xref{Warning Options}.
1061
1062 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1063 option is used.  Some header files may notice this macro and refrain
1064 from declaring certain functions or defining certain macros that the
1065 ISO standard doesn't call for; this is to avoid interfering with any
1066 programs that might use these names for other things.
1067
1068 Functions which would normally be built in but do not have semantics
1069 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1070 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1071 built-in functions provided by GCC}, for details of the functions
1072 affected.
1073
1074 @item -std=
1075 @opindex std
1076 Determine the language standard.  This option is currently only
1077 supported when compiling C or C++.  A value for this option must be
1078 provided; possible values are
1079
1080 @table @samp
1081 @item c89
1082 @itemx iso9899:1990
1083 ISO C90 (same as @option{-ansi}).
1084
1085 @item iso9899:199409
1086 ISO C90 as modified in amendment 1.
1087
1088 @item c99
1089 @itemx c9x
1090 @itemx iso9899:1999
1091 @itemx iso9899:199x
1092 ISO C99.  Note that this standard is not yet fully supported; see
1093 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1094 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1095
1096 @item gnu89
1097 Default, ISO C90 plus GNU extensions (including some C99 features).
1098
1099 @item gnu99
1100 @itemx gnu9x
1101 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1102 this will become the default.  The name @samp{gnu9x} is deprecated.
1103
1104 @item c++98
1105 The 1998 ISO C++ standard plus amendments.
1106
1107 @item gnu++98
1108 The same as @option{-std=c++98} plus GNU extensions.  This is the
1109 default for C++ code.
1110 @end table
1111
1112 Even when this option is not specified, you can still use some of the
1113 features of newer standards in so far as they do not conflict with
1114 previous C standards.  For example, you may use @code{__restrict__} even
1115 when @option{-std=c99} is not specified.
1116
1117 The @option{-std} options specifying some version of ISO C have the same
1118 effects as @option{-ansi}, except that features that were not in ISO C90
1119 but are in the specified version (for example, @samp{//} comments and
1120 the @code{inline} keyword in ISO C99) are not disabled.
1121
1122 @xref{Standards,,Language Standards Supported by GCC}, for details of
1123 these standard versions.
1124
1125 @item -aux-info @var{filename}
1126 @opindex aux-info
1127 Output to the given filename prototyped declarations for all functions
1128 declared and/or defined in a translation unit, including those in header
1129 files.  This option is silently ignored in any language other than C@.
1130
1131 Besides declarations, the file indicates, in comments, the origin of
1132 each declaration (source file and line), whether the declaration was
1133 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1134 @samp{O} for old, respectively, in the first character after the line
1135 number and the colon), and whether it came from a declaration or a
1136 definition (@samp{C} or @samp{F}, respectively, in the following
1137 character).  In the case of function definitions, a K&R-style list of
1138 arguments followed by their declarations is also provided, inside
1139 comments, after the declaration.
1140
1141 @item -fno-asm
1142 @opindex fno-asm
1143 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1144 keyword, so that code can use these words as identifiers.  You can use
1145 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1146 instead.  @option{-ansi} implies @option{-fno-asm}.
1147
1148 In C++, this switch only affects the @code{typeof} keyword, since
1149 @code{asm} and @code{inline} are standard keywords.  You may want to
1150 use the @option{-fno-gnu-keywords} flag instead, which has the same
1151 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1152 switch only affects the @code{asm} and @code{typeof} keywords, since
1153 @code{inline} is a standard keyword in ISO C99.
1154
1155 @item -fno-builtin
1156 @itemx -fno-builtin-@var{function}
1157 @opindex fno-builtin
1158 @cindex built-in functions
1159 Don't recognize built-in functions that do not begin with
1160 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1161 functions provided by GCC}, for details of the functions affected,
1162 including those which are not built-in functions when @option{-ansi} or
1163 @option{-std} options for strict ISO C conformance are used because they
1164 do not have an ISO standard meaning.
1165
1166 GCC normally generates special code to handle certain built-in functions
1167 more efficiently; for instance, calls to @code{alloca} may become single
1168 instructions that adjust the stack directly, and calls to @code{memcpy}
1169 may become inline copy loops.  The resulting code is often both smaller
1170 and faster, but since the function calls no longer appear as such, you
1171 cannot set a breakpoint on those calls, nor can you change the behavior
1172 of the functions by linking with a different library.
1173
1174 With the @option{-fno-builtin-@var{function}} option
1175 only the built-in function @var{function} is
1176 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1177 function is named this is not built-in in this version of GCC, this
1178 option is ignored.  There is no corresponding
1179 @option{-fbuiltin-@var{function}} option; if you wish to enable
1180 built-in functions selectively when using @option{-fno-builtin} or
1181 @option{-ffreestanding}, you may define macros such as:
1182
1183 @smallexample
1184 #define abs(n)          __builtin_abs ((n))
1185 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1186 @end smallexample
1187
1188 @item -fhosted
1189 @opindex fhosted
1190 @cindex hosted environment
1191
1192 Assert that compilation takes place in a hosted environment.  This implies
1193 @option{-fbuiltin}.  A hosted environment is one in which the
1194 entire standard library is available, and in which @code{main} has a return
1195 type of @code{int}.  Examples are nearly everything except a kernel.
1196 This is equivalent to @option{-fno-freestanding}.
1197
1198 @item -ffreestanding
1199 @opindex ffreestanding
1200 @cindex hosted environment
1201
1202 Assert that compilation takes place in a freestanding environment.  This
1203 implies @option{-fno-builtin}.  A freestanding environment
1204 is one in which the standard library may not exist, and program startup may
1205 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1206 This is equivalent to @option{-fno-hosted}.
1207
1208 @xref{Standards,,Language Standards Supported by GCC}, for details of
1209 freestanding and hosted environments.
1210
1211 @item -fms-extensions
1212 @opindex fms-extensions
1213 Accept some non-standard constructs used in Microsoft header files.
1214
1215 @item -trigraphs
1216 @opindex trigraphs
1217 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1218 options for strict ISO C conformance) implies @option{-trigraphs}.
1219
1220 @item -no-integrated-cpp
1221 @opindex no-integrated-cpp
1222 Performs a compilation in two passes: preprocessing and compiling.  This
1223 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1224 @option{-B} option. The user supplied compilation step can then add in
1225 an additional preprocessing step after normal preprocessing but before
1226 compiling. The default is to use the integrated cpp (internal cpp)
1227
1228 The semantics of this option will change if "cc1", "cc1plus", and
1229 "cc1obj" are merged.
1230
1231 @cindex traditional C language
1232 @cindex C language, traditional
1233 @item -traditional
1234 @itemx -traditional-cpp
1235 @opindex traditional-cpp
1236 @opindex traditional
1237 Formerly, these options caused GCC to attempt to emulate a pre-standard
1238 C compiler.  They are now only supported with the @option{-E} switch.
1239 The preprocessor continues to support a pre-standard mode.  See the GNU
1240 CPP manual for details.
1241
1242 @item -fcond-mismatch
1243 @opindex fcond-mismatch
1244 Allow conditional expressions with mismatched types in the second and
1245 third arguments.  The value of such an expression is void.  This option
1246 is not supported for C++.
1247
1248 @item -funsigned-char
1249 @opindex funsigned-char
1250 Let the type @code{char} be unsigned, like @code{unsigned char}.
1251
1252 Each kind of machine has a default for what @code{char} should
1253 be.  It is either like @code{unsigned char} by default or like
1254 @code{signed char} by default.
1255
1256 Ideally, a portable program should always use @code{signed char} or
1257 @code{unsigned char} when it depends on the signedness of an object.
1258 But many programs have been written to use plain @code{char} and
1259 expect it to be signed, or expect it to be unsigned, depending on the
1260 machines they were written for.  This option, and its inverse, let you
1261 make such a program work with the opposite default.
1262
1263 The type @code{char} is always a distinct type from each of
1264 @code{signed char} or @code{unsigned char}, even though its behavior
1265 is always just like one of those two.
1266
1267 @item -fsigned-char
1268 @opindex fsigned-char
1269 Let the type @code{char} be signed, like @code{signed char}.
1270
1271 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1272 the negative form of @option{-funsigned-char}.  Likewise, the option
1273 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1274
1275 @item -fsigned-bitfields
1276 @itemx -funsigned-bitfields
1277 @itemx -fno-signed-bitfields
1278 @itemx -fno-unsigned-bitfields
1279 @opindex fsigned-bitfields
1280 @opindex funsigned-bitfields
1281 @opindex fno-signed-bitfields
1282 @opindex fno-unsigned-bitfields
1283 These options control whether a bit-field is signed or unsigned, when the
1284 declaration does not use either @code{signed} or @code{unsigned}.  By
1285 default, such a bit-field is signed, because this is consistent: the
1286 basic integer types such as @code{int} are signed types.
1287 @end table
1288
1289 @node C++ Dialect Options
1290 @section Options Controlling C++ Dialect
1291
1292 @cindex compiler options, C++
1293 @cindex C++ options, command line
1294 @cindex options, C++
1295 This section describes the command-line options that are only meaningful
1296 for C++ programs; but you can also use most of the GNU compiler options
1297 regardless of what language your program is in.  For example, you
1298 might compile a file @code{firstClass.C} like this:
1299
1300 @smallexample
1301 g++ -g -frepo -O -c firstClass.C
1302 @end smallexample
1303
1304 @noindent
1305 In this example, only @option{-frepo} is an option meant
1306 only for C++ programs; you can use the other options with any
1307 language supported by GCC@.
1308
1309 Here is a list of options that are @emph{only} for compiling C++ programs:
1310
1311 @table @gcctabopt
1312
1313 @item -fabi-version=@var{n}
1314 @opindex fabi-version
1315 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1316 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1317 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1318 the version that conforms most closely to the C++ ABI specification.
1319 Therefore, the ABI obtained using version 0 will change as ABI bugs
1320 are fixed.
1321
1322 The default is version 2.
1323
1324 @item -fno-access-control
1325 @opindex fno-access-control
1326 Turn off all access checking.  This switch is mainly useful for working
1327 around bugs in the access control code.
1328
1329 @item -fcheck-new
1330 @opindex fcheck-new
1331 Check that the pointer returned by @code{operator new} is non-null
1332 before attempting to modify the storage allocated.  This check is
1333 normally unnecessary because the C++ standard specifies that
1334 @code{operator new} will only return @code{0} if it is declared
1335 @samp{throw()}, in which case the compiler will always check the
1336 return value even without this option.  In all other cases, when
1337 @code{operator new} has a non-empty exception specification, memory
1338 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1339 @samp{new (nothrow)}.
1340
1341 @item -fconserve-space
1342 @opindex fconserve-space
1343 Put uninitialized or runtime-initialized global variables into the
1344 common segment, as C does.  This saves space in the executable at the
1345 cost of not diagnosing duplicate definitions.  If you compile with this
1346 flag and your program mysteriously crashes after @code{main()} has
1347 completed, you may have an object that is being destroyed twice because
1348 two definitions were merged.
1349
1350 This option is no longer useful on most targets, now that support has
1351 been added for putting variables into BSS without making them common.
1352
1353 @item -fno-const-strings
1354 @opindex fno-const-strings
1355 Give string constants type @code{char *} instead of type @code{const
1356 char *}.  By default, G++ uses type @code{const char *} as required by
1357 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1358 actually modify the value of a string constant.
1359
1360 This option might be removed in a future release of G++.  For maximum
1361 portability, you should structure your code so that it works with
1362 string constants that have type @code{const char *}.
1363
1364 @item -fno-elide-constructors
1365 @opindex fno-elide-constructors
1366 The C++ standard allows an implementation to omit creating a temporary
1367 which is only used to initialize another object of the same type.
1368 Specifying this option disables that optimization, and forces G++ to
1369 call the copy constructor in all cases.
1370
1371 @item -fno-enforce-eh-specs
1372 @opindex fno-enforce-eh-specs
1373 Don't check for violation of exception specifications at runtime.  This
1374 option violates the C++ standard, but may be useful for reducing code
1375 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1376 will still optimize based on the exception specifications.
1377
1378 @item -ffor-scope
1379 @itemx -fno-for-scope
1380 @opindex ffor-scope
1381 @opindex fno-for-scope
1382 If @option{-ffor-scope} is specified, the scope of variables declared in
1383 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1384 as specified by the C++ standard.
1385 If @option{-fno-for-scope} is specified, the scope of variables declared in
1386 a @i{for-init-statement} extends to the end of the enclosing scope,
1387 as was the case in old versions of G++, and other (traditional)
1388 implementations of C++.
1389
1390 The default if neither flag is given to follow the standard,
1391 but to allow and give a warning for old-style code that would
1392 otherwise be invalid, or have different behavior.
1393
1394 @item -fno-gnu-keywords
1395 @opindex fno-gnu-keywords
1396 Do not recognize @code{typeof} as a keyword, so that code can use this
1397 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1398 @option{-ansi} implies @option{-fno-gnu-keywords}.
1399
1400 @item -fno-implicit-templates
1401 @opindex fno-implicit-templates
1402 Never emit code for non-inline templates which are instantiated
1403 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1404 @xref{Template Instantiation}, for more information.
1405
1406 @item -fno-implicit-inline-templates
1407 @opindex fno-implicit-inline-templates
1408 Don't emit code for implicit instantiations of inline templates, either.
1409 The default is to handle inlines differently so that compiles with and
1410 without optimization will need the same set of explicit instantiations.
1411
1412 @item -fno-implement-inlines
1413 @opindex fno-implement-inlines
1414 To save space, do not emit out-of-line copies of inline functions
1415 controlled by @samp{#pragma implementation}.  This will cause linker
1416 errors if these functions are not inlined everywhere they are called.
1417
1418 @item -fms-extensions
1419 @opindex fms-extensions
1420 Disable pedantic warnings about constructs used in MFC, such as implicit
1421 int and getting a pointer to member function via non-standard syntax.
1422
1423 @item -fno-nonansi-builtins
1424 @opindex fno-nonansi-builtins
1425 Disable built-in declarations of functions that are not mandated by
1426 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1427 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1428
1429 @item -fno-operator-names
1430 @opindex fno-operator-names
1431 Do not treat the operator name keywords @code{and}, @code{bitand},
1432 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1433 synonyms as keywords.
1434
1435 @item -fno-optional-diags
1436 @opindex fno-optional-diags
1437 Disable diagnostics that the standard says a compiler does not need to
1438 issue.  Currently, the only such diagnostic issued by G++ is the one for
1439 a name having multiple meanings within a class.
1440
1441 @item -fpermissive
1442 @opindex fpermissive
1443 Downgrade some diagnostics about nonconformant code from errors to
1444 warnings.  Thus, using @option{-fpermissive} will allow some
1445 nonconforming code to compile.
1446
1447 @item -frepo
1448 @opindex frepo
1449 Enable automatic template instantiation at link time.  This option also
1450 implies @option{-fno-implicit-templates}.  @xref{Template
1451 Instantiation}, for more information.
1452
1453 @item -fno-rtti
1454 @opindex fno-rtti
1455 Disable generation of information about every class with virtual
1456 functions for use by the C++ runtime type identification features
1457 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1458 of the language, you can save some space by using this flag.  Note that
1459 exception handling uses the same information, but it will generate it as
1460 needed.
1461
1462 @item -fstats
1463 @opindex fstats
1464 Emit statistics about front-end processing at the end of the compilation.
1465 This information is generally only useful to the G++ development team.
1466
1467 @item -ftemplate-depth-@var{n}
1468 @opindex ftemplate-depth
1469 Set the maximum instantiation depth for template classes to @var{n}.
1470 A limit on the template instantiation depth is needed to detect
1471 endless recursions during template class instantiation.  ANSI/ISO C++
1472 conforming programs must not rely on a maximum depth greater than 17.
1473
1474 @item -fno-threadsafe-statics
1475 @opindex fno-threadsafe-statics
1476 Do not emit the extra code to use the routines specified in the C++
1477 ABI for thread-safe initialization of local statics.  You can use this
1478 option to reduce code size slightly in code that doesn't need to be
1479 thread-safe.
1480
1481 @item -fuse-cxa-atexit
1482 @opindex fuse-cxa-atexit
1483 Register destructors for objects with static storage duration with the
1484 @code{__cxa_atexit} function rather than the @code{atexit} function.
1485 This option is required for fully standards-compliant handling of static
1486 destructors, but will only work if your C library supports
1487 @code{__cxa_atexit}.
1488
1489 @item -fvisibility-inlines-hidden
1490 @opindex fvisibility-inlines-hidden
1491 Causes all inlined methods to be marked with
1492 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1493 appear in the export table of a DSO and do not require a PLT indirection
1494 when used within the DSO. Enabling this option can have a dramatic effect
1495 on load and link times of a DSO as it massively reduces the size of the
1496 dynamic export table when the library makes heavy use of templates. While
1497 it can cause bloating through duplication of code within each DSO where
1498 it is used, often the wastage is less than the considerable space occupied
1499 by a long symbol name in the export table which is typical when using
1500 templates and namespaces. For even more savings, combine with the
1501 @code{-fvisibility=hidden} switch.
1502
1503 @item -fno-weak
1504 @opindex fno-weak
1505 Do not use weak symbol support, even if it is provided by the linker.
1506 By default, G++ will use weak symbols if they are available.  This
1507 option exists only for testing, and should not be used by end-users;
1508 it will result in inferior code and has no benefits.  This option may
1509 be removed in a future release of G++.
1510
1511 @item -nostdinc++
1512 @opindex nostdinc++
1513 Do not search for header files in the standard directories specific to
1514 C++, but do still search the other standard directories.  (This option
1515 is used when building the C++ library.)
1516 @end table
1517
1518 In addition, these optimization, warning, and code generation options
1519 have meanings only for C++ programs:
1520
1521 @table @gcctabopt
1522 @item -fno-default-inline
1523 @opindex fno-default-inline
1524 Do not assume @samp{inline} for functions defined inside a class scope.
1525 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1526 functions will have linkage like inline functions; they just won't be
1527 inlined by default.
1528
1529 @item -Wabi @r{(C++ only)}
1530 @opindex Wabi
1531 Warn when G++ generates code that is probably not compatible with the
1532 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1533 all such cases, there are probably some cases that are not warned about,
1534 even though G++ is generating incompatible code.  There may also be
1535 cases where warnings are emitted even though the code that is generated
1536 will be compatible.
1537
1538 You should rewrite your code to avoid these warnings if you are
1539 concerned about the fact that code generated by G++ may not be binary
1540 compatible with code generated by other compilers.
1541
1542 The known incompatibilities at this point include:
1543
1544 @itemize @bullet
1545
1546 @item
1547 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1548 pack data into the same byte as a base class.  For example:
1549
1550 @smallexample
1551 struct A @{ virtual void f(); int f1 : 1; @};
1552 struct B : public A @{ int f2 : 1; @};
1553 @end smallexample
1554
1555 @noindent
1556 In this case, G++ will place @code{B::f2} into the same byte
1557 as@code{A::f1}; other compilers will not.  You can avoid this problem
1558 by explicitly padding @code{A} so that its size is a multiple of the
1559 byte size on your platform; that will cause G++ and other compilers to
1560 layout @code{B} identically.
1561
1562 @item
1563 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1564 tail padding when laying out virtual bases.  For example:
1565
1566 @smallexample
1567 struct A @{ virtual void f(); char c1; @};
1568 struct B @{ B(); char c2; @};
1569 struct C : public A, public virtual B @{@};
1570 @end smallexample
1571
1572 @noindent
1573 In this case, G++ will not place @code{B} into the tail-padding for
1574 @code{A}; other compilers will.  You can avoid this problem by
1575 explicitly padding @code{A} so that its size is a multiple of its
1576 alignment (ignoring virtual base classes); that will cause G++ and other
1577 compilers to layout @code{C} identically.
1578
1579 @item
1580 Incorrect handling of bit-fields with declared widths greater than that
1581 of their underlying types, when the bit-fields appear in a union.  For
1582 example:
1583
1584 @smallexample
1585 union U @{ int i : 4096; @};
1586 @end smallexample
1587
1588 @noindent
1589 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1590 union too small by the number of bits in an @code{int}.
1591
1592 @item
1593 Empty classes can be placed at incorrect offsets.  For example:
1594
1595 @smallexample
1596 struct A @{@};
1597
1598 struct B @{
1599   A a;
1600   virtual void f ();
1601 @};
1602
1603 struct C : public B, public A @{@};
1604 @end smallexample
1605
1606 @noindent
1607 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1608 it should be placed at offset zero.  G++ mistakenly believes that the
1609 @code{A} data member of @code{B} is already at offset zero.
1610
1611 @item
1612 Names of template functions whose types involve @code{typename} or
1613 template template parameters can be mangled incorrectly.
1614
1615 @smallexample
1616 template <typename Q>
1617 void f(typename Q::X) @{@}
1618
1619 template <template <typename> class Q>
1620 void f(typename Q<int>::X) @{@}
1621 @end smallexample
1622
1623 @noindent
1624 Instantiations of these templates may be mangled incorrectly.
1625
1626 @end itemize
1627
1628 @item -Wctor-dtor-privacy @r{(C++ only)}
1629 @opindex Wctor-dtor-privacy
1630 Warn when a class seems unusable because all the constructors or
1631 destructors in that class are private, and it has neither friends nor
1632 public static member functions.
1633
1634 @item -Wnon-virtual-dtor @r{(C++ only)}
1635 @opindex Wnon-virtual-dtor
1636 Warn when a class appears to be polymorphic, thereby requiring a virtual
1637 destructor, yet it declares a non-virtual one.
1638 This warning is enabled by @option{-Wall}.
1639
1640 @item -Wreorder @r{(C++ only)}
1641 @opindex Wreorder
1642 @cindex reordering, warning
1643 @cindex warning for reordering of member initializers
1644 Warn when the order of member initializers given in the code does not
1645 match the order in which they must be executed.  For instance:
1646
1647 @smallexample
1648 struct A @{
1649   int i;
1650   int j;
1651   A(): j (0), i (1) @{ @}
1652 @};
1653 @end smallexample
1654
1655 The compiler will rearrange the member initializers for @samp{i}
1656 and @samp{j} to match the declaration order of the members, emitting
1657 a warning to that effect.  This warning is enabled by @option{-Wall}.
1658 @end table
1659
1660 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1661
1662 @table @gcctabopt
1663 @item -Weffc++ @r{(C++ only)}
1664 @opindex Weffc++
1665 Warn about violations of the following style guidelines from Scott Meyers'
1666 @cite{Effective C++} book:
1667
1668 @itemize @bullet
1669 @item
1670 Item 11:  Define a copy constructor and an assignment operator for classes
1671 with dynamically allocated memory.
1672
1673 @item
1674 Item 12:  Prefer initialization to assignment in constructors.
1675
1676 @item
1677 Item 14:  Make destructors virtual in base classes.
1678
1679 @item
1680 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1681
1682 @item
1683 Item 23:  Don't try to return a reference when you must return an object.
1684
1685 @end itemize
1686
1687 Also warn about violations of the following style guidelines from
1688 Scott Meyers' @cite{More Effective C++} book:
1689
1690 @itemize @bullet
1691 @item
1692 Item 6:  Distinguish between prefix and postfix forms of increment and
1693 decrement operators.
1694
1695 @item
1696 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1697
1698 @end itemize
1699
1700 When selecting this option, be aware that the standard library
1701 headers do not obey all of these guidelines; use @samp{grep -v}
1702 to filter out those warnings.
1703
1704 @item -Wno-deprecated @r{(C++ only)}
1705 @opindex Wno-deprecated
1706 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1707
1708 @item -Wno-non-template-friend @r{(C++ only)}
1709 @opindex Wno-non-template-friend
1710 Disable warnings when non-templatized friend functions are declared
1711 within a template.  Since the advent of explicit template specification
1712 support in G++, if the name of the friend is an unqualified-id (i.e.,
1713 @samp{friend foo(int)}), the C++ language specification demands that the
1714 friend declare or define an ordinary, nontemplate function.  (Section
1715 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1716 could be interpreted as a particular specialization of a templatized
1717 function.  Because this non-conforming behavior is no longer the default
1718 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1719 check existing code for potential trouble spots and is on by default.
1720 This new compiler behavior can be turned off with
1721 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1722 but disables the helpful warning.
1723
1724 @item -Wold-style-cast @r{(C++ only)}
1725 @opindex Wold-style-cast
1726 Warn if an old-style (C-style) cast to a non-void type is used within
1727 a C++ program.  The new-style casts (@samp{static_cast},
1728 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1729 unintended effects and much easier to search for.
1730
1731 @item -Woverloaded-virtual @r{(C++ only)}
1732 @opindex Woverloaded-virtual
1733 @cindex overloaded virtual fn, warning
1734 @cindex warning for overloaded virtual fn
1735 Warn when a function declaration hides virtual functions from a
1736 base class.  For example, in:
1737
1738 @smallexample
1739 struct A @{
1740   virtual void f();
1741 @};
1742
1743 struct B: public A @{
1744   void f(int);
1745 @};
1746 @end smallexample
1747
1748 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1749 like:
1750
1751 @smallexample
1752 B* b;
1753 b->f();
1754 @end smallexample
1755
1756 will fail to compile.
1757
1758 @item -Wno-pmf-conversions @r{(C++ only)}
1759 @opindex Wno-pmf-conversions
1760 Disable the diagnostic for converting a bound pointer to member function
1761 to a plain pointer.
1762
1763 @item -Wsign-promo @r{(C++ only)}
1764 @opindex Wsign-promo
1765 Warn when overload resolution chooses a promotion from unsigned or
1766 enumerated type to a signed type, over a conversion to an unsigned type of
1767 the same size.  Previous versions of G++ would try to preserve
1768 unsignedness, but the standard mandates the current behavior.
1769
1770 @item -Wsynth @r{(C++ only)}
1771 @opindex Wsynth
1772 @cindex warning for synthesized methods
1773 @cindex synthesized methods, warning
1774 Warn when G++'s synthesis behavior does not match that of cfront.  For
1775 instance:
1776
1777 @smallexample
1778 struct A @{
1779   operator int ();
1780   A& operator = (int);
1781 @};
1782
1783 main ()
1784 @{
1785   A a,b;
1786   a = b;
1787 @}
1788 @end smallexample
1789
1790 In this example, G++ will synthesize a default @samp{A& operator =
1791 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1792 @end table
1793
1794 @node Objective-C and Objective-C++ Dialect Options
1795 @section Options Controlling Objective-C and Objective-C++ Dialects
1796
1797 @cindex compiler options, Objective-C and Objective-C++
1798 @cindex Objective-C and Objective-C++ options, command line
1799 @cindex options, Objective-C and Objective-C++
1800 (NOTE: This manual does not describe the Objective-C and Objective-C++
1801 languages themselves.  See @xref{Standards,,Language Standards
1802 Supported by GCC}, for references.)
1803
1804 This section describes the command-line options that are only meaningful
1805 for Objective-C and Objective-C++ programs, but you can also use most of
1806 the language-independent GNU compiler options.
1807 For example, you might compile a file @code{some_class.m} like this:
1808
1809 @smallexample
1810 gcc -g -fgnu-runtime -O -c some_class.m
1811 @end smallexample
1812
1813 @noindent
1814 In this example, @option{-fgnu-runtime} is an option meant only for
1815 Objective-C and Objective-C++ programs; you can use the other options with
1816 any language supported by GCC@.
1817
1818 Note that since Objective-C is an extension of the C language, Objective-C
1819 compilations may also use options specific to the C front-end (e.g., 
1820 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1821 C++-specific options (e.g., @option{-Wabi}).
1822
1823 Here is a list of options that are @emph{only} for compiling Objective-C
1824 and Objective-C++ programs:
1825
1826 @table @gcctabopt
1827 @item -fconstant-string-class=@var{class-name}
1828 @opindex fconstant-string-class
1829 Use @var{class-name} as the name of the class to instantiate for each
1830 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1831 class name is @code{NXConstantString} if the GNU runtime is being used, and
1832 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1833 @option{-fconstant-cfstrings} option, if also present, will override the
1834 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1835 to be laid out as constant CoreFoundation strings.
1836
1837 @item -fgnu-runtime
1838 @opindex fgnu-runtime
1839 Generate object code compatible with the standard GNU Objective-C
1840 runtime.  This is the default for most types of systems.
1841
1842 @item -fnext-runtime
1843 @opindex fnext-runtime
1844 Generate output compatible with the NeXT runtime.  This is the default
1845 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1846 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1847 used.
1848
1849 @item -fno-nil-receivers
1850 @opindex fno-nil-receivers
1851 Assume that all Objective-C message dispatches (e.g.,
1852 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1853 is not @code{nil}.  This allows for more efficient entry points in the runtime
1854 to be used.  Currently, this option is only available in conjunction with
1855 the NeXT runtime on Mac OS X 10.3 and later.
1856
1857 @item -fobjc-exceptions
1858 @opindex fobjc-exceptions
1859 Enable syntactic support for structured exception handling in Objective-C,
1860 similar to what is offered by C++ and Java.  Currently, this option is only
1861 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1862
1863 @smallexample
1864   @@try @{
1865     @dots{}
1866        @@throw expr;
1867     @dots{}
1868   @}
1869   @@catch (AnObjCClass *exc) @{
1870     @dots{}
1871       @@throw expr;
1872     @dots{}
1873       @@throw;
1874     @dots{}
1875   @}
1876   @@catch (AnotherClass *exc) @{
1877     @dots{}
1878   @}
1879   @@catch (id allOthers) @{
1880     @dots{}
1881   @}
1882   @@finally @{
1883     @dots{}
1884       @@throw expr;
1885     @dots{}
1886   @}
1887 @end smallexample
1888
1889 The @code{@@throw} statement may appear anywhere in an Objective-C or
1890 Objective-C++ program; when used inside of a @code{@@catch} block, the
1891 @code{@@throw} may appear without an argument (as shown above), in which case
1892 the object caught by the @code{@@catch} will be rethrown.
1893
1894 Note that only (pointers to) Objective-C objects may be thrown and
1895 caught using this scheme.  When an object is thrown, it will be caught
1896 by the nearest @code{@@catch} clause capable of handling objects of that type,
1897 analogously to how @code{catch} blocks work in C++ and Java.  A
1898 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1899 any and all Objective-C exceptions not caught by previous @code{@@catch}
1900 clauses (if any).
1901
1902 The @code{@@finally} clause, if present, will be executed upon exit from the
1903 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1904 regardless of whether any exceptions are thrown, caught or rethrown
1905 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1906 of the @code{finally} clause in Java.
1907
1908 There are several caveats to using the new exception mechanism:
1909
1910 @itemize @bullet
1911 @item
1912 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1913 idioms provided by the @code{NSException} class, the new
1914 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1915 systems, due to additional functionality needed in the (NeXT) Objective-C
1916 runtime.
1917
1918 @item
1919 As mentioned above, the new exceptions do not support handling
1920 types other than Objective-C objects.   Furthermore, when used from
1921 Objective-C++, the Objective-C exception model does not interoperate with C++
1922 exceptions at this time.  This means you cannot @code{@@throw} an exception
1923 from Objective-C and @code{catch} it in C++, or vice versa
1924 (i.e., @code{throw @dots{} @@catch}).
1925 @end itemize
1926
1927 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1928 blocks for thread-safe execution:
1929
1930 @smallexample
1931   @@synchronized (ObjCClass *guard) @{
1932     @dots{}
1933   @}
1934 @end smallexample
1935
1936 Upon entering the @code{@@synchronized} block, a thread of execution shall
1937 first check whether a lock has been placed on the corresponding @code{guard}
1938 object by another thread.  If it has, the current thread shall wait until
1939 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1940 the current thread will place its own lock on it, execute the code contained in
1941 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1942 making @code{guard} available to other threads).
1943
1944 Unlike Java, Objective-C does not allow for entire methods to be marked
1945 @code{@@synchronized}.  Note that throwing exceptions out of
1946 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1947 to be unlocked properly.
1948
1949 @item -freplace-objc-classes
1950 @opindex freplace-objc-classes
1951 Emit a special marker instructing @command{ld(1)} not to statically link in
1952 the resulting object file, and allow @command{dyld(1)} to load it in at
1953 run time instead.  This is used in conjunction with the Fix-and-Continue
1954 debugging mode, where the object file in question may be recompiled and
1955 dynamically reloaded in the course of program execution, without the need
1956 to restart the program itself.  Currently, Fix-and-Continue functionality
1957 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1958 and later.
1959
1960 @item -fzero-link
1961 @opindex fzero-link
1962 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1963 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1964 compile time) with static class references that get initialized at load time,
1965 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1966 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1967 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1968 for individual class implementations to be modified during program execution.
1969
1970 @item -gen-decls
1971 @opindex gen-decls
1972 Dump interface declarations for all classes seen in the source file to a
1973 file named @file{@var{sourcename}.decl}.
1974
1975 @item -Wno-protocol
1976 @opindex Wno-protocol
1977 If a class is declared to implement a protocol, a warning is issued for
1978 every method in the protocol that is not implemented by the class.  The
1979 default behavior is to issue a warning for every method not explicitly
1980 implemented in the class, even if a method implementation is inherited
1981 from the superclass.  If you use the @code{-Wno-protocol} option, then
1982 methods inherited from the superclass are considered to be implemented,
1983 and no warning is issued for them.
1984
1985 @item -Wselector
1986 @opindex Wselector
1987 Warn if multiple methods of different types for the same selector are
1988 found during compilation.  The check is performed on the list of methods
1989 in the final stage of compilation.  Additionally, a check is performed
1990 for each selector appearing in a @code{@@selector(@dots{})}
1991 expression, and a corresponding method for that selector has been found
1992 during compilation.  Because these checks scan the method table only at
1993 the end of compilation, these warnings are not produced if the final
1994 stage of compilation is not reached, for example because an error is
1995 found during compilation, or because the @code{-fsyntax-only} option is
1996 being used.
1997
1998 @item -Wundeclared-selector
1999 @opindex Wundeclared-selector
2000 Warn if a @code{@@selector(@dots{})} expression referring to an
2001 undeclared selector is found.  A selector is considered undeclared if no
2002 method with that name has been declared before the
2003 @code{@@selector(@dots{})} expression, either explicitly in an
2004 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2005 an @code{@@implementation} section.  This option always performs its
2006 checks as soon as a @code{@@selector(@dots{})} expression is found,
2007 while @code{-Wselector} only performs its checks in the final stage of
2008 compilation.  This also enforces the coding style convention
2009 that methods and selectors must be declared before being used.
2010
2011 @item -print-objc-runtime-info
2012 @opindex print-objc-runtime-info
2013 Generate C header describing the largest structure that is passed by
2014 value, if any.
2015
2016 @end table
2017
2018 @node Language Independent Options
2019 @section Options to Control Diagnostic Messages Formatting
2020 @cindex options to control diagnostics formatting
2021 @cindex diagnostic messages
2022 @cindex message formatting
2023
2024 Traditionally, diagnostic messages have been formatted irrespective of
2025 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2026 below can be used to control the diagnostic messages formatting
2027 algorithm, e.g.@: how many characters per line, how often source location
2028 information should be reported.  Right now, only the C++ front end can
2029 honor these options.  However it is expected, in the near future, that
2030 the remaining front ends would be able to digest them correctly.
2031
2032 @table @gcctabopt
2033 @item -fmessage-length=@var{n}
2034 @opindex fmessage-length
2035 Try to format error messages so that they fit on lines of about @var{n}
2036 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2037 the front ends supported by GCC@.  If @var{n} is zero, then no
2038 line-wrapping will be done; each error message will appear on a single
2039 line.
2040
2041 @opindex fdiagnostics-show-location
2042 @item -fdiagnostics-show-location=once
2043 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2044 reporter to emit @emph{once} source location information; that is, in
2045 case the message is too long to fit on a single physical line and has to
2046 be wrapped, the source location won't be emitted (as prefix) again,
2047 over and over, in subsequent continuation lines.  This is the default
2048 behavior.
2049
2050 @item -fdiagnostics-show-location=every-line
2051 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2052 messages reporter to emit the same source location information (as
2053 prefix) for physical lines that result from the process of breaking
2054 a message which is too long to fit on a single line.
2055
2056 @end table
2057
2058 @node Warning Options
2059 @section Options to Request or Suppress Warnings
2060 @cindex options to control warnings
2061 @cindex warning messages
2062 @cindex messages, warning
2063 @cindex suppressing warnings
2064
2065 Warnings are diagnostic messages that report constructions which
2066 are not inherently erroneous but which are risky or suggest there
2067 may have been an error.
2068
2069 You can request many specific warnings with options beginning @samp{-W},
2070 for example @option{-Wimplicit} to request warnings on implicit
2071 declarations.  Each of these specific warning options also has a
2072 negative form beginning @samp{-Wno-} to turn off warnings;
2073 for example, @option{-Wno-implicit}.  This manual lists only one of the
2074 two forms, whichever is not the default.
2075
2076 The following options control the amount and kinds of warnings produced
2077 by GCC; for further, language-specific options also refer to
2078 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2079 Options}.
2080
2081 @table @gcctabopt
2082 @cindex syntax checking
2083 @item -fsyntax-only
2084 @opindex fsyntax-only
2085 Check the code for syntax errors, but don't do anything beyond that.
2086
2087 @item -pedantic
2088 @opindex pedantic
2089 Issue all the warnings demanded by strict ISO C and ISO C++;
2090 reject all programs that use forbidden extensions, and some other
2091 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2092 version of the ISO C standard specified by any @option{-std} option used.
2093
2094 Valid ISO C and ISO C++ programs should compile properly with or without
2095 this option (though a rare few will require @option{-ansi} or a
2096 @option{-std} option specifying the required version of ISO C)@.  However,
2097 without this option, certain GNU extensions and traditional C and C++
2098 features are supported as well.  With this option, they are rejected.
2099
2100 @option{-pedantic} does not cause warning messages for use of the
2101 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2102 warnings are also disabled in the expression that follows
2103 @code{__extension__}.  However, only system header files should use
2104 these escape routes; application programs should avoid them.
2105 @xref{Alternate Keywords}.
2106
2107 Some users try to use @option{-pedantic} to check programs for strict ISO
2108 C conformance.  They soon find that it does not do quite what they want:
2109 it finds some non-ISO practices, but not all---only those for which
2110 ISO C @emph{requires} a diagnostic, and some others for which
2111 diagnostics have been added.
2112
2113 A feature to report any failure to conform to ISO C might be useful in
2114 some instances, but would require considerable additional work and would
2115 be quite different from @option{-pedantic}.  We don't have plans to
2116 support such a feature in the near future.
2117
2118 Where the standard specified with @option{-std} represents a GNU
2119 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2120 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2121 extended dialect is based.  Warnings from @option{-pedantic} are given
2122 where they are required by the base standard.  (It would not make sense
2123 for such warnings to be given only for features not in the specified GNU
2124 C dialect, since by definition the GNU dialects of C include all
2125 features the compiler supports with the given option, and there would be
2126 nothing to warn about.)
2127
2128 @item -pedantic-errors
2129 @opindex pedantic-errors
2130 Like @option{-pedantic}, except that errors are produced rather than
2131 warnings.
2132
2133 @item -w
2134 @opindex w
2135 Inhibit all warning messages.
2136
2137 @item -Wno-import
2138 @opindex Wno-import
2139 Inhibit warning messages about the use of @samp{#import}.
2140
2141 @item -Wchar-subscripts
2142 @opindex Wchar-subscripts
2143 Warn if an array subscript has type @code{char}.  This is a common cause
2144 of error, as programmers often forget that this type is signed on some
2145 machines.
2146
2147 @item -Wcomment
2148 @opindex Wcomment
2149 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2150 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2151
2152 @item -Wfatal-errors
2153 @opindex Wfatal-errors
2154 This option causes the compiler to abort compilation on the first error
2155 occurred rather than trying to keep going and printing further error
2156 messages.
2157
2158 @item -Wformat
2159 @opindex Wformat
2160 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2161 the arguments supplied have types appropriate to the format string
2162 specified, and that the conversions specified in the format string make
2163 sense.  This includes standard functions, and others specified by format
2164 attributes (@pxref{Function Attributes}), in the @code{printf},
2165 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2166 not in the C standard) families (or other target-specific families).
2167
2168 The formats are checked against the format features supported by GNU
2169 libc version 2.2.  These include all ISO C90 and C99 features, as well
2170 as features from the Single Unix Specification and some BSD and GNU
2171 extensions.  Other library implementations may not support all these
2172 features; GCC does not support warning about features that go beyond a
2173 particular library's limitations.  However, if @option{-pedantic} is used
2174 with @option{-Wformat}, warnings will be given about format features not
2175 in the selected standard version (but not for @code{strfmon} formats,
2176 since those are not in any version of the C standard).  @xref{C Dialect
2177 Options,,Options Controlling C Dialect}.
2178
2179 Since @option{-Wformat} also checks for null format arguments for
2180 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2181
2182 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2183 aspects of format checking, the options @option{-Wformat-y2k},
2184 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2185 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2186 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2187
2188 @item -Wformat-y2k
2189 @opindex Wformat-y2k
2190 If @option{-Wformat} is specified, also warn about @code{strftime}
2191 formats which may yield only a two-digit year.
2192
2193 @item -Wno-format-extra-args
2194 @opindex Wno-format-extra-args
2195 If @option{-Wformat} is specified, do not warn about excess arguments to a
2196 @code{printf} or @code{scanf} format function.  The C standard specifies
2197 that such arguments are ignored.
2198
2199 Where the unused arguments lie between used arguments that are
2200 specified with @samp{$} operand number specifications, normally
2201 warnings are still given, since the implementation could not know what
2202 type to pass to @code{va_arg} to skip the unused arguments.  However,
2203 in the case of @code{scanf} formats, this option will suppress the
2204 warning if the unused arguments are all pointers, since the Single
2205 Unix Specification says that such unused arguments are allowed.
2206
2207 @item -Wno-format-zero-length
2208 @opindex Wno-format-zero-length
2209 If @option{-Wformat} is specified, do not warn about zero-length formats.
2210 The C standard specifies that zero-length formats are allowed.
2211
2212 @item -Wformat-nonliteral
2213 @opindex Wformat-nonliteral
2214 If @option{-Wformat} is specified, also warn if the format string is not a
2215 string literal and so cannot be checked, unless the format function
2216 takes its format arguments as a @code{va_list}.
2217
2218 @item -Wformat-security
2219 @opindex Wformat-security
2220 If @option{-Wformat} is specified, also warn about uses of format
2221 functions that represent possible security problems.  At present, this
2222 warns about calls to @code{printf} and @code{scanf} functions where the
2223 format string is not a string literal and there are no format arguments,
2224 as in @code{printf (foo);}.  This may be a security hole if the format
2225 string came from untrusted input and contains @samp{%n}.  (This is
2226 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2227 in future warnings may be added to @option{-Wformat-security} that are not
2228 included in @option{-Wformat-nonliteral}.)
2229
2230 @item -Wformat=2
2231 @opindex Wformat=2
2232 Enable @option{-Wformat} plus format checks not included in
2233 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2234 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2235
2236 @item -Wnonnull
2237 @opindex Wnonnull
2238 Warn about passing a null pointer for arguments marked as
2239 requiring a non-null value by the @code{nonnull} function attribute.
2240
2241 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2242 can be disabled with the @option{-Wno-nonnull} option.
2243
2244 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2245 @opindex Winit-self
2246 Warn about uninitialized variables which are initialized with themselves.
2247 Note this option can only be used with the @option{-Wuninitialized} option,
2248 which in turn only works with @option{-O1} and above.
2249
2250 For example, GCC will warn about @code{i} being uninitialized in the
2251 following snippet only when @option{-Winit-self} has been specified:
2252 @smallexample
2253 @group
2254 int f()
2255 @{
2256   int i = i;
2257   return i;
2258 @}
2259 @end group
2260 @end smallexample
2261
2262 @item -Wimplicit-int
2263 @opindex Wimplicit-int
2264 Warn when a declaration does not specify a type.
2265
2266 @item -Wimplicit-function-declaration
2267 @itemx -Werror-implicit-function-declaration
2268 @opindex Wimplicit-function-declaration
2269 @opindex Werror-implicit-function-declaration
2270 Give a warning (or error) whenever a function is used before being
2271 declared.
2272
2273 @item -Wimplicit
2274 @opindex Wimplicit
2275 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2276
2277 @item -Wmain
2278 @opindex Wmain
2279 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2280 function with external linkage, returning int, taking either zero
2281 arguments, two, or three arguments of appropriate types.
2282
2283 @item -Wmissing-braces
2284 @opindex Wmissing-braces
2285 Warn if an aggregate or union initializer is not fully bracketed.  In
2286 the following example, the initializer for @samp{a} is not fully
2287 bracketed, but that for @samp{b} is fully bracketed.
2288
2289 @smallexample
2290 int a[2][2] = @{ 0, 1, 2, 3 @};
2291 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2292 @end smallexample
2293
2294 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2295 @opindex Wmissing-include-dirs
2296 Warn if a user-supplied include directory does not exist.
2297
2298 @item -Wparentheses
2299 @opindex Wparentheses
2300 Warn if parentheses are omitted in certain contexts, such
2301 as when there is an assignment in a context where a truth value
2302 is expected, or when operators are nested whose precedence people
2303 often get confused about.  Only the warning for an assignment used as
2304 a truth value is supported when compiling C++; the other warnings are
2305 only supported when compiling C@.
2306
2307 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2308 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2309 interpretation from that of ordinary mathematical notation.
2310
2311 Also warn about constructions where there may be confusion to which
2312 @code{if} statement an @code{else} branch belongs.  Here is an example of
2313 such a case:
2314
2315 @smallexample
2316 @group
2317 @{
2318   if (a)
2319     if (b)
2320       foo ();
2321   else
2322     bar ();
2323 @}
2324 @end group
2325 @end smallexample
2326
2327 In C, every @code{else} branch belongs to the innermost possible @code{if}
2328 statement, which in this example is @code{if (b)}.  This is often not
2329 what the programmer expected, as illustrated in the above example by
2330 indentation the programmer chose.  When there is the potential for this
2331 confusion, GCC will issue a warning when this flag is specified.
2332 To eliminate the warning, add explicit braces around the innermost
2333 @code{if} statement so there is no way the @code{else} could belong to
2334 the enclosing @code{if}.  The resulting code would look like this:
2335
2336 @smallexample
2337 @group
2338 @{
2339   if (a)
2340     @{
2341       if (b)
2342         foo ();
2343       else
2344         bar ();
2345     @}
2346 @}
2347 @end group
2348 @end smallexample
2349
2350 @item -Wsequence-point
2351 @opindex Wsequence-point
2352 Warn about code that may have undefined semantics because of violations
2353 of sequence point rules in the C standard.
2354
2355 The C standard defines the order in which expressions in a C program are
2356 evaluated in terms of @dfn{sequence points}, which represent a partial
2357 ordering between the execution of parts of the program: those executed
2358 before the sequence point, and those executed after it.  These occur
2359 after the evaluation of a full expression (one which is not part of a
2360 larger expression), after the evaluation of the first operand of a
2361 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2362 function is called (but after the evaluation of its arguments and the
2363 expression denoting the called function), and in certain other places.
2364 Other than as expressed by the sequence point rules, the order of
2365 evaluation of subexpressions of an expression is not specified.  All
2366 these rules describe only a partial order rather than a total order,
2367 since, for example, if two functions are called within one expression
2368 with no sequence point between them, the order in which the functions
2369 are called is not specified.  However, the standards committee have
2370 ruled that function calls do not overlap.
2371
2372 It is not specified when between sequence points modifications to the
2373 values of objects take effect.  Programs whose behavior depends on this
2374 have undefined behavior; the C standard specifies that ``Between the
2375 previous and next sequence point an object shall have its stored value
2376 modified at most once by the evaluation of an expression.  Furthermore,
2377 the prior value shall be read only to determine the value to be
2378 stored.''.  If a program breaks these rules, the results on any
2379 particular implementation are entirely unpredictable.
2380
2381 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2382 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2383 diagnosed by this option, and it may give an occasional false positive
2384 result, but in general it has been found fairly effective at detecting
2385 this sort of problem in programs.
2386
2387 The present implementation of this option only works for C programs.  A
2388 future implementation may also work for C++ programs.
2389
2390 The C standard is worded confusingly, therefore there is some debate
2391 over the precise meaning of the sequence point rules in subtle cases.
2392 Links to discussions of the problem, including proposed formal
2393 definitions, may be found on the GCC readings page, at
2394 @w{@uref{http://gcc.gnu.org/readings.html}}.
2395
2396 @item -Wreturn-type
2397 @opindex Wreturn-type
2398 Warn whenever a function is defined with a return-type that defaults to
2399 @code{int}.  Also warn about any @code{return} statement with no
2400 return-value in a function whose return-type is not @code{void}.
2401
2402 For C, also warn if the return type of a function has a type qualifier
2403 such as @code{const}.  Such a type qualifier has no effect, since the
2404 value returned by a function is not an lvalue.  ISO C prohibits
2405 qualified @code{void} return types on function definitions, so such
2406 return types always receive a warning even without this option.
2407
2408 For C++, a function without return type always produces a diagnostic
2409 message, even when @option{-Wno-return-type} is specified.  The only
2410 exceptions are @samp{main} and functions defined in system headers.
2411
2412 @item -Wswitch
2413 @opindex Wswitch
2414 Warn whenever a @code{switch} statement has an index of enumerated type
2415 and lacks a @code{case} for one or more of the named codes of that
2416 enumeration.  (The presence of a @code{default} label prevents this
2417 warning.)  @code{case} labels outside the enumeration range also
2418 provoke warnings when this option is used.
2419
2420 @item -Wswitch-default
2421 @opindex Wswitch-switch
2422 Warn whenever a @code{switch} statement does not have a @code{default}
2423 case.
2424
2425 @item -Wswitch-enum
2426 @opindex Wswitch-enum
2427 Warn whenever a @code{switch} statement has an index of enumerated type
2428 and lacks a @code{case} for one or more of the named codes of that
2429 enumeration.  @code{case} labels outside the enumeration range also
2430 provoke warnings when this option is used.
2431
2432 @item -Wtrigraphs
2433 @opindex Wtrigraphs
2434 Warn if any trigraphs are encountered that might change the meaning of
2435 the program (trigraphs within comments are not warned about).
2436
2437 @item -Wunused-function
2438 @opindex Wunused-function
2439 Warn whenever a static function is declared but not defined or a
2440 non\-inline static function is unused.
2441
2442 @item -Wunused-label
2443 @opindex Wunused-label
2444 Warn whenever a label is declared but not used.
2445
2446 To suppress this warning use the @samp{unused} attribute
2447 (@pxref{Variable Attributes}).
2448
2449 @item -Wunused-parameter
2450 @opindex Wunused-parameter
2451 Warn whenever a function parameter is unused aside from its declaration.
2452
2453 To suppress this warning use the @samp{unused} attribute
2454 (@pxref{Variable Attributes}).
2455
2456 @item -Wunused-variable
2457 @opindex Wunused-variable
2458 Warn whenever a local variable or non-constant static variable is unused
2459 aside from its declaration
2460
2461 To suppress this warning use the @samp{unused} attribute
2462 (@pxref{Variable Attributes}).
2463
2464 @item -Wunused-value
2465 @opindex Wunused-value
2466 Warn whenever a statement computes a result that is explicitly not used.
2467
2468 To suppress this warning cast the expression to @samp{void}.
2469
2470 @item -Wunused
2471 @opindex Wunused
2472 All the above @option{-Wunused} options combined.
2473
2474 In order to get a warning about an unused function parameter, you must
2475 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2476 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2477
2478 @item -Wuninitialized
2479 @opindex Wuninitialized
2480 Warn if an automatic variable is used without first being initialized or
2481 if a variable may be clobbered by a @code{setjmp} call.
2482
2483 These warnings are possible only in optimizing compilation,
2484 because they require data flow information that is computed only
2485 when optimizing.  If you don't specify @option{-O}, you simply won't
2486 get these warnings.
2487
2488 If you want to warn about code which uses the uninitialized value of the
2489 variable in its own initializer, use the @option{-Winit-self} option.
2490
2491 These warnings occur only for variables that are candidates for
2492 register allocation.  Therefore, they do not occur for a variable that
2493 is declared @code{volatile}, or whose address is taken, or whose size
2494 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2495 structures, unions or arrays, even when they are in registers.
2496
2497 Note that there may be no warning about a variable that is used only
2498 to compute a value that itself is never used, because such
2499 computations may be deleted by data flow analysis before the warnings
2500 are printed.
2501
2502 These warnings are made optional because GCC is not smart
2503 enough to see all the reasons why the code might be correct
2504 despite appearing to have an error.  Here is one example of how
2505 this can happen:
2506
2507 @smallexample
2508 @group
2509 @{
2510   int x;
2511   switch (y)
2512     @{
2513     case 1: x = 1;
2514       break;
2515     case 2: x = 4;
2516       break;
2517     case 3: x = 5;
2518     @}
2519   foo (x);
2520 @}
2521 @end group
2522 @end smallexample
2523
2524 @noindent
2525 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2526 always initialized, but GCC doesn't know this.  Here is
2527 another common case:
2528
2529 @smallexample
2530 @{
2531   int save_y;
2532   if (change_y) save_y = y, y = new_y;
2533   @dots{}
2534   if (change_y) y = save_y;
2535 @}
2536 @end smallexample
2537
2538 @noindent
2539 This has no bug because @code{save_y} is used only if it is set.
2540
2541 @cindex @code{longjmp} warnings
2542 This option also warns when a non-volatile automatic variable might be
2543 changed by a call to @code{longjmp}.  These warnings as well are possible
2544 only in optimizing compilation.
2545
2546 The compiler sees only the calls to @code{setjmp}.  It cannot know
2547 where @code{longjmp} will be called; in fact, a signal handler could
2548 call it at any point in the code.  As a result, you may get a warning
2549 even when there is in fact no problem because @code{longjmp} cannot
2550 in fact be called at the place which would cause a problem.
2551
2552 Some spurious warnings can be avoided if you declare all the functions
2553 you use that never return as @code{noreturn}.  @xref{Function
2554 Attributes}.
2555
2556 @item -Wunknown-pragmas
2557 @opindex Wunknown-pragmas
2558 @cindex warning for unknown pragmas
2559 @cindex unknown pragmas, warning
2560 @cindex pragmas, warning of unknown
2561 Warn when a #pragma directive is encountered which is not understood by
2562 GCC@.  If this command line option is used, warnings will even be issued
2563 for unknown pragmas in system header files.  This is not the case if
2564 the warnings were only enabled by the @option{-Wall} command line option.
2565
2566 @item -Wstrict-aliasing
2567 @opindex Wstrict-aliasing
2568 This option is only active when @option{-fstrict-aliasing} is active.
2569 It warns about code which might break the strict aliasing rules that the
2570 compiler is using for optimization. The warning does not catch all
2571 cases, but does attempt to catch the more common pitfalls. It is
2572 included in @option{-Wall}.
2573
2574 @item -Wstrict-aliasing=2
2575 @opindex Wstrict-aliasing=2
2576 This option is only active when @option{-fstrict-aliasing} is active.
2577 It warns about all code which might break the strict aliasing rules that the
2578 compiler is using for optimization.  This warning catches all cases, but
2579 it will also give a warning for some ambiguous cases that are safe.
2580
2581 @item -Wall
2582 @opindex Wall
2583 All of the above @samp{-W} options combined.  This enables all the
2584 warnings about constructions that some users consider questionable, and
2585 that are easy to avoid (or modify to prevent the warning), even in
2586 conjunction with macros.  This also enables some language-specific
2587 warnings described in @ref{C++ Dialect Options} and
2588 @ref{Objective-C and Objective-C++ Dialect Options}.
2589 @end table
2590
2591 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2592 Some of them warn about constructions that users generally do not
2593 consider questionable, but which occasionally you might wish to check
2594 for; others warn about constructions that are necessary or hard to avoid
2595 in some cases, and there is no simple way to modify the code to suppress
2596 the warning.
2597
2598 @table @gcctabopt
2599 @item -Wextra
2600 @opindex W
2601 @opindex Wextra
2602 (This option used to be called @option{-W}.  The older name is still
2603 supported, but the newer name is more descriptive.)  Print extra warning
2604 messages for these events:
2605
2606 @itemize @bullet
2607 @item
2608 A function can return either with or without a value.  (Falling
2609 off the end of the function body is considered returning without
2610 a value.)  For example, this function would evoke such a
2611 warning:
2612
2613 @smallexample
2614 @group
2615 foo (a)
2616 @{
2617   if (a > 0)
2618     return a;
2619 @}
2620 @end group
2621 @end smallexample
2622
2623 @item
2624 An expression-statement or the left-hand side of a comma expression
2625 contains no side effects.
2626 To suppress the warning, cast the unused expression to void.
2627 For example, an expression such as @samp{x[i,j]} will cause a warning,
2628 but @samp{x[(void)i,j]} will not.
2629
2630 @item
2631 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2632
2633 @item
2634 Storage-class specifiers like @code{static} are not the first things in
2635 a declaration.  According to the C Standard, this usage is obsolescent.
2636
2637 @item
2638 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2639 arguments.
2640
2641 @item
2642 A comparison between signed and unsigned values could produce an
2643 incorrect result when the signed value is converted to unsigned.
2644 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2645
2646 @item
2647 An aggregate has an initializer which does not initialize all members.
2648 This warning can be independently controlled by
2649 @option{-Wmissing-field-initializers}.
2650
2651 @item
2652 A function parameter is declared without a type specifier in K&R-style
2653 functions:
2654
2655 @smallexample
2656 void foo(bar) @{ @}
2657 @end smallexample
2658
2659 @item
2660 An empty body occurs in an @samp{if} or @samp{else} statement.
2661
2662 @item
2663 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2664 @samp{>}, or @samp{>=}.
2665
2666 @item
2667 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2668
2669 @item
2670 Any of several floating-point events that often indicate errors, such as
2671 overflow, underflow, loss of precision, etc.
2672
2673 @item @r{(C++ only)}
2674 An enumerator and a non-enumerator both appear in a conditional expression.
2675
2676 @item @r{(C++ only)}
2677 A non-static reference or non-static @samp{const} member appears in a
2678 class without constructors.
2679
2680 @item @r{(C++ only)}
2681 Ambiguous virtual bases.
2682
2683 @item @r{(C++ only)}
2684 Subscripting an array which has been declared @samp{register}.
2685
2686 @item @r{(C++ only)}
2687 Taking the address of a variable which has been declared @samp{register}.
2688
2689 @item @r{(C++ only)}
2690 A base class is not initialized in a derived class' copy constructor.
2691 @end itemize
2692
2693 @item -Wno-div-by-zero
2694 @opindex Wno-div-by-zero
2695 @opindex Wdiv-by-zero
2696 Do not warn about compile-time integer division by zero.  Floating point
2697 division by zero is not warned about, as it can be a legitimate way of
2698 obtaining infinities and NaNs.
2699
2700 @item -Wsystem-headers
2701 @opindex Wsystem-headers
2702 @cindex warnings from system headers
2703 @cindex system headers, warnings from
2704 Print warning messages for constructs found in system header files.
2705 Warnings from system headers are normally suppressed, on the assumption
2706 that they usually do not indicate real problems and would only make the
2707 compiler output harder to read.  Using this command line option tells
2708 GCC to emit warnings from system headers as if they occurred in user
2709 code.  However, note that using @option{-Wall} in conjunction with this
2710 option will @emph{not} warn about unknown pragmas in system
2711 headers---for that, @option{-Wunknown-pragmas} must also be used.
2712
2713 @item -Wfloat-equal
2714 @opindex Wfloat-equal
2715 Warn if floating point values are used in equality comparisons.
2716
2717 The idea behind this is that sometimes it is convenient (for the
2718 programmer) to consider floating-point values as approximations to
2719 infinitely precise real numbers.  If you are doing this, then you need
2720 to compute (by analyzing the code, or in some other way) the maximum or
2721 likely maximum error that the computation introduces, and allow for it
2722 when performing comparisons (and when producing output, but that's a
2723 different problem).  In particular, instead of testing for equality, you
2724 would check to see whether the two values have ranges that overlap; and
2725 this is done with the relational operators, so equality comparisons are
2726 probably mistaken.
2727
2728 @item -Wtraditional @r{(C only)}
2729 @opindex Wtraditional
2730 Warn about certain constructs that behave differently in traditional and
2731 ISO C@.  Also warn about ISO C constructs that have no traditional C
2732 equivalent, and/or problematic constructs which should be avoided.
2733
2734 @itemize @bullet
2735 @item
2736 Macro parameters that appear within string literals in the macro body.
2737 In traditional C macro replacement takes place within string literals,
2738 but does not in ISO C@.
2739
2740 @item
2741 In traditional C, some preprocessor directives did not exist.
2742 Traditional preprocessors would only consider a line to be a directive
2743 if the @samp{#} appeared in column 1 on the line.  Therefore
2744 @option{-Wtraditional} warns about directives that traditional C
2745 understands but would ignore because the @samp{#} does not appear as the
2746 first character on the line.  It also suggests you hide directives like
2747 @samp{#pragma} not understood by traditional C by indenting them.  Some
2748 traditional implementations would not recognize @samp{#elif}, so it
2749 suggests avoiding it altogether.
2750
2751 @item
2752 A function-like macro that appears without arguments.
2753
2754 @item
2755 The unary plus operator.
2756
2757 @item
2758 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2759 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2760 constants.)  Note, these suffixes appear in macros defined in the system
2761 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2762 Use of these macros in user code might normally lead to spurious
2763 warnings, however GCC's integrated preprocessor has enough context to
2764 avoid warning in these cases.
2765
2766 @item
2767 A function declared external in one block and then used after the end of
2768 the block.
2769
2770 @item
2771 A @code{switch} statement has an operand of type @code{long}.
2772
2773 @item
2774 A non-@code{static} function declaration follows a @code{static} one.
2775 This construct is not accepted by some traditional C compilers.
2776
2777 @item
2778 The ISO type of an integer constant has a different width or
2779 signedness from its traditional type.  This warning is only issued if
2780 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2781 typically represent bit patterns, are not warned about.
2782
2783 @item
2784 Usage of ISO string concatenation is detected.
2785
2786 @item
2787 Initialization of automatic aggregates.
2788
2789 @item
2790 Identifier conflicts with labels.  Traditional C lacks a separate
2791 namespace for labels.
2792
2793 @item
2794 Initialization of unions.  If the initializer is zero, the warning is
2795 omitted.  This is done under the assumption that the zero initializer in
2796 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2797 initializer warnings and relies on default initialization to zero in the
2798 traditional C case.
2799
2800 @item
2801 Conversions by prototypes between fixed/floating point values and vice
2802 versa.  The absence of these prototypes when compiling with traditional
2803 C would cause serious problems.  This is a subset of the possible
2804 conversion warnings, for the full set use @option{-Wconversion}.
2805
2806 @item
2807 Use of ISO C style function definitions.  This warning intentionally is
2808 @emph{not} issued for prototype declarations or variadic functions
2809 because these ISO C features will appear in your code when using
2810 libiberty's traditional C compatibility macros, @code{PARAMS} and
2811 @code{VPARAMS}.  This warning is also bypassed for nested functions
2812 because that feature is already a GCC extension and thus not relevant to
2813 traditional C compatibility.
2814 @end itemize
2815
2816 @item -Wdeclaration-after-statement @r{(C only)}
2817 @opindex Wdeclaration-after-statement
2818 Warn when a declaration is found after a statement in a block.  This
2819 construct, known from C++, was introduced with ISO C99 and is by default
2820 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2821 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2822
2823 @item -Wundef
2824 @opindex Wundef
2825 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2826
2827 @item -Wendif-labels
2828 @opindex Wendif-labels
2829 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2830
2831 @item -Wshadow
2832 @opindex Wshadow
2833 Warn whenever a local variable shadows another local variable, parameter or
2834 global variable or whenever a built-in function is shadowed.
2835
2836 @item -Wlarger-than-@var{len}
2837 @opindex Wlarger-than
2838 Warn whenever an object of larger than @var{len} bytes is defined.
2839
2840 @item -Wpointer-arith
2841 @opindex Wpointer-arith
2842 Warn about anything that depends on the ``size of'' a function type or
2843 of @code{void}.  GNU C assigns these types a size of 1, for
2844 convenience in calculations with @code{void *} pointers and pointers
2845 to functions.
2846
2847 @item -Wbad-function-cast @r{(C only)}
2848 @opindex Wbad-function-cast
2849 Warn whenever a function call is cast to a non-matching type.
2850 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2851
2852 @item -Wcast-qual
2853 @opindex Wcast-qual
2854 Warn whenever a pointer is cast so as to remove a type qualifier from
2855 the target type.  For example, warn if a @code{const char *} is cast
2856 to an ordinary @code{char *}.
2857
2858 @item -Wcast-align
2859 @opindex Wcast-align
2860 Warn whenever a pointer is cast such that the required alignment of the
2861 target is increased.  For example, warn if a @code{char *} is cast to
2862 an @code{int *} on machines where integers can only be accessed at
2863 two- or four-byte boundaries.
2864
2865 @item -Wwrite-strings
2866 @opindex Wwrite-strings
2867 When compiling C, give string constants the type @code{const
2868 char[@var{length}]} so that
2869 copying the address of one into a non-@code{const} @code{char *}
2870 pointer will get a warning; when compiling C++, warn about the
2871 deprecated conversion from string constants to @code{char *}.
2872 These warnings will help you find at
2873 compile time code that can try to write into a string constant, but
2874 only if you have been very careful about using @code{const} in
2875 declarations and prototypes.  Otherwise, it will just be a nuisance;
2876 this is why we did not make @option{-Wall} request these warnings.
2877
2878 @item -Wconversion
2879 @opindex Wconversion
2880 Warn if a prototype causes a type conversion that is different from what
2881 would happen to the same argument in the absence of a prototype.  This
2882 includes conversions of fixed point to floating and vice versa, and
2883 conversions changing the width or signedness of a fixed point argument
2884 except when the same as the default promotion.
2885
2886 Also, warn if a negative integer constant expression is implicitly
2887 converted to an unsigned type.  For example, warn about the assignment
2888 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2889 casts like @code{(unsigned) -1}.
2890
2891 @item -Wsign-compare
2892 @opindex Wsign-compare
2893 @cindex warning for comparison of signed and unsigned values
2894 @cindex comparison of signed and unsigned values, warning
2895 @cindex signed and unsigned values, comparison warning
2896 Warn when a comparison between signed and unsigned values could produce
2897 an incorrect result when the signed value is converted to unsigned.
2898 This warning is also enabled by @option{-Wextra}; to get the other warnings
2899 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2900
2901 @item -Waggregate-return
2902 @opindex Waggregate-return
2903 Warn if any functions that return structures or unions are defined or
2904 called.  (In languages where you can return an array, this also elicits
2905 a warning.)
2906
2907 @item -Wstrict-prototypes @r{(C only)}
2908 @opindex Wstrict-prototypes
2909 Warn if a function is declared or defined without specifying the
2910 argument types.  (An old-style function definition is permitted without
2911 a warning if preceded by a declaration which specifies the argument
2912 types.)
2913
2914 @item -Wold-style-definition @r{(C only)}
2915 @opindex Wold-style-definition
2916 Warn if an old-style function definition is used.  A warning is given
2917 even if there is a previous prototype.
2918
2919 @item -Wmissing-prototypes @r{(C only)}
2920 @opindex Wmissing-prototypes
2921 Warn if a global function is defined without a previous prototype
2922 declaration.  This warning is issued even if the definition itself
2923 provides a prototype.  The aim is to detect global functions that fail
2924 to be declared in header files.
2925
2926 @item -Wmissing-declarations @r{(C only)}
2927 @opindex Wmissing-declarations
2928 Warn if a global function is defined without a previous declaration.
2929 Do so even if the definition itself provides a prototype.
2930 Use this option to detect global functions that are not declared in
2931 header files.
2932
2933 @item -Wmissing-field-initializers
2934 @opindex Wmissing-field-initializers
2935 @opindex W
2936 @opindex Wextra
2937 Warn if a structure's initializer has some fields missing.  For
2938 example, the following code would cause such a warning, because
2939 @code{x.h} is implicitly zero:
2940
2941 @smallexample
2942 struct s @{ int f, g, h; @};
2943 struct s x = @{ 3, 4 @};
2944 @end smallexample
2945
2946 This option does not warn about designated initializers, so the following
2947 modification would not trigger a warning:
2948
2949 @smallexample
2950 struct s @{ int f, g, h; @};
2951 struct s x = @{ .f = 3, .g = 4 @};
2952 @end smallexample
2953
2954 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2955 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2956
2957 @item -Wmissing-noreturn
2958 @opindex Wmissing-noreturn
2959 Warn about functions which might be candidates for attribute @code{noreturn}.
2960 Note these are only possible candidates, not absolute ones.  Care should
2961 be taken to manually verify functions actually do not ever return before
2962 adding the @code{noreturn} attribute, otherwise subtle code generation
2963 bugs could be introduced.  You will not get a warning for @code{main} in
2964 hosted C environments.
2965
2966 @item -Wmissing-format-attribute
2967 @opindex Wmissing-format-attribute
2968 @opindex Wformat
2969 If @option{-Wformat} is enabled, also warn about functions which might be
2970 candidates for @code{format} attributes.  Note these are only possible
2971 candidates, not absolute ones.  GCC will guess that @code{format}
2972 attributes might be appropriate for any function that calls a function
2973 like @code{vprintf} or @code{vscanf}, but this might not always be the
2974 case, and some functions for which @code{format} attributes are
2975 appropriate may not be detected.  This option has no effect unless
2976 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2977
2978 @item -Wno-multichar
2979 @opindex Wno-multichar
2980 @opindex Wmultichar
2981 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2982 Usually they indicate a typo in the user's code, as they have
2983 implementation-defined values, and should not be used in portable code.
2984
2985 @item -Wno-deprecated-declarations
2986 @opindex Wno-deprecated-declarations
2987 Do not warn about uses of functions, variables, and types marked as
2988 deprecated by using the @code{deprecated} attribute.
2989 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2990 @pxref{Type Attributes}.)
2991
2992 @item -Wpacked
2993 @opindex Wpacked
2994 Warn if a structure is given the packed attribute, but the packed
2995 attribute has no effect on the layout or size of the structure.
2996 Such structures may be mis-aligned for little benefit.  For
2997 instance, in this code, the variable @code{f.x} in @code{struct bar}
2998 will be misaligned even though @code{struct bar} does not itself
2999 have the packed attribute:
3000
3001 @smallexample
3002 @group
3003 struct foo @{
3004   int x;
3005   char a, b, c, d;
3006 @} __attribute__((packed));
3007 struct bar @{
3008   char z;
3009   struct foo f;
3010 @};
3011 @end group
3012 @end smallexample
3013
3014 @item -Wpadded
3015 @opindex Wpadded
3016 Warn if padding is included in a structure, either to align an element
3017 of the structure or to align the whole structure.  Sometimes when this
3018 happens it is possible to rearrange the fields of the structure to
3019 reduce the padding and so make the structure smaller.
3020
3021 @item -Wredundant-decls
3022 @opindex Wredundant-decls
3023 Warn if anything is declared more than once in the same scope, even in
3024 cases where multiple declaration is valid and changes nothing.
3025
3026 @item -Wnested-externs @r{(C only)}
3027 @opindex Wnested-externs
3028 Warn if an @code{extern} declaration is encountered within a function.
3029
3030 @item -Wunreachable-code
3031 @opindex Wunreachable-code
3032 Warn if the compiler detects that code will never be executed.
3033
3034 This option is intended to warn when the compiler detects that at
3035 least a whole line of source code will never be executed, because
3036 some condition is never satisfied or because it is after a
3037 procedure that never returns.
3038
3039 It is possible for this option to produce a warning even though there
3040 are circumstances under which part of the affected line can be executed,
3041 so care should be taken when removing apparently-unreachable code.
3042
3043 For instance, when a function is inlined, a warning may mean that the
3044 line is unreachable in only one inlined copy of the function.
3045
3046 This option is not made part of @option{-Wall} because in a debugging
3047 version of a program there is often substantial code which checks
3048 correct functioning of the program and is, hopefully, unreachable
3049 because the program does work.  Another common use of unreachable
3050 code is to provide behavior which is selectable at compile-time.
3051
3052 @item -Winline
3053 @opindex Winline
3054 Warn if a function can not be inlined and it was declared as inline.
3055 Even with this option, the compiler will not warn about failures to
3056 inline functions declared in system headers.
3057
3058 The compiler uses a variety of heuristics to determine whether or not
3059 to inline a function.  For example, the compiler takes into account
3060 the size of the function being inlined and the the amount of inlining
3061 that has already been done in the current function.  Therefore,
3062 seemingly insignificant changes in the source program can cause the
3063 warnings produced by @option{-Winline} to appear or disappear.
3064
3065 @item -Wno-invalid-offsetof @r{(C++ only)}
3066 @opindex Wno-invalid-offsetof
3067 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3068 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3069 to a non-POD type is undefined.  In existing C++ implementations,
3070 however, @samp{offsetof} typically gives meaningful results even when
3071 applied to certain kinds of non-POD types. (Such as a simple
3072 @samp{struct} that fails to be a POD type only by virtue of having a
3073 constructor.)  This flag is for users who are aware that they are
3074 writing nonportable code and who have deliberately chosen to ignore the
3075 warning about it.
3076
3077 The restrictions on @samp{offsetof} may be relaxed in a future version
3078 of the C++ standard.
3079
3080 @item -Winvalid-pch
3081 @opindex Winvalid-pch
3082 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3083 the search path but can't be used.
3084
3085 @item -Wlong-long
3086 @opindex Wlong-long
3087 @opindex Wno-long-long
3088 Warn if @samp{long long} type is used.  This is default.  To inhibit
3089 the warning messages, use @option{-Wno-long-long}.  Flags
3090 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3091 only when @option{-pedantic} flag is used.
3092
3093 @item -Wvariadic-macros
3094 @opindex Wvariadic-macros
3095 @opindex Wno-variadic-macros
3096 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3097 alternate syntax when in pedantic ISO C99 mode.  This is default.
3098 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3099
3100 @item -Wdisabled-optimization
3101 @opindex Wdisabled-optimization
3102 Warn if a requested optimization pass is disabled.  This warning does
3103 not generally indicate that there is anything wrong with your code; it
3104 merely indicates that GCC's optimizers were unable to handle the code
3105 effectively.  Often, the problem is that your code is too big or too
3106 complex; GCC will refuse to optimize programs when the optimization
3107 itself is likely to take inordinate amounts of time.
3108
3109 @item -Werror
3110 @opindex Werror
3111 Make all warnings into errors.
3112 @end table
3113
3114 @node Debugging Options
3115 @section Options for Debugging Your Program or GCC
3116 @cindex options, debugging
3117 @cindex debugging information options
3118
3119 GCC has various special options that are used for debugging
3120 either your program or GCC:
3121
3122 @table @gcctabopt
3123 @item -g
3124 @opindex g
3125 Produce debugging information in the operating system's native format
3126 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3127 information.
3128
3129 On most systems that use stabs format, @option{-g} enables use of extra
3130 debugging information that only GDB can use; this extra information
3131 makes debugging work better in GDB but will probably make other debuggers
3132 crash or
3133 refuse to read the program.  If you want to control for certain whether
3134 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3135 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3136
3137 GCC allows you to use @option{-g} with
3138 @option{-O}.  The shortcuts taken by optimized code may occasionally
3139 produce surprising results: some variables you declared may not exist
3140 at all; flow of control may briefly move where you did not expect it;
3141 some statements may not be executed because they compute constant
3142 results or their values were already at hand; some statements may
3143 execute in different places because they were moved out of loops.
3144
3145 Nevertheless it proves possible to debug optimized output.  This makes
3146 it reasonable to use the optimizer for programs that might have bugs.
3147
3148 The following options are useful when GCC is generated with the
3149 capability for more than one debugging format.
3150
3151 @item -ggdb
3152 @opindex ggdb
3153 Produce debugging information for use by GDB@.  This means to use the
3154 most expressive format available (DWARF 2, stabs, or the native format
3155 if neither of those are supported), including GDB extensions if at all
3156 possible.
3157
3158 @item -gstabs
3159 @opindex gstabs
3160 Produce debugging information in stabs format (if that is supported),
3161 without GDB extensions.  This is the format used by DBX on most BSD
3162 systems.  On MIPS, Alpha and System V Release 4 systems this option
3163 produces stabs debugging output which is not understood by DBX or SDB@.
3164 On System V Release 4 systems this option requires the GNU assembler.
3165
3166 @item -feliminate-unused-debug-symbols
3167 @opindex feliminate-unused-debug-symbols
3168 Produce debugging information in stabs format (if that is supported),
3169 for only symbols that are actually used.
3170
3171 @item -gstabs+
3172 @opindex gstabs+
3173 Produce debugging information in stabs format (if that is supported),
3174 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3175 use of these extensions is likely to make other debuggers crash or
3176 refuse to read the program.
3177
3178 @item -gcoff
3179 @opindex gcoff
3180 Produce debugging information in COFF format (if that is supported).
3181 This is the format used by SDB on most System V systems prior to
3182 System V Release 4.
3183
3184 @item -gxcoff
3185 @opindex gxcoff
3186 Produce debugging information in XCOFF format (if that is supported).
3187 This is the format used by the DBX debugger on IBM RS/6000 systems.
3188
3189 @item -gxcoff+
3190 @opindex gxcoff+
3191 Produce debugging information in XCOFF format (if that is supported),
3192 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3193 use of these extensions is likely to make other debuggers crash or
3194 refuse to read the program, and may cause assemblers other than the GNU
3195 assembler (GAS) to fail with an error.
3196
3197 @item -gdwarf-2
3198 @opindex gdwarf-2
3199 Produce debugging information in DWARF version 2 format (if that is
3200 supported).  This is the format used by DBX on IRIX 6.  With this
3201 option, GCC uses features of DWARF version 3 when they are useful;
3202 version 3 is upward compatible with version 2, but may still cause
3203 problems for older debuggers.
3204
3205 @item -gvms
3206 @opindex gvms
3207 Produce debugging information in VMS debug format (if that is
3208 supported).  This is the format used by DEBUG on VMS systems.
3209
3210 @item -g@var{level}
3211 @itemx -ggdb@var{level}
3212 @itemx -gstabs@var{level}
3213 @itemx -gcoff@var{level}
3214 @itemx -gxcoff@var{level}
3215 @itemx -gvms@var{level}
3216 Request debugging information and also use @var{level} to specify how
3217 much information.  The default level is 2.
3218
3219 Level 1 produces minimal information, enough for making backtraces in
3220 parts of the program that you don't plan to debug.  This includes
3221 descriptions of functions and external variables, but no information
3222 about local variables and no line numbers.
3223
3224 Level 3 includes extra information, such as all the macro definitions
3225 present in the program.  Some debuggers support macro expansion when
3226 you use @option{-g3}.
3227
3228 @option{-gdwarf-2} does not accept a concatenated debug level, because
3229 GCC used to support an option @option{-gdwarf} that meant to generate
3230 debug information in version 1 of the DWARF format (which is very
3231 different from version 2), and it would have been too confusing.  That
3232 debug format is long obsolete, but the option cannot be changed now.
3233 Instead use an additional @option{-g@var{level}} option to change the
3234 debug level for DWARF2.
3235
3236 @item -feliminate-dwarf2-dups
3237 @opindex feliminate-dwarf2-dups
3238 Compress DWARF2 debugging information by eliminating duplicated
3239 information about each symbol.  This option only makes sense when
3240 generating DWARF2 debugging information with @option{-gdwarf-2}.
3241
3242 @cindex @command{prof}
3243 @item -p
3244 @opindex p
3245 Generate extra code to write profile information suitable for the
3246 analysis program @command{prof}.  You must use this option when compiling
3247 the source files you want data about, and you must also use it when
3248 linking.
3249
3250 @cindex @command{gprof}
3251 @item -pg
3252 @opindex pg
3253 Generate extra code to write profile information suitable for the
3254 analysis program @command{gprof}.  You must use this option when compiling
3255 the source files you want data about, and you must also use it when
3256 linking.
3257
3258 @item -Q
3259 @opindex Q
3260 Makes the compiler print out each function name as it is compiled, and
3261 print some statistics about each pass when it finishes.
3262
3263 @item -ftime-report
3264 @opindex ftime-report
3265 Makes the compiler print some statistics about the time consumed by each
3266 pass when it finishes.
3267
3268 @item -fmem-report
3269 @opindex fmem-report
3270 Makes the compiler print some statistics about permanent memory
3271 allocation when it finishes.
3272
3273 @item -fprofile-arcs
3274 @opindex fprofile-arcs
3275 Add code so that program flow @dfn{arcs} are instrumented.  During
3276 execution the program records how many times each branch and call is
3277 executed and how many times it is taken or returns.  When the compiled
3278 program exits it saves this data to a file called
3279 @file{@var{auxname}.gcda} for each source file. The data may be used for
3280 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3281 test coverage analysis (@option{-ftest-coverage}). Each object file's
3282 @var{auxname} is generated from the name of the output file, if
3283 explicitly specified and it is not the final executable, otherwise it is
3284 the basename of the source file. In both cases any suffix is removed
3285 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3286 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3287
3288 @itemize
3289
3290 @item
3291 Compile the source files with @option{-fprofile-arcs} plus optimization
3292 and code generation options. For test coverage analysis, use the
3293 additional @option{-ftest-coverage} option. You do not need to profile
3294 every source file in a program.
3295
3296 @item
3297 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3298 (the latter implies the former).
3299
3300 @item
3301 Run the program on a representative workload to generate the arc profile
3302 information. This may be repeated any number of times. You can run
3303 concurrent instances of your program, and provided that the file system
3304 supports locking, the data files will be correctly updated. Also
3305 @code{fork} calls are detected and correctly handled (double counting
3306 will not happen).
3307
3308 @item
3309 For profile-directed optimizations, compile the source files again with
3310 the same optimization and code generation options plus
3311 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3312 Control Optimization}).
3313
3314 @item
3315 For test coverage analysis, use @command{gcov} to produce human readable
3316 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3317 @command{gcov} documentation for further information.
3318
3319 @end itemize
3320
3321 With @option{-fprofile-arcs}, for each function of your program GCC
3322 creates a program flow graph, then finds a spanning tree for the graph.
3323 Only arcs that are not on the spanning tree have to be instrumented: the
3324 compiler adds code to count the number of times that these arcs are
3325 executed.  When an arc is the only exit or only entrance to a block, the
3326 instrumentation code can be added to the block; otherwise, a new basic
3327 block must be created to hold the instrumentation code.
3328
3329 @item -ftree-based-profiling
3330 @opindex ftree-based-profiling
3331 This option is used in addition to @option{-fprofile-arcs} or
3332 @option{-fbranch-probabilities} to control whether those optimizations
3333 are performed on a tree-based or rtl-based internal representation.
3334 If you use this option when compiling with @option{-fprofile-arcs},
3335 you must also use it when compiling later with @option{-fbranch-probabilities}.
3336 Currently the tree-based optimization is in an early stage of
3337 development, and this option is recommended only for those people
3338 working on improving it.
3339
3340 @need 2000
3341 @item -ftest-coverage
3342 @opindex ftest-coverage
3343 Produce a notes file that the @command{gcov} code-coverage utility
3344 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3345 show program coverage. Each source file's note file is called
3346 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3347 above for a description of @var{auxname} and instructions on how to
3348 generate test coverage data. Coverage data will match the source files
3349 more closely, if you do not optimize.
3350
3351 @item -d@var{letters}
3352 @opindex d
3353 Says to make debugging dumps during compilation at times specified by
3354 @var{letters}.  This is used for debugging the compiler.  The file names
3355 for most of the dumps are made by appending a pass number and a word to
3356 the @var{dumpname}. @var{dumpname} is generated from the name of the
3357 output file, if explicitly specified and it is not an executable,
3358 otherwise it is the basename of the source file. In both cases any
3359 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3360 Here are the possible letters for use in @var{letters}, and their
3361 meanings:
3362
3363 @table @samp
3364 @item A
3365 @opindex dA
3366 Annotate the assembler output with miscellaneous debugging information.
3367 @item b
3368 @opindex db
3369 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3370 @item B
3371 @opindex dB
3372 Dump after block reordering, to @file{@var{file}.32.bbro}.
3373 @item c
3374 @opindex dc
3375 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3376 @item C
3377 @opindex dC
3378 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3379 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3380 @item d
3381 @opindex dd
3382 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3383 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3384 @item D
3385 @opindex dD
3386 Dump all macro definitions, at the end of preprocessing, in addition to
3387 normal output.
3388 @item E
3389 @opindex dE
3390 Dump after the third if conversion, to @file{@var{file}.31.ce3}.
3391 @item f
3392 @opindex df
3393 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3394 Also dump after life analysis, to @file{@var{file}.19.life}.
3395 @item g
3396 @opindex dg
3397 Dump after global register allocation, to @file{@var{file}.26.greg}.
3398 @item G
3399 @opindex dG
3400 Dump after GCSE, to @file{@var{file}.08.gcse}.
3401 Also dump after jump bypassing and control flow optimizations, to
3402 @file{@var{file}.10.bypass}.
3403 @item h
3404 @opindex dh
3405 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3406 @item i
3407 @opindex di
3408 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3409 @item j
3410 @opindex dj
3411 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3412 @item k
3413 @opindex dk
3414 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3415 @item l
3416 @opindex dl
3417 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3418 @item L
3419 @opindex dL
3420 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3421 @file{@var{file}.16.loop2}.
3422 @item m
3423 @opindex dm
3424 Dump after modulo scheduling, to @file{@var{file}.23.sms}.
3425 @item M
3426 @opindex dM
3427 Dump after performing the machine dependent reorganization pass, to
3428 @file{@var{file}.36.mach}.
3429 @item n
3430 @opindex dn
3431 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3432 @item N
3433 @opindex dN
3434 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3435 @item o
3436 @opindex do
3437 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3438 @item r
3439 @opindex dr
3440 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3441 @item R
3442 @opindex dR
3443 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3444 @item s
3445 @opindex ds
3446 Dump after CSE (including the jump optimization that sometimes follows
3447 CSE), to @file{@var{file}.06.cse}.
3448 @item S
3449 @opindex dS
3450 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3451 @item t
3452 @opindex dt
3453 Dump after the second CSE pass (including the jump optimization that
3454 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3455 @item T
3456 @opindex dT
3457 Dump after running tracer, to @file{@var{file}.15.tracer}.
3458 @item u
3459 @opindex du
3460 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3461 @item U
3462 @opindex dU
3463 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3464 @item V
3465 @opindex dV
3466 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3467 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3468 @item w
3469 @opindex dw
3470 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3471 @item z
3472 @opindex dz
3473 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3474 @item Z
3475 @opindex dZ
3476 Dump after constructing the web, to @file{@var{file}.17.web}.
3477 @item a
3478 @opindex da
3479 Produce all the dumps listed above.
3480 @item H
3481 @opindex dH
3482 Produce a core dump whenever an error occurs.
3483 @item m
3484 @opindex dm
3485 Print statistics on memory usage, at the end of the run, to
3486 standard error.
3487 @item p
3488 @opindex dp
3489 Annotate the assembler output with a comment indicating which
3490 pattern and alternative was used.  The length of each instruction is
3491 also printed.
3492 @item P
3493 @opindex dP
3494 Dump the RTL in the assembler output as a comment before each instruction.
3495 Also turns on @option{-dp} annotation.
3496 @item v
3497 @opindex dv
3498 For each of the other indicated dump files (except for
3499 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3500 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3501 @item x
3502 @opindex dx
3503 Just generate RTL for a function instead of compiling it.  Usually used
3504 with @samp{r}.
3505 @item y
3506 @opindex dy
3507 Dump debugging information during parsing, to standard error.
3508 @end table
3509
3510 @item -fdump-unnumbered
3511 @opindex fdump-unnumbered
3512 When doing debugging dumps (see @option{-d} option above), suppress instruction
3513 numbers and line number note output.  This makes it more feasible to
3514 use diff on debugging dumps for compiler invocations with different
3515 options, in particular with and without @option{-g}.
3516
3517 @item -fdump-translation-unit @r{(C and C++ only)}
3518 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3519 @opindex fdump-translation-unit
3520 Dump a representation of the tree structure for the entire translation
3521 unit to a file.  The file name is made by appending @file{.tu} to the
3522 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3523 controls the details of the dump as described for the
3524 @option{-fdump-tree} options.
3525
3526 @item -fdump-class-hierarchy @r{(C++ only)}
3527 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3528 @opindex fdump-class-hierarchy
3529 Dump a representation of each class's hierarchy and virtual function
3530 table layout to a file.  The file name is made by appending @file{.class}
3531 to the source file name.  If the @samp{-@var{options}} form is used,
3532 @var{options} controls the details of the dump as described for the
3533 @option{-fdump-tree} options.
3534
3535 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3536 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3537 @opindex fdump-tree
3538 Control the dumping at various stages of processing the intermediate
3539 language tree to a file.  The file name is generated by appending a switch
3540 specific suffix to the source file name.  If the @samp{-@var{options}}
3541 form is used, @var{options} is a list of @samp{-} separated options that
3542 control the details of the dump. Not all options are applicable to all
3543 dumps, those which are not meaningful will be ignored. The following
3544 options are available
3545
3546 @table @samp
3547 @item address
3548 Print the address of each node.  Usually this is not meaningful as it
3549 changes according to the environment and source file. Its primary use
3550 is for tying up a dump file with a debug environment.
3551 @item slim
3552 Inhibit dumping of members of a scope or body of a function merely
3553 because that scope has been reached.  Only dump such items when they
3554 are directly reachable by some other path.  When dumping pretty-printed
3555 trees, this option inhibits dumping the bodies of control structures.
3556 @item raw
3557 Print a raw representation of the tree.  By default, trees are
3558 pretty-printed into a C-like representation.
3559 @item details
3560 Enable more detailed dumps (not honored by every dump option).
3561 @item stats
3562 Enable dumping various statistics about the pass (not honored by every dump
3563 option).
3564 @item blocks
3565 Enable showing basic block boundaries (disabled in raw dumps).
3566 @item vops
3567 Enable showing virtual operands for every statement.
3568 @item lineno
3569 Enable showing line numbers for statements.
3570 @item uid
3571 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3572 @item all
3573 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3574 @end table
3575
3576 The following tree dumps are possible:
3577 @table @samp
3578
3579 @item original
3580 Dump before any tree based optimization, to @file{@var{file}.original}.
3581
3582 @item optimized
3583 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3584
3585 @item inlined
3586 Dump after function inlining, to @file{@var{file}.inlined}.
3587
3588 @item gimple
3589 @opindex fdump-tree-gimple
3590 Dump each function before and after the gimplification pass to a file.  The
3591 file name is made by appending @file{.gimple} to the source file name.
3592
3593 @item cfg
3594 @opindex fdump-tree-cfg
3595 Dump the control flow graph of each function to a file.  The file name is
3596 made by appending @file{.cfg} to the source file name.
3597
3598 @item vcg
3599 @opindex fdump-tree-vcg
3600 Dump the control flow graph of each function to a file in VCG format.  The
3601 file name is made by appending @file{.vcg} to the source file name.  Note
3602 that if the file contains more than one function, the generated file cannot
3603 be used directly by VCG.  You will need to cut and paste each function's
3604 graph into its own separate file first.
3605
3606 @item ch
3607 @opindex fdump-tree-ch
3608 Dump each function after copying loop headers.  The file name is made by
3609 appending @file{.ch} to the source file name.
3610
3611 @item ssa
3612 @opindex fdump-tree-ssa
3613 Dump SSA related information to a file.  The file name is made by appending
3614 @file{.ssa} to the source file name.
3615
3616 @item alias
3617 @opindex fdump-tree-alias
3618 Dump aliasing information for each function.  The file name is made by
3619 appending @file{.alias} to the source file name.
3620
3621 @item ccp
3622 @opindex fdump-tree-ccp
3623 Dump each function after CCP.  The file name is made by appending
3624 @file{.ccp} to the source file name.
3625
3626 @item pre
3627 @opindex fdump-tree-pre
3628 Dump trees after partial redundancy elimination.  The file name is made
3629 by appending @file{.pre} to the source file name.
3630
3631 @item fre
3632 @opindex fdump-tree-fre
3633 Dump trees after full redundancy elimination.  The file name is made
3634 by appending @file{.fre} to the source file name.
3635
3636 @item dce
3637 @opindex fdump-tree-dce
3638 Dump each function after dead code elimination.  The file name is made by
3639 appending @file{.dce} to the source file name.
3640
3641 @item mudflap
3642 @opindex fdump-tree-mudflap
3643 Dump each function after adding mudflap instrumentation.  The file name is
3644 made by appending @file{.mudflap} to the source file name.
3645
3646 @item sra
3647 @opindex fdump-tree-sra
3648 Dump each function after performing scalar replacement of aggregates.  The
3649 file name is made by appending @file{.sra} to the source file name.
3650
3651 @item dom
3652 @opindex fdump-tree-dom
3653 Dump each function after applying dominator tree optimizations.  The file
3654 name is made by appending @file{.dom} to the source file name.
3655
3656 @item dse
3657 @opindex fdump-tree-dse
3658 Dump each function after applying dead store elimination.  The file
3659 name is made by appending @file{.dse} to the source file name.
3660
3661 @item phiopt
3662 @opindex fdump-tree-phiopt
3663 Dump each function after optimizing PHI nodes into straightline code.  The file
3664 name is made by appending @file{.phiopt} to the source file name.
3665
3666 @item forwprop
3667 @opindex fdump-tree-forwprop
3668 Dump each function after forward propagating single use variables.  The file
3669 name is made by appending @file{.forwprop} to the source file name.
3670
3671 @item copyrename
3672 @opindex fdump-tree-copyrename
3673 Dump each function after applying the copy rename optimization.  The file
3674 name is made by appending @file{.copyrename} to the source file name.
3675
3676 @item nrv
3677 @opindex fdump-tree-nrv
3678 Dump each function after applying the named return value optimization on
3679 generic trees.  The file name is made by appending @file{.nrv} to the source
3680 file name.
3681
3682 @item vect
3683 @opindex fdump-tree-vect
3684 Dump each function after applying vectorization of loops.  The file name is 
3685 made by appending @file{.vect} to the source file name.
3686
3687 @item all
3688 @opindex fdump-tree-all
3689 Enable all the available tree dumps with the flags provided in this option.
3690 @end table
3691
3692 @item -frandom-seed=@var{string}
3693 @opindex frandom-string
3694 This option provides a seed that GCC uses when it would otherwise use
3695 random numbers.  It is used to generate certain symbol names
3696 that have to be different in every compiled file. It is also used to
3697 place unique stamps in coverage data files and the object files that
3698 produce them. You can use the @option{-frandom-seed} option to produce
3699 reproducibly identical object files.
3700
3701 The @var{string} should be different for every file you compile.
3702
3703 @item -fsched-verbose=@var{n}
3704 @opindex fsched-verbose
3705 On targets that use instruction scheduling, this option controls the
3706 amount of debugging output the scheduler prints.  This information is
3707 written to standard error, unless @option{-dS} or @option{-dR} is
3708 specified, in which case it is output to the usual dump
3709 listing file, @file{.sched} or @file{.sched2} respectively.  However
3710 for @var{n} greater than nine, the output is always printed to standard
3711 error.
3712
3713 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3714 same information as @option{-dRS}.  For @var{n} greater than one, it
3715 also output basic block probabilities, detailed ready list information
3716 and unit/insn info.  For @var{n} greater than two, it includes RTL
3717 at abort point, control-flow and regions info.  And for @var{n} over
3718 four, @option{-fsched-verbose} also includes dependence info.
3719
3720 @item -save-temps
3721 @opindex save-temps
3722 Store the usual ``temporary'' intermediate files permanently; place them
3723 in the current directory and name them based on the source file.  Thus,
3724 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3725 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3726 preprocessed @file{foo.i} output file even though the compiler now
3727 normally uses an integrated preprocessor.
3728
3729 @item -time
3730 @opindex time
3731 Report the CPU time taken by each subprocess in the compilation
3732 sequence.  For C source files, this is the compiler proper and assembler
3733 (plus the linker if linking is done).  The output looks like this:
3734
3735 @smallexample
3736 # cc1 0.12 0.01
3737 # as 0.00 0.01
3738 @end smallexample
3739
3740 The first number on each line is the ``user time,'' that is time spent
3741 executing the program itself.  The second number is ``system time,''
3742 time spent executing operating system routines on behalf of the program.
3743 Both numbers are in seconds.
3744
3745 @item -fvar-tracking
3746 @opindex fvar-tracking
3747 Run variable tracking pass. It computes where variables are stored at each
3748 position in code. Better debugging information is then generated
3749 (if the debugging information format supports this information).
3750
3751 It is enabled by default when compiling with optimization (@option{-Os},
3752 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3753 the debug info format supports it.
3754
3755 @item -print-file-name=@var{library}
3756 @opindex print-file-name
3757 Print the full absolute name of the library file @var{library} that
3758 would be used when linking---and don't do anything else.  With this
3759 option, GCC does not compile or link anything; it just prints the
3760 file name.
3761
3762 @item -print-multi-directory
3763 @opindex print-multi-directory
3764 Print the directory name corresponding to the multilib selected by any
3765 other switches present in the command line.  This directory is supposed
3766 to exist in @env{GCC_EXEC_PREFIX}.
3767
3768 @item -print-multi-lib
3769 @opindex print-multi-lib
3770 Print the mapping from multilib directory names to compiler switches
3771 that enable them.  The directory name is separated from the switches by
3772 @samp{;}, and each switch starts with an @samp{@@} instead of the
3773 @samp{-}, without spaces between multiple switches.  This is supposed to
3774 ease shell-processing.
3775
3776 @item -print-prog-name=@var{program}
3777 @opindex print-prog-name
3778 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3779
3780 @item -print-libgcc-file-name
3781 @opindex print-libgcc-file-name
3782 Same as @option{-print-file-name=libgcc.a}.
3783
3784 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3785 but you do want to link with @file{libgcc.a}.  You can do
3786
3787 @smallexample
3788 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3789 @end smallexample
3790
3791 @item -print-search-dirs
3792 @opindex print-search-dirs
3793 Print the name of the configured installation directory and a list of
3794 program and library directories @command{gcc} will search---and don't do anything else.
3795
3796 This is useful when @command{gcc} prints the error message
3797 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3798 To resolve this you either need to put @file{cpp0} and the other compiler
3799 components where @command{gcc} expects to find them, or you can set the environment
3800 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3801 Don't forget the trailing '/'.
3802 @xref{Environment Variables}.
3803
3804 @item -dumpmachine
3805 @opindex dumpmachine
3806 Print the compiler's target machine (for example,
3807 @samp{i686-pc-linux-gnu})---and don't do anything else.
3808
3809 @item -dumpversion
3810 @opindex dumpversion
3811 Print the compiler version (for example, @samp{3.0})---and don't do
3812 anything else.
3813
3814 @item -dumpspecs
3815 @opindex dumpspecs
3816 Print the compiler's built-in specs---and don't do anything else.  (This
3817 is used when GCC itself is being built.)  @xref{Spec Files}.
3818
3819 @item -feliminate-unused-debug-types
3820 @opindex feliminate-unused-debug-types
3821 Normally, when producing DWARF2 output, GCC will emit debugging
3822 information for all types declared in a compilation
3823 unit, regardless of whether or not they are actually used
3824 in that compilation unit.  Sometimes this is useful, such as
3825 if, in the debugger, you want to cast a value to a type that is
3826 not actually used in your program (but is declared).  More often,
3827 however, this results in a significant amount of wasted space.
3828 With this option, GCC will avoid producing debug symbol output
3829 for types that are nowhere used in the source file being compiled.
3830 @end table
3831
3832 @node Optimize Options
3833 @section Options That Control Optimization
3834 @cindex optimize options
3835 @cindex options, optimization
3836
3837 These options control various sorts of optimizations.
3838
3839 Without any optimization option, the compiler's goal is to reduce the
3840 cost of compilation and to make debugging produce the expected
3841 results.  Statements are independent: if you stop the program with a
3842 breakpoint between statements, you can then assign a new value to any
3843 variable or change the program counter to any other statement in the
3844 function and get exactly the results you would expect from the source
3845 code.
3846
3847 Turning on optimization flags makes the compiler attempt to improve
3848 the performance and/or code size at the expense of compilation time
3849 and possibly the ability to debug the program.
3850
3851 The compiler performs optimization based on the knowledge it has of
3852 the program.  Optimization levels @option{-O2} and above, in
3853 particular, enable @emph{unit-at-a-time} mode, which allows the
3854 compiler to consider information gained from later functions in
3855 the file when compiling a function.  Compiling multiple files at
3856 once to a single output file in @emph{unit-at-a-time} mode allows
3857 the compiler to use information gained from all of the files when
3858 compiling each of them.
3859
3860 Not all optimizations are controlled directly by a flag.  Only
3861 optimizations that have a flag are listed.
3862
3863 @table @gcctabopt
3864 @item -O
3865 @itemx -O1
3866 @opindex O
3867 @opindex O1
3868 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3869 more memory for a large function.
3870
3871 With @option{-O}, the compiler tries to reduce code size and execution
3872 time, without performing any optimizations that take a great deal of
3873 compilation time.
3874
3875 @option{-O} turns on the following optimization flags:
3876 @gccoptlist{-fdefer-pop @gol
3877 -fmerge-constants @gol
3878 -fthread-jumps @gol
3879 -floop-optimize @gol
3880 -fif-conversion @gol
3881 -fif-conversion2 @gol
3882 -fdelayed-branch @gol
3883 -fguess-branch-probability @gol
3884 -fcprop-registers}
3885
3886 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3887 where doing so does not interfere with debugging.
3888
3889 @item -O2
3890 @opindex O2
3891 Optimize even more.  GCC performs nearly all supported optimizations
3892 that do not involve a space-speed tradeoff.  The compiler does not
3893 perform loop unrolling or function inlining when you specify @option{-O2}.
3894 As compared to @option{-O}, this option increases both compilation time
3895 and the performance of the generated code.
3896
3897 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3898 also turns on the following optimization flags:
3899 @gccoptlist{-fforce-mem @gol
3900 -foptimize-sibling-calls @gol
3901 -fstrength-reduce @gol
3902 -fcse-follow-jumps  -fcse-skip-blocks @gol
3903 -frerun-cse-after-loop  -frerun-loop-opt @gol
3904 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3905 -fdelete-null-pointer-checks @gol
3906 -fexpensive-optimizations @gol
3907 -fregmove @gol
3908 -fschedule-insns  -fschedule-insns2 @gol
3909 -fsched-interblock  -fsched-spec @gol
3910 -fcaller-saves @gol
3911 -fpeephole2 @gol
3912 -freorder-blocks  -freorder-functions @gol
3913 -fstrict-aliasing @gol
3914 -funit-at-a-time @gol
3915 -falign-functions  -falign-jumps @gol
3916 -falign-loops  -falign-labels @gol
3917 -fcrossjumping}
3918
3919 Please note the warning under @option{-fgcse} about
3920 invoking @option{-O2} on programs that use computed gotos.
3921
3922 @item -O3
3923 @opindex O3
3924 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3925 @option{-O2} and also turns on the @option{-finline-functions},
3926 @option{-fweb} and @option{-fgcse-after-reload} options.
3927
3928 @item -O0
3929 @opindex O0
3930 Do not optimize.  This is the default.
3931
3932 @item -Os
3933 @opindex Os
3934 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3935 do not typically increase code size.  It also performs further
3936 optimizations designed to reduce code size.
3937
3938 @option{-Os} disables the following optimization flags:
3939 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3940 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
3941
3942 If you use multiple @option{-O} options, with or without level numbers,
3943 the last such option is the one that is effective.
3944 @end table
3945
3946 Options of the form @option{-f@var{flag}} specify machine-independent
3947 flags.  Most flags have both positive and negative forms; the negative
3948 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3949 below, only one of the forms is listed---the one you typically will
3950 use.  You can figure out the other form by either removing @samp{no-}
3951 or adding it.
3952
3953 The following options control specific optimizations.  They are either
3954 activated by @option{-O} options or are related to ones that are.  You
3955 can use the following flags in the rare cases when ``fine-tuning'' of
3956 optimizations to be performed is desired.
3957
3958 @table @gcctabopt
3959 @item -fno-default-inline
3960 @opindex fno-default-inline
3961 Do not make member functions inline by default merely because they are
3962 defined inside the class scope (C++ only).  Otherwise, when you specify
3963 @w{@option{-O}}, member functions defined inside class scope are compiled
3964 inline by default; i.e., you don't need to add @samp{inline} in front of
3965 the member function name.
3966
3967 @item -fno-defer-pop
3968 @opindex fno-defer-pop
3969 Always pop the arguments to each function call as soon as that function
3970 returns.  For machines which must pop arguments after a function call,
3971 the compiler normally lets arguments accumulate on the stack for several
3972 function calls and pops them all at once.
3973
3974 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3975
3976 @item -fforce-mem
3977 @opindex fforce-mem
3978 Force memory operands to be copied into registers before doing
3979 arithmetic on them.  This produces better code by making all memory
3980 references potential common subexpressions.  When they are not common
3981 subexpressions, instruction combination should eliminate the separate
3982 register-load.
3983
3984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3985
3986 @item -fforce-addr
3987 @opindex fforce-addr
3988 Force memory address constants to be copied into registers before
3989 doing arithmetic on them.  This may produce better code just as
3990 @option{-fforce-mem} may.
3991
3992 @item -fomit-frame-pointer
3993 @opindex fomit-frame-pointer
3994 Don't keep the frame pointer in a register for functions that
3995 don't need one.  This avoids the instructions to save, set up and
3996 restore frame pointers; it also makes an extra register available
3997 in many functions.  @strong{It also makes debugging impossible on
3998 some machines.}
3999
4000 On some machines, such as the VAX, this flag has no effect, because
4001 the standard calling sequence automatically handles the frame pointer
4002 and nothing is saved by pretending it doesn't exist.  The
4003 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4004 whether a target machine supports this flag.  @xref{Registers,,Register
4005 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4006
4007 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4008
4009 @item -foptimize-sibling-calls
4010 @opindex foptimize-sibling-calls
4011 Optimize sibling and tail recursive calls.
4012
4013 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4014
4015 @item -fno-inline
4016 @opindex fno-inline
4017 Don't pay attention to the @code{inline} keyword.  Normally this option
4018 is used to keep the compiler from expanding any functions inline.
4019 Note that if you are not optimizing, no functions can be expanded inline.
4020
4021 @item -finline-functions
4022 @opindex finline-functions
4023 Integrate all simple functions into their callers.  The compiler
4024 heuristically decides which functions are simple enough to be worth
4025 integrating in this way.
4026
4027 If all calls to a given function are integrated, and the function is
4028 declared @code{static}, then the function is normally not output as
4029 assembler code in its own right.
4030
4031 Enabled at level @option{-O3}.
4032
4033 @item -finline-limit=@var{n}
4034 @opindex finline-limit
4035 By default, GCC limits the size of functions that can be inlined.  This flag
4036 allows the control of this limit for functions that are explicitly marked as
4037 inline (i.e., marked with the inline keyword or defined within the class
4038 definition in c++).  @var{n} is the size of functions that can be inlined in
4039 number of pseudo instructions (not counting parameter handling).  The default
4040 value of @var{n} is 600.
4041 Increasing this value can result in more inlined code at
4042 the cost of compilation time and memory consumption.  Decreasing usually makes
4043 the compilation faster and less code will be inlined (which presumably
4044 means slower programs).  This option is particularly useful for programs that
4045 use inlining heavily such as those based on recursive templates with C++.
4046
4047 Inlining is actually controlled by a number of parameters, which may be
4048 specified individually by using @option{--param @var{name}=@var{value}}.
4049 The @option{-finline-limit=@var{n}} option sets some of these parameters
4050 as follows:
4051
4052 @table @gcctabopt
4053  @item max-inline-insns-single
4054   is set to @var{n}/2.
4055  @item max-inline-insns-auto
4056   is set to @var{n}/2.
4057  @item min-inline-insns
4058   is set to 130 or @var{n}/4, whichever is smaller.
4059  @item max-inline-insns-rtl
4060   is set to @var{n}.
4061 @end table
4062
4063 See below for a documentation of the individual
4064 parameters controlling inlining.
4065
4066 @emph{Note:} pseudo instruction represents, in this particular context, an
4067 abstract measurement of function's size.  In no way, it represents a count
4068 of assembly instructions and as such its exact meaning might change from one
4069 release to an another.
4070
4071 @item -fkeep-inline-functions
4072 @opindex fkeep-inline-functions
4073 In C, emit @code{static} functions that are declared @code{inline}
4074 into the object file, even if the function has been inlined into all
4075 of its callers.  This switch does not affect functions using the
4076 @code{extern inline} extension in GNU C.  In C++, emit any and all
4077 inline functions into the object file.
4078
4079 @item -fkeep-static-consts
4080 @opindex fkeep-static-consts
4081 Emit variables declared @code{static const} when optimization isn't turned
4082 on, even if the variables aren't referenced.
4083
4084 GCC enables this option by default.  If you want to force the compiler to
4085 check if the variable was referenced, regardless of whether or not
4086 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4087
4088 @item -fmerge-constants
4089 Attempt to merge identical constants (string constants and floating point
4090 constants) across compilation units.
4091
4092 This option is the default for optimized compilation if the assembler and
4093 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4094 behavior.
4095
4096 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4097
4098 @item -fmerge-all-constants
4099 Attempt to merge identical constants and identical variables.
4100
4101 This option implies @option{-fmerge-constants}.  In addition to
4102 @option{-fmerge-constants} this considers e.g. even constant initialized
4103 arrays or initialized constant variables with integral or floating point
4104 types.  Languages like C or C++ require each non-automatic variable to
4105 have distinct location, so using this option will result in non-conforming
4106 behavior.
4107
4108 @item -fmodulo-sched
4109 @opindex fmodulo-sched
4110 Perform swing modulo scheduling immediately before the first scheduling
4111 pass.  This pass looks at innermost loops and reorders their
4112 instructions by overlapping different iterations.
4113
4114 @item -fnew-ra
4115 @opindex fnew-ra
4116 Use a graph coloring register allocator.  Currently this option is meant
4117 only for testing.  Users should not specify this option, since it is not
4118 yet ready for production use.
4119
4120 @item -fno-branch-count-reg
4121 @opindex fno-branch-count-reg
4122 Do not use ``decrement and branch'' instructions on a count register,
4123 but instead generate a sequence of instructions that decrement a
4124 register, compare it against zero, then branch based upon the result.
4125 This option is only meaningful on architectures that support such
4126 instructions, which include x86, PowerPC, IA-64 and S/390.
4127
4128 The default is @option{-fbranch-count-reg}, enabled when
4129 @option{-fstrength-reduce} is enabled.
4130
4131 @item -fno-function-cse
4132 @opindex fno-function-cse
4133 Do not put function addresses in registers; make each instruction that
4134 calls a constant function contain the function's address explicitly.
4135
4136 This option results in less efficient code, but some strange hacks
4137 that alter the assembler output may be confused by the optimizations
4138 performed when this option is not used.
4139
4140 The default is @option{-ffunction-cse}
4141
4142 @item -fno-zero-initialized-in-bss
4143 @opindex fno-zero-initialized-in-bss
4144 If the target supports a BSS section, GCC by default puts variables that
4145 are initialized to zero into BSS@.  This can save space in the resulting
4146 code.
4147
4148 This option turns off this behavior because some programs explicitly
4149 rely on variables going to the data section.  E.g., so that the
4150 resulting executable can find the beginning of that section and/or make
4151 assumptions based on that.
4152
4153 The default is @option{-fzero-initialized-in-bss}.
4154
4155 @item -fbounds-check
4156 @opindex fbounds-check
4157 For front-ends that support it, generate additional code to check that
4158 indices used to access arrays are within the declared range.  This is
4159 currently only supported by the Java and Fortran front-ends, where
4160 this option defaults to true and false respectively.
4161
4162 @item -fmudflap -fmudflapth -fmudflapir
4163 @opindex fmudflap
4164 @opindex fmudflapth
4165 @opindex fmudflapir
4166 @cindex bounds checking
4167 @cindex mudflap
4168 For front-ends that support it (C and C++), instrument all risky
4169 pointer/array dereferencing operations, some standard library
4170 string/heap functions, and some other associated constructs with
4171 range/validity tests.  Modules so instrumented should be immune to
4172 buffer overflows, invalid heap use, and some other classes of C/C++
4173 programming errors.  The instrumentation relies on a separate runtime
4174 library (@file{libmudflap}), which will be linked into a program if
4175 @option{-fmudflap} is given at link time.  Run-time behavior of the
4176 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4177 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4178 for its options.
4179
4180 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4181 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4182 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4183 instrumentation should ignore pointer reads.  This produces less
4184 instrumentation (and therefore faster execution) and still provides
4185 some protection against outright memory corrupting writes, but allows
4186 erroneously read data to propagate within a program.
4187
4188 @item -fstrength-reduce
4189 @opindex fstrength-reduce
4190 Perform the optimizations of loop strength reduction and
4191 elimination of iteration variables.
4192
4193 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4194
4195 @item -fthread-jumps
4196 @opindex fthread-jumps
4197 Perform optimizations where we check to see if a jump branches to a
4198 location where another comparison subsumed by the first is found.  If
4199 so, the first branch is redirected to either the destination of the
4200 second branch or a point immediately following it, depending on whether
4201 the condition is known to be true or false.
4202
4203 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4204
4205 @item -fcse-follow-jumps
4206 @opindex fcse-follow-jumps
4207 In common subexpression elimination, scan through jump instructions
4208 when the target of the jump is not reached by any other path.  For
4209 example, when CSE encounters an @code{if} statement with an
4210 @code{else} clause, CSE will follow the jump when the condition
4211 tested is false.
4212
4213 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4214
4215 @item -fcse-skip-blocks
4216 @opindex fcse-skip-blocks
4217 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4218 follow jumps which conditionally skip over blocks.  When CSE
4219 encounters a simple @code{if} statement with no else clause,
4220 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4221 body of the @code{if}.
4222
4223 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4224
4225 @item -frerun-cse-after-loop
4226 @opindex frerun-cse-after-loop
4227 Re-run common subexpression elimination after loop optimizations has been
4228 performed.
4229
4230 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4231
4232 @item -frerun-loop-opt
4233 @opindex frerun-loop-opt
4234 Run the loop optimizer twice.
4235
4236 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4237
4238 @item -fgcse
4239 @opindex fgcse
4240 Perform a global common subexpression elimination pass.
4241 This pass also performs global constant and copy propagation.
4242
4243 @emph{Note:} When compiling a program using computed gotos, a GCC
4244 extension, you may get better runtime performance if you disable
4245 the global common subexpression elimination pass by adding
4246 @option{-fno-gcse} to the command line.
4247
4248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4249
4250 @item -fgcse-lm
4251 @opindex fgcse-lm
4252 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4253 attempt to move loads which are only killed by stores into themselves.  This
4254 allows a loop containing a load/store sequence to be changed to a load outside
4255 the loop, and a copy/store within the loop.
4256
4257 Enabled by default when gcse is enabled.
4258
4259 @item -fgcse-sm
4260 @opindex fgcse-sm
4261 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4262 global common subexpression elimination.  This pass will attempt to move
4263 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4264 loops containing a load/store sequence can be changed to a load before
4265 the loop and a store after the loop.
4266
4267 Enabled by default when gcse is enabled.
4268
4269 @item -fgcse-las
4270 @opindex fgcse-las
4271 When @option{-fgcse-las} is enabled, the global common subexpression
4272 elimination pass eliminates redundant loads that come after stores to the
4273 same memory location (both partial and full redundancies).
4274
4275 Enabled by default when gcse is enabled.
4276
4277 @item -fgcse-after-reload
4278 @opindex fgcse-after-reload
4279 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4280 pass is performed after reload. The purpose of this pass is to cleanup
4281 redundant spilling.
4282
4283 @item -floop-optimize
4284 @opindex floop-optimize
4285 Perform loop optimizations: move constant expressions out of loops, simplify
4286 exit test conditions and optionally do strength-reduction and loop unrolling as
4287 well.
4288
4289 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4290
4291 @item -floop-optimize2
4292 @opindex floop-optimize2
4293 Perform loop optimizations using the new loop optimizer.  The optimizations
4294 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4295 by separate flags.
4296
4297 @item -fcrossjumping
4298 @opindex crossjumping
4299 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4300 resulting code may or may not perform better than without cross-jumping.
4301
4302 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4303
4304 @item -fif-conversion
4305 @opindex if-conversion
4306 Attempt to transform conditional jumps into branch-less equivalents.  This
4307 include use of conditional moves, min, max, set flags and abs instructions, and
4308 some tricks doable by standard arithmetics.  The use of conditional execution
4309 on chips where it is available is controlled by @code{if-conversion2}.
4310
4311 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4312
4313 @item -fif-conversion2
4314 @opindex if-conversion2
4315 Use conditional execution (where available) to transform conditional jumps into
4316 branch-less equivalents.
4317
4318 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4319
4320 @item -fdelete-null-pointer-checks
4321 @opindex fdelete-null-pointer-checks
4322 Use global dataflow analysis to identify and eliminate useless checks
4323 for null pointers.  The compiler assumes that dereferencing a null
4324 pointer would have halted the program.  If a pointer is checked after
4325 it has already been dereferenced, it cannot be null.
4326
4327 In some environments, this assumption is not true, and programs can
4328 safely dereference null pointers.  Use
4329 @option{-fno-delete-null-pointer-checks} to disable this optimization
4330 for programs which depend on that behavior.
4331
4332 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4333
4334 @item -fexpensive-optimizations
4335 @opindex fexpensive-optimizations
4336 Perform a number of minor optimizations that are relatively expensive.
4337
4338 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4339
4340 @item -foptimize-register-move
4341 @itemx -fregmove
4342 @opindex foptimize-register-move
4343 @opindex fregmove
4344 Attempt to reassign register numbers in move instructions and as
4345 operands of other simple instructions in order to maximize the amount of
4346 register tying.  This is especially helpful on machines with two-operand
4347 instructions.
4348
4349 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4350 optimization.
4351
4352 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4353
4354 @item -fdelayed-branch
4355 @opindex fdelayed-branch
4356 If supported for the target machine, attempt to reorder instructions
4357 to exploit instruction slots available after delayed branch
4358 instructions.
4359
4360 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4361
4362 @item -fschedule-insns
4363 @opindex fschedule-insns
4364 If supported for the target machine, attempt to reorder instructions to
4365 eliminate execution stalls due to required data being unavailable.  This
4366 helps machines that have slow floating point or memory load instructions
4367 by allowing other instructions to be issued until the result of the load
4368 or floating point instruction is required.
4369
4370 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4371
4372 @item -fschedule-insns2
4373 @opindex fschedule-insns2
4374 Similar to @option{-fschedule-insns}, but requests an additional pass of
4375 instruction scheduling after register allocation has been done.  This is
4376 especially useful on machines with a relatively small number of
4377 registers and where memory load instructions take more than one cycle.
4378
4379 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4380
4381 @item -fno-sched-interblock
4382 @opindex fno-sched-interblock
4383 Don't schedule instructions across basic blocks.  This is normally
4384 enabled by default when scheduling before register allocation, i.e.@:
4385 with @option{-fschedule-insns} or at @option{-O2} or higher.
4386
4387 @item -fno-sched-spec
4388 @opindex fno-sched-spec
4389 Don't allow speculative motion of non-load instructions.  This is normally
4390 enabled by default when scheduling before register allocation, i.e.@:
4391 with @option{-fschedule-insns} or at @option{-O2} or higher.
4392
4393 @item -fsched-spec-load
4394 @opindex fsched-spec-load
4395 Allow speculative motion of some load instructions.  This only makes
4396 sense when scheduling before register allocation, i.e.@: with
4397 @option{-fschedule-insns} or at @option{-O2} or higher.
4398
4399 @item -fsched-spec-load-dangerous
4400 @opindex fsched-spec-load-dangerous
4401 Allow speculative motion of more load instructions.  This only makes
4402 sense when scheduling before register allocation, i.e.@: with
4403 @option{-fschedule-insns} or at @option{-O2} or higher.
4404
4405 @item -fsched-stalled-insns=@var{n}
4406 @opindex fsched-stalled-insns
4407 Define how many insns (if any) can be moved prematurely from the queue
4408 of stalled insns into the ready list, during the second scheduling pass.
4409
4410 @item -fsched-stalled-insns-dep=@var{n}
4411 @opindex fsched-stalled-insns-dep
4412 Define how many insn groups (cycles) will be examined for a dependency
4413 on a stalled insn that is candidate for premature removal from the queue
4414 of stalled insns.  Has an effect only during the second scheduling pass,
4415 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4416
4417 @item -fsched2-use-superblocks
4418 @opindex fsched2-use-superblocks
4419 When scheduling after register allocation, do use superblock scheduling
4420 algorithm.  Superblock scheduling allows motion across basic block boundaries
4421 resulting on faster schedules.  This option is experimental, as not all machine
4422 descriptions used by GCC model the CPU closely enough to avoid unreliable
4423 results from the algorithm.
4424
4425 This only makes sense when scheduling after register allocation, i.e.@: with
4426 @option{-fschedule-insns2} or at @option{-O2} or higher.
4427
4428 @item -fsched2-use-traces
4429 @opindex fsched2-use-traces
4430 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4431 allocation and additionally perform code duplication in order to increase the
4432 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4433 trace formation.
4434
4435 This mode should produce faster but significantly longer programs.  Also
4436 without @code{-fbranch-probabilities} the traces constructed may not match the
4437 reality and hurt the performance.  This only makes
4438 sense when scheduling after register allocation, i.e.@: with
4439 @option{-fschedule-insns2} or at @option{-O2} or higher.
4440
4441 @item -freschedule-modulo-scheduled-loops
4442 @opindex fscheduling-in-modulo-scheduled-loops
4443 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4444 we may want to prevent the later scheduling passes from changing its schedule, we use this
4445 option to control that.
4446
4447 @item -fcaller-saves
4448 @opindex fcaller-saves
4449 Enable values to be allocated in registers that will be clobbered by
4450 function calls, by emitting extra instructions to save and restore the
4451 registers around such calls.  Such allocation is done only when it
4452 seems to result in better code than would otherwise be produced.
4453
4454 This option is always enabled by default on certain machines, usually
4455 those which have no call-preserved registers to use instead.
4456
4457 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4458
4459 @item -ftree-pre
4460 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4461 enabled by default at -O and higher.
4462
4463 @item -ftree-fre
4464 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4465 between FRE and PRE is that FRE only considers expressions
4466 that are computed on all paths leading to the redundant computation.
4467 This analysis faster than PRE, though it exposes fewer redundancies.
4468 This flag is enabled by default at -O and higher.
4469
4470 @item -ftree-ccp
4471 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4472 is enabled by default at -O and higher.
4473
4474 @item -ftree-dce
4475 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4476 default at -O and higher.
4477
4478 @item -ftree-dominator-opts
4479 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4480 default at -O and higher.
4481
4482 @item -ftree-ch
4483 Perform loop header copying on trees.  This is beneficial since it increases
4484 effectivity of code motion optimizations.  It also saves one jump.  This flag
4485 is enabled by default at -O and higher.  It is not enabled for -Os, since it
4486 usually increases code size.
4487
4488 @item -ftree-loop-optimize
4489 Perform loop optimizations on trees.  This flag is enabled by default at -O
4490 and higher.
4491
4492 @item -ftree-lim
4493 Perform loop invariant motion on trees.  This pass moves only invartiants that
4494 would be hard to handle on rtl level (function calls, operations that expand to
4495 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4496 operands of conditions that are invariant out of the loop, so that we can use
4497 just trivial invariantness analysis in loop unswitching.  The pass also includes
4498 store motion.
4499
4500 @item -fivcanon
4501 Create a canonical counter for number of iterations in the loop for that
4502 determining number of iterations requires complicated analysis.  Later
4503 optimizations then may determine the number easily.  Useful especially
4504 in connection with unrolling.
4505
4506 @item -ftree-sra
4507 Perform scalar replacement of aggregates.  This pass replaces structure
4508 references with scalars to prevent committing structures to memory too
4509 early.  This flag is enabled by default at -O and higher.
4510
4511 @item -ftree-copyrename
4512 Perform copy renaming on trees.  This pass attempts to rename compiler
4513 temporaries to other variables at copy locations, usually resulting in
4514 variable names which more closely resemble the original variables.  This flag
4515 is enabled by default at -O and higher.
4516
4517 @item -ftree-ter
4518 Perform temporary expression replacement during the SSA->normal phase.  Single
4519 use/single def temporaries are replaced at their use location with their
4520 defining expression.  This results in non-GIMPLE code, but gives the expanders
4521 much more complex trees to work on resulting in better RTL generation.  This is
4522 enabled by default at -O and higher.
4523
4524 @item -ftree-lrs
4525 Perform live range splitting during the SSA->normal phase.  Distinct live
4526 ranges of a variable are split into unique variables, allowing for better
4527 optimization later.  This is enabled by default at -O and higher.
4528
4529 @item -ftree-vectorize
4530 Perform loop vectorization on trees.
4531
4532 @item -ftracer
4533 @opindex ftracer
4534 Perform tail duplication to enlarge superblock size. This transformation
4535 simplifies the control flow of the function allowing other optimizations to do
4536 better job.
4537
4538 @item -funroll-loops
4539 @opindex funroll-loops
4540 Unroll loops whose number of iterations can be determined at compile
4541 time or upon entry to the loop.  @option{-funroll-loops} implies both
4542 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4543 option makes code larger, and may or may not make it run faster.
4544
4545 @item -funroll-all-loops
4546 @opindex funroll-all-loops
4547 Unroll all loops, even if their number of iterations is uncertain when
4548 the loop is entered.  This usually makes programs run more slowly.
4549 @option{-funroll-all-loops} implies the same options as
4550 @option{-funroll-loops},
4551
4552 @item -fprefetch-loop-arrays
4553 @opindex fprefetch-loop-arrays
4554 If supported by the target machine, generate instructions to prefetch
4555 memory to improve the performance of loops that access large arrays.
4556
4557 @item -fmove-all-movables
4558 @opindex fmove-all-movables
4559 Forces all invariant computations in loops to be moved
4560 outside the loop.
4561
4562 @item -freduce-all-givs
4563 @opindex freduce-all-givs
4564 Forces all general-induction variables in loops to be
4565 strength-reduced.
4566
4567 @emph{Note:} When compiling programs written in Fortran,
4568 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4569 by default when you use the optimizer.
4570
4571 These options may generate better or worse code; results are highly
4572 dependent on the structure of loops within the source code.
4573
4574 These two options are intended to be removed someday, once
4575 they have helped determine the efficacy of various
4576 approaches to improving loop optimizations.
4577
4578 Please contact @w{@email{gcc@@gcc.gnu.org}}, and describe how use of
4579 these options affects the performance of your production code.
4580 Examples of code that runs @emph{slower} when these options are
4581 @emph{enabled} are very valuable.
4582
4583 @item -fno-peephole
4584 @itemx -fno-peephole2
4585 @opindex fno-peephole
4586 @opindex fno-peephole2
4587 Disable any machine-specific peephole optimizations.  The difference
4588 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4589 are implemented in the compiler; some targets use one, some use the
4590 other, a few use both.
4591
4592 @option{-fpeephole} is enabled by default.
4593 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4594
4595 @item -fno-guess-branch-probability
4596 @opindex fno-guess-branch-probability
4597 Do not guess branch probabilities using a randomized model.
4598
4599 Sometimes GCC will opt to use a randomized model to guess branch
4600 probabilities, when none are available from either profiling feedback
4601 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4602 different runs of the compiler on the same program may produce different
4603 object code.
4604
4605 In a hard real-time system, people don't want different runs of the
4606 compiler to produce code that has different behavior; minimizing
4607 non-determinism is of paramount import.  This switch allows users to
4608 reduce non-determinism, possibly at the expense of inferior
4609 optimization.
4610
4611 The default is @option{-fguess-branch-probability} at levels
4612 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4613
4614 @item -freorder-blocks
4615 @opindex freorder-blocks
4616 Reorder basic blocks in the compiled function in order to reduce number of
4617 taken branches and improve code locality.
4618
4619 Enabled at levels @option{-O2}, @option{-O3}.
4620
4621 @item -freorder-blocks-and-partition
4622 @opindex freorder-blocks-and-partition
4623 In addition to reordering basic blocks in the compiled function, in order
4624 to reduce number of taken branches, partitions hot and cold basic blocks
4625 into separate sections of the assembly and .o files, to improve
4626 paging and cache locality performance.
4627
4628 This optimization is automatically turned off in the presence of
4629 exception handling, for linkonce sections, for functions with a user-defined
4630 section attribute and on any architecture that does not support named
4631 sections.
4632
4633 @item -freorder-functions
4634 @opindex freorder-functions
4635 Reorder basic blocks in the compiled function in order to reduce number of
4636 taken branches and improve code locality. This is implemented by using special
4637 subsections @code{.text.hot} for most frequently executed functions and
4638 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4639 the linker so object file format must support named sections and linker must
4640 place them in a reasonable way.
4641
4642 Also profile feedback must be available in to make this option effective.  See
4643 @option{-fprofile-arcs} for details.
4644
4645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4646
4647 @item -fstrict-aliasing
4648 @opindex fstrict-aliasing
4649 Allows the compiler to assume the strictest aliasing rules applicable to
4650 the language being compiled.  For C (and C++), this activates
4651 optimizations based on the type of expressions.  In particular, an
4652 object of one type is assumed never to reside at the same address as an
4653 object of a different type, unless the types are almost the same.  For
4654 example, an @code{unsigned int} can alias an @code{int}, but not a
4655 @code{void*} or a @code{double}.  A character type may alias any other
4656 type.
4657
4658 Pay special attention to code like this:
4659 @smallexample
4660 union a_union @{
4661   int i;
4662   double d;
4663 @};
4664
4665 int f() @{
4666   a_union t;
4667   t.d = 3.0;
4668   return t.i;
4669 @}
4670 @end smallexample
4671 The practice of reading from a different union member than the one most
4672 recently written to (called ``type-punning'') is common.  Even with
4673 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4674 is accessed through the union type.  So, the code above will work as
4675 expected.  However, this code might not:
4676 @smallexample
4677 int f() @{
4678   a_union t;
4679   int* ip;
4680   t.d = 3.0;
4681   ip = &t.i;
4682   return *ip;
4683 @}
4684 @end smallexample
4685
4686 Every language that wishes to perform language-specific alias analysis
4687 should define a function that computes, given an @code{tree}
4688 node, an alias set for the node.  Nodes in different alias sets are not
4689 allowed to alias.  For an example, see the C front-end function
4690 @code{c_get_alias_set}.
4691
4692 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4693
4694 @item -falign-functions
4695 @itemx -falign-functions=@var{n}
4696 @opindex falign-functions
4697 Align the start of functions to the next power-of-two greater than
4698 @var{n}, skipping up to @var{n} bytes.  For instance,
4699 @option{-falign-functions=32} aligns functions to the next 32-byte
4700 boundary, but @option{-falign-functions=24} would align to the next
4701 32-byte boundary only if this can be done by skipping 23 bytes or less.
4702
4703 @option{-fno-align-functions} and @option{-falign-functions=1} are
4704 equivalent and mean that functions will not be aligned.
4705
4706 Some assemblers only support this flag when @var{n} is a power of two;
4707 in that case, it is rounded up.
4708
4709 If @var{n} is not specified or is zero, use a machine-dependent default.
4710
4711 Enabled at levels @option{-O2}, @option{-O3}.
4712
4713 @item -falign-labels
4714 @itemx -falign-labels=@var{n}
4715 @opindex falign-labels
4716 Align all branch targets to a power-of-two boundary, skipping up to
4717 @var{n} bytes like @option{-falign-functions}.  This option can easily
4718 make code slower, because it must insert dummy operations for when the
4719 branch target is reached in the usual flow of the code.
4720
4721 @option{-fno-align-labels} and @option{-falign-labels=1} are
4722 equivalent and mean that labels will not be aligned.
4723
4724 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4725 are greater than this value, then their values are used instead.
4726
4727 If @var{n} is not specified or is zero, use a machine-dependent default
4728 which is very likely to be @samp{1}, meaning no alignment.
4729
4730 Enabled at levels @option{-O2}, @option{-O3}.
4731
4732 @item -falign-loops
4733 @itemx -falign-loops=@var{n}
4734 @opindex falign-loops
4735 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4736 like @option{-falign-functions}.  The hope is that the loop will be
4737 executed many times, which will make up for any execution of the dummy
4738 operations.
4739
4740 @option{-fno-align-loops} and @option{-falign-loops=1} are
4741 equivalent and mean that loops will not be aligned.
4742
4743 If @var{n} is not specified or is zero, use a machine-dependent default.
4744
4745 Enabled at levels @option{-O2}, @option{-O3}.
4746
4747 @item -falign-jumps
4748 @itemx -falign-jumps=@var{n}
4749 @opindex falign-jumps
4750 Align branch targets to a power-of-two boundary, for branch targets
4751 where the targets can only be reached by jumping, skipping up to @var{n}
4752 bytes like @option{-falign-functions}.  In this case, no dummy operations
4753 need be executed.
4754
4755 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4756 equivalent and mean that loops will not be aligned.
4757
4758 If @var{n} is not specified or is zero, use a machine-dependent default.
4759
4760 Enabled at levels @option{-O2}, @option{-O3}.
4761
4762 @item -funit-at-a-time
4763 @opindex funit-at-a-time
4764 Parse the whole compilation unit before starting to produce code.
4765 This allows some extra optimizations to take place but consumes
4766 more memory (in general).  There are some compatibility issues
4767 with @emph{unit-at-at-time} mode:
4768 @itemize @bullet
4769 @item
4770 enabling @emph{unit-at-a-time} mode may change the order
4771 in which functions, variables, and top-level @code{asm} statements
4772 are emitted, and will likely break code relying on some particular
4773 ordering.  The majority of such top-level @code{asm} statements,
4774 though, can be replaced by @code{section} attributes.
4775
4776 @item
4777 @emph{unit-at-a-time} mode removes unreferenced static variables
4778 and functions are removed.  This may result in undefined references
4779 when an @code{asm} statement refers directly to variables or functions
4780 that are otherwise unused.  In that case either the variable/function
4781 shall be listed as an operand of the @code{asm} statement operand or,
4782 in the case of top-level @code{asm} statements the attribute @code{used}
4783 shall be used on the declaration.
4784
4785 @item
4786 Static functions now can use non-standard passing conventions that
4787 may break @code{asm} statements calling functions directly. Again,
4788 attribute @code{used} will prevent this behavior.
4789 @end itemize
4790
4791 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4792 but this scheme may not be supported by future releases of GCC.
4793
4794 Enabled at levels @option{-O2}, @option{-O3}.
4795
4796 @item -fweb
4797 @opindex fweb
4798 Constructs webs as commonly used for register allocation purposes and assign
4799 each web individual pseudo register.  This allows the register allocation pass
4800 to operate on pseudos directly, but also strengthens several other optimization
4801 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4802 however, make debugging impossible, since variables will no longer stay in a
4803 ``home register''.
4804
4805 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4806 on targets where the default format for debugging information supports
4807 variable tracking.
4808
4809 @item -fno-cprop-registers
4810 @opindex fno-cprop-registers
4811 After register allocation and post-register allocation instruction splitting,
4812 we perform a copy-propagation pass to try to reduce scheduling dependencies
4813 and occasionally eliminate the copy.
4814
4815 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4816
4817 @item -fprofile-generate
4818 @opindex fprofile-generate
4819
4820 Enable options usually used for instrumenting application to produce
4821 profile useful for later recompilation with profile feedback based
4822 optimization.  You must use @code{-fprofile-generate} both when
4823 compiling and when linking your program.
4824
4825 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4826
4827 @item -fprofile-use
4828 @opindex fprofile-use
4829 Enable profile feedback directed optimizations, and optimizations
4830 generally profitable only with profile feedback available.
4831
4832 The following options are enabled: @code{-fbranch-probabilities},
4833 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4834
4835 @end table
4836
4837 The following options control compiler behavior regarding floating
4838 point arithmetic.  These options trade off between speed and
4839 correctness.  All must be specifically enabled.
4840
4841 @table @gcctabopt
4842 @item -ffloat-store
4843 @opindex ffloat-store
4844 Do not store floating point variables in registers, and inhibit other
4845 options that might change whether a floating point value is taken from a
4846 register or memory.
4847
4848 @cindex floating point precision
4849 This option prevents undesirable excess precision on machines such as
4850 the 68000 where the floating registers (of the 68881) keep more
4851 precision than a @code{double} is supposed to have.  Similarly for the
4852 x86 architecture.  For most programs, the excess precision does only
4853 good, but a few programs rely on the precise definition of IEEE floating
4854 point.  Use @option{-ffloat-store} for such programs, after modifying
4855 them to store all pertinent intermediate computations into variables.
4856
4857 @item -ffast-math
4858 @opindex ffast-math
4859 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4860 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4861 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4862
4863 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4864
4865 This option should never be turned on by any @option{-O} option since
4866 it can result in incorrect output for programs which depend on
4867 an exact implementation of IEEE or ISO rules/specifications for
4868 math functions.
4869
4870 @item -fno-math-errno
4871 @opindex fno-math-errno
4872 Do not set ERRNO after calling math functions that are executed
4873 with a single instruction, e.g., sqrt.  A program that relies on
4874 IEEE exceptions for math error handling may want to use this flag
4875 for speed while maintaining IEEE arithmetic compatibility.
4876
4877 This option should never be turned on by any @option{-O} option since
4878 it can result in incorrect output for programs which depend on
4879 an exact implementation of IEEE or ISO rules/specifications for
4880 math functions.
4881
4882 The default is @option{-fmath-errno}.
4883
4884 @item -funsafe-math-optimizations
4885 @opindex funsafe-math-optimizations
4886 Allow optimizations for floating-point arithmetic that (a) assume
4887 that arguments and results are valid and (b) may violate IEEE or
4888 ANSI standards.  When used at link-time, it may include libraries
4889 or startup files that change the default FPU control word or other
4890 similar optimizations.
4891
4892 This option should never be turned on by any @option{-O} option since
4893 it can result in incorrect output for programs which depend on
4894 an exact implementation of IEEE or ISO rules/specifications for
4895 math functions.
4896
4897 The default is @option{-fno-unsafe-math-optimizations}.
4898
4899 @item -ffinite-math-only
4900 @opindex ffinite-math-only
4901 Allow optimizations for floating-point arithmetic that assume
4902 that arguments and results are not NaNs or +-Infs.
4903
4904 This option should never be turned on by any @option{-O} option since
4905 it can result in incorrect output for programs which depend on
4906 an exact implementation of IEEE or ISO rules/specifications.
4907
4908 The default is @option{-fno-finite-math-only}.
4909
4910 @item -fno-trapping-math
4911 @opindex fno-trapping-math
4912 Compile code assuming that floating-point operations cannot generate
4913 user-visible traps.  These traps include division by zero, overflow,
4914 underflow, inexact result and invalid operation.  This option implies
4915 @option{-fno-signaling-nans}.  Setting this option may allow faster
4916 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4917
4918 This option should never be turned on by any @option{-O} option since
4919 it can result in incorrect output for programs which depend on
4920 an exact implementation of IEEE or ISO rules/specifications for
4921 math functions.
4922
4923 The default is @option{-ftrapping-math}.
4924
4925 @item -frounding-math
4926 @opindex frounding-math
4927 Disable transformations and optimizations that assume default floating
4928 point rounding behavior.  This is round-to-zero for all floating point
4929 to integer conversions, and round-to-nearest for all other arithmetic
4930 truncations.  This option should be specified for programs that change
4931 the FP rounding mode dynamically, or that may be executed with a
4932 non-default rounding mode.  This option disables constant folding of
4933 floating point expressions at compile-time (which may be affected by
4934 rounding mode) and arithmetic transformations that are unsafe in the
4935 presence of sign-dependent rounding modes.
4936
4937 The default is @option{-fno-rounding-math}.
4938
4939 This option is experimental and does not currently guarantee to
4940 disable all GCC optimizations that are affected by rounding mode.
4941 Future versions of GCC may provide finer control of this setting
4942 using C99's @code{FENV_ACCESS} pragma.  This command line option
4943 will be used to specify the default state for @code{FENV_ACCESS}.
4944
4945 @item -fsignaling-nans
4946 @opindex fsignaling-nans
4947 Compile code assuming that IEEE signaling NaNs may generate user-visible
4948 traps during floating-point operations.  Setting this option disables
4949 optimizations that may change the number of exceptions visible with
4950 signaling NaNs.  This option implies @option{-ftrapping-math}.
4951
4952 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4953 be defined.
4954
4955 The default is @option{-fno-signaling-nans}.
4956
4957 This option is experimental and does not currently guarantee to
4958 disable all GCC optimizations that affect signaling NaN behavior.
4959
4960 @item -fsingle-precision-constant
4961 @opindex fsingle-precision-constant
4962 Treat floating point constant as single precision constant instead of
4963 implicitly converting it to double precision constant.
4964
4965
4966 @end table
4967
4968 The following options control optimizations that may improve
4969 performance, but are not enabled by any @option{-O} options.  This
4970 section includes experimental options that may produce broken code.
4971
4972 @table @gcctabopt
4973 @item -fbranch-probabilities
4974 @opindex fbranch-probabilities
4975 After running a program compiled with @option{-fprofile-arcs}
4976 (@pxref{Debugging Options,, Options for Debugging Your Program or
4977 @command{gcc}}), you can compile it a second time using
4978 @option{-fbranch-probabilities}, to improve optimizations based on
4979 the number of times each branch was taken.  When the program
4980 compiled with @option{-fprofile-arcs} exits it saves arc execution
4981 counts to a file called @file{@var{sourcename}.gcda} for each source
4982 file  The information in this data file is very dependent on the
4983 structure of the generated code, so you must use the same source code
4984 and the same optimization options for both compilations.
4985
4986 With @option{-fbranch-probabilities}, GCC puts a
4987 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4988 These can be used to improve optimization.  Currently, they are only
4989 used in one place: in @file{reorg.c}, instead of guessing which path a
4990 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4991 exactly determine which path is taken more often.
4992
4993 @item -fprofile-values
4994 @opindex fprofile-values
4995 If combined with @option{-fprofile-arcs}, it adds code so that some
4996 data about values of expressions in the program is gathered.
4997
4998 With @option{-fbranch-probabilities}, it reads back the data gathered
4999 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5000 notes to instructions for their later usage in optimizations.
5001
5002 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5003
5004 @item -fvpt
5005 @opindex fvpt
5006 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5007 a code to gather information about values of expressions.
5008
5009 With @option{-fbranch-probabilities}, it reads back the data gathered
5010 and actually performs the optimizations based on them.
5011 Currently the optimizations include specialization of division operation
5012 using the knowledge about the value of the denominator.
5013
5014 @item -fspeculative-prefetching
5015 @opindex fspeculative-prefetching
5016 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5017 a code to gather information about addresses of memory references in the
5018 program.
5019
5020 With @option{-fbranch-probabilities}, it reads back the data gathered
5021 and issues prefetch instructions according to them.  In addition to the opportunities
5022 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5023 memory access patterns -- for example accesses to the data stored in linked
5024 list whose elements are usually allocated sequentially.
5025
5026 In order to prevent issuing double prefetches, usage of
5027 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5028
5029 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5030
5031 @item -frename-registers
5032 @opindex frename-registers
5033 Attempt to avoid false dependencies in scheduled code by making use
5034 of registers left over after register allocation.  This optimization
5035 will most benefit processors with lots of registers.  Depending on the
5036 debug information format adopted by the target, however, it can
5037 make debugging impossible, since variables will no longer stay in
5038 a ``home register''.
5039
5040 Not enabled by default at any level because it has known bugs.
5041
5042 @item -fnew-ra
5043 @opindex fnew-ra
5044 Use a graph coloring register allocator.  Currently this option is meant
5045 for testing, so we are interested to hear about miscompilations with
5046 @option{-fnew-ra}.
5047
5048 @item -ftracer
5049 @opindex ftracer
5050 Perform tail duplication to enlarge superblock size. This transformation
5051 simplifies the control flow of the function allowing other optimizations to do
5052 better job.
5053
5054 Enabled with @option{-fprofile-use}.
5055
5056 @item -funroll-loops
5057 @opindex funroll-loops
5058 Unroll loops whose number of iterations can be determined at compile time or
5059 upon entry to the loop.  @option{-funroll-loops} implies
5060 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5061 (i.e. complete removal of loops with small constant number of iterations).
5062 This option makes code larger, and may or may not make it run faster.
5063
5064 Enabled with @option{-fprofile-use}.
5065
5066 @item -funroll-all-loops
5067 @opindex funroll-all-loops
5068 Unroll all loops, even if their number of iterations is uncertain when
5069 the loop is entered.  This usually makes programs run more slowly.
5070 @option{-funroll-all-loops} implies the same options as
5071 @option{-funroll-loops}.
5072
5073 @item -fpeel-loops
5074 @opindex fpeel-loops
5075 Peels the loops for that there is enough information that they do not
5076 roll much (from profile feedback).  It also turns on complete loop peeling
5077 (i.e. complete removal of loops with small constant number of iterations).
5078
5079 Enabled with @option{-fprofile-use}.
5080
5081 @item -fmove-loop-invariants
5082 @opindex fmove-loop-invariants
5083 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5084 at level @option{-O1}
5085
5086 @item -funswitch-loops
5087 @opindex funswitch-loops
5088 Move branches with loop invariant conditions out of the loop, with duplicates
5089 of the loop on both branches (modified according to result of the condition).
5090
5091 @item -fold-unroll-loops
5092 @opindex fold-unroll-loops
5093 Unroll loops whose number of iterations can be determined at compile
5094 time or upon entry to the loop, using the old loop unroller whose loop
5095 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
5096 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5097 option makes code larger, and may or may not make it run faster.
5098
5099 @item -fold-unroll-all-loops
5100 @opindex fold-unroll-all-loops
5101 Unroll all loops, even if their number of iterations is uncertain when
5102 the loop is entered. This is done using the old loop unroller whose loop
5103 recognition is based on notes from frontend.  This usually makes programs run more slowly.
5104 @option{-fold-unroll-all-loops} implies the same options as
5105 @option{-fold-unroll-loops}.
5106
5107 @item -fprefetch-loop-arrays
5108 @opindex fprefetch-loop-arrays
5109 If supported by the target machine, generate instructions to prefetch
5110 memory to improve the performance of loops that access large arrays.
5111
5112 Disabled at level @option{-Os}.
5113
5114 @item -ffunction-sections
5115 @itemx -fdata-sections
5116 @opindex ffunction-sections
5117 @opindex fdata-sections
5118 Place each function or data item into its own section in the output
5119 file if the target supports arbitrary sections.  The name of the
5120 function or the name of the data item determines the section's name
5121 in the output file.
5122
5123 Use these options on systems where the linker can perform optimizations
5124 to improve locality of reference in the instruction space.  Most systems
5125 using the ELF object format and SPARC processors running Solaris 2 have
5126 linkers with such optimizations.  AIX may have these optimizations in
5127 the future.
5128
5129 Only use these options when there are significant benefits from doing
5130 so.  When you specify these options, the assembler and linker will
5131 create larger object and executable files and will also be slower.
5132 You will not be able to use @code{gprof} on all systems if you
5133 specify this option and you may have problems with debugging if
5134 you specify both this option and @option{-g}.
5135
5136 @item -fbranch-target-load-optimize
5137 @opindex fbranch-target-load-optimize
5138 Perform branch target register load optimization before prologue / epilogue
5139 threading.
5140 The use of target registers can typically be exposed only during reload,
5141 thus hoisting loads out of loops and doing inter-block scheduling needs
5142 a separate optimization pass.
5143
5144 @item -fbranch-target-load-optimize2
5145 @opindex fbranch-target-load-optimize2
5146 Perform branch target register load optimization after prologue / epilogue
5147 threading.
5148
5149 @item -fbtr-bb-exclusive
5150 @opindex fbtr-bb-exclusive
5151 When performing branch target register load optimization, don't reuse
5152 branch target registers in within any basic block.
5153
5154 @item --param @var{name}=@var{value}
5155 @opindex param
5156 In some places, GCC uses various constants to control the amount of
5157 optimization that is done.  For example, GCC will not inline functions
5158 that contain more that a certain number of instructions.  You can
5159 control some of these constants on the command-line using the
5160 @option{--param} option.
5161
5162 The names of specific parameters, and the meaning of the values, are
5163 tied to the internals of the compiler, and are subject to change
5164 without notice in future releases.
5165
5166 In each case, the @var{value} is an integer.  The allowable choices for
5167 @var{name} are given in the following table:
5168
5169 @table @gcctabopt
5170 @item max-crossjump-edges
5171 The maximum number of incoming edges to consider for crossjumping.
5172 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5173 the number of edges incoming to each block.  Increasing values mean
5174 more aggressive optimization, making the compile time increase with
5175 probably small improvement in executable size.
5176
5177 @item min-crossjump-insns
5178 The minimum number of instructions which must be matched at the end
5179 of two blocks before crossjumping will be performed on them.  This
5180 value is ignored in the case where all instructions in the block being
5181 crossjumped from are matched.  The default value is 5.
5182
5183 @item max-delay-slot-insn-search
5184 The maximum number of instructions to consider when looking for an
5185 instruction to fill a delay slot.  If more than this arbitrary number of
5186 instructions is searched, the time savings from filling the delay slot
5187 will be minimal so stop searching.  Increasing values mean more
5188 aggressive optimization, making the compile time increase with probably
5189 small improvement in executable run time.
5190
5191 @item max-delay-slot-live-search
5192 When trying to fill delay slots, the maximum number of instructions to
5193 consider when searching for a block with valid live register
5194 information.  Increasing this arbitrarily chosen value means more
5195 aggressive optimization, increasing the compile time.  This parameter
5196 should be removed when the delay slot code is rewritten to maintain the
5197 control-flow graph.
5198
5199 @item max-gcse-memory
5200 The approximate maximum amount of memory that will be allocated in
5201 order to perform the global common subexpression elimination
5202 optimization.  If more memory than specified is required, the
5203 optimization will not be done.
5204
5205 @item max-gcse-passes
5206 The maximum number of passes of GCSE to run.  The default is 1.
5207
5208 @item max-pending-list-length
5209 The maximum number of pending dependencies scheduling will allow
5210 before flushing the current state and starting over.  Large functions
5211 with few branches or calls can create excessively large lists which
5212 needlessly consume memory and resources.
5213
5214 @item max-inline-insns-single
5215 Several parameters control the tree inliner used in gcc.
5216 This number sets the maximum number of instructions (counted in GCC's
5217 internal representation) in a single function that the tree inliner
5218 will consider for inlining.  This only affects functions declared
5219 inline and methods implemented in a class declaration (C++).
5220 The default value is 500.
5221
5222 @item max-inline-insns-auto
5223 When you use @option{-finline-functions} (included in @option{-O3}),
5224 a lot of functions that would otherwise not be considered for inlining
5225 by the compiler will be investigated.  To those functions, a different
5226 (more restrictive) limit compared to functions declared inline can
5227 be applied.
5228 The default value is 120.
5229
5230 @item large-function-insns
5231 The limit specifying really large functions.  For functions greater than this
5232 limit inlining is constrained by @option{--param large-function-growth}.
5233 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5234 algorithms used by the backend.
5235 This parameter is ignored when @option{-funit-at-a-time} is not used.
5236 The default value is 3000.
5237
5238 @item large-function-growth
5239 Specifies maximal growth of large function caused by inlining in percents.
5240 This parameter is ignored when @option{-funit-at-a-time} is not used.
5241 The default value is 200.
5242
5243 @item inline-unit-growth
5244 Specifies maximal overall growth of the compilation unit caused by inlining.
5245 This parameter is ignored when @option{-funit-at-a-time} is not used.
5246 The default value is 150.
5247
5248 @item max-inline-insns-recursive
5249 @itemx max-inline-insns-recursive-auto
5250 Specifies maximum number of instructions out-of-line copy of self recursive inline
5251 function can grow into by performing recursive inlining.
5252
5253 For functions declared inline @option{--param max-inline-insns-recursive} is
5254 taken into acount.  For function not declared inline, recursive inlining
5255 happens only when @option{-finline-functions} (included in @option{-O3}) is
5256 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5257 default value is 500.
5258
5259 @item max-inline-recursive-depth
5260 @itemx max-inline-recursive-depth-auto
5261 Specifies maximum recursion depth used by the recursive inlining.
5262
5263 For functions declared inline @option{--param max-inline-recursive-depth} is
5264 taken into acount.  For function not declared inline, recursive inlining
5265 happens only when @option{-finline-functions} (included in @option{-O3}) is
5266 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5267 default value is 500.
5268
5269 @item max-inline-insns-rtl
5270 For languages that use the RTL inliner (this happens at a later stage
5271 than tree inlining), you can set the maximum allowable size (counted
5272 in RTL instructions) for the RTL inliner with this parameter.
5273 The default value is 600.
5274
5275 @item max-unrolled-insns
5276 The maximum number of instructions that a loop should have if that loop
5277 is unrolled, and if the loop is unrolled, it determines how many times
5278 the loop code is unrolled.
5279
5280 @item max-average-unrolled-insns
5281 The maximum number of instructions biased by probabilities of their execution
5282 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5283 it determines how many times the loop code is unrolled.
5284
5285 @item max-unroll-times
5286 The maximum number of unrollings of a single loop.
5287
5288 @item max-peeled-insns
5289 The maximum number of instructions that a loop should have if that loop
5290 is peeled, and if the loop is peeled, it determines how many times
5291 the loop code is peeled.
5292
5293 @item max-peel-times
5294 The maximum number of peelings of a single loop.
5295
5296 @item max-completely-peeled-insns
5297 The maximum number of insns of a completely peeled loop.
5298
5299 @item max-completely-peel-times
5300 The maximum number of iterations of a loop to be suitable for complete peeling.
5301
5302 @item max-unswitch-insns
5303 The maximum number of insns of an unswitched loop.
5304
5305 @item max-unswitch-level
5306 The maximum number of branches unswitched in a single loop.
5307
5308 @item lim-expensive
5309 The minimum cost of an expensive expression in the loop invariant motion.
5310
5311 @item max-iterations-to-track
5312
5313 The maximum number of iterations of a loop the brute force algorithm
5314 for analysis of # of iterations of the loop tries to evaluate.
5315
5316 @item hot-bb-count-fraction
5317 Select fraction of the maximal count of repetitions of basic block in program
5318 given basic block needs to have to be considered hot.
5319
5320 @item hot-bb-frequency-fraction
5321 Select fraction of the maximal frequency of executions of basic block in
5322 function given basic block needs to have to be considered hot
5323
5324 @item tracer-dynamic-coverage
5325 @itemx tracer-dynamic-coverage-feedback
5326
5327 This value is used to limit superblock formation once the given percentage of
5328 executed instructions is covered.  This limits unnecessary code size
5329 expansion.
5330
5331 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5332 feedback is available.  The real profiles (as opposed to statically estimated
5333 ones) are much less balanced allowing the threshold to be larger value.
5334
5335 @item tracer-max-code-growth
5336 Stop tail duplication once code growth has reached given percentage.  This is
5337 rather hokey argument, as most of the duplicates will be eliminated later in
5338 cross jumping, so it may be set to much higher values than is the desired code
5339 growth.
5340
5341 @item tracer-min-branch-ratio
5342
5343 Stop reverse growth when the reverse probability of best edge is less than this
5344 threshold (in percent).
5345
5346 @item tracer-min-branch-ratio
5347 @itemx tracer-min-branch-ratio-feedback
5348
5349 Stop forward growth if the best edge do have probability lower than this
5350 threshold.
5351
5352 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5353 compilation for profile feedback and one for compilation without.  The value
5354 for compilation with profile feedback needs to be more conservative (higher) in
5355 order to make tracer effective.
5356
5357 @item max-cse-path-length
5358
5359 Maximum number of basic blocks on path that cse considers.  The default is 10.
5360
5361 @item global-var-threshold
5362
5363 Counts the number of function calls (N) and the number of
5364 call-clobbered variables (V).  If NxV is larger than this limit, a
5365 single artificial variable will be created to represent all the
5366 call-clobbered variables at function call sites.  This artificial
5367 variable will then be made to alias every call-clobbered variable.
5368 (done as int * size_t on the host machine; beware overflow).
5369
5370 @item max-aliased-vops
5371
5372 Maxiumum number of virtual operands allowed to represent aliases
5373 before triggering the alias grouping heuristic.  Alias grouping
5374 reduces compile times and memory consumption needed for aliasing at
5375 the expense of precision loss in alias information.
5376
5377 @item ggc-min-expand
5378
5379 GCC uses a garbage collector to manage its own memory allocation.  This
5380 parameter specifies the minimum percentage by which the garbage
5381 collector's heap should be allowed to expand between collections.
5382 Tuning this may improve compilation speed; it has no effect on code
5383 generation.
5384
5385 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5386 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5387 the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS.  If
5388 GCC is not able to calculate RAM on a particular platform, the lower
5389 bound of 30% is used.  Setting this parameter and
5390 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5391 every opportunity.  This is extremely slow, but can be useful for
5392 debugging.
5393
5394 @item ggc-min-heapsize
5395
5396 Minimum size of the garbage collector's heap before it begins bothering
5397 to collect garbage.  The first collection occurs after the heap expands
5398 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5399 tuning this may improve compilation speed, and has no effect on code
5400 generation.
5401
5402 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5403 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5404 with a lower bound of 4096 (four megabytes) and an upper bound of
5405 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5406 particular platform, the lower bound is used.  Setting this parameter
5407 very large effectively disables garbage collection.  Setting this
5408 parameter and @option{ggc-min-expand} to zero causes a full collection
5409 to occur at every opportunity.
5410
5411 @item max-reload-search-insns
5412 The maximum number of instruction reload should look backward for equivalent
5413 register.  Increasing values mean more aggressive optimization, making the
5414 compile time increase with probably slightly better performance.  The default
5415 value is 100.
5416
5417 @item max-cselib-memory-location
5418 The maximum number of memory locations cselib should take into acount.
5419 Increasing values mean more aggressive optimization, making the compile time
5420 increase with probably slightly better performance.  The default value is 500.
5421
5422 @item reorder-blocks-duplicate
5423 @itemx reorder-blocks-duplicate-feedback
5424
5425 Used by basic block reordering pass to decide whether to use unconditional
5426 branch or duplicate the code on its destination.  Code is duplicated when its
5427 estimated size is smaller than this value multiplied by the estimated size of
5428 unconditional jump in the hot spots of the program.
5429
5430 The @option{reorder-block-duplicate-feedback} is used only when profile
5431 feedback is available and may be set to higher values than
5432 @option{reorder-block-duplicate} since information about the hot spots is more
5433 accurate.
5434
5435 @item max-sched-region-blocks
5436 The maximum number of blocks in a region to be considered for
5437 interblock scheduling.  The default value is 10.
5438
5439 @item max-sched-region-insns
5440 The maximum number of insns in a region to be considered for
5441 interblock scheduling.  The default value is 100.
5442
5443 @item integer-share-limit
5444 Small integer constants can use a shared data structure, reducing the
5445 compiler's memory usage and increasing its speed.  This sets the maximum
5446 value of a shared integer constant's.  The default value is 256.
5447
5448 @end table
5449 @end table
5450
5451 @node Preprocessor Options
5452 @section Options Controlling the Preprocessor
5453 @cindex preprocessor options
5454 @cindex options, preprocessor
5455
5456 These options control the C preprocessor, which is run on each C source
5457 file before actual compilation.
5458
5459 If you use the @option{-E} option, nothing is done except preprocessing.
5460 Some of these options make sense only together with @option{-E} because
5461 they cause the preprocessor output to be unsuitable for actual
5462 compilation.
5463
5464 @table @gcctabopt
5465 @opindex Wp
5466 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5467 and pass @var{option} directly through to the preprocessor.  If
5468 @var{option} contains commas, it is split into multiple options at the
5469 commas.  However, many options are modified, translated or interpreted
5470 by the compiler driver before being passed to the preprocessor, and
5471 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5472 interface is undocumented and subject to change, so whenever possible
5473 you should avoid using @option{-Wp} and let the driver handle the
5474 options instead.
5475
5476 @item -Xpreprocessor @var{option}
5477 @opindex preprocessor
5478 Pass @var{option} as an option to the preprocessor.  You can use this to
5479 supply system-specific preprocessor options which GCC does not know how to
5480 recognize.
5481
5482 If you want to pass an option that takes an argument, you must use
5483 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5484 @end table
5485
5486 @include cppopts.texi
5487
5488 @node Assembler Options
5489 @section Passing Options to the Assembler
5490
5491 @c prevent bad page break with this line
5492 You can pass options to the assembler.
5493
5494 @table @gcctabopt
5495 @item -Wa,@var{option}
5496 @opindex Wa
5497 Pass @var{option} as an option to the assembler.  If @var{option}
5498 contains commas, it is split into multiple options at the commas.
5499
5500 @item -Xassembler @var{option}
5501 @opindex Xassembler
5502 Pass @var{option} as an option to the assembler.  You can use this to
5503 supply system-specific assembler options which GCC does not know how to
5504 recognize.
5505
5506 If you want to pass an option that takes an argument, you must use
5507 @option{-Xassembler} twice, once for the option and once for the argument.
5508
5509 @end table
5510
5511 @node Link Options
5512 @section Options for Linking
5513 @cindex link options
5514 @cindex options, linking
5515
5516 These options come into play when the compiler links object files into
5517 an executable output file.  They are meaningless if the compiler is
5518 not doing a link step.
5519
5520 @table @gcctabopt
5521 @cindex file names
5522 @item @var{object-file-name}
5523 A file name that does not end in a special recognized suffix is
5524 considered to name an object file or library.  (Object files are
5525 distinguished from libraries by the linker according to the file
5526 contents.)  If linking is done, these object files are used as input
5527 to the linker.
5528
5529 @item -c
5530 @itemx -S
5531 @itemx -E
5532 @opindex c
5533 @opindex S
5534 @opindex E
5535 If any of these options is used, then the linker is not run, and
5536 object file names should not be used as arguments.  @xref{Overall
5537 Options}.
5538
5539 @cindex Libraries
5540 @item -l@var{library}
5541 @itemx -l @var{library}
5542 @opindex l
5543 Search the library named @var{library} when linking.  (The second
5544 alternative with the library as a separate argument is only for
5545 POSIX compliance and is not recommended.)
5546
5547 It makes a difference where in the command you write this option; the
5548 linker searches and processes libraries and object files in the order they
5549 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5550 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5551 to functions in @samp{z}, those functions may not be loaded.
5552
5553 The linker searches a standard list of directories for the library,
5554 which is actually a file named @file{lib@var{library}.a}.  The linker
5555 then uses this file as if it had been specified precisely by name.
5556
5557 The directories searched include several standard system directories
5558 plus any that you specify with @option{-L}.
5559
5560 Normally the files found this way are library files---archive files
5561 whose members are object files.  The linker handles an archive file by
5562 scanning through it for members which define symbols that have so far
5563 been referenced but not defined.  But if the file that is found is an
5564 ordinary object file, it is linked in the usual fashion.  The only
5565 difference between using an @option{-l} option and specifying a file name
5566 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5567 and searches several directories.
5568
5569 @item -lobjc
5570 @opindex lobjc
5571 You need this special case of the @option{-l} option in order to
5572 link an Objective-C or Objective-C++ program.
5573
5574 @item -nostartfiles
5575 @opindex nostartfiles
5576 Do not use the standard system startup files when linking.
5577 The standard system libraries are used normally, unless @option{-nostdlib}
5578 or @option{-nodefaultlibs} is used.
5579
5580 @item -nodefaultlibs
5581 @opindex nodefaultlibs
5582 Do not use the standard system libraries when linking.
5583 Only the libraries you specify will be passed to the linker.
5584 The standard startup files are used normally, unless @option{-nostartfiles}
5585 is used.  The compiler may generate calls to @code{memcmp},
5586 @code{memset}, @code{memcpy} and @code{memmove}.
5587 These entries are usually resolved by entries in
5588 libc.  These entry points should be supplied through some other
5589 mechanism when this option is specified.
5590
5591 @item -nostdlib
5592 @opindex nostdlib
5593 Do not use the standard system startup files or libraries when linking.
5594 No startup files and only the libraries you specify will be passed to
5595 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5596 @code{memcpy} and @code{memmove}.
5597 These entries are usually resolved by entries in
5598 libc.  These entry points should be supplied through some other
5599 mechanism when this option is specified.
5600
5601 @cindex @option{-lgcc}, use with @option{-nostdlib}
5602 @cindex @option{-nostdlib} and unresolved references
5603 @cindex unresolved references and @option{-nostdlib}
5604 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5605 @cindex @option{-nodefaultlibs} and unresolved references
5606 @cindex unresolved references and @option{-nodefaultlibs}
5607 One of the standard libraries bypassed by @option{-nostdlib} and
5608 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5609 that GCC uses to overcome shortcomings of particular machines, or special
5610 needs for some languages.
5611 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5612 Collection (GCC) Internals},
5613 for more discussion of @file{libgcc.a}.)
5614 In most cases, you need @file{libgcc.a} even when you want to avoid
5615 other standard libraries.  In other words, when you specify @option{-nostdlib}
5616 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5617 This ensures that you have no unresolved references to internal GCC
5618 library subroutines.  (For example, @samp{__main}, used to ensure C++
5619 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5620 GNU Compiler Collection (GCC) Internals}.)
5621
5622 @item -pie
5623 @opindex pie
5624 Produce a position independent executable on targets which support it.
5625 For predictable results, you must also specify the same set of options
5626 that were used to generate code (@option{-fpie}, @option{-fPIE},
5627 or model suboptions) when you specify this option.
5628
5629 @item -s
5630 @opindex s
5631 Remove all symbol table and relocation information from the executable.
5632
5633 @item -static
5634 @opindex static
5635 On systems that support dynamic linking, this prevents linking with the shared
5636 libraries.  On other systems, this option has no effect.
5637
5638 @item -shared
5639 @opindex shared
5640 Produce a shared object which can then be linked with other objects to
5641 form an executable.  Not all systems support this option.  For predictable
5642 results, you must also specify the same set of options that were used to
5643 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5644 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5645 needs to build supplementary stub code for constructors to work.  On
5646 multi-libbed systems, @samp{gcc -shared} must select the correct support
5647 libraries to link against.  Failing to supply the correct flags may lead
5648 to subtle defects.  Supplying them in cases where they are not necessary
5649 is innocuous.}
5650
5651 @item -shared-libgcc
5652 @itemx -static-libgcc
5653 @opindex shared-libgcc
5654 @opindex static-libgcc
5655 On systems that provide @file{libgcc} as a shared library, these options
5656 force the use of either the shared or static version respectively.
5657 If no shared version of @file{libgcc} was built when the compiler was
5658 configured, these options have no effect.
5659
5660 There are several situations in which an application should use the
5661 shared @file{libgcc} instead of the static version.  The most common
5662 of these is when the application wishes to throw and catch exceptions
5663 across different shared libraries.  In that case, each of the libraries
5664 as well as the application itself should use the shared @file{libgcc}.
5665
5666 Therefore, the G++ and GCJ drivers automatically add
5667 @option{-shared-libgcc} whenever you build a shared library or a main
5668 executable, because C++ and Java programs typically use exceptions, so
5669 this is the right thing to do.
5670
5671 If, instead, you use the GCC driver to create shared libraries, you may
5672 find that they will not always be linked with the shared @file{libgcc}.
5673 If GCC finds, at its configuration time, that you have a non-GNU linker
5674 or a GNU linker that does not support option @option{--eh-frame-hdr},
5675 it will link the shared version of @file{libgcc} into shared libraries
5676 by default.  Otherwise, it will take advantage of the linker and optimize
5677 away the linking with the shared version of @file{libgcc}, linking with
5678 the static version of libgcc by default.  This allows exceptions to
5679 propagate through such shared libraries, without incurring relocation
5680 costs at library load time.
5681
5682 However, if a library or main executable is supposed to throw or catch
5683 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5684 for the languages used in the program, or using the option
5685 @option{-shared-libgcc}, such that it is linked with the shared
5686 @file{libgcc}.
5687
5688 @item -symbolic
5689 @opindex symbolic
5690 Bind references to global symbols when building a shared object.  Warn
5691 about any unresolved references (unless overridden by the link editor
5692 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5693 this option.
5694
5695 @item -Xlinker @var{option}
5696 @opindex Xlinker
5697 Pass @var{option} as an option to the linker.  You can use this to
5698 supply system-specific linker options which GCC does not know how to
5699 recognize.
5700
5701 If you want to pass an option that takes an argument, you must use
5702 @option{-Xlinker} twice, once for the option and once for the argument.
5703 For example, to pass @option{-assert definitions}, you must write
5704 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5705 @option{-Xlinker "-assert definitions"}, because this passes the entire
5706 string as a single argument, which is not what the linker expects.
5707
5708 @item -Wl,@var{option}
5709 @opindex Wl
5710 Pass @var{option} as an option to the linker.  If @var{option} contains
5711 commas, it is split into multiple options at the commas.
5712
5713 @item -u @var{symbol}
5714 @opindex u
5715 Pretend the symbol @var{symbol} is undefined, to force linking of
5716 library modules to define it.  You can use @option{-u} multiple times with
5717 different symbols to force loading of additional library modules.
5718 @end table
5719
5720 @node Directory Options
5721 @section Options for Directory Search
5722 @cindex directory options
5723 @cindex options, directory search
5724 @cindex search path
5725
5726 These options specify directories to search for header files, for
5727 libraries and for parts of the compiler:
5728
5729 @table @gcctabopt
5730 @item -I@var{dir}
5731 @opindex I
5732 Add the directory @var{dir} to the head of the list of directories to be
5733 searched for header files.  This can be used to override a system header
5734 file, substituting your own version, since these directories are
5735 searched before the system header file directories.  However, you should
5736 not use this option to add directories that contain vendor-supplied
5737 system header files (use @option{-isystem} for that).  If you use more than
5738 one @option{-I} option, the directories are scanned in left-to-right
5739 order; the standard system directories come after.
5740
5741 If a standard system include directory, or a directory specified with
5742 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5743 option will be ignored.  The directory will still be searched but as a
5744 system directory at its normal position in the system include chain.
5745 This is to ensure that GCC's procedure to fix buggy system headers and
5746 the ordering for the include_next directive are not inadvertently changed.
5747 If you really need to change the search order for system directories,
5748 use the @option{-nostdinc} and/or @option{-isystem} options.
5749
5750 @item -iquote@var{dir}
5751 @opindex iquote
5752 Add the directory @var{dir} to the head of the list of directories to
5753 be searched for header files only for the case of @samp{#include
5754 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5755 otherwise just like @option{-I}.
5756
5757 @item -L@var{dir}
5758 @opindex L
5759 Add directory @var{dir} to the list of directories to be searched
5760 for @option{-l}.
5761
5762 @item -B@var{prefix}
5763 @opindex B
5764 This option specifies where to find the executables, libraries,
5765 include files, and data files of the compiler itself.
5766
5767 The compiler driver program runs one or more of the subprograms
5768 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5769 @var{prefix} as a prefix for each program it tries to run, both with and
5770 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5771
5772 For each subprogram to be run, the compiler driver first tries the
5773 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5774 was not specified, the driver tries two standard prefixes, which are
5775 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5776 those results in a file name that is found, the unmodified program
5777 name is searched for using the directories specified in your
5778 @env{PATH} environment variable.
5779
5780 The compiler will check to see if the path provided by the @option{-B}
5781 refers to a directory, and if necessary it will add a directory
5782 separator character at the end of the path.
5783
5784 @option{-B} prefixes that effectively specify directory names also apply
5785 to libraries in the linker, because the compiler translates these
5786 options into @option{-L} options for the linker.  They also apply to
5787 includes files in the preprocessor, because the compiler translates these
5788 options into @option{-isystem} options for the preprocessor.  In this case,
5789 the compiler appends @samp{include} to the prefix.
5790
5791 The run-time support file @file{libgcc.a} can also be searched for using
5792 the @option{-B} prefix, if needed.  If it is not found there, the two
5793 standard prefixes above are tried, and that is all.  The file is left
5794 out of the link if it is not found by those means.
5795
5796 Another way to specify a prefix much like the @option{-B} prefix is to use
5797 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5798 Variables}.
5799
5800 As a special kludge, if the path provided by @option{-B} is
5801 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5802 9, then it will be replaced by @file{[dir/]include}.  This is to help
5803 with boot-strapping the compiler.
5804
5805 @item -specs=@var{file}
5806 @opindex specs
5807 Process @var{file} after the compiler reads in the standard @file{specs}
5808 file, in order to override the defaults that the @file{gcc} driver
5809 program uses when determining what switches to pass to @file{cc1},
5810 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5811 @option{-specs=@var{file}} can be specified on the command line, and they
5812 are processed in order, from left to right.
5813
5814 @item -I-
5815 @opindex I-
5816 This option has been deprecated.  Please use @option{-iquote} instead for
5817 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5818 Any directories you specify with @option{-I} options before the @option{-I-}
5819 option are searched only for the case of @samp{#include "@var{file}"};
5820 they are not searched for @samp{#include <@var{file}>}.
5821
5822 If additional directories are specified with @option{-I} options after
5823 the @option{-I-}, these directories are searched for all @samp{#include}
5824 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5825 this way.)
5826
5827 In addition, the @option{-I-} option inhibits the use of the current
5828 directory (where the current input file came from) as the first search
5829 directory for @samp{#include "@var{file}"}.  There is no way to
5830 override this effect of @option{-I-}.  With @option{-I.} you can specify
5831 searching the directory which was current when the compiler was
5832 invoked.  That is not exactly the same as what the preprocessor does
5833 by default, but it is often satisfactory.
5834
5835 @option{-I-} does not inhibit the use of the standard system directories
5836 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5837 independent.
5838 @end table
5839
5840 @c man end
5841
5842 @node Spec Files
5843 @section Specifying subprocesses and the switches to pass to them
5844 @cindex Spec Files
5845
5846 @command{gcc} is a driver program.  It performs its job by invoking a
5847 sequence of other programs to do the work of compiling, assembling and
5848 linking.  GCC interprets its command-line parameters and uses these to
5849 deduce which programs it should invoke, and which command-line options
5850 it ought to place on their command lines.  This behavior is controlled
5851 by @dfn{spec strings}.  In most cases there is one spec string for each
5852 program that GCC can invoke, but a few programs have multiple spec
5853 strings to control their behavior.  The spec strings built into GCC can
5854 be overridden by using the @option{-specs=} command-line switch to specify
5855 a spec file.
5856
5857 @dfn{Spec files} are plaintext files that are used to construct spec
5858 strings.  They consist of a sequence of directives separated by blank
5859 lines.  The type of directive is determined by the first non-whitespace
5860 character on the line and it can be one of the following:
5861
5862 @table @code
5863 @item %@var{command}
5864 Issues a @var{command} to the spec file processor.  The commands that can
5865 appear here are:
5866
5867 @table @code
5868 @item %include <@var{file}>
5869 @cindex %include
5870 Search for @var{file} and insert its text at the current point in the
5871 specs file.
5872
5873 @item %include_noerr <@var{file}>
5874 @cindex %include_noerr
5875 Just like @samp{%include}, but do not generate an error message if the include
5876 file cannot be found.
5877
5878 @item %rename @var{old_name} @var{new_name}
5879 @cindex %rename
5880 Rename the spec string @var{old_name} to @var{new_name}.
5881
5882 @end table
5883
5884 @item *[@var{spec_name}]:
5885 This tells the compiler to create, override or delete the named spec
5886 string.  All lines after this directive up to the next directive or
5887 blank line are considered to be the text for the spec string.  If this
5888 results in an empty string then the spec will be deleted.  (Or, if the
5889 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5890 does not currently exist a new spec will be created.  If the spec does
5891 exist then its contents will be overridden by the text of this
5892 directive, unless the first character of that text is the @samp{+}
5893 character, in which case the text will be appended to the spec.
5894
5895 @item [@var{suffix}]:
5896 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5897 and up to the next directive or blank line are considered to make up the
5898 spec string for the indicated suffix.  When the compiler encounters an
5899 input file with the named suffix, it will processes the spec string in
5900 order to work out how to compile that file.  For example:
5901
5902 @smallexample
5903 .ZZ:
5904 z-compile -input %i
5905 @end smallexample
5906
5907 This says that any input file whose name ends in @samp{.ZZ} should be
5908 passed to the program @samp{z-compile}, which should be invoked with the
5909 command-line switch @option{-input} and with the result of performing the
5910 @samp{%i} substitution.  (See below.)
5911
5912 As an alternative to providing a spec string, the text that follows a
5913 suffix directive can be one of the following:
5914
5915 @table @code
5916 @item @@@var{language}
5917 This says that the suffix is an alias for a known @var{language}.  This is
5918 similar to using the @option{-x} command-line switch to GCC to specify a
5919 language explicitly.  For example:
5920
5921 @smallexample
5922 .ZZ:
5923 @@c++
5924 @end smallexample
5925
5926 Says that .ZZ files are, in fact, C++ source files.
5927
5928 @item #@var{name}
5929 This causes an error messages saying:
5930
5931 @smallexample
5932 @var{name} compiler not installed on this system.
5933 @end smallexample
5934 @end table
5935
5936 GCC already has an extensive list of suffixes built into it.
5937 This directive will add an entry to the end of the list of suffixes, but
5938 since the list is searched from the end backwards, it is effectively
5939 possible to override earlier entries using this technique.
5940
5941 @end table
5942
5943 GCC has the following spec strings built into it.  Spec files can
5944 override these strings or create their own.  Note that individual
5945 targets can also add their own spec strings to this list.
5946
5947 @smallexample
5948 asm          Options to pass to the assembler
5949 asm_final    Options to pass to the assembler post-processor
5950 cpp          Options to pass to the C preprocessor
5951 cc1          Options to pass to the C compiler
5952 cc1plus      Options to pass to the C++ compiler
5953 endfile      Object files to include at the end of the link
5954 link         Options to pass to the linker
5955 lib          Libraries to include on the command line to the linker
5956 libgcc       Decides which GCC support library to pass to the linker
5957 linker       Sets the name of the linker
5958 predefines   Defines to be passed to the C preprocessor
5959 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5960              by default
5961 startfile    Object files to include at the start of the link
5962 @end smallexample
5963
5964 Here is a small example of a spec file:
5965
5966 @smallexample
5967 %rename lib                 old_lib
5968
5969 *lib:
5970 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5971 @end smallexample
5972
5973 This example renames the spec called @samp{lib} to @samp{old_lib} and
5974 then overrides the previous definition of @samp{lib} with a new one.
5975 The new definition adds in some extra command-line options before
5976 including the text of the old definition.
5977
5978 @dfn{Spec strings} are a list of command-line options to be passed to their
5979 corresponding program.  In addition, the spec strings can contain
5980 @samp{%}-prefixed sequences to substitute variable text or to
5981 conditionally insert text into the command line.  Using these constructs
5982 it is possible to generate quite complex command lines.
5983
5984 Here is a table of all defined @samp{%}-sequences for spec
5985 strings.  Note that spaces are not generated automatically around the
5986 results of expanding these sequences.  Therefore you can concatenate them
5987 together or combine them with constant text in a single argument.
5988
5989 @table @code
5990 @item %%
5991 Substitute one @samp{%} into the program name or argument.
5992
5993 @item %i
5994 Substitute the name of the input file being processed.
5995
5996 @item %b
5997 Substitute the basename of the input file being processed.
5998 This is the substring up to (and not including) the last period
5999 and not including the directory.
6000
6001 @item %B
6002 This is the same as @samp{%b}, but include the file suffix (text after
6003 the last period).
6004
6005 @item %d
6006 Marks the argument containing or following the @samp{%d} as a
6007 temporary file name, so that that file will be deleted if GCC exits
6008 successfully.  Unlike @samp{%g}, this contributes no text to the
6009 argument.
6010
6011 @item %g@var{suffix}
6012 Substitute a file name that has suffix @var{suffix} and is chosen
6013 once per compilation, and mark the argument in the same way as
6014 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6015 name is now chosen in a way that is hard to predict even when previously
6016 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6017 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6018 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6019 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6020 was simply substituted with a file name chosen once per compilation,
6021 without regard to any appended suffix (which was therefore treated
6022 just like ordinary text), making such attacks more likely to succeed.
6023
6024 @item %u@var{suffix}
6025 Like @samp{%g}, but generates a new temporary file name even if
6026 @samp{%u@var{suffix}} was already seen.
6027
6028 @item %U@var{suffix}
6029 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6030 new one if there is no such last file name.  In the absence of any
6031 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6032 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6033 would involve the generation of two distinct file names, one
6034 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6035 simply substituted with a file name chosen for the previous @samp{%u},
6036 without regard to any appended suffix.
6037
6038 @item %j@var{suffix}
6039 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6040 writable, and if save-temps is off; otherwise, substitute the name
6041 of a temporary file, just like @samp{%u}.  This temporary file is not
6042 meant for communication between processes, but rather as a junk
6043 disposal mechanism.
6044
6045 @item %|@var{suffix}
6046 @itemx %m@var{suffix}
6047 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6048 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6049 all.  These are the two most common ways to instruct a program that it
6050 should read from standard input or write to standard output.  If you
6051 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6052 construct: see for example @file{f/lang-specs.h}.
6053
6054 @item %.@var{SUFFIX}
6055 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6056 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6057 terminated by the next space or %.
6058
6059 @item %w
6060 Marks the argument containing or following the @samp{%w} as the
6061 designated output file of this compilation.  This puts the argument
6062 into the sequence of arguments that @samp{%o} will substitute later.
6063
6064 @item %o
6065 Substitutes the names of all the output files, with spaces
6066 automatically placed around them.  You should write spaces
6067 around the @samp{%o} as well or the results are undefined.
6068 @samp{%o} is for use in the specs for running the linker.
6069 Input files whose names have no recognized suffix are not compiled
6070 at all, but they are included among the output files, so they will
6071 be linked.
6072
6073 @item %O
6074 Substitutes the suffix for object files.  Note that this is
6075 handled specially when it immediately follows @samp{%g, %u, or %U},
6076 because of the need for those to form complete file names.  The
6077 handling is such that @samp{%O} is treated exactly as if it had already
6078 been substituted, except that @samp{%g, %u, and %U} do not currently
6079 support additional @var{suffix} characters following @samp{%O} as they would
6080 following, for example, @samp{.o}.
6081
6082 @item %p
6083 Substitutes the standard macro predefinitions for the
6084 current target machine.  Use this when running @code{cpp}.
6085
6086 @item %P
6087 Like @samp{%p}, but puts @samp{__} before and after the name of each
6088 predefined macro, except for macros that start with @samp{__} or with
6089 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6090 C@.
6091
6092 @item %I
6093 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6094 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6095 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6096 as necessary.
6097
6098 @item %s
6099 Current argument is the name of a library or startup file of some sort.
6100 Search for that file in a standard list of directories and substitute
6101 the full name found.
6102
6103 @item %e@var{str}
6104 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6105 Use this when inconsistent options are detected.
6106
6107 @item %(@var{name})
6108 Substitute the contents of spec string @var{name} at this point.
6109
6110 @item %[@var{name}]
6111 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6112
6113 @item %x@{@var{option}@}
6114 Accumulate an option for @samp{%X}.
6115
6116 @item %X
6117 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6118 spec string.
6119
6120 @item %Y
6121 Output the accumulated assembler options specified by @option{-Wa}.
6122
6123 @item %Z
6124 Output the accumulated preprocessor options specified by @option{-Wp}.
6125
6126 @item %a
6127 Process the @code{asm} spec.  This is used to compute the
6128 switches to be passed to the assembler.
6129
6130 @item %A
6131 Process the @code{asm_final} spec.  This is a spec string for
6132 passing switches to an assembler post-processor, if such a program is
6133 needed.
6134
6135 @item %l
6136 Process the @code{link} spec.  This is the spec for computing the
6137 command line passed to the linker.  Typically it will make use of the
6138 @samp{%L %G %S %D and %E} sequences.
6139
6140 @item %D
6141 Dump out a @option{-L} option for each directory that GCC believes might
6142 contain startup files.  If the target supports multilibs then the
6143 current multilib directory will be prepended to each of these paths.
6144
6145 @item %M
6146 Output the multilib directory with directory separators replaced with
6147 @samp{_}.  If multilib directories are not set, or the multilib directory is
6148 @file{.} then this option emits nothing.
6149
6150 @item %L
6151 Process the @code{lib} spec.  This is a spec string for deciding which
6152 libraries should be included on the command line to the linker.
6153
6154 @item %G
6155 Process the @code{libgcc} spec.  This is a spec string for deciding
6156 which GCC support library should be included on the command line to the linker.
6157
6158 @item %S
6159 Process the @code{startfile} spec.  This is a spec for deciding which
6160 object files should be the first ones passed to the linker.  Typically
6161 this might be a file named @file{crt0.o}.
6162
6163 @item %E
6164 Process the @code{endfile} spec.  This is a spec string that specifies
6165 the last object files that will be passed to the linker.
6166
6167 @item %C
6168 Process the @code{cpp} spec.  This is used to construct the arguments
6169 to be passed to the C preprocessor.
6170
6171 @item %1
6172 Process the @code{cc1} spec.  This is used to construct the options to be
6173 passed to the actual C compiler (@samp{cc1}).
6174
6175 @item %2
6176 Process the @code{cc1plus} spec.  This is used to construct the options to be
6177 passed to the actual C++ compiler (@samp{cc1plus}).
6178
6179 @item %*
6180 Substitute the variable part of a matched option.  See below.
6181 Note that each comma in the substituted string is replaced by
6182 a single space.
6183
6184 @item %<@code{S}
6185 Remove all occurrences of @code{-S} from the command line.  Note---this
6186 command is position dependent.  @samp{%} commands in the spec string
6187 before this one will see @code{-S}, @samp{%} commands in the spec string
6188 after this one will not.
6189
6190 @item %:@var{function}(@var{args})
6191 Call the named function @var{function}, passing it @var{args}.
6192 @var{args} is first processed as a nested spec string, then split
6193 into an argument vector in the usual fashion.  The function returns
6194 a string which is processed as if it had appeared literally as part
6195 of the current spec.
6196
6197 The following built-in spec functions are provided:
6198
6199 @table @code
6200 @item @code{if-exists}
6201 The @code{if-exists} spec function takes one argument, an absolute
6202 pathname to a file.  If the file exists, @code{if-exists} returns the
6203 pathname.  Here is a small example of its usage:
6204
6205 @smallexample
6206 *startfile:
6207 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6208 @end smallexample
6209
6210 @item @code{if-exists-else}
6211 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6212 spec function, except that it takes two arguments.  The first argument is
6213 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6214 returns the pathname.  If it does not exist, it returns the second argument.
6215 This way, @code{if-exists-else} can be used to select one file or another,
6216 based on the existence of the first.  Here is a small example of its usage:
6217
6218 @smallexample
6219 *startfile:
6220 crt0%O%s %:if-exists(crti%O%s) \
6221 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6222 @end smallexample
6223 @end table
6224
6225 @item %@{@code{S}@}
6226 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6227 If that switch was not specified, this substitutes nothing.  Note that
6228 the leading dash is omitted when specifying this option, and it is
6229 automatically inserted if the substitution is performed.  Thus the spec
6230 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6231 and would output the command line option @option{-foo}.
6232
6233 @item %W@{@code{S}@}
6234 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6235 deleted on failure.
6236
6237 @item %@{@code{S}*@}
6238 Substitutes all the switches specified to GCC whose names start
6239 with @code{-S}, but which also take an argument.  This is used for
6240 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6241 GCC considers @option{-o foo} as being
6242 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6243 text, including the space.  Thus two arguments would be generated.
6244
6245 @item %@{@code{S}*&@code{T}*@}
6246 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6247 (the order of @code{S} and @code{T} in the spec is not significant).
6248 There can be any number of ampersand-separated variables; for each the
6249 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6250
6251 @item %@{@code{S}:@code{X}@}
6252 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6253
6254 @item %@{!@code{S}:@code{X}@}
6255 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6256
6257 @item %@{@code{S}*:@code{X}@}
6258 Substitutes @code{X} if one or more switches whose names start with
6259 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6260 once, no matter how many such switches appeared.  However, if @code{%*}
6261 appears somewhere in @code{X}, then @code{X} will be substituted once
6262 for each matching switch, with the @code{%*} replaced by the part of
6263 that switch that matched the @code{*}.
6264
6265 @item %@{.@code{S}:@code{X}@}
6266 Substitutes @code{X}, if processing a file with suffix @code{S}.
6267
6268 @item %@{!.@code{S}:@code{X}@}
6269 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6270
6271 @item %@{@code{S}|@code{P}:@code{X}@}
6272 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6273 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6274 although they have a stronger binding than the @samp{|}.  If @code{%*}
6275 appears in @code{X}, all of the alternatives must be starred, and only
6276 the first matching alternative is substituted.
6277
6278 For example, a spec string like this:
6279
6280 @smallexample
6281 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6282 @end smallexample
6283
6284 will output the following command-line options from the following input
6285 command-line options:
6286
6287 @smallexample
6288 fred.c        -foo -baz
6289 jim.d         -bar -boggle
6290 -d fred.c     -foo -baz -boggle
6291 -d jim.d      -bar -baz -boggle
6292 @end smallexample
6293
6294 @item %@{S:X; T:Y; :D@}
6295
6296 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6297 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6298 be as many clauses as you need.  This may be combined with @code{.},
6299 @code{!}, @code{|}, and @code{*} as needed.
6300
6301
6302 @end table
6303
6304 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6305 construct may contain other nested @samp{%} constructs or spaces, or
6306 even newlines.  They are processed as usual, as described above.
6307 Trailing white space in @code{X} is ignored.  White space may also
6308 appear anywhere on the left side of the colon in these constructs,
6309 except between @code{.} or @code{*} and the corresponding word.
6310
6311 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6312 handled specifically in these constructs.  If another value of
6313 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6314 @option{-W} switch is found later in the command line, the earlier
6315 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6316 just one letter, which passes all matching options.
6317
6318 The character @samp{|} at the beginning of the predicate text is used to
6319 indicate that a command should be piped to the following command, but
6320 only if @option{-pipe} is specified.
6321
6322 It is built into GCC which switches take arguments and which do not.
6323 (You might think it would be useful to generalize this to allow each
6324 compiler's spec to say which switches take arguments.  But this cannot
6325 be done in a consistent fashion.  GCC cannot even decide which input
6326 files have been specified without knowing which switches take arguments,
6327 and it must know which input files to compile in order to tell which
6328 compilers to run).
6329
6330 GCC also knows implicitly that arguments starting in @option{-l} are to be
6331 treated as compiler output files, and passed to the linker in their
6332 proper position among the other output files.
6333
6334 @c man begin OPTIONS
6335
6336 @node Target Options
6337 @section Specifying Target Machine and Compiler Version
6338 @cindex target options
6339 @cindex cross compiling
6340 @cindex specifying machine version
6341 @cindex specifying compiler version and target machine
6342 @cindex compiler version, specifying
6343 @cindex target machine, specifying
6344
6345 The usual way to run GCC is to run the executable called @file{gcc}, or
6346 @file{<machine>-gcc} when cross-compiling, or
6347 @file{<machine>-gcc-<version>} to run a version other than the one that
6348 was installed last.  Sometimes this is inconvenient, so GCC provides
6349 options that will switch to another cross-compiler or version.
6350
6351 @table @gcctabopt
6352 @item -b @var{machine}
6353 @opindex b
6354 The argument @var{machine} specifies the target machine for compilation.
6355
6356 The value to use for @var{machine} is the same as was specified as the
6357 machine type when configuring GCC as a cross-compiler.  For
6358 example, if a cross-compiler was configured with @samp{configure
6359 i386v}, meaning to compile for an 80386 running System V, then you
6360 would specify @option{-b i386v} to run that cross compiler.
6361
6362 @item -V @var{version}
6363 @opindex V
6364 The argument @var{version} specifies which version of GCC to run.
6365 This is useful when multiple versions are installed.  For example,
6366 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6367 @end table
6368
6369 The @option{-V} and @option{-b} options work by running the
6370 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6371 use them if you can just run that directly.
6372
6373 @node Submodel Options
6374 @section Hardware Models and Configurations
6375 @cindex submodel options
6376 @cindex specifying hardware config
6377 @cindex hardware models and configurations, specifying
6378 @cindex machine dependent options
6379
6380 Earlier we discussed the standard option @option{-b} which chooses among
6381 different installed compilers for completely different target
6382 machines, such as VAX vs.@: 68000 vs.@: 80386.
6383
6384 In addition, each of these target machine types can have its own
6385 special options, starting with @samp{-m}, to choose among various
6386 hardware models or configurations---for example, 68010 vs 68020,
6387 floating coprocessor or none.  A single installed version of the
6388 compiler can compile for any model or configuration, according to the
6389 options specified.
6390
6391 Some configurations of the compiler also support additional special
6392 options, usually for compatibility with other compilers on the same
6393 platform.
6394
6395 These options are defined by the macro @code{TARGET_SWITCHES} in the
6396 machine description.  The default for the options is also defined by
6397 that macro, which enables you to change the defaults.
6398
6399 @c This list is ordered alphanumerically by subsection name.
6400 @c It should be the same order and spelling as these options are listed
6401 @c in Machine Dependent Options
6402
6403 @menu
6404 * ARC Options::
6405 * ARM Options::
6406 * AVR Options::
6407 * CRIS Options::
6408 * Darwin Options::
6409 * DEC Alpha Options::
6410 * DEC Alpha/VMS Options::
6411 * FRV Options::
6412 * H8/300 Options::
6413 * HPPA Options::
6414 * i386 and x86-64 Options::
6415 * IA-64 Options::
6416 * M32R/D Options::
6417 * M680x0 Options::
6418 * M68hc1x Options::
6419 * MCore Options::
6420 * MIPS Options::
6421 * MMIX Options::
6422 * MN10300 Options::
6423 * NS32K Options::
6424 * PDP-11 Options::
6425 * PowerPC Options::
6426 * RS/6000 and PowerPC Options::
6427 * S/390 and zSeries Options::
6428 * SH Options::
6429 * SPARC Options::
6430 * System V Options::
6431 * TMS320C3x/C4x Options::
6432 * V850 Options::
6433 * VAX Options::
6434 * x86-64 Options::
6435 * Xstormy16 Options::
6436 * Xtensa Options::
6437 * zSeries Options::
6438 @end menu
6439
6440 @node ARC Options
6441 @subsection ARC Options
6442 @cindex ARC Options
6443
6444 These options are defined for ARC implementations:
6445
6446 @table @gcctabopt
6447 @item -EL
6448 @opindex EL
6449 Compile code for little endian mode.  This is the default.
6450
6451 @item -EB
6452 @opindex EB
6453 Compile code for big endian mode.
6454
6455 @item -mmangle-cpu
6456 @opindex mmangle-cpu
6457 Prepend the name of the cpu to all public symbol names.
6458 In multiple-processor systems, there are many ARC variants with different
6459 instruction and register set characteristics.  This flag prevents code
6460 compiled for one cpu to be linked with code compiled for another.
6461 No facility exists for handling variants that are ``almost identical''.
6462 This is an all or nothing option.
6463
6464 @item -mcpu=@var{cpu}
6465 @opindex mcpu
6466 Compile code for ARC variant @var{cpu}.
6467 Which variants are supported depend on the configuration.
6468 All variants support @option{-mcpu=base}, this is the default.
6469
6470 @item -mtext=@var{text-section}
6471 @itemx -mdata=@var{data-section}
6472 @itemx -mrodata=@var{readonly-data-section}
6473 @opindex mtext
6474 @opindex mdata
6475 @opindex mrodata
6476 Put functions, data, and readonly data in @var{text-section},
6477 @var{data-section}, and @var{readonly-data-section} respectively
6478 by default.  This can be overridden with the @code{section} attribute.
6479 @xref{Variable Attributes}.
6480
6481 @end table
6482
6483 @node ARM Options
6484 @subsection ARM Options
6485 @cindex ARM options
6486
6487 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6488 architectures:
6489
6490 @table @gcctabopt
6491 @item -mabi=@var{name}
6492 @opindex mabi
6493 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6494 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6495
6496 @item -mapcs-frame
6497 @opindex mapcs-frame
6498 Generate a stack frame that is compliant with the ARM Procedure Call
6499 Standard for all functions, even if this is not strictly necessary for
6500 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6501 with this option will cause the stack frames not to be generated for
6502 leaf functions.  The default is @option{-mno-apcs-frame}.
6503
6504 @item -mapcs
6505 @opindex mapcs
6506 This is a synonym for @option{-mapcs-frame}.
6507
6508 @ignore
6509 @c not currently implemented
6510 @item -mapcs-stack-check
6511 @opindex mapcs-stack-check
6512 Generate code to check the amount of stack space available upon entry to
6513 every function (that actually uses some stack space).  If there is
6514 insufficient space available then either the function
6515 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6516 called, depending upon the amount of stack space required.  The run time
6517 system is required to provide these functions.  The default is
6518 @option{-mno-apcs-stack-check}, since this produces smaller code.
6519
6520 @c not currently implemented
6521 @item -mapcs-float
6522 @opindex mapcs-float
6523 Pass floating point arguments using the float point registers.  This is
6524 one of the variants of the APCS@.  This option is recommended if the
6525 target hardware has a floating point unit or if a lot of floating point
6526 arithmetic is going to be performed by the code.  The default is
6527 @option{-mno-apcs-float}, since integer only code is slightly increased in
6528 size if @option{-mapcs-float} is used.
6529
6530 @c not currently implemented
6531 @item -mapcs-reentrant
6532 @opindex mapcs-reentrant
6533 Generate reentrant, position independent code.  The default is
6534 @option{-mno-apcs-reentrant}.
6535 @end ignore
6536
6537 @item -mthumb-interwork
6538 @opindex mthumb-interwork
6539 Generate code which supports calling between the ARM and Thumb
6540 instruction sets.  Without this option the two instruction sets cannot
6541 be reliably used inside one program.  The default is
6542 @option{-mno-thumb-interwork}, since slightly larger code is generated
6543 when @option{-mthumb-interwork} is specified.
6544
6545 @item -mno-sched-prolog
6546 @opindex mno-sched-prolog
6547 Prevent the reordering of instructions in the function prolog, or the
6548 merging of those instruction with the instructions in the function's
6549 body.  This means that all functions will start with a recognizable set
6550 of instructions (or in fact one of a choice from a small set of
6551 different function prologues), and this information can be used to
6552 locate the start if functions inside an executable piece of code.  The
6553 default is @option{-msched-prolog}.
6554
6555 @item -mhard-float
6556 @opindex mhard-float
6557 Generate output containing floating point instructions.  This is the
6558 default.
6559
6560 @item -msoft-float
6561 @opindex msoft-float
6562 Generate output containing library calls for floating point.
6563 @strong{Warning:} the requisite libraries are not available for all ARM
6564 targets.  Normally the facilities of the machine's usual C compiler are
6565 used, but this cannot be done directly in cross-compilation.  You must make
6566 your own arrangements to provide suitable library functions for
6567 cross-compilation.
6568
6569 @option{-msoft-float} changes the calling convention in the output file;
6570 therefore, it is only useful if you compile @emph{all} of a program with
6571 this option.  In particular, you need to compile @file{libgcc.a}, the
6572 library that comes with GCC, with @option{-msoft-float} in order for
6573 this to work.
6574
6575 @item -mfloat-abi=@var{name}
6576 @opindex mfloat-abi
6577 Specifies which ABI to use for floating point values.  Permissible values
6578 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6579
6580 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6581 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6582 of floating point instructions, but still uses the soft-float calling
6583 conventions.
6584
6585 @item -mlittle-endian
6586 @opindex mlittle-endian
6587 Generate code for a processor running in little-endian mode.  This is
6588 the default for all standard configurations.
6589
6590 @item -mbig-endian
6591 @opindex mbig-endian
6592 Generate code for a processor running in big-endian mode; the default is
6593 to compile code for a little-endian processor.
6594
6595 @item -mwords-little-endian
6596 @opindex mwords-little-endian
6597 This option only applies when generating code for big-endian processors.
6598 Generate code for a little-endian word order but a big-endian byte
6599 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6600 option should only be used if you require compatibility with code for
6601 big-endian ARM processors generated by versions of the compiler prior to
6602 2.8.
6603
6604 @item -mcpu=@var{name}
6605 @opindex mcpu
6606 This specifies the name of the target ARM processor.  GCC uses this name
6607 to determine what kind of instructions it can emit when generating
6608 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6609 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6610 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6611 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6612 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6613 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6614 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6615 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6616 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6617 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6618 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6619 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6620 @samp{arm1136j-s}, @samp{arm1136jf-s} ,@samp{xscale}, @samp{iwmmxt},
6621 @samp{ep9312}.
6622
6623 @itemx -mtune=@var{name}
6624 @opindex mtune
6625 This option is very similar to the @option{-mcpu=} option, except that
6626 instead of specifying the actual target processor type, and hence
6627 restricting which instructions can be used, it specifies that GCC should
6628 tune the performance of the code as if the target were of the type
6629 specified in this option, but still choosing the instructions that it
6630 will generate based on the cpu specified by a @option{-mcpu=} option.
6631 For some ARM implementations better performance can be obtained by using
6632 this option.
6633
6634 @item -march=@var{name}
6635 @opindex march
6636 This specifies the name of the target ARM architecture.  GCC uses this
6637 name to determine what kind of instructions it can emit when generating
6638 assembly code.  This option can be used in conjunction with or instead
6639 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6640 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6641 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6642 @samp{iwmmxt}, @samp{ep9312}.
6643
6644 @item -mfpu=@var{name}
6645 @itemx -mfpe=@var{number}
6646 @itemx -mfp=@var{number}
6647 @opindex mfpu
6648 @opindex mfpe
6649 @opindex mfp
6650 This specifies what floating point hardware (or hardware emulation) is
6651 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6652 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6653 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6654 with older versions of GCC@.
6655
6656 If @option{-msoft-float} is specified this specifies the format of
6657 floating point values.
6658
6659 @item -mstructure-size-boundary=@var{n}
6660 @opindex mstructure-size-boundary
6661 The size of all structures and unions will be rounded up to a multiple
6662 of the number of bits set by this option.  Permissible values are 8, 32
6663 and 64.  The default value varies for different toolchains.  For the COFF
6664 targeted toolchain the default value is 8.  A value of 64 is only allowed
6665 if the underlying ABI supports it.
6666
6667 Specifying the larger number can produce faster, more efficient code, but
6668 can also increase the size of the program.  Different values are potentially
6669 incompatible.  Code compiled with one value cannot necessarily expect to
6670 work with code or libraries compiled with another value, if they exchange
6671 information using structures or unions.
6672
6673 @item -mabort-on-noreturn
6674 @opindex mabort-on-noreturn
6675 Generate a call to the function @code{abort} at the end of a
6676 @code{noreturn} function.  It will be executed if the function tries to
6677 return.
6678
6679 @item -mlong-calls
6680 @itemx -mno-long-calls
6681 @opindex mlong-calls
6682 @opindex mno-long-calls
6683 Tells the compiler to perform function calls by first loading the
6684 address of the function into a register and then performing a subroutine
6685 call on this register.  This switch is needed if the target function
6686 will lie outside of the 64 megabyte addressing range of the offset based
6687 version of subroutine call instruction.
6688
6689 Even if this switch is enabled, not all function calls will be turned
6690 into long calls.  The heuristic is that static functions, functions
6691 which have the @samp{short-call} attribute, functions that are inside
6692 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6693 definitions have already been compiled within the current compilation
6694 unit, will not be turned into long calls.  The exception to this rule is
6695 that weak function definitions, functions with the @samp{long-call}
6696 attribute or the @samp{section} attribute, and functions that are within
6697 the scope of a @samp{#pragma long_calls} directive, will always be
6698 turned into long calls.
6699
6700 This feature is not enabled by default.  Specifying
6701 @option{-mno-long-calls} will restore the default behavior, as will
6702 placing the function calls within the scope of a @samp{#pragma
6703 long_calls_off} directive.  Note these switches have no effect on how
6704 the compiler generates code to handle function calls via function
6705 pointers.
6706
6707 @item -mnop-fun-dllimport
6708 @opindex mnop-fun-dllimport
6709 Disable support for the @code{dllimport} attribute.
6710
6711 @item -msingle-pic-base
6712 @opindex msingle-pic-base
6713 Treat the register used for PIC addressing as read-only, rather than
6714 loading it in the prologue for each function.  The run-time system is
6715 responsible for initializing this register with an appropriate value
6716 before execution begins.
6717
6718 @item -mpic-register=@var{reg}
6719 @opindex mpic-register
6720 Specify the register to be used for PIC addressing.  The default is R10
6721 unless stack-checking is enabled, when R9 is used.
6722
6723 @item -mcirrus-fix-invalid-insns
6724 @opindex mcirrus-fix-invalid-insns
6725 @opindex mno-cirrus-fix-invalid-insns
6726 Insert NOPs into the instruction stream to in order to work around
6727 problems with invalid Maverick instruction combinations.  This option
6728 is only valid if the @option{-mcpu=ep9312} option has been used to
6729 enable generation of instructions for the Cirrus Maverick floating
6730 point co-processor.  This option is not enabled by default, since the
6731 problem is only present in older Maverick implementations.  The default
6732 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6733 switch.
6734
6735 @item -mpoke-function-name
6736 @opindex mpoke-function-name
6737 Write the name of each function into the text section, directly
6738 preceding the function prologue.  The generated code is similar to this:
6739
6740 @smallexample
6741      t0
6742          .ascii "arm_poke_function_name", 0
6743          .align
6744      t1
6745          .word 0xff000000 + (t1 - t0)
6746      arm_poke_function_name
6747          mov     ip, sp
6748          stmfd   sp!, @{fp, ip, lr, pc@}
6749          sub     fp, ip, #4
6750 @end smallexample
6751
6752 When performing a stack backtrace, code can inspect the value of
6753 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6754 location @code{pc - 12} and the top 8 bits are set, then we know that
6755 there is a function name embedded immediately preceding this location
6756 and has length @code{((pc[-3]) & 0xff000000)}.
6757
6758 @item -mthumb
6759 @opindex mthumb
6760 Generate code for the 16-bit Thumb instruction set.  The default is to
6761 use the 32-bit ARM instruction set.
6762
6763 @item -mtpcs-frame
6764 @opindex mtpcs-frame
6765 Generate a stack frame that is compliant with the Thumb Procedure Call
6766 Standard for all non-leaf functions.  (A leaf function is one that does
6767 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6768
6769 @item -mtpcs-leaf-frame
6770 @opindex mtpcs-leaf-frame
6771 Generate a stack frame that is compliant with the Thumb Procedure Call
6772 Standard for all leaf functions.  (A leaf function is one that does
6773 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6774
6775 @item -mcallee-super-interworking
6776 @opindex mcallee-super-interworking
6777 Gives all externally visible functions in the file being compiled an ARM
6778 instruction set header which switches to Thumb mode before executing the
6779 rest of the function.  This allows these functions to be called from
6780 non-interworking code.
6781
6782 @item -mcaller-super-interworking
6783 @opindex mcaller-super-interworking
6784 Allows calls via function pointers (including virtual functions) to
6785 execute correctly regardless of whether the target code has been
6786 compiled for interworking or not.  There is a small overhead in the cost
6787 of executing a function pointer if this option is enabled.
6788
6789 @end table
6790
6791 @node AVR Options
6792 @subsection AVR Options
6793 @cindex AVR Options
6794
6795 These options are defined for AVR implementations:
6796
6797 @table @gcctabopt
6798 @item -mmcu=@var{mcu}
6799 @opindex mmcu
6800 Specify ATMEL AVR instruction set or MCU type.
6801
6802 Instruction set avr1 is for the minimal AVR core, not supported by the C
6803 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6804 attiny11, attiny12, attiny15, attiny28).
6805
6806 Instruction set avr2 (default) is for the classic AVR core with up to
6807 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6808 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6809 at90c8534, at90s8535).
6810
6811 Instruction set avr3 is for the classic AVR core with up to 128K program
6812 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6813
6814 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6815 memory space (MCU types: atmega8, atmega83, atmega85).
6816
6817 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6818 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6819 atmega64, atmega128, at43usb355, at94k).
6820
6821 @item -msize
6822 @opindex msize
6823 Output instruction sizes to the asm file.
6824
6825 @item -minit-stack=@var{N}
6826 @opindex minit-stack
6827 Specify the initial stack address, which may be a symbol or numeric value,
6828 @samp{__stack} is the default.
6829
6830 @item -mno-interrupts
6831 @opindex mno-interrupts
6832 Generated code is not compatible with hardware interrupts.
6833 Code size will be smaller.
6834
6835 @item -mcall-prologues
6836 @opindex mcall-prologues
6837 Functions prologues/epilogues expanded as call to appropriate
6838 subroutines.  Code size will be smaller.
6839
6840 @item -mno-tablejump
6841 @opindex mno-tablejump
6842 Do not generate tablejump insns which sometimes increase code size.
6843
6844 @item -mtiny-stack
6845 @opindex mtiny-stack
6846 Change only the low 8 bits of the stack pointer.
6847
6848 @item -mint8
6849 @opindex mint8
6850 Assume int to be 8 bit integer. This affects the sizes of all types: A
6851 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
6852 and long long will be 4 bytes. Please note that this option does not
6853 comply to the C standards, but it will provide you with smaller code
6854 size.
6855 @end table
6856
6857 @node CRIS Options
6858 @subsection CRIS Options
6859 @cindex CRIS Options
6860
6861 These options are defined specifically for the CRIS ports.
6862
6863 @table @gcctabopt
6864 @item -march=@var{architecture-type}
6865 @itemx -mcpu=@var{architecture-type}
6866 @opindex march
6867 @opindex mcpu
6868 Generate code for the specified architecture.  The choices for
6869 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
6870 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
6871 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
6872 @samp{v10}.
6873
6874 @item -mtune=@var{architecture-type}
6875 @opindex mtune
6876 Tune to @var{architecture-type} everything applicable about the generated
6877 code, except for the ABI and the set of available instructions.  The
6878 choices for @var{architecture-type} are the same as for
6879 @option{-march=@var{architecture-type}}.
6880
6881 @item -mmax-stack-frame=@var{n}
6882 @opindex mmax-stack-frame
6883 Warn when the stack frame of a function exceeds @var{n} bytes.
6884
6885 @item -melinux-stacksize=@var{n}
6886 @opindex melinux-stacksize
6887 Only available with the @samp{cris-axis-aout} target.  Arranges for
6888 indications in the program to the kernel loader that the stack of the
6889 program should be set to @var{n} bytes.
6890
6891 @item -metrax4
6892 @itemx -metrax100
6893 @opindex metrax4
6894 @opindex metrax100
6895 The options @option{-metrax4} and @option{-metrax100} are synonyms for
6896 @option{-march=v3} and @option{-march=v8} respectively.
6897
6898 @item -mmul-bug-workaround
6899 @itemx -mno-mul-bug-workaround
6900 @opindex mmul-bug-workaround
6901 @opindex mno-mul-bug-workaround
6902 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
6903 models where it applies.  This option is active by default.
6904
6905 @item -mpdebug
6906 @opindex mpdebug
6907 Enable CRIS-specific verbose debug-related information in the assembly
6908 code.  This option also has the effect to turn off the @samp{#NO_APP}
6909 formatted-code indicator to the assembler at the beginning of the
6910 assembly file.
6911
6912 @item -mcc-init
6913 @opindex mcc-init
6914 Do not use condition-code results from previous instruction; always emit
6915 compare and test instructions before use of condition codes.
6916
6917 @item -mno-side-effects
6918 @opindex mno-side-effects
6919 Do not emit instructions with side-effects in addressing modes other than
6920 post-increment.
6921
6922 @item -mstack-align
6923 @itemx -mno-stack-align
6924 @itemx -mdata-align
6925 @itemx -mno-data-align
6926 @itemx -mconst-align
6927 @itemx -mno-const-align
6928 @opindex mstack-align
6929 @opindex mno-stack-align
6930 @opindex mdata-align
6931 @opindex mno-data-align
6932 @opindex mconst-align
6933 @opindex mno-const-align
6934 These options (no-options) arranges (eliminate arrangements) for the
6935 stack-frame, individual data and constants to be aligned for the maximum
6936 single data access size for the chosen CPU model.  The default is to
6937 arrange for 32-bit alignment.  ABI details such as structure layout are
6938 not affected by these options.
6939
6940 @item -m32-bit
6941 @itemx -m16-bit
6942 @itemx -m8-bit
6943 @opindex m32-bit
6944 @opindex m16-bit
6945 @opindex m8-bit
6946 Similar to the stack- data- and const-align options above, these options
6947 arrange for stack-frame, writable data and constants to all be 32-bit,
6948 16-bit or 8-bit aligned.  The default is 32-bit alignment.
6949
6950 @item -mno-prologue-epilogue
6951 @itemx -mprologue-epilogue
6952 @opindex mno-prologue-epilogue
6953 @opindex mprologue-epilogue
6954 With @option{-mno-prologue-epilogue}, the normal function prologue and
6955 epilogue that sets up the stack-frame are omitted and no return
6956 instructions or return sequences are generated in the code.  Use this
6957 option only together with visual inspection of the compiled code: no
6958 warnings or errors are generated when call-saved registers must be saved,
6959 or storage for local variable needs to be allocated.
6960
6961 @item -mno-gotplt
6962 @itemx -mgotplt
6963 @opindex mno-gotplt
6964 @opindex mgotplt
6965 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
6966 instruction sequences that load addresses for functions from the PLT part
6967 of the GOT rather than (traditional on other architectures) calls to the
6968 PLT.  The default is @option{-mgotplt}.
6969
6970 @item -maout
6971 @opindex maout
6972 Legacy no-op option only recognized with the cris-axis-aout target.
6973
6974 @item -melf
6975 @opindex melf
6976 Legacy no-op option only recognized with the cris-axis-elf and
6977 cris-axis-linux-gnu targets.
6978
6979 @item -melinux
6980 @opindex melinux
6981 Only recognized with the cris-axis-aout target, where it selects a
6982 GNU/linux-like multilib, include files and instruction set for
6983 @option{-march=v8}.
6984
6985 @item -mlinux
6986 @opindex mlinux
6987 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
6988
6989 @item -sim
6990 @opindex sim
6991 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
6992 to link with input-output functions from a simulator library.  Code,
6993 initialized data and zero-initialized data are allocated consecutively.
6994
6995 @item -sim2
6996 @opindex sim2
6997 Like @option{-sim}, but pass linker options to locate initialized data at
6998 0x40000000 and zero-initialized data at 0x80000000.
6999 @end table
7000
7001 @node Darwin Options
7002 @subsection Darwin Options
7003 @cindex Darwin options
7004
7005 These options are defined for all architectures running the Darwin operating
7006 system.  They are useful for compatibility with other Mac OS compilers.
7007
7008 @table @gcctabopt
7009 @item -F@var{dir}
7010 @opindex F
7011 Add the framework directory @var{dir} to the head of the list of
7012 directories to be searched for header files.  These directories are
7013 interleaved with those specified by @option{-I} options and are
7014 scanned in a left-to-right order.
7015
7016 A framework directory is a directory with frameworks in it.  A
7017 framework is a directory with a @samp{"Headers"} and/or
7018 @samp{"PrivateHeaders"} directory contained directly in it that ends
7019 in @samp{".framework"}.  The name of a framework is the name of this
7020 directory excluding the @samp{".framework"}.  Headers associated with
7021 the framework are found in one of those two directories, with
7022 @samp{"Headers"} being searched first.  A subframework is a framework
7023 directory that is in a framework's @samp{"Frameworks"} directory.
7024 Includes of subframework headers can only appear in a header of a
7025 framework that contains the subframework, or in a sibling subframework
7026 header.  Two subframeworks are siblings if they occur in the same
7027 framework.  A subframework should not have the same name as a
7028 framework, a warning will be issued if this is violated.  Currently a
7029 subframework cannot have subframeworks, in the future, the mechanism
7030 may be extended to support this.  The standard frameworks can be found
7031 in @samp{"/System/Library/Frameworks"} and
7032 @samp{"/Library/Frameworks"}.  An example include looks like
7033 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7034 the name of the framework and header.h is found in the
7035 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7036
7037 @item -gused
7038 @opindex -gused
7039 Emit debugging information for symbols that are used. For STABS
7040 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7041 This is by default ON.
7042
7043 @item -gfull
7044 @opindex -gfull
7045 Emit debugging information for all symbols and types.
7046
7047 @item -mone-byte-bool
7048 @opindex -mone-byte-bool
7049 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7050 By default @samp{sizeof(bool)} is @samp{4} when compiling for 
7051 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7052 option has no effect on x86.
7053
7054 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7055 to generate code that is not binary compatible with code generated
7056 without that switch.  Using this switch may require recompiling all
7057 other modules in a program, including system libraries.  Use this 
7058 switch to conform to a non-default data model.
7059
7060 @item -mfix-and-continue
7061 @itemx -ffix-and-continue
7062 @itemx -findirect-data
7063 @opindex mfix-and-continue
7064 @opindex ffix-and-continue
7065 @opindex findirect-data
7066 Generate code suitable for fast turn around development.  Needed to
7067 enable gdb to dynamically load @code{.o} files into already running
7068 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7069 are provided for backwards compatibility.
7070
7071 @item -all_load
7072 @opindex all_load
7073 Loads all members of static archive libraries.
7074 See man ld(1) for more information.
7075
7076 @item -arch_errors_fatal
7077 @opindex arch_errors_fatal
7078 Cause the errors having to do with files that have the wrong architecture
7079 to be fatal.
7080
7081 @item -bind_at_load
7082 @opindex bind_at_load
7083 Causes the output file to be marked such that the dynamic linker will
7084 bind all undefined references when the file is loaded or launched.
7085
7086 @item -bundle
7087 @opindex bundle
7088 Produce a Mach-o bundle format file.
7089 See man ld(1) for more information.
7090
7091 @item -bundle_loader @var{executable}
7092 @opindex bundle_loader
7093 This specifies the @var{executable} that will be loading the build
7094 output file being linked. See man ld(1) for more information.
7095
7096 @item -allowable_client  @var{client_name}
7097 @itemx -arch_only
7098
7099 @itemx -client_name
7100 @itemx -compatibility_version
7101 @itemx -current_version
7102 @itemx -dead_strip
7103 @itemx -dependency-file
7104 @itemx -dylib_file
7105 @itemx -dylinker_install_name
7106 @itemx -dynamic
7107 @itemx -dynamiclib
7108 @itemx -exported_symbols_list
7109 @itemx -filelist
7110 @itemx -flat_namespace
7111 @itemx -force_cpusubtype_ALL
7112 @itemx -force_flat_namespace
7113 @itemx -headerpad_max_install_names
7114 @itemx -image_base
7115 @itemx -init
7116 @itemx -install_name
7117 @itemx -keep_private_externs
7118 @itemx -multi_module
7119 @itemx -multiply_defined
7120 @itemx -multiply_defined_unused
7121 @itemx -noall_load
7122 @itemx -no_dead_strip_inits_and_terms
7123 @itemx -nofixprebinding
7124 @itemx -nomultidefs
7125 @itemx -noprebind
7126 @itemx -noseglinkedit
7127 @itemx -pagezero_size
7128 @itemx -prebind
7129 @itemx -prebind_all_twolevel_modules
7130 @itemx -private_bundle
7131 @itemx -read_only_relocs
7132 @itemx -sectalign
7133 @itemx -sectobjectsymbols
7134 @itemx -whyload
7135 @itemx -seg1addr
7136 @itemx -sectcreate
7137 @itemx -sectobjectsymbols
7138 @itemx -sectorder
7139 @itemx -seg_addr_table
7140 @itemx -seg_addr_table_filename
7141 @itemx -seglinkedit
7142 @itemx -segprot
7143 @itemx -segs_read_only_addr
7144 @itemx -segs_read_write_addr
7145 @itemx -single_module
7146 @itemx -static
7147 @itemx -sub_library
7148 @itemx -sub_umbrella
7149 @itemx -twolevel_namespace
7150 @itemx -umbrella
7151 @itemx -undefined
7152 @itemx -unexported_symbols_list
7153 @itemx -weak_reference_mismatches
7154 @itemx -whatsloaded
7155
7156 @opindex allowable_client
7157 @opindex arch_only
7158 @opindex client_name
7159 @opindex compatibility_version
7160 @opindex current_version
7161 @opindex dead_strip
7162 @opindex dependency-file
7163 @opindex dylib_file
7164 @opindex dylinker_install_name
7165 @opindex dynamic
7166 @opindex dynamiclib
7167 @opindex exported_symbols_list
7168 @opindex filelist
7169 @opindex flat_namespace
7170 @opindex force_cpusubtype_ALL
7171 @opindex force_flat_namespace
7172 @opindex headerpad_max_install_names
7173 @opindex image_base
7174 @opindex init
7175 @opindex install_name
7176 @opindex keep_private_externs
7177 @opindex multi_module
7178 @opindex multiply_defined
7179 @opindex multiply_defined_unused
7180 @opindex noall_load
7181 @opindex no_dead_strip_inits_and_terms
7182 @opindex nofixprebinding
7183 @opindex nomultidefs
7184 @opindex noprebind
7185 @opindex noseglinkedit
7186 @opindex pagezero_size
7187 @opindex prebind
7188 @opindex prebind_all_twolevel_modules
7189 @opindex private_bundle
7190 @opindex read_only_relocs
7191 @opindex sectalign
7192 @opindex sectobjectsymbols
7193 @opindex whyload
7194 @opindex seg1addr
7195 @opindex sectcreate
7196 @opindex sectobjectsymbols
7197 @opindex sectorder
7198 @opindex seg_addr_table
7199 @opindex seg_addr_table_filename
7200 @opindex seglinkedit
7201 @opindex segprot
7202 @opindex segs_read_only_addr
7203 @opindex segs_read_write_addr
7204 @opindex single_module
7205 @opindex static
7206 @opindex sub_library
7207 @opindex sub_umbrella
7208 @opindex twolevel_namespace
7209 @opindex umbrella
7210 @opindex undefined
7211 @opindex unexported_symbols_list
7212 @opindex weak_reference_mismatches
7213 @opindex whatsloaded
7214
7215 These options are available for Darwin linker. Darwin linker man page
7216 describes them in detail.
7217 @end table
7218
7219 @node DEC Alpha Options
7220 @subsection DEC Alpha Options
7221
7222 These @samp{-m} options are defined for the DEC Alpha implementations:
7223
7224 @table @gcctabopt
7225 @item -mno-soft-float
7226 @itemx -msoft-float
7227 @opindex mno-soft-float
7228 @opindex msoft-float
7229 Use (do not use) the hardware floating-point instructions for
7230 floating-point operations.  When @option{-msoft-float} is specified,
7231 functions in @file{libgcc.a} will be used to perform floating-point
7232 operations.  Unless they are replaced by routines that emulate the
7233 floating-point operations, or compiled in such a way as to call such
7234 emulations routines, these routines will issue floating-point
7235 operations.   If you are compiling for an Alpha without floating-point
7236 operations, you must ensure that the library is built so as not to call
7237 them.
7238
7239 Note that Alpha implementations without floating-point operations are
7240 required to have floating-point registers.
7241
7242 @item -mfp-reg
7243 @itemx -mno-fp-regs
7244 @opindex mfp-reg
7245 @opindex mno-fp-regs
7246 Generate code that uses (does not use) the floating-point register set.
7247 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7248 register set is not used, floating point operands are passed in integer
7249 registers as if they were integers and floating-point results are passed
7250 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7251 so any function with a floating-point argument or return value called by code
7252 compiled with @option{-mno-fp-regs} must also be compiled with that
7253 option.
7254
7255 A typical use of this option is building a kernel that does not use,
7256 and hence need not save and restore, any floating-point registers.
7257
7258 @item -mieee
7259 @opindex mieee
7260 The Alpha architecture implements floating-point hardware optimized for
7261 maximum performance.  It is mostly compliant with the IEEE floating
7262 point standard.  However, for full compliance, software assistance is
7263 required.  This option generates code fully IEEE compliant code
7264 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7265 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7266 defined during compilation.  The resulting code is less efficient but is
7267 able to correctly support denormalized numbers and exceptional IEEE
7268 values such as not-a-number and plus/minus infinity.  Other Alpha
7269 compilers call this option @option{-ieee_with_no_inexact}.
7270
7271 @item -mieee-with-inexact
7272 @opindex mieee-with-inexact
7273 This is like @option{-mieee} except the generated code also maintains
7274 the IEEE @var{inexact-flag}.  Turning on this option causes the
7275 generated code to implement fully-compliant IEEE math.  In addition to
7276 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7277 macro.  On some Alpha implementations the resulting code may execute
7278 significantly slower than the code generated by default.  Since there is
7279 very little code that depends on the @var{inexact-flag}, you should
7280 normally not specify this option.  Other Alpha compilers call this
7281 option @option{-ieee_with_inexact}.
7282
7283 @item -mfp-trap-mode=@var{trap-mode}
7284 @opindex mfp-trap-mode
7285 This option controls what floating-point related traps are enabled.
7286 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7287 The trap mode can be set to one of four values:
7288
7289 @table @samp
7290 @item n
7291 This is the default (normal) setting.  The only traps that are enabled
7292 are the ones that cannot be disabled in software (e.g., division by zero
7293 trap).
7294
7295 @item u
7296 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7297 as well.
7298
7299 @item su
7300 Like @samp{su}, but the instructions are marked to be safe for software
7301 completion (see Alpha architecture manual for details).
7302
7303 @item sui
7304 Like @samp{su}, but inexact traps are enabled as well.
7305 @end table
7306
7307 @item -mfp-rounding-mode=@var{rounding-mode}
7308 @opindex mfp-rounding-mode
7309 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7310 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7311 of:
7312
7313 @table @samp
7314 @item n
7315 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7316 the nearest machine number or towards the even machine number in case
7317 of a tie.
7318
7319 @item m
7320 Round towards minus infinity.
7321
7322 @item c
7323 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7324
7325 @item d
7326 Dynamic rounding mode.  A field in the floating point control register
7327 (@var{fpcr}, see Alpha architecture reference manual) controls the
7328 rounding mode in effect.  The C library initializes this register for
7329 rounding towards plus infinity.  Thus, unless your program modifies the
7330 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7331 @end table
7332
7333 @item -mtrap-precision=@var{trap-precision}
7334 @opindex mtrap-precision
7335 In the Alpha architecture, floating point traps are imprecise.  This
7336 means without software assistance it is impossible to recover from a
7337 floating trap and program execution normally needs to be terminated.
7338 GCC can generate code that can assist operating system trap handlers
7339 in determining the exact location that caused a floating point trap.
7340 Depending on the requirements of an application, different levels of
7341 precisions can be selected:
7342
7343 @table @samp
7344 @item p
7345 Program precision.  This option is the default and means a trap handler
7346 can only identify which program caused a floating point exception.
7347
7348 @item f
7349 Function precision.  The trap handler can determine the function that
7350 caused a floating point exception.
7351
7352 @item i
7353 Instruction precision.  The trap handler can determine the exact
7354 instruction that caused a floating point exception.
7355 @end table
7356
7357 Other Alpha compilers provide the equivalent options called
7358 @option{-scope_safe} and @option{-resumption_safe}.
7359
7360 @item -mieee-conformant
7361 @opindex mieee-conformant
7362 This option marks the generated code as IEEE conformant.  You must not
7363 use this option unless you also specify @option{-mtrap-precision=i} and either
7364 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7365 is to emit the line @samp{.eflag 48} in the function prologue of the
7366 generated assembly file.  Under DEC Unix, this has the effect that
7367 IEEE-conformant math library routines will be linked in.
7368
7369 @item -mbuild-constants
7370 @opindex mbuild-constants
7371 Normally GCC examines a 32- or 64-bit integer constant to
7372 see if it can construct it from smaller constants in two or three
7373 instructions.  If it cannot, it will output the constant as a literal and
7374 generate code to load it from the data segment at runtime.
7375
7376 Use this option to require GCC to construct @emph{all} integer constants
7377 using code, even if it takes more instructions (the maximum is six).
7378
7379 You would typically use this option to build a shared library dynamic
7380 loader.  Itself a shared library, it must relocate itself in memory
7381 before it can find the variables and constants in its own data segment.
7382
7383 @item -malpha-as
7384 @itemx -mgas
7385 @opindex malpha-as
7386 @opindex mgas
7387 Select whether to generate code to be assembled by the vendor-supplied
7388 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7389
7390 @item -mbwx
7391 @itemx -mno-bwx
7392 @itemx -mcix
7393 @itemx -mno-cix
7394 @itemx -mfix
7395 @itemx -mno-fix
7396 @itemx -mmax
7397 @itemx -mno-max
7398 @opindex mbwx
7399 @opindex mno-bwx
7400 @opindex mcix
7401 @opindex mno-cix
7402 @opindex mfix
7403 @opindex mno-fix
7404 @opindex mmax
7405 @opindex mno-max
7406 Indicate whether GCC should generate code to use the optional BWX,
7407 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7408 sets supported by the CPU type specified via @option{-mcpu=} option or that
7409 of the CPU on which GCC was built if none was specified.
7410
7411 @item -mfloat-vax
7412 @itemx -mfloat-ieee
7413 @opindex mfloat-vax
7414 @opindex mfloat-ieee
7415 Generate code that uses (does not use) VAX F and G floating point
7416 arithmetic instead of IEEE single and double precision.
7417
7418 @item -mexplicit-relocs
7419 @itemx -mno-explicit-relocs
7420 @opindex mexplicit-relocs
7421 @opindex mno-explicit-relocs
7422 Older Alpha assemblers provided no way to generate symbol relocations
7423 except via assembler macros.  Use of these macros does not allow
7424 optimal instruction scheduling.  GNU binutils as of version 2.12
7425 supports a new syntax that allows the compiler to explicitly mark
7426 which relocations should apply to which instructions.  This option
7427 is mostly useful for debugging, as GCC detects the capabilities of
7428 the assembler when it is built and sets the default accordingly.
7429
7430 @item -msmall-data
7431 @itemx -mlarge-data
7432 @opindex msmall-data
7433 @opindex mlarge-data
7434 When @option{-mexplicit-relocs} is in effect, static data is
7435 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7436 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7437 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7438 16-bit relocations off of the @code{$gp} register.  This limits the
7439 size of the small data area to 64KB, but allows the variables to be
7440 directly accessed via a single instruction.
7441
7442 The default is @option{-mlarge-data}.  With this option the data area
7443 is limited to just below 2GB.  Programs that require more than 2GB of
7444 data must use @code{malloc} or @code{mmap} to allocate the data in the
7445 heap instead of in the program's data segment.
7446
7447 When generating code for shared libraries, @option{-fpic} implies
7448 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7449
7450 @item -msmall-text
7451 @itemx -mlarge-text
7452 @opindex msmall-text
7453 @opindex mlarge-text
7454 When @option{-msmall-text} is used, the compiler assumes that the
7455 code of the entire program (or shared library) fits in 4MB, and is
7456 thus reachable with a branch instruction.  When @option{-msmall-data}
7457 is used, the compiler can assume that all local symbols share the
7458 same @code{$gp} value, and thus reduce the number of instructions
7459 required for a function call from 4 to 1.
7460
7461 The default is @option{-mlarge-text}.
7462
7463 @item -mcpu=@var{cpu_type}
7464 @opindex mcpu
7465 Set the instruction set and instruction scheduling parameters for
7466 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7467 style name or the corresponding chip number.  GCC supports scheduling
7468 parameters for the EV4, EV5 and EV6 family of processors and will
7469 choose the default values for the instruction set from the processor
7470 you specify.  If you do not specify a processor type, GCC will default
7471 to the processor on which the compiler was built.
7472
7473 Supported values for @var{cpu_type} are
7474
7475 @table @samp
7476 @item ev4
7477 @itemx ev45
7478 @itemx 21064
7479 Schedules as an EV4 and has no instruction set extensions.
7480
7481 @item ev5
7482 @itemx 21164
7483 Schedules as an EV5 and has no instruction set extensions.
7484
7485 @item ev56
7486 @itemx 21164a
7487 Schedules as an EV5 and supports the BWX extension.
7488
7489 @item pca56
7490 @itemx 21164pc
7491 @itemx 21164PC
7492 Schedules as an EV5 and supports the BWX and MAX extensions.
7493
7494 @item ev6
7495 @itemx 21264
7496 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7497
7498 @item ev67
7499 @itemx 21264a
7500 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7501 @end table
7502
7503 @item -mtune=@var{cpu_type}
7504 @opindex mtune
7505 Set only the instruction scheduling parameters for machine type
7506 @var{cpu_type}.  The instruction set is not changed.
7507
7508 @item -mmemory-latency=@var{time}
7509 @opindex mmemory-latency
7510 Sets the latency the scheduler should assume for typical memory
7511 references as seen by the application.  This number is highly
7512 dependent on the memory access patterns used by the application
7513 and the size of the external cache on the machine.
7514
7515 Valid options for @var{time} are
7516
7517 @table @samp
7518 @item @var{number}
7519 A decimal number representing clock cycles.
7520
7521 @item L1
7522 @itemx L2
7523 @itemx L3
7524 @itemx main
7525 The compiler contains estimates of the number of clock cycles for
7526 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7527 (also called Dcache, Scache, and Bcache), as well as to main memory.
7528 Note that L3 is only valid for EV5.
7529
7530 @end table
7531 @end table
7532
7533 @node DEC Alpha/VMS Options
7534 @subsection DEC Alpha/VMS Options
7535
7536 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7537
7538 @table @gcctabopt
7539 @item -mvms-return-codes
7540 @opindex mvms-return-codes
7541 Return VMS condition codes from main.  The default is to return POSIX
7542 style condition (e.g.@ error) codes.
7543 @end table
7544
7545 @node FRV Options
7546 @subsection FRV Options
7547 @cindex FRV Options
7548
7549 @table @gcctabopt
7550 @item -mgpr-32
7551 @opindex mgpr-32
7552
7553 Only use the first 32 general purpose registers.
7554
7555 @item -mgpr-64
7556 @opindex mgpr-64
7557
7558 Use all 64 general purpose registers.
7559
7560 @item -mfpr-32
7561 @opindex mfpr-32
7562
7563 Use only the first 32 floating point registers.
7564
7565 @item -mfpr-64
7566 @opindex mfpr-64
7567
7568 Use all 64 floating point registers
7569
7570 @item -mhard-float
7571 @opindex mhard-float
7572
7573 Use hardware instructions for floating point operations.
7574
7575 @item -msoft-float
7576 @opindex msoft-float
7577
7578 Use library routines for floating point operations.
7579
7580 @item -malloc-cc
7581 @opindex malloc-cc
7582
7583 Dynamically allocate condition code registers.
7584
7585 @item -mfixed-cc
7586 @opindex mfixed-cc
7587
7588 Do not try to dynamically allocate condition code registers, only
7589 use @code{icc0} and @code{fcc0}.
7590
7591 @item -mdword
7592 @opindex mdword
7593
7594 Change ABI to use double word insns.
7595
7596 @item -mno-dword
7597 @opindex mno-dword
7598
7599 Do not use double word instructions.
7600
7601 @item -mdouble
7602 @opindex mdouble
7603
7604 Use floating point double instructions.
7605
7606 @item -mno-double
7607 @opindex mno-double
7608
7609 Do not use floating point double instructions.
7610
7611 @item -mmedia
7612 @opindex mmedia
7613
7614 Use media instructions.
7615
7616 @item -mno-media
7617 @opindex mno-media
7618
7619 Do not use media instructions.
7620
7621 @item -mmuladd
7622 @opindex mmuladd
7623
7624 Use multiply and add/subtract instructions.
7625
7626 @item -mno-muladd
7627 @opindex mno-muladd
7628
7629 Do not use multiply and add/subtract instructions.
7630
7631 @item -mfdpic
7632 @opindex mfdpic
7633
7634 Select the FDPIC ABI, that uses function descriptors to represent
7635 pointers to functions.  Without any PIC/PIE-related options, it
7636 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7637 assumes GOT entries and small data are within a 12-bit range from the
7638 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7639 are computed with 32 bits.
7640
7641 @item -minline-plt
7642 @opindex minline-plt
7643
7644 Enable inlining of PLT entries in function calls to functions that are
7645 not known to bind locally.  It has no effect without @option{-mfdpic}.
7646 It's enabled by default if optimizing for speed and compiling for
7647 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7648 optimization option such as @option{-O3} or above is present in the
7649 command line.
7650
7651 @item -mgprel-ro
7652 @opindex mgprel-ro
7653
7654 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7655 that is known to be in read-only sections.  It's enabled by default,
7656 except for @option{-fpic} or @option{-fpie}: even though it may help
7657 make the global offset table smaller, it trades 1 instruction for 4.
7658 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7659 one of which may be shared by multiple symbols, and it avoids the need
7660 for a GOT entry for the referenced symbol, so it's more likely to be a
7661 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7662
7663 @item -multilib-library-pic
7664 @opindex multilib-library-pic
7665
7666 Link with the (library, not FD) pic libraries.  It's implied by
7667 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7668 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7669 it explicitly.
7670
7671 @item -mlinked-fp
7672 @opindex mlinked-fp
7673
7674 Follow the EABI requirement of always creating a frame pointer whenever
7675 a stack frame is allocated.  This option is enabled by default and can
7676 be disabled with @option{-mno-linked-fp}.
7677
7678 @item -mlibrary-pic
7679 @opindex mlibrary-pic
7680
7681 Generate position-independent EABI code.
7682
7683 @item -macc-4
7684 @opindex macc-4
7685
7686 Use only the first four media accumulator registers.
7687
7688 @item -macc-8
7689 @opindex macc-8
7690
7691 Use all eight media accumulator registers.
7692
7693 @item -mpack
7694 @opindex mpack
7695
7696 Pack VLIW instructions.
7697
7698 @item -mno-pack
7699 @opindex mno-pack
7700
7701 Do not pack VLIW instructions.
7702
7703 @item -mno-eflags
7704 @opindex mno-eflags
7705
7706 Do not mark ABI switches in e_flags.
7707
7708 @item -mcond-move
7709 @opindex mcond-move
7710
7711 Enable the use of conditional-move instructions (default).
7712
7713 This switch is mainly for debugging the compiler and will likely be removed
7714 in a future version.
7715
7716 @item -mno-cond-move
7717 @opindex mno-cond-move
7718
7719 Disable the use of conditional-move instructions.
7720
7721 This switch is mainly for debugging the compiler and will likely be removed
7722 in a future version.
7723
7724 @item -mscc
7725 @opindex mscc
7726
7727 Enable the use of conditional set instructions (default).
7728
7729 This switch is mainly for debugging the compiler and will likely be removed
7730 in a future version.
7731
7732 @item -mno-scc
7733 @opindex mno-scc
7734
7735 Disable the use of conditional set instructions.
7736
7737 This switch is mainly for debugging the compiler and will likely be removed
7738 in a future version.
7739
7740 @item -mcond-exec
7741 @opindex mcond-exec
7742
7743 Enable the use of conditional execution (default).
7744
7745 This switch is mainly for debugging the compiler and will likely be removed
7746 in a future version.
7747
7748 @item -mno-cond-exec
7749 @opindex mno-cond-exec
7750
7751 Disable the use of conditional execution.
7752
7753 This switch is mainly for debugging the compiler and will likely be removed
7754 in a future version.
7755
7756 @item -mvliw-branch
7757 @opindex mvliw-branch
7758
7759 Run a pass to pack branches into VLIW instructions (default).
7760
7761 This switch is mainly for debugging the compiler and will likely be removed
7762 in a future version.
7763
7764 @item -mno-vliw-branch
7765 @opindex mno-vliw-branch
7766
7767 Do not run a pass to pack branches into VLIW instructions.
7768
7769 This switch is mainly for debugging the compiler and will likely be removed
7770 in a future version.
7771
7772 @item -mmulti-cond-exec
7773 @opindex mmulti-cond-exec
7774
7775 Enable optimization of @code{&&} and @code{||} in conditional execution
7776 (default).
7777
7778 This switch is mainly for debugging the compiler and will likely be removed
7779 in a future version.
7780
7781 @item -mno-multi-cond-exec
7782 @opindex mno-multi-cond-exec
7783
7784 Disable optimization of @code{&&} and @code{||} in conditional execution.
7785
7786 This switch is mainly for debugging the compiler and will likely be removed
7787 in a future version.
7788
7789 @item -mnested-cond-exec
7790 @opindex mnested-cond-exec
7791
7792 Enable nested conditional execution optimizations (default).
7793
7794 This switch is mainly for debugging the compiler and will likely be removed
7795 in a future version.
7796
7797 @item -mno-nested-cond-exec
7798 @opindex mno-nested-cond-exec
7799
7800 Disable nested conditional execution optimizations.
7801
7802 This switch is mainly for debugging the compiler and will likely be removed
7803 in a future version.
7804
7805 @item -mtomcat-stats
7806 @opindex mtomcat-stats
7807
7808 Cause gas to print out tomcat statistics.
7809
7810 @item -mcpu=@var{cpu}
7811 @opindex mcpu
7812
7813 Select the processor type for which to generate code.  Possible values are
7814 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
7815 @samp{frv}.
7816
7817 @end table
7818
7819 @node H8/300 Options
7820 @subsection H8/300 Options
7821
7822 These @samp{-m} options are defined for the H8/300 implementations:
7823
7824 @table @gcctabopt
7825 @item -mrelax
7826 @opindex mrelax
7827 Shorten some address references at link time, when possible; uses the
7828 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7829 ld, Using ld}, for a fuller description.
7830
7831 @item -mh
7832 @opindex mh
7833 Generate code for the H8/300H@.
7834
7835 @item -ms
7836 @opindex ms
7837 Generate code for the H8S@.
7838
7839 @item -mn
7840 @opindex mn
7841 Generate code for the H8S and H8/300H in the normal mode.  This switch
7842 must be used either with -mh or -ms.
7843
7844 @item -ms2600
7845 @opindex ms2600
7846 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
7847
7848 @item -mint32
7849 @opindex mint32
7850 Make @code{int} data 32 bits by default.
7851
7852 @item -malign-300
7853 @opindex malign-300
7854 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
7855 The default for the H8/300H and H8S is to align longs and floats on 4
7856 byte boundaries.
7857 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
7858 This option has no effect on the H8/300.
7859 @end table
7860
7861 @node HPPA Options
7862 @subsection HPPA Options
7863 @cindex HPPA Options
7864
7865 These @samp{-m} options are defined for the HPPA family of computers:
7866
7867 @table @gcctabopt
7868 @item -march=@var{architecture-type}
7869 @opindex march
7870 Generate code for the specified architecture.  The choices for
7871 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7872 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7873 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7874 architecture option for your machine.  Code compiled for lower numbered
7875 architectures will run on higher numbered architectures, but not the
7876 other way around.
7877
7878 @item -mpa-risc-1-0
7879 @itemx -mpa-risc-1-1
7880 @itemx -mpa-risc-2-0
7881 @opindex mpa-risc-1-0
7882 @opindex mpa-risc-1-1
7883 @opindex mpa-risc-2-0
7884 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7885
7886 @item -mbig-switch
7887 @opindex mbig-switch
7888 Generate code suitable for big switch tables.  Use this option only if
7889 the assembler/linker complain about out of range branches within a switch
7890 table.
7891
7892 @item -mjump-in-delay
7893 @opindex mjump-in-delay
7894 Fill delay slots of function calls with unconditional jump instructions
7895 by modifying the return pointer for the function call to be the target
7896 of the conditional jump.
7897
7898 @item -mdisable-fpregs
7899 @opindex mdisable-fpregs
7900 Prevent floating point registers from being used in any manner.  This is
7901 necessary for compiling kernels which perform lazy context switching of
7902 floating point registers.  If you use this option and attempt to perform
7903 floating point operations, the compiler will abort.
7904
7905 @item -mdisable-indexing
7906 @opindex mdisable-indexing
7907 Prevent the compiler from using indexing address modes.  This avoids some
7908 rather obscure problems when compiling MIG generated code under MACH@.
7909
7910 @item -mno-space-regs
7911 @opindex mno-space-regs
7912 Generate code that assumes the target has no space registers.  This allows
7913 GCC to generate faster indirect calls and use unscaled index address modes.
7914
7915 Such code is suitable for level 0 PA systems and kernels.
7916
7917 @item -mfast-indirect-calls
7918 @opindex mfast-indirect-calls
7919 Generate code that assumes calls never cross space boundaries.  This
7920 allows GCC to emit code which performs faster indirect calls.
7921
7922 This option will not work in the presence of shared libraries or nested
7923 functions.
7924
7925 @item -mfixed-range=@var{register-range}
7926 @opindex mfixed-range
7927 Generate code treating the given register range as fixed registers.
7928 A fixed register is one that the register allocator can not use.  This is
7929 useful when compiling kernel code.  A register range is specified as
7930 two registers separated by a dash.  Multiple register ranges can be
7931 specified separated by a comma.
7932
7933 @item -mlong-load-store
7934 @opindex mlong-load-store
7935 Generate 3-instruction load and store sequences as sometimes required by
7936 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7937 the HP compilers.
7938
7939 @item -mportable-runtime
7940 @opindex mportable-runtime
7941 Use the portable calling conventions proposed by HP for ELF systems.
7942
7943 @item -mgas
7944 @opindex mgas
7945 Enable the use of assembler directives only GAS understands.
7946
7947 @item -mschedule=@var{cpu-type}
7948 @opindex mschedule
7949 Schedule code according to the constraints for the machine type
7950 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7951 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
7952 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7953 proper scheduling option for your machine.  The default scheduling is
7954 @samp{8000}.
7955
7956 @item -mlinker-opt
7957 @opindex mlinker-opt
7958 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
7959 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
7960 linkers in which they give bogus error messages when linking some programs.
7961
7962 @item -msoft-float
7963 @opindex msoft-float
7964 Generate output containing library calls for floating point.
7965 @strong{Warning:} the requisite libraries are not available for all HPPA
7966 targets.  Normally the facilities of the machine's usual C compiler are
7967 used, but this cannot be done directly in cross-compilation.  You must make
7968 your own arrangements to provide suitable library functions for
7969 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7970 does provide software floating point support.
7971
7972 @option{-msoft-float} changes the calling convention in the output file;
7973 therefore, it is only useful if you compile @emph{all} of a program with
7974 this option.  In particular, you need to compile @file{libgcc.a}, the
7975 library that comes with GCC, with @option{-msoft-float} in order for
7976 this to work.
7977
7978 @item -msio
7979 @opindex msio
7980 Generate the predefine, @code{_SIO}, for server IO.  The default is
7981 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
7982 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
7983 options are available under HP-UX and HI-UX.
7984
7985 @item -mgnu-ld
7986 @opindex gnu-ld
7987 Use GNU ld specific options.  This passes @option{-shared} to ld when
7988 building a shared library.  It is the default when GCC is configured,
7989 explicitly or implicitly, with the GNU linker.  This option does not
7990 have any affect on which ld is called, it only changes what parameters
7991 are passed to that ld.  The ld that is called is determined by the
7992 @option{--with-ld} configure option, GCC's program search path, and
7993 finally by the user's @env{PATH}.  The linker used by GCC can be printed
7994 using @samp{which `gcc -print-prog-name=ld`}.
7995
7996 @item -mhp-ld
7997 @opindex hp-ld
7998 Use HP ld specific options.  This passes @option{-b} to ld when building
7999 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8000 links.  It is the default when GCC is configured, explicitly or
8001 implicitly, with the HP linker.  This option does not have any affect on
8002 which ld is called, it only changes what parameters are passed to that
8003 ld.  The ld that is called is determined by the @option{--with-ld}
8004 configure option, GCC's program search path, and finally by the user's
8005 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8006 `gcc -print-prog-name=ld`}.
8007
8008 @item -mlong-calls
8009 @opindex mno-long-calls
8010 Generate code that uses long call sequences.  This ensures that a call
8011 is always able to reach linker generated stubs.  The default is to generate
8012 long calls only when the distance from the call site to the beginning
8013 of the function or translation unit, as the case may be, exceeds a
8014 predefined limit set by the branch type being used.  The limits for
8015 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8016 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8017 240,000 bytes.
8018
8019 Distances are measured from the beginning of functions when using the
8020 @option{-ffunction-sections} option, or when using the @option{-mgas}
8021 and @option{-mno-portable-runtime} options together under HP-UX with
8022 the SOM linker.
8023
8024 It is normally not desirable to use this option as it will degrade
8025 performance.  However, it may be useful in large applications,
8026 particularly when partial linking is used to build the application.
8027
8028 The types of long calls used depends on the capabilities of the
8029 assembler and linker, and the type of code being generated.  The
8030 impact on systems that support long absolute calls, and long pic
8031 symbol-difference or pc-relative calls should be relatively small.
8032 However, an indirect call is used on 32-bit ELF systems in pic code
8033 and it is quite long.
8034
8035 @item -munix=@var{unix-std}
8036 @opindex march
8037 Generate compiler predefines and select a startfile for the specified
8038 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8039 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8040 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8041 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8042 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8043 and later.
8044
8045 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8046 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8047 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8048 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8049 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8050 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8051
8052 It is @emph{important} to note that this option changes the interfaces
8053 for various library routines.  It also affects the operational behavior
8054 of the C library.  Thus, @emph{extreme} care is needed in using this
8055 option.
8056
8057 Library code that is intended to operate with more than one UNIX
8058 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8059 as appropriate.  Most GNU software doesn't provide this capability.
8060
8061 @item -nolibdld
8062 @opindex nolibdld
8063 Suppress the generation of link options to search libdld.sl when the
8064 @option{-static} option is specified on HP-UX 10 and later.
8065
8066 @item -static
8067 @opindex static
8068 The HP-UX implementation of setlocale in libc has a dependency on
8069 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8070 when the @option{-static} option is specified, special link options
8071 are needed to resolve this dependency.
8072
8073 On HP-UX 10 and later, the GCC driver adds the necessary options to
8074 link with libdld.sl when the @option{-static} option is specified.
8075 This causes the resulting binary to be dynamic.  On the 64-bit port,
8076 the linkers generate dynamic binaries by default in any case.  The
8077 @option{-nolibdld} option can be used to prevent the GCC driver from
8078 adding these link options.
8079
8080 @item -threads
8081 @opindex threads
8082 Add support for multithreading with the @dfn{dce thread} library
8083 under HP-UX.  This option sets flags for both the preprocessor and
8084 linker.
8085 @end table
8086
8087 @node i386 and x86-64 Options
8088 @subsection Intel 386 and AMD x86-64 Options
8089 @cindex i386 Options
8090 @cindex x86-64 Options
8091 @cindex Intel 386 Options
8092 @cindex AMD x86-64 Options
8093
8094 These @samp{-m} options are defined for the i386 and x86-64 family of
8095 computers:
8096
8097 @table @gcctabopt
8098 @item -mtune=@var{cpu-type}
8099 @opindex mtune
8100 Tune to @var{cpu-type} everything applicable about the generated code, except
8101 for the ABI and the set of available instructions.  The choices for
8102 @var{cpu-type} are:
8103 @table @emph
8104 @item i386
8105 Original Intel's i386 CPU.
8106 @item i486
8107 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8108 @item i586, pentium
8109 Intel Pentium CPU with no MMX support.
8110 @item pentium-mmx
8111 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8112 @item i686, pentiumpro
8113 Intel PentiumPro CPU.
8114 @item pentium2
8115 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8116 @item pentium3, pentium3m
8117 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8118 support.
8119 @item pentium-m
8120 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8121 support.  Used by Centrino notebooks.
8122 @item pentium4, pentium4m
8123 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8124 @item prescott
8125 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8126 set support.
8127 @item nocona
8128 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8129 SSE2 and SSE3 instruction set support.
8130 @item k6
8131 AMD K6 CPU with MMX instruction set support.
8132 @item k6-2, k6-3
8133 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8134 @item athlon, athlon-tbird
8135 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8136 support.
8137 @item athlon-4, athlon-xp, athlon-mp
8138 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8139 instruction set support.
8140 @item k8, opteron, athlon64, athlon-fx
8141 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8142 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8143 @item winchip-c6
8144 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8145 set support.
8146 @item winchip2
8147 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8148 instruction set support.
8149 @item c3
8150 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8151 implemented for this chip.)
8152 @item c3-2
8153 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8154 implemented for this chip.)
8155 @end table
8156
8157 While picking a specific @var{cpu-type} will schedule things appropriately
8158 for that particular chip, the compiler will not generate any code that
8159 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8160 being used.
8161
8162 @item -march=@var{cpu-type}
8163 @opindex march
8164 Generate instructions for the machine type @var{cpu-type}.  The choices
8165 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8166 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8167
8168 @item -mcpu=@var{cpu-type}
8169 @opindex mcpu
8170 A deprecated synonym for @option{-mtune}.
8171
8172 @item -m386
8173 @itemx -m486
8174 @itemx -mpentium
8175 @itemx -mpentiumpro
8176 @opindex m386
8177 @opindex m486
8178 @opindex mpentium
8179 @opindex mpentiumpro
8180 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8181 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8182 These synonyms are deprecated.
8183
8184 @item -mfpmath=@var{unit}
8185 @opindex march
8186 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8187 for @var{unit} are:
8188
8189 @table @samp
8190 @item 387
8191 Use the standard 387 floating point coprocessor present majority of chips and
8192 emulated otherwise.  Code compiled with this option will run almost everywhere.
8193 The temporary results are computed in 80bit precision instead of precision
8194 specified by the type resulting in slightly different results compared to most
8195 of other chips. See @option{-ffloat-store} for more detailed description.
8196
8197 This is the default choice for i386 compiler.
8198
8199 @item sse
8200 Use scalar floating point instructions present in the SSE instruction set.
8201 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8202 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8203 instruction set supports only single precision arithmetics, thus the double and
8204 extended precision arithmetics is still done using 387.  Later version, present
8205 only in Pentium4 and the future AMD x86-64 chips supports double precision
8206 arithmetics too.
8207
8208 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8209 @option{-msse2} switches to enable SSE extensions and make this option
8210 effective.  For x86-64 compiler, these extensions are enabled by default.
8211
8212 The resulting code should be considerably faster in the majority of cases and avoid
8213 the numerical instability problems of 387 code, but may break some existing
8214 code that expects temporaries to be 80bit.
8215
8216 This is the default choice for the x86-64 compiler.
8217
8218 @item sse,387
8219 Attempt to utilize both instruction sets at once.  This effectively double the
8220 amount of available registers and on chips with separate execution units for
8221 387 and SSE the execution resources too.  Use this option with care, as it is
8222 still experimental, because the GCC register allocator does not model separate
8223 functional units well resulting in instable performance.
8224 @end table
8225
8226 @item -masm=@var{dialect}
8227 @opindex masm=@var{dialect}
8228 Output asm instructions using selected @var{dialect}. Supported choices are
8229 @samp{intel} or @samp{att} (the default one).
8230
8231 @item -mieee-fp
8232 @itemx -mno-ieee-fp
8233 @opindex mieee-fp
8234 @opindex mno-ieee-fp
8235 Control whether or not the compiler uses IEEE floating point
8236 comparisons.  These handle correctly the case where the result of a
8237 comparison is unordered.
8238
8239 @item -msoft-float
8240 @opindex msoft-float
8241 Generate output containing library calls for floating point.
8242 @strong{Warning:} the requisite libraries are not part of GCC@.
8243 Normally the facilities of the machine's usual C compiler are used, but
8244 this can't be done directly in cross-compilation.  You must make your
8245 own arrangements to provide suitable library functions for
8246 cross-compilation.
8247
8248 On machines where a function returns floating point results in the 80387
8249 register stack, some floating point opcodes may be emitted even if
8250 @option{-msoft-float} is used.
8251
8252 @item -mno-fp-ret-in-387
8253 @opindex mno-fp-ret-in-387
8254 Do not use the FPU registers for return values of functions.
8255
8256 The usual calling convention has functions return values of types
8257 @code{float} and @code{double} in an FPU register, even if there
8258 is no FPU@.  The idea is that the operating system should emulate
8259 an FPU@.
8260
8261 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8262 in ordinary CPU registers instead.
8263
8264 @item -mno-fancy-math-387
8265 @opindex mno-fancy-math-387
8266 Some 387 emulators do not support the @code{sin}, @code{cos} and
8267 @code{sqrt} instructions for the 387.  Specify this option to avoid
8268 generating those instructions.  This option is the default on FreeBSD,
8269 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8270 indicates that the target cpu will always have an FPU and so the
8271 instruction will not need emulation.  As of revision 2.6.1, these
8272 instructions are not generated unless you also use the
8273 @option{-funsafe-math-optimizations} switch.
8274
8275 @item -malign-double
8276 @itemx -mno-align-double
8277 @opindex malign-double
8278 @opindex mno-align-double
8279 Control whether GCC aligns @code{double}, @code{long double}, and
8280 @code{long long} variables on a two word boundary or a one word
8281 boundary.  Aligning @code{double} variables on a two word boundary will
8282 produce code that runs somewhat faster on a @samp{Pentium} at the
8283 expense of more memory.
8284
8285 @strong{Warning:} if you use the @option{-malign-double} switch,
8286 structures containing the above types will be aligned differently than
8287 the published application binary interface specifications for the 386
8288 and will not be binary compatible with structures in code compiled
8289 without that switch.
8290
8291 @item -m96bit-long-double
8292 @itemx -m128bit-long-double
8293 @opindex m96bit-long-double
8294 @opindex m128bit-long-double
8295 These switches control the size of @code{long double} type. The i386
8296 application binary interface specifies the size to be 96 bits,
8297 so @option{-m96bit-long-double} is the default in 32 bit mode.
8298
8299 Modern architectures (Pentium and newer) would prefer @code{long double}
8300 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8301 conforming to the ABI, this would not be possible.  So specifying a
8302 @option{-m128bit-long-double} will align @code{long double}
8303 to a 16 byte boundary by padding the @code{long double} with an additional
8304 32 bit zero.
8305
8306 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8307 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8308
8309 Notice that neither of these options enable any extra precision over the x87
8310 standard of 80 bits for a @code{long double}.
8311
8312 @strong{Warning:} if you override the default value for your target ABI, the
8313 structures and arrays containing @code{long double} variables will change
8314 their size as well as function calling convention for function taking
8315 @code{long double} will be modified.  Hence they will not be binary
8316 compatible with arrays or structures in code compiled without that switch.
8317
8318
8319 @item -msvr3-shlib
8320 @itemx -mno-svr3-shlib
8321 @opindex msvr3-shlib
8322 @opindex mno-svr3-shlib
8323 Control whether GCC places uninitialized local variables into the
8324 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8325 into @code{bss}.  These options are meaningful only on System V Release 3.
8326
8327 @item -mrtd
8328 @opindex mrtd
8329 Use a different function-calling convention, in which functions that
8330 take a fixed number of arguments return with the @code{ret} @var{num}
8331 instruction, which pops their arguments while returning.  This saves one
8332 instruction in the caller since there is no need to pop the arguments
8333 there.
8334
8335 You can specify that an individual function is called with this calling
8336 sequence with the function attribute @samp{stdcall}.  You can also
8337 override the @option{-mrtd} option by using the function attribute
8338 @samp{cdecl}.  @xref{Function Attributes}.
8339
8340 @strong{Warning:} this calling convention is incompatible with the one
8341 normally used on Unix, so you cannot use it if you need to call
8342 libraries compiled with the Unix compiler.
8343
8344 Also, you must provide function prototypes for all functions that
8345 take variable numbers of arguments (including @code{printf});
8346 otherwise incorrect code will be generated for calls to those
8347 functions.
8348
8349 In addition, seriously incorrect code will result if you call a
8350 function with too many arguments.  (Normally, extra arguments are
8351 harmlessly ignored.)
8352
8353 @item -mregparm=@var{num}
8354 @opindex mregparm
8355 Control how many registers are used to pass integer arguments.  By
8356 default, no registers are used to pass arguments, and at most 3
8357 registers can be used.  You can control this behavior for a specific
8358 function by using the function attribute @samp{regparm}.
8359 @xref{Function Attributes}.
8360
8361 @strong{Warning:} if you use this switch, and
8362 @var{num} is nonzero, then you must build all modules with the same
8363 value, including any libraries.  This includes the system libraries and
8364 startup modules.
8365
8366 @item -mpreferred-stack-boundary=@var{num}
8367 @opindex mpreferred-stack-boundary
8368 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8369 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8370 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8371 size (@option{-Os}), in which case the default is the minimum correct
8372 alignment (4 bytes for x86, and 8 bytes for x86-64).
8373
8374 On Pentium and PentiumPro, @code{double} and @code{long double} values
8375 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8376 suffer significant run time performance penalties.  On Pentium III, the
8377 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8378 penalties if it is not 16 byte aligned.
8379
8380 To ensure proper alignment of this values on the stack, the stack boundary
8381 must be as aligned as that required by any value stored on the stack.
8382 Further, every function must be generated such that it keeps the stack
8383 aligned.  Thus calling a function compiled with a higher preferred
8384 stack boundary from a function compiled with a lower preferred stack
8385 boundary will most likely misalign the stack.  It is recommended that
8386 libraries that use callbacks always use the default setting.
8387
8388 This extra alignment does consume extra stack space, and generally
8389 increases code size.  Code that is sensitive to stack space usage, such
8390 as embedded systems and operating system kernels, may want to reduce the
8391 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8392
8393 @item -mmmx
8394 @itemx -mno-mmx
8395 @item -msse
8396 @itemx -mno-sse
8397 @item -msse2
8398 @itemx -mno-sse2
8399 @item -msse3
8400 @itemx -mno-sse3
8401 @item -m3dnow
8402 @itemx -mno-3dnow
8403 @opindex mmmx
8404 @opindex mno-mmx
8405 @opindex msse
8406 @opindex mno-sse
8407 @opindex m3dnow
8408 @opindex mno-3dnow
8409 These switches enable or disable the use of built-in functions that allow
8410 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8411 instruction set.
8412
8413 @xref{X86 Built-in Functions}, for details of the functions enabled
8414 and disabled by these switches.
8415
8416 To have SSE/SSE2 instructions generated automatically from floating-point
8417 code, see @option{-mfpmath=sse}.
8418
8419 @item -mpush-args
8420 @itemx -mno-push-args
8421 @opindex mpush-args
8422 @opindex mno-push-args
8423 Use PUSH operations to store outgoing parameters.  This method is shorter
8424 and usually equally fast as method using SUB/MOV operations and is enabled
8425 by default.  In some cases disabling it may improve performance because of
8426 improved scheduling and reduced dependencies.
8427
8428 @item -maccumulate-outgoing-args
8429 @opindex maccumulate-outgoing-args
8430 If enabled, the maximum amount of space required for outgoing arguments will be
8431 computed in the function prologue.  This is faster on most modern CPUs
8432 because of reduced dependencies, improved scheduling and reduced stack usage
8433 when preferred stack boundary is not equal to 2.  The drawback is a notable
8434 increase in code size.  This switch implies @option{-mno-push-args}.
8435
8436 @item -mthreads
8437 @opindex mthreads
8438 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8439 on thread-safe exception handling must compile and link all code with the
8440 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8441 @option{-D_MT}; when linking, it links in a special thread helper library
8442 @option{-lmingwthrd} which cleans up per thread exception handling data.
8443
8444 @item -mno-align-stringops
8445 @opindex mno-align-stringops
8446 Do not align destination of inlined string operations.  This switch reduces
8447 code size and improves performance in case the destination is already aligned,
8448 but GCC doesn't know about it.
8449
8450 @item -minline-all-stringops
8451 @opindex minline-all-stringops
8452 By default GCC inlines string operations only when destination is known to be
8453 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8454 size, but may improve performance of code that depends on fast memcpy, strlen
8455 and memset for short lengths.
8456
8457 @item -momit-leaf-frame-pointer
8458 @opindex momit-leaf-frame-pointer
8459 Don't keep the frame pointer in a register for leaf functions.  This
8460 avoids the instructions to save, set up and restore frame pointers and
8461 makes an extra register available in leaf functions.  The option
8462 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8463 which might make debugging harder.
8464
8465 @item -mtls-direct-seg-refs
8466 @itemx -mno-tls-direct-seg-refs
8467 @opindex mtls-direct-seg-refs
8468 Controls whether TLS variables may be accessed with offsets from the
8469 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8470 or whether the thread base pointer must be added.  Whether or not this
8471 is legal depends on the operating system, and whether it maps the
8472 segment to cover the entire TLS area.
8473
8474 For systems that use GNU libc, the default is on.
8475 @end table
8476
8477 These @samp{-m} switches are supported in addition to the above
8478 on AMD x86-64 processors in 64-bit environments.
8479
8480 @table @gcctabopt
8481 @item -m32
8482 @itemx -m64
8483 @opindex m32
8484 @opindex m64
8485 Generate code for a 32-bit or 64-bit environment.
8486 The 32-bit environment sets int, long and pointer to 32 bits and
8487 generates code that runs on any i386 system.
8488 The 64-bit environment sets int to 32 bits and long and pointer
8489 to 64 bits and generates code for AMD's x86-64 architecture.
8490
8491 @item -mno-red-zone
8492 @opindex no-red-zone
8493 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8494 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8495 stack pointer that will not be modified by signal or interrupt handlers
8496 and therefore can be used for temporary data without adjusting the stack
8497 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8498
8499 @item -mcmodel=small
8500 @opindex mcmodel=small
8501 Generate code for the small code model: the program and its symbols must
8502 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8503 Programs can be statically or dynamically linked.  This is the default
8504 code model.
8505
8506 @item -mcmodel=kernel
8507 @opindex mcmodel=kernel
8508 Generate code for the kernel code model.  The kernel runs in the
8509 negative 2 GB of the address space.
8510 This model has to be used for Linux kernel code.
8511
8512 @item -mcmodel=medium
8513 @opindex mcmodel=medium
8514 Generate code for the medium model: The program is linked in the lower 2
8515 GB of the address space but symbols can be located anywhere in the
8516 address space.  Programs can be statically or dynamically linked, but
8517 building of shared libraries are not supported with the medium model.
8518
8519 @item -mcmodel=large
8520 @opindex mcmodel=large
8521 Generate code for the large model: This model makes no assumptions
8522 about addresses and sizes of sections.  Currently GCC does not implement
8523 this model.
8524 @end table
8525
8526 @node IA-64 Options
8527 @subsection IA-64 Options
8528 @cindex IA-64 Options
8529
8530 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8531
8532 @table @gcctabopt
8533 @item -mbig-endian
8534 @opindex mbig-endian
8535 Generate code for a big endian target.  This is the default for HP-UX@.
8536
8537 @item -mlittle-endian
8538 @opindex mlittle-endian
8539 Generate code for a little endian target.  This is the default for AIX5
8540 and GNU/Linux.
8541
8542 @item -mgnu-as
8543 @itemx -mno-gnu-as
8544 @opindex mgnu-as
8545 @opindex mno-gnu-as
8546 Generate (or don't) code for the GNU assembler.  This is the default.
8547 @c Also, this is the default if the configure option @option{--with-gnu-as}
8548 @c is used.
8549
8550 @item -mgnu-ld
8551 @itemx -mno-gnu-ld
8552 @opindex mgnu-ld
8553 @opindex mno-gnu-ld
8554 Generate (or don't) code for the GNU linker.  This is the default.
8555 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8556 @c is used.
8557
8558 @item -mno-pic
8559 @opindex mno-pic
8560 Generate code that does not use a global pointer register.  The result
8561 is not position independent code, and violates the IA-64 ABI@.
8562
8563 @item -mvolatile-asm-stop
8564 @itemx -mno-volatile-asm-stop
8565 @opindex mvolatile-asm-stop
8566 @opindex mno-volatile-asm-stop
8567 Generate (or don't) a stop bit immediately before and after volatile asm
8568 statements.
8569
8570 @item -mb-step
8571 @opindex mb-step
8572 Generate code that works around Itanium B step errata.
8573
8574 @item -mregister-names
8575 @itemx -mno-register-names
8576 @opindex mregister-names
8577 @opindex mno-register-names
8578 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8579 the stacked registers.  This may make assembler output more readable.
8580
8581 @item -mno-sdata
8582 @itemx -msdata
8583 @opindex mno-sdata
8584 @opindex msdata
8585 Disable (or enable) optimizations that use the small data section.  This may
8586 be useful for working around optimizer bugs.
8587
8588 @item -mconstant-gp
8589 @opindex mconstant-gp
8590 Generate code that uses a single constant global pointer value.  This is
8591 useful when compiling kernel code.
8592
8593 @item -mauto-pic
8594 @opindex mauto-pic
8595 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8596 This is useful when compiling firmware code.
8597
8598 @item -minline-float-divide-min-latency
8599 @opindex minline-float-divide-min-latency
8600 Generate code for inline divides of floating point values
8601 using the minimum latency algorithm.
8602
8603 @item -minline-float-divide-max-throughput
8604 @opindex minline-float-divide-max-throughput
8605 Generate code for inline divides of floating point values
8606 using the maximum throughput algorithm.
8607
8608 @item -minline-int-divide-min-latency
8609 @opindex minline-int-divide-min-latency
8610 Generate code for inline divides of integer values
8611 using the minimum latency algorithm.
8612
8613 @item -minline-int-divide-max-throughput
8614 @opindex minline-int-divide-max-throughput
8615 Generate code for inline divides of integer values
8616 using the maximum throughput algorithm.
8617
8618 @item -mno-dwarf2-asm
8619 @itemx -mdwarf2-asm
8620 @opindex mno-dwarf2-asm
8621 @opindex mdwarf2-asm
8622 Don't (or do) generate assembler code for the DWARF2 line number debugging
8623 info.  This may be useful when not using the GNU assembler.
8624
8625 @item -mfixed-range=@var{register-range}
8626 @opindex mfixed-range
8627 Generate code treating the given register range as fixed registers.
8628 A fixed register is one that the register allocator can not use.  This is
8629 useful when compiling kernel code.  A register range is specified as
8630 two registers separated by a dash.  Multiple register ranges can be
8631 specified separated by a comma.
8632
8633 @item -mearly-stop-bits
8634 @itemx -mno-early-stop-bits
8635 @opindex mearly-stop-bits
8636 @opindex mno-early-stop-bits
8637 Allow stop bits to be placed earlier than immediately preceding the
8638 instruction that triggered the stop bit.  This can improve instruction
8639 scheduling, but does not always do so.
8640 @end table
8641
8642 @node M32R/D Options
8643 @subsection M32R/D Options
8644 @cindex M32R/D options
8645
8646 These @option{-m} options are defined for Renesas M32R/D architectures:
8647
8648 @table @gcctabopt
8649 @item -m32r2
8650 @opindex m32r2
8651 Generate code for the M32R/2@.
8652
8653 @item -m32rx
8654 @opindex m32rx
8655 Generate code for the M32R/X@.
8656
8657 @item -m32r
8658 @opindex m32r
8659 Generate code for the M32R@.  This is the default.
8660
8661 @item -mmodel=small
8662 @opindex mmodel=small
8663 Assume all objects live in the lower 16MB of memory (so that their addresses
8664 can be loaded with the @code{ld24} instruction), and assume all subroutines
8665 are reachable with the @code{bl} instruction.
8666 This is the default.
8667
8668 The addressability of a particular object can be set with the
8669 @code{model} attribute.
8670
8671 @item -mmodel=medium
8672 @opindex mmodel=medium
8673 Assume objects may be anywhere in the 32-bit address space (the compiler
8674 will generate @code{seth/add3} instructions to load their addresses), and
8675 assume all subroutines are reachable with the @code{bl} instruction.
8676
8677 @item -mmodel=large
8678 @opindex mmodel=large
8679 Assume objects may be anywhere in the 32-bit address space (the compiler
8680 will generate @code{seth/add3} instructions to load their addresses), and
8681 assume subroutines may not be reachable with the @code{bl} instruction
8682 (the compiler will generate the much slower @code{seth/add3/jl}
8683 instruction sequence).
8684
8685 @item -msdata=none
8686 @opindex msdata=none
8687 Disable use of the small data area.  Variables will be put into
8688 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8689 @code{section} attribute has been specified).
8690 This is the default.
8691
8692 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8693 Objects may be explicitly put in the small data area with the
8694 @code{section} attribute using one of these sections.
8695
8696 @item -msdata=sdata
8697 @opindex msdata=sdata
8698 Put small global and static data in the small data area, but do not
8699 generate special code to reference them.
8700
8701 @item -msdata=use
8702 @opindex msdata=use
8703 Put small global and static data in the small data area, and generate
8704 special instructions to reference them.
8705
8706 @item -G @var{num}
8707 @opindex G
8708 @cindex smaller data references
8709 Put global and static objects less than or equal to @var{num} bytes
8710 into the small data or bss sections instead of the normal data or bss
8711 sections.  The default value of @var{num} is 8.
8712 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8713 for this option to have any effect.
8714
8715 All modules should be compiled with the same @option{-G @var{num}} value.
8716 Compiling with different values of @var{num} may or may not work; if it
8717 doesn't the linker will give an error message---incorrect code will not be
8718 generated.
8719
8720 @item -mdebug
8721 @opindex mdebug
8722 Makes the M32R specific code in the compiler display some statistics
8723 that might help in debugging programs.
8724
8725 @item -malign-loops
8726 @opindex malign-loops
8727 Align all loops to a 32-byte boundary.
8728
8729 @item -mno-align-loops
8730 @opindex mno-align-loops
8731 Do not enforce a 32-byte alignment for loops.  This is the default.
8732
8733 @item -missue-rate=@var{number}
8734 @opindex missue-rate=@var{number}
8735 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8736 or 2.
8737
8738 @item -mbranch-cost=@var{number}
8739 @opindex mbranch-cost=@var{number}
8740 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8741 preferred over conditional code, if it is 2, then the opposite will
8742 apply.
8743
8744 @item -mflush-trap=@var{number}
8745 @opindex mflush-trap=@var{number}
8746 Specifies the trap number to use to flush the cache.  The default is
8747 12.  Valid numbers are between 0 and 15 inclusive.
8748
8749 @item -mno-flush-trap
8750 @opindex mno-flush-trap
8751 Specifies that the cache cannot be flushed by using a trap.
8752
8753 @item -mflush-func=@var{name}
8754 @opindex mflush-func=@var{name}
8755 Specifies the name of the operating system function to call to flush
8756 the cache.  The default is @emph{_flush_cache}, but a function call
8757 will only be used if a trap is not available.
8758
8759 @item -mno-flush-func
8760 @opindex mno-flush-func
8761 Indicates that there is no OS function for flushing the cache.
8762
8763 @end table
8764
8765 @node M680x0 Options
8766 @subsection M680x0 Options
8767 @cindex M680x0 options
8768
8769 These are the @samp{-m} options defined for the 68000 series.  The default
8770 values for these options depends on which style of 68000 was selected when
8771 the compiler was configured; the defaults for the most common choices are
8772 given below.
8773
8774 @table @gcctabopt
8775 @item -m68000
8776 @itemx -mc68000
8777 @opindex m68000
8778 @opindex mc68000
8779 Generate output for a 68000.  This is the default
8780 when the compiler is configured for 68000-based systems.
8781
8782 Use this option for microcontrollers with a 68000 or EC000 core,
8783 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8784
8785 @item -m68020
8786 @itemx -mc68020
8787 @opindex m68020
8788 @opindex mc68020
8789 Generate output for a 68020.  This is the default
8790 when the compiler is configured for 68020-based systems.
8791
8792 @item -m68881
8793 @opindex m68881
8794 Generate output containing 68881 instructions for floating point.
8795 This is the default for most 68020 systems unless @option{--nfp} was
8796 specified when the compiler was configured.
8797
8798 @item -m68030
8799 @opindex m68030
8800 Generate output for a 68030.  This is the default when the compiler is
8801 configured for 68030-based systems.
8802
8803 @item -m68040
8804 @opindex m68040
8805 Generate output for a 68040.  This is the default when the compiler is
8806 configured for 68040-based systems.
8807
8808 This option inhibits the use of 68881/68882 instructions that have to be
8809 emulated by software on the 68040.  Use this option if your 68040 does not
8810 have code to emulate those instructions.
8811
8812 @item -m68060
8813 @opindex m68060
8814 Generate output for a 68060.  This is the default when the compiler is
8815 configured for 68060-based systems.
8816
8817 This option inhibits the use of 68020 and 68881/68882 instructions that
8818 have to be emulated by software on the 68060.  Use this option if your 68060
8819 does not have code to emulate those instructions.
8820
8821 @item -mcpu32
8822 @opindex mcpu32
8823 Generate output for a CPU32.  This is the default
8824 when the compiler is configured for CPU32-based systems.
8825
8826 Use this option for microcontrollers with a
8827 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
8828 68336, 68340, 68341, 68349 and 68360.
8829
8830 @item -m5200
8831 @opindex m5200
8832 Generate output for a 520X ``coldfire'' family cpu.  This is the default
8833 when the compiler is configured for 520X-based systems.
8834
8835 Use this option for microcontroller with a 5200 core, including
8836 the MCF5202, MCF5203, MCF5204 and MCF5202.
8837
8838
8839 @item -m68020-40
8840 @opindex m68020-40
8841 Generate output for a 68040, without using any of the new instructions.
8842 This results in code which can run relatively efficiently on either a
8843 68020/68881 or a 68030 or a 68040.  The generated code does use the
8844 68881 instructions that are emulated on the 68040.
8845
8846 @item -m68020-60
8847 @opindex m68020-60
8848 Generate output for a 68060, without using any of the new instructions.
8849 This results in code which can run relatively efficiently on either a
8850 68020/68881 or a 68030 or a 68040.  The generated code does use the
8851 68881 instructions that are emulated on the 68060.
8852
8853 @item -msoft-float
8854 @opindex msoft-float
8855 Generate output containing library calls for floating point.
8856 @strong{Warning:} the requisite libraries are not available for all m68k
8857 targets.  Normally the facilities of the machine's usual C compiler are
8858 used, but this can't be done directly in cross-compilation.  You must
8859 make your own arrangements to provide suitable library functions for
8860 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
8861 @samp{m68k-*-coff} do provide software floating point support.
8862
8863 @item -mshort
8864 @opindex mshort
8865 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8866 Additionally, parameters passed on the stack are also aligned to a
8867 16-bit boundary even on targets whose API mandates promotion to 32-bit.
8868
8869 @item -mnobitfield
8870 @opindex mnobitfield
8871 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
8872 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
8873
8874 @item -mbitfield
8875 @opindex mbitfield
8876 Do use the bit-field instructions.  The @option{-m68020} option implies
8877 @option{-mbitfield}.  This is the default if you use a configuration
8878 designed for a 68020.
8879
8880 @item -mrtd
8881 @opindex mrtd
8882 Use a different function-calling convention, in which functions
8883 that take a fixed number of arguments return with the @code{rtd}
8884 instruction, which pops their arguments while returning.  This
8885 saves one instruction in the caller since there is no need to pop
8886 the arguments there.
8887
8888 This calling convention is incompatible with the one normally
8889 used on Unix, so you cannot use it if you need to call libraries
8890 compiled with the Unix compiler.
8891
8892 Also, you must provide function prototypes for all functions that
8893 take variable numbers of arguments (including @code{printf});
8894 otherwise incorrect code will be generated for calls to those
8895 functions.
8896
8897 In addition, seriously incorrect code will result if you call a
8898 function with too many arguments.  (Normally, extra arguments are
8899 harmlessly ignored.)
8900
8901 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
8902 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
8903
8904 @item -malign-int
8905 @itemx -mno-align-int
8906 @opindex malign-int
8907 @opindex mno-align-int
8908 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
8909 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
8910 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
8911 Aligning variables on 32-bit boundaries produces code that runs somewhat
8912 faster on processors with 32-bit busses at the expense of more memory.
8913
8914 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
8915 align structures containing the above types  differently than
8916 most published application binary interface specifications for the m68k.
8917
8918 @item -mpcrel
8919 @opindex mpcrel
8920 Use the pc-relative addressing mode of the 68000 directly, instead of
8921 using a global offset table.  At present, this option implies @option{-fpic},
8922 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
8923 not presently supported with @option{-mpcrel}, though this could be supported for
8924 68020 and higher processors.
8925
8926 @item -mno-strict-align
8927 @itemx -mstrict-align
8928 @opindex mno-strict-align
8929 @opindex mstrict-align
8930 Do not (do) assume that unaligned memory references will be handled by
8931 the system.
8932
8933 @item -msep-data
8934 Generate code that allows the data segment to be located in a different
8935 area of memory from the text segment.  This allows for execute in place in
8936 an environment without virtual memory management.  This option implies -fPIC.
8937
8938 @item -mno-sep-data
8939 Generate code that assumes that the data segment follows the text segment.
8940 This is the default.
8941
8942 @item -mid-shared-library
8943 Generate code that supports shared libraries via the library ID method.
8944 This allows for execute in place and shared libraries in an environment
8945 without virtual memory management.  This option implies -fPIC.
8946
8947 @item -mno-id-shared-library
8948 Generate code that doesn't assume ID based shared libraries are being used.
8949 This is the default.
8950
8951 @item -mshared-library-id=n
8952 Specified the identification number of the ID based shared library being
8953 compiled.  Specifying a value of 0 will generate more compact code, specifying
8954 other values will force the allocation of that number to the current
8955 library but is no more space or time efficient than omitting this option.
8956
8957 @end table
8958
8959 @node M68hc1x Options
8960 @subsection M68hc1x Options
8961 @cindex M68hc1x options
8962
8963 These are the @samp{-m} options defined for the 68hc11 and 68hc12
8964 microcontrollers.  The default values for these options depends on
8965 which style of microcontroller was selected when the compiler was configured;
8966 the defaults for the most common choices are given below.
8967
8968 @table @gcctabopt
8969 @item -m6811
8970 @itemx -m68hc11
8971 @opindex m6811
8972 @opindex m68hc11
8973 Generate output for a 68HC11.  This is the default
8974 when the compiler is configured for 68HC11-based systems.
8975
8976 @item -m6812
8977 @itemx -m68hc12
8978 @opindex m6812
8979 @opindex m68hc12
8980 Generate output for a 68HC12.  This is the default
8981 when the compiler is configured for 68HC12-based systems.
8982
8983 @item -m68S12
8984 @itemx -m68hcs12
8985 @opindex m68S12
8986 @opindex m68hcs12
8987 Generate output for a 68HCS12.
8988
8989 @item -mauto-incdec
8990 @opindex mauto-incdec
8991 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
8992 addressing modes.
8993
8994 @item -minmax
8995 @itemx -nominmax
8996 @opindex minmax
8997 @opindex mnominmax
8998 Enable the use of 68HC12 min and max instructions.
8999
9000 @item -mlong-calls
9001 @itemx -mno-long-calls
9002 @opindex mlong-calls
9003 @opindex mno-long-calls
9004 Treat all calls as being far away (near).  If calls are assumed to be
9005 far away, the compiler will use the @code{call} instruction to
9006 call a function and the @code{rtc} instruction for returning.
9007
9008 @item -mshort
9009 @opindex mshort
9010 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9011
9012 @item -msoft-reg-count=@var{count}
9013 @opindex msoft-reg-count
9014 Specify the number of pseudo-soft registers which are used for the
9015 code generation.  The maximum number is 32.  Using more pseudo-soft
9016 register may or may not result in better code depending on the program.
9017 The default is 4 for 68HC11 and 2 for 68HC12.
9018
9019 @end table
9020
9021 @node MCore Options
9022 @subsection MCore Options
9023 @cindex MCore options
9024
9025 These are the @samp{-m} options defined for the Motorola M*Core
9026 processors.
9027
9028 @table @gcctabopt
9029
9030 @item -mhardlit
9031 @itemx -mno-hardlit
9032 @opindex mhardlit
9033 @opindex mno-hardlit
9034 Inline constants into the code stream if it can be done in two
9035 instructions or less.
9036
9037 @item -mdiv
9038 @itemx -mno-div
9039 @opindex mdiv
9040 @opindex mno-div
9041 Use the divide instruction.  (Enabled by default).
9042
9043 @item -mrelax-immediate
9044 @itemx -mno-relax-immediate
9045 @opindex mrelax-immediate
9046 @opindex mno-relax-immediate
9047 Allow arbitrary sized immediates in bit operations.
9048
9049 @item -mwide-bitfields
9050 @itemx -mno-wide-bitfields
9051 @opindex mwide-bitfields
9052 @opindex mno-wide-bitfields
9053 Always treat bit-fields as int-sized.
9054
9055 @item -m4byte-functions
9056 @itemx -mno-4byte-functions
9057 @opindex m4byte-functions
9058 @opindex mno-4byte-functions
9059 Force all functions to be aligned to a four byte boundary.
9060
9061 @item -mcallgraph-data
9062 @itemx -mno-callgraph-data
9063 @opindex mcallgraph-data
9064 @opindex mno-callgraph-data
9065 Emit callgraph information.
9066
9067 @item -mslow-bytes
9068 @itemx -mno-slow-bytes
9069 @opindex mslow-bytes
9070 @opindex mno-slow-bytes
9071 Prefer word access when reading byte quantities.
9072
9073 @item -mlittle-endian
9074 @itemx -mbig-endian
9075 @opindex mlittle-endian
9076 @opindex mbig-endian
9077 Generate code for a little endian target.
9078
9079 @item -m210
9080 @itemx -m340
9081 @opindex m210
9082 @opindex m340
9083 Generate code for the 210 processor.
9084 @end table
9085
9086 @node MIPS Options
9087 @subsection MIPS Options
9088 @cindex MIPS options
9089
9090 @table @gcctabopt
9091
9092 @item -EB
9093 @opindex EB
9094 Generate big-endian code.
9095
9096 @item -EL
9097 @opindex EL
9098 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9099 configurations.
9100
9101 @item -march=@var{arch}
9102 @opindex march
9103 Generate code that will run on @var{arch}, which can be the name of a
9104 generic MIPS ISA, or the name of a particular processor.
9105 The ISA names are:
9106 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9107 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9108 The processor names are:
9109 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9110 @samp{m4k},
9111 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9112 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9113 @samp{rm9000},
9114 @samp{orion},
9115 @samp{sb1},
9116 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9117 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9118 The special value @samp{from-abi} selects the
9119 most compatible architecture for the selected ABI (that is,
9120 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9121
9122 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9123 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9124 @samp{vr} may be written @samp{r}.
9125
9126 GCC defines two macros based on the value of this option.  The first
9127 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9128 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9129 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9130 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9131 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9132
9133 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9134 above.  In other words, it will have the full prefix and will not
9135 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9136 the macro names the resolved architecture (either @samp{"mips1"} or
9137 @samp{"mips3"}).  It names the default architecture when no
9138 @option{-march} option is given.
9139
9140 @item -mtune=@var{arch}
9141 @opindex mtune
9142 Optimize for @var{arch}.  Among other things, this option controls
9143 the way instructions are scheduled, and the perceived cost of arithmetic
9144 operations.  The list of @var{arch} values is the same as for
9145 @option{-march}.
9146
9147 When this option is not used, GCC will optimize for the processor
9148 specified by @option{-march}.  By using @option{-march} and
9149 @option{-mtune} together, it is possible to generate code that will
9150 run on a family of processors, but optimize the code for one
9151 particular member of that family.
9152
9153 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9154 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9155 @samp{-march} ones described above.
9156
9157 @item -mips1
9158 @opindex mips1
9159 Equivalent to @samp{-march=mips1}.
9160
9161 @item -mips2
9162 @opindex mips2
9163 Equivalent to @samp{-march=mips2}.
9164
9165 @item -mips3
9166 @opindex mips3
9167 Equivalent to @samp{-march=mips3}.
9168
9169 @item -mips4
9170 @opindex mips4
9171 Equivalent to @samp{-march=mips4}.
9172
9173 @item -mips32
9174 @opindex mips32
9175 Equivalent to @samp{-march=mips32}.
9176
9177 @item -mips32r2
9178 @opindex mips32r2
9179 Equivalent to @samp{-march=mips32r2}.
9180
9181 @item -mips64
9182 @opindex mips64
9183 Equivalent to @samp{-march=mips64}.
9184
9185 @item -mips16
9186 @itemx -mno-mips16
9187 @opindex mips16
9188 @opindex mno-mips16
9189 Use (do not use) the MIPS16 ISA.
9190
9191 @item -mabi=32
9192 @itemx -mabi=o64
9193 @itemx -mabi=n32
9194 @itemx -mabi=64
9195 @itemx -mabi=eabi
9196 @opindex mabi=32
9197 @opindex mabi=o64
9198 @opindex mabi=n32
9199 @opindex mabi=64
9200 @opindex mabi=eabi
9201 Generate code for the given ABI@.
9202
9203 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9204 generates 64-bit code when you select a 64-bit architecture, but you
9205 can use @option{-mgp32} to get 32-bit code instead.
9206
9207 For information about the O64 ABI, see
9208 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9209
9210 @item -mabicalls
9211 @itemx -mno-abicalls
9212 @opindex mabicalls
9213 @opindex mno-abicalls
9214 Generate (do not generate) SVR4-style position-independent code.
9215 @option{-mabicalls} is the default for SVR4-based systems.
9216
9217 @item -mxgot
9218 @itemx -mno-xgot
9219 @opindex mxgot
9220 @opindex mno-xgot
9221 Lift (do not lift) the usual restrictions on the size of the global
9222 offset table.
9223
9224 GCC normally uses a single instruction to load values from the GOT.
9225 While this is relatively efficient, it will only work if the GOT
9226 is smaller than about 64k.  Anything larger will cause the linker
9227 to report an error such as:
9228
9229 @cindex relocation truncated to fit (MIPS)
9230 @smallexample
9231 relocation truncated to fit: R_MIPS_GOT16 foobar
9232 @end smallexample
9233
9234 If this happens, you should recompile your code with @option{-mxgot}.
9235 It should then work with very large GOTs, although it will also be
9236 less efficient, since it will take three instructions to fetch the
9237 value of a global symbol.
9238
9239 Note that some linkers can create multiple GOTs.  If you have such a
9240 linker, you should only need to use @option{-mxgot} when a single object
9241 file accesses more than 64k's worth of GOT entries.  Very few do.
9242
9243 These options have no effect unless GCC is generating position
9244 independent code.
9245
9246 @item -mgp32
9247 @opindex mgp32
9248 Assume that general-purpose registers are 32 bits wide.
9249
9250 @item -mgp64
9251 @opindex mgp64
9252 Assume that general-purpose registers are 64 bits wide.
9253
9254 @item -mfp32
9255 @opindex mfp32
9256 Assume that floating-point registers are 32 bits wide.
9257
9258 @item -mfp64
9259 @opindex mfp64
9260 Assume that floating-point registers are 64 bits wide.
9261
9262 @item -mhard-float
9263 @opindex mhard-float
9264 Use floating-point coprocessor instructions.
9265
9266 @item -msoft-float
9267 @opindex msoft-float
9268 Do not use floating-point coprocessor instructions.  Implement
9269 floating-point calculations using library calls instead.
9270
9271 @item -msingle-float
9272 @opindex msingle-float
9273 Assume that the floating-point coprocessor only supports single-precision
9274 operations.
9275
9276 @itemx -mdouble-float
9277 @opindex mdouble-float
9278 Assume that the floating-point coprocessor supports double-precision
9279 operations.  This is the default.
9280
9281 @itemx -mpaired-single
9282 @itemx -mno-paired-single
9283 @opindex mpaired-single
9284 @opindex mno-paired-single
9285 Use (do not use) the paired single instructions.
9286
9287 @itemx -mips3d
9288 @itemx -mno-mips3d
9289 @opindex mips3d
9290 @opindex mno-mips3d
9291 Use (do not use) the MIPS-3D ASE.  The option @option{-mips3d} implies
9292 @option{-mpaired-single}.
9293
9294 @item -mint64
9295 @opindex mint64
9296 Force @code{int} and @code{long} types to be 64 bits wide.  See
9297 @option{-mlong32} for an explanation of the default and the way
9298 that the pointer size is determined.
9299
9300 @item -mlong64
9301 @opindex mlong64
9302 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9303 an explanation of the default and the way that the pointer size is
9304 determined.
9305
9306 @item -mlong32
9307 @opindex mlong32
9308 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9309
9310 The default size of @code{int}s, @code{long}s and pointers depends on
9311 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9312 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9313 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9314 or the same size as integer registers, whichever is smaller.
9315
9316 @item -G @var{num}
9317 @opindex G
9318 @cindex smaller data references (MIPS)
9319 @cindex gp-relative references (MIPS)
9320 Put global and static items less than or equal to @var{num} bytes into
9321 the small data or bss section instead of the normal data or bss section.
9322 This allows the data to be accessed using a single instruction.
9323
9324 All modules should be compiled with the same @option{-G @var{num}}
9325 value.
9326
9327 @item -membedded-data
9328 @itemx -mno-embedded-data
9329 @opindex membedded-data
9330 @opindex mno-embedded-data
9331 Allocate variables to the read-only data section first if possible, then
9332 next in the small data section if possible, otherwise in data.  This gives
9333 slightly slower code than the default, but reduces the amount of RAM required
9334 when executing, and thus may be preferred for some embedded systems.
9335
9336 @item -muninit-const-in-rodata
9337 @itemx -mno-uninit-const-in-rodata
9338 @opindex muninit-const-in-rodata
9339 @opindex mno-uninit-const-in-rodata
9340 Put uninitialized @code{const} variables in the read-only data section.
9341 This option is only meaningful in conjunction with @option{-membedded-data}.
9342
9343 @item -msplit-addresses
9344 @itemx -mno-split-addresses
9345 @opindex msplit-addresses
9346 @opindex mno-split-addresses
9347 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9348 relocation operators.  This option has been superceded by
9349 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9350
9351 @item -mexplicit-relocs
9352 @itemx -mno-explicit-relocs
9353 @opindex mexplicit-relocs
9354 @opindex mno-explicit-relocs
9355 Use (do not use) assembler relocation operators when dealing with symbolic
9356 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9357 is to use assembler macros instead.
9358
9359 @option{-mexplicit-relocs} is the default if GCC was configured
9360 to use an assembler that supports relocation operators.
9361
9362 @item -mcheck-zero-division
9363 @itemx -mno-check-zero-division
9364 @opindex mcheck-zero-division
9365 @opindex mno-check-zero-division
9366 Trap (do not trap) on integer division by zero.  The default is
9367 @option{-mcheck-zero-division}.
9368
9369 @item -mmemcpy
9370 @itemx -mno-memcpy
9371 @opindex mmemcpy
9372 @opindex mno-memcpy
9373 Force (do not force) the use of @code{memcpy()} for non-trivial block
9374 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9375 most constant-sized copies.
9376
9377 @item -mlong-calls
9378 @itemx -mno-long-calls
9379 @opindex mlong-calls
9380 @opindex mno-long-calls
9381 Disable (do not disable) use of the @code{jal} instruction.  Calling
9382 functions using @code{jal} is more efficient but requires the caller
9383 and callee to be in the same 256 megabyte segment.
9384
9385 This option has no effect on abicalls code.  The default is
9386 @option{-mno-long-calls}.
9387
9388 @item -mmad
9389 @itemx -mno-mad
9390 @opindex mmad
9391 @opindex mno-mad
9392 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9393 instructions, as provided by the R4650 ISA.
9394
9395 @item -mfused-madd
9396 @itemx -mno-fused-madd
9397 @opindex mfused-madd
9398 @opindex mno-fused-madd
9399 Enable (disable) use of the floating point multiply-accumulate
9400 instructions, when they are available.  The default is
9401 @option{-mfused-madd}.
9402
9403 When multiply-accumulate instructions are used, the intermediate
9404 product is calculated to infinite precision and is not subject to
9405 the FCSR Flush to Zero bit.  This may be undesirable in some
9406 circumstances.
9407
9408 @item -nocpp
9409 @opindex nocpp
9410 Tell the MIPS assembler to not run its preprocessor over user
9411 assembler files (with a @samp{.s} suffix) when assembling them.
9412
9413 @item -mfix-r4000
9414 @itemx -mno-fix-r4000
9415 @opindex mfix-r4000
9416 @opindex mno-fix-r4000
9417 Work around certain R4000 CPU errata:
9418 @itemize @minus
9419 @item
9420 A double-word or a variable shift may give an incorrect result if executed
9421 immediately after starting an integer division.
9422 @item
9423 A double-word or a variable shift may give an incorrect result if executed
9424 while an integer multiplication is in progress.
9425 @item
9426 An integer division may give an incorrect result if started in a delay slot
9427 of a taken branch or a jump.
9428 @end itemize
9429
9430 @item -mfix-r4400
9431 @itemx -mno-fix-r4400
9432 @opindex mfix-r4400
9433 @opindex mno-fix-r4400
9434 Work around certain R4400 CPU errata:
9435 @itemize @minus
9436 @item
9437 A double-word or a variable shift may give an incorrect result if executed
9438 immediately after starting an integer division.
9439 @end itemize
9440
9441 @item -mfix-vr4120
9442 @itemx -mno-fix-vr4120
9443 @opindex mfix-vr4120
9444 Work around certain VR4120 errata:
9445 @itemize @minus
9446 @item
9447 @code{dmultu} does not always produce the correct result.
9448 @item
9449 @code{div} and @code{ddiv} do not always produce the correct result if one
9450 of the operands is negative.
9451 @end itemize
9452 The workarounds for the division errata rely on special functions in
9453 @file{libgcc.a}.  At present, these functions are only provided by
9454 the @code{mips64vr*-elf} configurations.
9455
9456 Other VR4120 errata require a nop to be inserted between certain pairs of
9457 instructions.  These errata are handled by the assembler, not by GCC itself.
9458
9459 @item -mfix-sb1
9460 @itemx -mno-fix-sb1
9461 @opindex mfix-sb1
9462 Work around certain SB-1 CPU core errata.
9463 (This flag currently works around the SB-1 revision 2
9464 ``F1'' and ``F2'' floating point errata.)
9465
9466 @item -mflush-func=@var{func}
9467 @itemx -mno-flush-func
9468 @opindex mflush-func
9469 Specifies the function to call to flush the I and D caches, or to not
9470 call any such function.  If called, the function must take the same
9471 arguments as the common @code{_flush_func()}, that is, the address of the
9472 memory range for which the cache is being flushed, the size of the
9473 memory range, and the number 3 (to flush both caches).  The default
9474 depends on the target GCC was configured for, but commonly is either
9475 @samp{_flush_func} or @samp{__cpu_flush}.
9476
9477 @item -mbranch-likely
9478 @itemx -mno-branch-likely
9479 @opindex mbranch-likely
9480 @opindex mno-branch-likely
9481 Enable or disable use of Branch Likely instructions, regardless of the
9482 default for the selected architecture.  By default, Branch Likely
9483 instructions may be generated if they are supported by the selected
9484 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9485 and processors which implement those architectures; for those, Branch
9486 Likely instructions will not be generated by default because the MIPS32
9487 and MIPS64 architectures specifically deprecate their use.
9488
9489 @item -mfp-exceptions
9490 @itemx -mno-fp-exceptions
9491 @opindex mfp-exceptions
9492 Specifies whether FP exceptions are enabled.  This affects how we schedule
9493 FP instructions for some processors.  The default is that FP exceptions are
9494 enabled.
9495
9496 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9497 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9498 FP pipe.
9499
9500 @item -mvr4130-align
9501 @itemx -mno-vr4130-align
9502 @opindex mvr4130-align
9503 The VR4130 pipeline is two-way superscalar, but can only issue two
9504 instructions together if the first one is 8-byte aligned.  When this
9505 option is enabled, GCC will align pairs of instructions that it
9506 thinks should execute in parallel.
9507
9508 This option only has an effect when optimizing for the VR4130.
9509 It normally makes code faster, but at the expense of making it bigger.
9510 It is enabled by default at optimization level @option{-O3}.
9511 @end table
9512
9513 @node MMIX Options
9514 @subsection MMIX Options
9515 @cindex MMIX Options
9516
9517 These options are defined for the MMIX:
9518
9519 @table @gcctabopt
9520 @item -mlibfuncs
9521 @itemx -mno-libfuncs
9522 @opindex mlibfuncs
9523 @opindex mno-libfuncs
9524 Specify that intrinsic library functions are being compiled, passing all
9525 values in registers, no matter the size.
9526
9527 @item -mepsilon
9528 @itemx -mno-epsilon
9529 @opindex mepsilon
9530 @opindex mno-epsilon
9531 Generate floating-point comparison instructions that compare with respect
9532 to the @code{rE} epsilon register.
9533
9534 @item -mabi=mmixware
9535 @itemx -mabi=gnu
9536 @opindex mabi-mmixware
9537 @opindex mabi=gnu
9538 Generate code that passes function parameters and return values that (in
9539 the called function) are seen as registers @code{$0} and up, as opposed to
9540 the GNU ABI which uses global registers @code{$231} and up.
9541
9542 @item -mzero-extend
9543 @itemx -mno-zero-extend
9544 @opindex mzero-extend
9545 @opindex mno-zero-extend
9546 When reading data from memory in sizes shorter than 64 bits, use (do not
9547 use) zero-extending load instructions by default, rather than
9548 sign-extending ones.
9549
9550 @item -mknuthdiv
9551 @itemx -mno-knuthdiv
9552 @opindex mknuthdiv
9553 @opindex mno-knuthdiv
9554 Make the result of a division yielding a remainder have the same sign as
9555 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9556 remainder follows the sign of the dividend.  Both methods are
9557 arithmetically valid, the latter being almost exclusively used.
9558
9559 @item -mtoplevel-symbols
9560 @itemx -mno-toplevel-symbols
9561 @opindex mtoplevel-symbols
9562 @opindex mno-toplevel-symbols
9563 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9564 code can be used with the @code{PREFIX} assembly directive.
9565
9566 @item -melf
9567 @opindex melf
9568 Generate an executable in the ELF format, rather than the default
9569 @samp{mmo} format used by the @command{mmix} simulator.
9570
9571 @item -mbranch-predict
9572 @itemx -mno-branch-predict
9573 @opindex mbranch-predict
9574 @opindex mno-branch-predict
9575 Use (do not use) the probable-branch instructions, when static branch
9576 prediction indicates a probable branch.
9577
9578 @item -mbase-addresses
9579 @itemx -mno-base-addresses
9580 @opindex mbase-addresses
9581 @opindex mno-base-addresses
9582 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9583 base address automatically generates a request (handled by the assembler
9584 and the linker) for a constant to be set up in a global register.  The
9585 register is used for one or more base address requests within the range 0
9586 to 255 from the value held in the register.  The generally leads to short
9587 and fast code, but the number of different data items that can be
9588 addressed is limited.  This means that a program that uses lots of static
9589 data may require @option{-mno-base-addresses}.
9590
9591 @item -msingle-exit
9592 @itemx -mno-single-exit
9593 @opindex msingle-exit
9594 @opindex mno-single-exit
9595 Force (do not force) generated code to have a single exit point in each
9596 function.
9597 @end table
9598
9599 @node MN10300 Options
9600 @subsection MN10300 Options
9601 @cindex MN10300 options
9602
9603 These @option{-m} options are defined for Matsushita MN10300 architectures:
9604
9605 @table @gcctabopt
9606 @item -mmult-bug
9607 @opindex mmult-bug
9608 Generate code to avoid bugs in the multiply instructions for the MN10300
9609 processors.  This is the default.
9610
9611 @item -mno-mult-bug
9612 @opindex mno-mult-bug
9613 Do not generate code to avoid bugs in the multiply instructions for the
9614 MN10300 processors.
9615
9616 @item -mam33
9617 @opindex mam33
9618 Generate code which uses features specific to the AM33 processor.
9619
9620 @item -mno-am33
9621 @opindex mno-am33
9622 Do not generate code which uses features specific to the AM33 processor.  This
9623 is the default.
9624
9625 @item -mno-crt0
9626 @opindex mno-crt0
9627 Do not link in the C run-time initialization object file.
9628
9629 @item -mrelax
9630 @opindex mrelax
9631 Indicate to the linker that it should perform a relaxation optimization pass
9632 to shorten branches, calls and absolute memory addresses.  This option only
9633 has an effect when used on the command line for the final link step.
9634
9635 This option makes symbolic debugging impossible.
9636 @end table
9637
9638 @node NS32K Options
9639 @subsection NS32K Options
9640 @cindex NS32K options
9641
9642 These are the @samp{-m} options defined for the 32000 series.  The default
9643 values for these options depends on which style of 32000 was selected when
9644 the compiler was configured; the defaults for the most common choices are
9645 given below.
9646
9647 @table @gcctabopt
9648 @item -m32032
9649 @itemx -m32032
9650 @opindex m32032
9651 @opindex m32032
9652 Generate output for a 32032.  This is the default
9653 when the compiler is configured for 32032 and 32016 based systems.
9654
9655 @item -m32332
9656 @itemx -m32332
9657 @opindex m32332
9658 @opindex m32332
9659 Generate output for a 32332.  This is the default
9660 when the compiler is configured for 32332-based systems.
9661
9662 @item -m32532
9663 @itemx -m32532
9664 @opindex m32532
9665 @opindex m32532
9666 Generate output for a 32532.  This is the default
9667 when the compiler is configured for 32532-based systems.
9668
9669 @item -m32081
9670 @opindex m32081
9671 Generate output containing 32081 instructions for floating point.
9672 This is the default for all systems.
9673
9674 @item -m32381
9675 @opindex m32381
9676 Generate output containing 32381 instructions for floating point.  This
9677 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9678 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9679
9680 @item -mmulti-add
9681 @opindex mmulti-add
9682 Try and generate multiply-add floating point instructions @code{polyF}
9683 and @code{dotF}.  This option is only available if the @option{-m32381}
9684 option is in effect.  Using these instructions requires changes to
9685 register allocation which generally has a negative impact on
9686 performance.  This option should only be enabled when compiling code
9687 particularly likely to make heavy use of multiply-add instructions.
9688
9689 @item -mnomulti-add
9690 @opindex mnomulti-add
9691 Do not try and generate multiply-add floating point instructions
9692 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9693
9694 @item -msoft-float
9695 @opindex msoft-float
9696 Generate output containing library calls for floating point.
9697 @strong{Warning:} the requisite libraries may not be available.
9698
9699 @item -mieee-compare
9700 @itemx -mno-ieee-compare
9701 @opindex mieee-compare
9702 @opindex mno-ieee-compare
9703 Control whether or not the compiler uses IEEE floating point
9704 comparisons.  These handle correctly the case where the result of a
9705 comparison is unordered.
9706 @strong{Warning:} the requisite kernel support may not be available.
9707
9708 @item -mnobitfield
9709 @opindex mnobitfield
9710 Do not use the bit-field instructions.  On some machines it is faster to
9711 use shifting and masking operations.  This is the default for the pc532.
9712
9713 @item -mbitfield
9714 @opindex mbitfield
9715 Do use the bit-field instructions.  This is the default for all platforms
9716 except the pc532.
9717
9718 @item -mrtd
9719 @opindex mrtd
9720 Use a different function-calling convention, in which functions
9721 that take a fixed number of arguments return pop their
9722 arguments on return with the @code{ret} instruction.
9723
9724 This calling convention is incompatible with the one normally
9725 used on Unix, so you cannot use it if you need to call libraries
9726 compiled with the Unix compiler.
9727
9728 Also, you must provide function prototypes for all functions that
9729 take variable numbers of arguments (including @code{printf});
9730 otherwise incorrect code will be generated for calls to those
9731 functions.
9732
9733 In addition, seriously incorrect code will result if you call a
9734 function with too many arguments.  (Normally, extra arguments are
9735 harmlessly ignored.)
9736
9737 This option takes its name from the 680x0 @code{rtd} instruction.
9738
9739
9740 @item -mregparam
9741 @opindex mregparam
9742 Use a different function-calling convention where the first two arguments
9743 are passed in registers.
9744
9745 This calling convention is incompatible with the one normally
9746 used on Unix, so you cannot use it if you need to call libraries
9747 compiled with the Unix compiler.
9748
9749 @item -mnoregparam
9750 @opindex mnoregparam
9751 Do not pass any arguments in registers.  This is the default for all
9752 targets.
9753
9754 @item -msb
9755 @opindex msb
9756 It is OK to use the sb as an index register which is always loaded with
9757 zero.  This is the default for the pc532-netbsd target.
9758
9759 @item -mnosb
9760 @opindex mnosb
9761 The sb register is not available for use or has not been initialized to
9762 zero by the run time system.  This is the default for all targets except
9763 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9764 @option{-fpic} is set.
9765
9766 @item -mhimem
9767 @opindex mhimem
9768 Many ns32000 series addressing modes use displacements of up to 512MB@.
9769 If an address is above 512MB then displacements from zero can not be used.
9770 This option causes code to be generated which can be loaded above 512MB@.
9771 This may be useful for operating systems or ROM code.
9772
9773 @item -mnohimem
9774 @opindex mnohimem
9775 Assume code will be loaded in the first 512MB of virtual address space.
9776 This is the default for all platforms.
9777
9778 @end table
9779
9780 @node PDP-11 Options
9781 @subsection PDP-11 Options
9782 @cindex PDP-11 Options
9783
9784 These options are defined for the PDP-11:
9785
9786 @table @gcctabopt
9787 @item -mfpu
9788 @opindex mfpu
9789 Use hardware FPP floating point.  This is the default.  (FIS floating
9790 point on the PDP-11/40 is not supported.)
9791
9792 @item -msoft-float
9793 @opindex msoft-float
9794 Do not use hardware floating point.
9795
9796 @item -mac0
9797 @opindex mac0
9798 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9799
9800 @item -mno-ac0
9801 @opindex mno-ac0
9802 Return floating-point results in memory.  This is the default.
9803
9804 @item -m40
9805 @opindex m40
9806 Generate code for a PDP-11/40.
9807
9808 @item -m45
9809 @opindex m45
9810 Generate code for a PDP-11/45.  This is the default.
9811
9812 @item -m10
9813 @opindex m10
9814 Generate code for a PDP-11/10.
9815
9816 @item -mbcopy-builtin
9817 @opindex bcopy-builtin
9818 Use inline @code{movmemhi} patterns for copying memory.  This is the
9819 default.
9820
9821 @item -mbcopy
9822 @opindex mbcopy
9823 Do not use inline @code{movmemhi} patterns for copying memory.
9824
9825 @item -mint16
9826 @itemx -mno-int32
9827 @opindex mint16
9828 @opindex mno-int32
9829 Use 16-bit @code{int}.  This is the default.
9830
9831 @item -mint32
9832 @itemx -mno-int16
9833 @opindex mint32
9834 @opindex mno-int16
9835 Use 32-bit @code{int}.
9836
9837 @item -mfloat64
9838 @itemx -mno-float32
9839 @opindex mfloat64
9840 @opindex mno-float32
9841 Use 64-bit @code{float}.  This is the default.
9842
9843 @item -mfloat32
9844 @itemx -mno-float64
9845 @opindex mfloat32
9846 @opindex mno-float64
9847 Use 32-bit @code{float}.
9848
9849 @item -mabshi
9850 @opindex mabshi
9851 Use @code{abshi2} pattern.  This is the default.
9852
9853 @item -mno-abshi
9854 @opindex mno-abshi
9855 Do not use @code{abshi2} pattern.
9856
9857 @item -mbranch-expensive
9858 @opindex mbranch-expensive
9859 Pretend that branches are expensive.  This is for experimenting with
9860 code generation only.
9861
9862 @item -mbranch-cheap
9863 @opindex mbranch-cheap
9864 Do not pretend that branches are expensive.  This is the default.
9865
9866 @item -msplit
9867 @opindex msplit
9868 Generate code for a system with split I&D.
9869
9870 @item -mno-split
9871 @opindex mno-split
9872 Generate code for a system without split I&D.  This is the default.
9873
9874 @item -munix-asm
9875 @opindex munix-asm
9876 Use Unix assembler syntax.  This is the default when configured for
9877 @samp{pdp11-*-bsd}.
9878
9879 @item -mdec-asm
9880 @opindex mdec-asm
9881 Use DEC assembler syntax.  This is the default when configured for any
9882 PDP-11 target other than @samp{pdp11-*-bsd}.
9883 @end table
9884
9885 @node PowerPC Options
9886 @subsection PowerPC Options
9887 @cindex PowerPC options
9888
9889 These are listed under @xref{RS/6000 and PowerPC Options}.
9890
9891 @node RS/6000 and PowerPC Options
9892 @subsection IBM RS/6000 and PowerPC Options
9893 @cindex RS/6000 and PowerPC Options
9894 @cindex IBM RS/6000 and PowerPC Options
9895
9896 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
9897 @table @gcctabopt
9898 @item -mpower
9899 @itemx -mno-power
9900 @itemx -mpower2
9901 @itemx -mno-power2
9902 @itemx -mpowerpc
9903 @itemx -mno-powerpc
9904 @itemx -mpowerpc-gpopt
9905 @itemx -mno-powerpc-gpopt
9906 @itemx -mpowerpc-gfxopt
9907 @itemx -mno-powerpc-gfxopt
9908 @itemx -mpowerpc64
9909 @itemx -mno-powerpc64
9910 @opindex mpower
9911 @opindex mno-power
9912 @opindex mpower2
9913 @opindex mno-power2
9914 @opindex mpowerpc
9915 @opindex mno-powerpc
9916 @opindex mpowerpc-gpopt
9917 @opindex mno-powerpc-gpopt
9918 @opindex mpowerpc-gfxopt
9919 @opindex mno-powerpc-gfxopt
9920 @opindex mpowerpc64
9921 @opindex mno-powerpc64
9922 GCC supports two related instruction set architectures for the
9923 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
9924 instructions supported by the @samp{rios} chip set used in the original
9925 RS/6000 systems and the @dfn{PowerPC} instruction set is the
9926 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
9927 the IBM 4xx microprocessors.
9928
9929 Neither architecture is a subset of the other.  However there is a
9930 large common subset of instructions supported by both.  An MQ
9931 register is included in processors supporting the POWER architecture.
9932
9933 You use these options to specify which instructions are available on the
9934 processor you are using.  The default value of these options is
9935 determined when configuring GCC@.  Specifying the
9936 @option{-mcpu=@var{cpu_type}} overrides the specification of these
9937 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
9938 rather than the options listed above.
9939
9940 The @option{-mpower} option allows GCC to generate instructions that
9941 are found only in the POWER architecture and to use the MQ register.
9942 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
9943 to generate instructions that are present in the POWER2 architecture but
9944 not the original POWER architecture.
9945
9946 The @option{-mpowerpc} option allows GCC to generate instructions that
9947 are found only in the 32-bit subset of the PowerPC architecture.
9948 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
9949 GCC to use the optional PowerPC architecture instructions in the
9950 General Purpose group, including floating-point square root.  Specifying
9951 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
9952 use the optional PowerPC architecture instructions in the Graphics
9953 group, including floating-point select.
9954
9955 The @option{-mpowerpc64} option allows GCC to generate the additional
9956 64-bit instructions that are found in the full PowerPC64 architecture
9957 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
9958 @option{-mno-powerpc64}.
9959
9960 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
9961 will use only the instructions in the common subset of both
9962 architectures plus some special AIX common-mode calls, and will not use
9963 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
9964 permits GCC to use any instruction from either architecture and to
9965 allow use of the MQ register; specify this for the Motorola MPC601.
9966
9967 @item -mnew-mnemonics
9968 @itemx -mold-mnemonics
9969 @opindex mnew-mnemonics
9970 @opindex mold-mnemonics
9971 Select which mnemonics to use in the generated assembler code.  With
9972 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
9973 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
9974 assembler mnemonics defined for the POWER architecture.  Instructions
9975 defined in only one architecture have only one mnemonic; GCC uses that
9976 mnemonic irrespective of which of these options is specified.
9977
9978 GCC defaults to the mnemonics appropriate for the architecture in
9979 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
9980 value of these option.  Unless you are building a cross-compiler, you
9981 should normally not specify either @option{-mnew-mnemonics} or
9982 @option{-mold-mnemonics}, but should instead accept the default.
9983
9984 @item -mcpu=@var{cpu_type}
9985 @opindex mcpu
9986 Set architecture type, register usage, choice of mnemonics, and
9987 instruction scheduling parameters for machine type @var{cpu_type}.
9988 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
9989 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
9990 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
9991 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
9992 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9993 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
9994 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9995 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
9996 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
9997
9998 @option{-mcpu=common} selects a completely generic processor.  Code
9999 generated under this option will run on any POWER or PowerPC processor.
10000 GCC will use only the instructions in the common subset of both
10001 architectures, and will not use the MQ register.  GCC assumes a generic
10002 processor model for scheduling purposes.
10003
10004 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10005 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10006 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10007 types, with an appropriate, generic processor model assumed for
10008 scheduling purposes.
10009
10010 The other options specify a specific processor.  Code generated under
10011 those options will run best on that processor, and may not run at all on
10012 others.
10013
10014 The @option{-mcpu} options automatically enable or disable the
10015 following options: @option{-maltivec}, @option{-mhard-float},
10016 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10017 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10018 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10019 @option{-mstring}.  The particular options set for any particular CPU
10020 will vary between compiler versions, depending on what setting seems
10021 to produce optimal code for that CPU; it doesn't necessarily reflect
10022 the actual hardware's capabilities.  If you wish to set an individual
10023 option to a particular value, you may specify it after the
10024 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10025
10026 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10027 not enabled or disabled by the @option{-mcpu} option at present, since
10028 AIX does not have full support for these options.  You may still
10029 enable or disable them individually if you're sure it'll work in your
10030 environment.
10031
10032 @item -mtune=@var{cpu_type}
10033 @opindex mtune
10034 Set the instruction scheduling parameters for machine type
10035 @var{cpu_type}, but do not set the architecture type, register usage, or
10036 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10037 values for @var{cpu_type} are used for @option{-mtune} as for
10038 @option{-mcpu}.  If both are specified, the code generated will use the
10039 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10040 scheduling parameters set by @option{-mtune}.
10041
10042 @item -maltivec
10043 @itemx -mno-altivec
10044 @opindex maltivec
10045 @opindex mno-altivec
10046 These switches enable or disable the use of built-in functions that
10047 allow access to the AltiVec instruction set.  You may also need to set
10048 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10049 enhancements.
10050
10051 @item -mabi=spe
10052 @opindex mabi=spe
10053 Extend the current ABI with SPE ABI extensions.  This does not change
10054 the default ABI, instead it adds the SPE ABI extensions to the current
10055 ABI@.
10056
10057 @item -mabi=no-spe
10058 @opindex mabi=no-spe
10059 Disable Booke SPE ABI extensions for the current ABI.
10060
10061 @item -misel=@var{yes/no}
10062 @itemx -misel
10063 @opindex misel
10064 This switch enables or disables the generation of ISEL instructions.
10065
10066 @item -mspe=@var{yes/no}
10067 @itemx -mspe
10068 @opindex mspe
10069 This switch enables or disables the generation of SPE simd
10070 instructions.
10071
10072 @item -mfloat-gprs=@var{yes/no}
10073 @itemx -mfloat-gprs
10074 @opindex mfloat-gprs
10075 This switch enables or disables the generation of floating point
10076 operations on the general purpose registers for architectures that
10077 support it.  This option is currently only available on the MPC8540.
10078
10079 @item -m32
10080 @itemx -m64
10081 @opindex m32
10082 @opindex m64
10083 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10084 targets (including GNU/Linux).  The 32-bit environment sets int, long
10085 and pointer to 32 bits and generates code that runs on any PowerPC
10086 variant.  The 64-bit environment sets int to 32 bits and long and
10087 pointer to 64 bits, and generates code for PowerPC64, as for
10088 @option{-mpowerpc64}.
10089
10090 @item -mfull-toc
10091 @itemx -mno-fp-in-toc
10092 @itemx -mno-sum-in-toc
10093 @itemx -mminimal-toc
10094 @opindex mfull-toc
10095 @opindex mno-fp-in-toc
10096 @opindex mno-sum-in-toc
10097 @opindex mminimal-toc
10098 Modify generation of the TOC (Table Of Contents), which is created for
10099 every executable file.  The @option{-mfull-toc} option is selected by
10100 default.  In that case, GCC will allocate at least one TOC entry for
10101 each unique non-automatic variable reference in your program.  GCC
10102 will also place floating-point constants in the TOC@.  However, only
10103 16,384 entries are available in the TOC@.
10104
10105 If you receive a linker error message that saying you have overflowed
10106 the available TOC space, you can reduce the amount of TOC space used
10107 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10108 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10109 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10110 generate code to calculate the sum of an address and a constant at
10111 run-time instead of putting that sum into the TOC@.  You may specify one
10112 or both of these options.  Each causes GCC to produce very slightly
10113 slower and larger code at the expense of conserving TOC space.
10114
10115 If you still run out of space in the TOC even when you specify both of
10116 these options, specify @option{-mminimal-toc} instead.  This option causes
10117 GCC to make only one TOC entry for every file.  When you specify this
10118 option, GCC will produce code that is slower and larger but which
10119 uses extremely little TOC space.  You may wish to use this option
10120 only on files that contain less frequently executed code.
10121
10122 @item -maix64
10123 @itemx -maix32
10124 @opindex maix64
10125 @opindex maix32
10126 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10127 @code{long} type, and the infrastructure needed to support them.
10128 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10129 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10130 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10131
10132 @item -mxl-call
10133 @itemx -mno-xl-call
10134 @opindex mxl-call
10135 @opindex mno-xl-call
10136 On AIX, pass floating-point arguments to prototyped functions beyond the
10137 register save area (RSA) on the stack in addition to argument FPRs.  The
10138 AIX calling convention was extended but not initially documented to
10139 handle an obscure K&R C case of calling a function that takes the
10140 address of its arguments with fewer arguments than declared.  AIX XL
10141 compilers access floating point arguments which do not fit in the
10142 RSA from the stack when a subroutine is compiled without
10143 optimization.  Because always storing floating-point arguments on the
10144 stack is inefficient and rarely needed, this option is not enabled by
10145 default and only is necessary when calling subroutines compiled by AIX
10146 XL compilers without optimization.
10147
10148 @item -mpe
10149 @opindex mpe
10150 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10151 application written to use message passing with special startup code to
10152 enable the application to run.  The system must have PE installed in the
10153 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10154 must be overridden with the @option{-specs=} option to specify the
10155 appropriate directory location.  The Parallel Environment does not
10156 support threads, so the @option{-mpe} option and the @option{-pthread}
10157 option are incompatible.
10158
10159 @item -malign-natural
10160 @itemx -malign-power
10161 @opindex malign-natural
10162 @opindex malign-power
10163 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10164 @option{-malign-natural} overrides the ABI-defined alignment of larger
10165 types, such as floating-point doubles, on their natural size-based boundary.
10166 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10167 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
10168
10169 @item -msoft-float
10170 @itemx -mhard-float
10171 @opindex msoft-float
10172 @opindex mhard-float
10173 Generate code that does not use (uses) the floating-point register set.
10174 Software floating point emulation is provided if you use the
10175 @option{-msoft-float} option, and pass the option to GCC when linking.
10176
10177 @item -mmultiple
10178 @itemx -mno-multiple
10179 @opindex mmultiple
10180 @opindex mno-multiple
10181 Generate code that uses (does not use) the load multiple word
10182 instructions and the store multiple word instructions.  These
10183 instructions are generated by default on POWER systems, and not
10184 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10185 endian PowerPC systems, since those instructions do not work when the
10186 processor is in little endian mode.  The exceptions are PPC740 and
10187 PPC750 which permit the instructions usage in little endian mode.
10188
10189 @item -mstring
10190 @itemx -mno-string
10191 @opindex mstring
10192 @opindex mno-string
10193 Generate code that uses (does not use) the load string instructions
10194 and the store string word instructions to save multiple registers and
10195 do small block moves.  These instructions are generated by default on
10196 POWER systems, and not generated on PowerPC systems.  Do not use
10197 @option{-mstring} on little endian PowerPC systems, since those
10198 instructions do not work when the processor is in little endian mode.
10199 The exceptions are PPC740 and PPC750 which permit the instructions
10200 usage in little endian mode.
10201
10202 @item -mupdate
10203 @itemx -mno-update
10204 @opindex mupdate
10205 @opindex mno-update
10206 Generate code that uses (does not use) the load or store instructions
10207 that update the base register to the address of the calculated memory
10208 location.  These instructions are generated by default.  If you use
10209 @option{-mno-update}, there is a small window between the time that the
10210 stack pointer is updated and the address of the previous frame is
10211 stored, which means code that walks the stack frame across interrupts or
10212 signals may get corrupted data.
10213
10214 @item -mfused-madd
10215 @itemx -mno-fused-madd
10216 @opindex mfused-madd
10217 @opindex mno-fused-madd
10218 Generate code that uses (does not use) the floating point multiply and
10219 accumulate instructions.  These instructions are generated by default if
10220 hardware floating is used.
10221
10222 @item -mno-bit-align
10223 @itemx -mbit-align
10224 @opindex mno-bit-align
10225 @opindex mbit-align
10226 On System V.4 and embedded PowerPC systems do not (do) force structures
10227 and unions that contain bit-fields to be aligned to the base type of the
10228 bit-field.
10229
10230 For example, by default a structure containing nothing but 8
10231 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10232 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10233 the structure would be aligned to a 1 byte boundary and be one byte in
10234 size.
10235
10236 @item -mno-strict-align
10237 @itemx -mstrict-align
10238 @opindex mno-strict-align
10239 @opindex mstrict-align
10240 On System V.4 and embedded PowerPC systems do not (do) assume that
10241 unaligned memory references will be handled by the system.
10242
10243 @item -mrelocatable
10244 @itemx -mno-relocatable
10245 @opindex mrelocatable
10246 @opindex mno-relocatable
10247 On embedded PowerPC systems generate code that allows (does not allow)
10248 the program to be relocated to a different address at runtime.  If you
10249 use @option{-mrelocatable} on any module, all objects linked together must
10250 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10251
10252 @item -mrelocatable-lib
10253 @itemx -mno-relocatable-lib
10254 @opindex mrelocatable-lib
10255 @opindex mno-relocatable-lib
10256 On embedded PowerPC systems generate code that allows (does not allow)
10257 the program to be relocated to a different address at runtime.  Modules
10258 compiled with @option{-mrelocatable-lib} can be linked with either modules
10259 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10260 with modules compiled with the @option{-mrelocatable} options.
10261
10262 @item -mno-toc
10263 @itemx -mtoc
10264 @opindex mno-toc
10265 @opindex mtoc
10266 On System V.4 and embedded PowerPC systems do not (do) assume that
10267 register 2 contains a pointer to a global area pointing to the addresses
10268 used in the program.
10269
10270 @item -mlittle
10271 @itemx -mlittle-endian
10272 @opindex mlittle
10273 @opindex mlittle-endian
10274 On System V.4 and embedded PowerPC systems compile code for the
10275 processor in little endian mode.  The @option{-mlittle-endian} option is
10276 the same as @option{-mlittle}.
10277
10278 @item -mbig
10279 @itemx -mbig-endian
10280 @opindex mbig
10281 @opindex mbig-endian
10282 On System V.4 and embedded PowerPC systems compile code for the
10283 processor in big endian mode.  The @option{-mbig-endian} option is
10284 the same as @option{-mbig}.
10285
10286 @item -mdynamic-no-pic
10287 @opindex mdynamic-no-pic
10288 On Darwin and Mac OS X systems, compile code so that it is not
10289 relocatable, but that its external references are relocatable.  The
10290 resulting code is suitable for applications, but not shared
10291 libraries.
10292
10293 @item -mprioritize-restricted-insns=@var{priority}
10294 @opindex mprioritize-restricted-insns
10295 This option controls the priority that is assigned to
10296 dispatch-slot restricted instructions during the second scheduling
10297 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10298 @var{no/highest/second-highest} priority to dispatch slot restricted
10299 instructions.
10300
10301 @item -msched-costly-dep=@var{dependence_type}
10302 @opindex msched-costly-dep
10303 This option controls which dependences are considered costly
10304 by the target during instruction scheduling.  The argument
10305 @var{dependence_type} takes one of the following values:
10306 @var{no}: no dependence is costly,
10307 @var{all}: all dependences are costly,
10308 @var{true_store_to_load}: a true dependence from store to load is costly,
10309 @var{store_to_load}: any dependence from store to load is costly,
10310 @var{number}: any dependence which latency >= @var{number} is costly.
10311
10312 @item -minsert-sched-nops=@var{scheme}
10313 @opindex minsert-sched-nops
10314 This option controls which nop insertion scheme will be used during
10315 the second scheduling pass. The argument @var{scheme} takes one of the
10316 following values:
10317 @var{no}: Don't insert nops.
10318 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10319 according to the scheduler's grouping.
10320 @var{regroup_exact}: Insert nops to force costly dependent insns into
10321 separate groups.  Insert exactly as many nops as needed to force an insn
10322 to a new group, according to the estimated processor grouping.
10323 @var{number}: Insert nops to force costly dependent insns into
10324 separate groups.  Insert @var{number} nops to force an insn to a new group.
10325
10326 @item -mcall-sysv
10327 @opindex mcall-sysv
10328 On System V.4 and embedded PowerPC systems compile code using calling
10329 conventions that adheres to the March 1995 draft of the System V
10330 Application Binary Interface, PowerPC processor supplement.  This is the
10331 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10332
10333 @item -mcall-sysv-eabi
10334 @opindex mcall-sysv-eabi
10335 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10336
10337 @item -mcall-sysv-noeabi
10338 @opindex mcall-sysv-noeabi
10339 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10340
10341 @item -mcall-solaris
10342 @opindex mcall-solaris
10343 On System V.4 and embedded PowerPC systems compile code for the Solaris
10344 operating system.
10345
10346 @item -mcall-linux
10347 @opindex mcall-linux
10348 On System V.4 and embedded PowerPC systems compile code for the
10349 Linux-based GNU system.
10350
10351 @item -mcall-gnu
10352 @opindex mcall-gnu
10353 On System V.4 and embedded PowerPC systems compile code for the
10354 Hurd-based GNU system.
10355
10356 @item -mcall-netbsd
10357 @opindex mcall-netbsd
10358 On System V.4 and embedded PowerPC systems compile code for the
10359 NetBSD operating system.
10360
10361 @item -maix-struct-return
10362 @opindex maix-struct-return
10363 Return all structures in memory (as specified by the AIX ABI)@.
10364
10365 @item -msvr4-struct-return
10366 @opindex msvr4-struct-return
10367 Return structures smaller than 8 bytes in registers (as specified by the
10368 SVR4 ABI)@.
10369
10370 @item -mabi=altivec
10371 @opindex mabi=altivec
10372 Extend the current ABI with AltiVec ABI extensions.  This does not
10373 change the default ABI, instead it adds the AltiVec ABI extensions to
10374 the current ABI@.
10375
10376 @item -mabi=no-altivec
10377 @opindex mabi=no-altivec
10378 Disable AltiVec ABI extensions for the current ABI.
10379
10380 @item -mprototype
10381 @itemx -mno-prototype
10382 @opindex mprototype
10383 @opindex mno-prototype
10384 On System V.4 and embedded PowerPC systems assume that all calls to
10385 variable argument functions are properly prototyped.  Otherwise, the
10386 compiler must insert an instruction before every non prototyped call to
10387 set or clear bit 6 of the condition code register (@var{CR}) to
10388 indicate whether floating point values were passed in the floating point
10389 registers in case the function takes a variable arguments.  With
10390 @option{-mprototype}, only calls to prototyped variable argument functions
10391 will set or clear the bit.
10392
10393 @item -msim
10394 @opindex msim
10395 On embedded PowerPC systems, assume that the startup module is called
10396 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10397 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10398 configurations.
10399
10400 @item -mmvme
10401 @opindex mmvme
10402 On embedded PowerPC systems, assume that the startup module is called
10403 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10404 @file{libc.a}.
10405
10406 @item -mads
10407 @opindex mads
10408 On embedded PowerPC systems, assume that the startup module is called
10409 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10410 @file{libc.a}.
10411
10412 @item -myellowknife
10413 @opindex myellowknife
10414 On embedded PowerPC systems, assume that the startup module is called
10415 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10416 @file{libc.a}.
10417
10418 @item -mvxworks
10419 @opindex mvxworks
10420 On System V.4 and embedded PowerPC systems, specify that you are
10421 compiling for a VxWorks system.
10422
10423 @item -mwindiss
10424 @opindex mwindiss
10425 Specify that you are compiling for the WindISS simulation environment.
10426
10427 @item -memb
10428 @opindex memb
10429 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10430 header to indicate that @samp{eabi} extended relocations are used.
10431
10432 @item -meabi
10433 @itemx -mno-eabi
10434 @opindex meabi
10435 @opindex mno-eabi
10436 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10437 Embedded Applications Binary Interface (eabi) which is a set of
10438 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10439 means that the stack is aligned to an 8 byte boundary, a function
10440 @code{__eabi} is called to from @code{main} to set up the eabi
10441 environment, and the @option{-msdata} option can use both @code{r2} and
10442 @code{r13} to point to two separate small data areas.  Selecting
10443 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10444 do not call an initialization function from @code{main}, and the
10445 @option{-msdata} option will only use @code{r13} to point to a single
10446 small data area.  The @option{-meabi} option is on by default if you
10447 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10448
10449 @item -msdata=eabi
10450 @opindex msdata=eabi
10451 On System V.4 and embedded PowerPC systems, put small initialized
10452 @code{const} global and static data in the @samp{.sdata2} section, which
10453 is pointed to by register @code{r2}.  Put small initialized
10454 non-@code{const} global and static data in the @samp{.sdata} section,
10455 which is pointed to by register @code{r13}.  Put small uninitialized
10456 global and static data in the @samp{.sbss} section, which is adjacent to
10457 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10458 incompatible with the @option{-mrelocatable} option.  The
10459 @option{-msdata=eabi} option also sets the @option{-memb} option.
10460
10461 @item -msdata=sysv
10462 @opindex msdata=sysv
10463 On System V.4 and embedded PowerPC systems, put small global and static
10464 data in the @samp{.sdata} section, which is pointed to by register
10465 @code{r13}.  Put small uninitialized global and static data in the
10466 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10467 The @option{-msdata=sysv} option is incompatible with the
10468 @option{-mrelocatable} option.
10469
10470 @item -msdata=default
10471 @itemx -msdata
10472 @opindex msdata=default
10473 @opindex msdata
10474 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10475 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10476 same as @option{-msdata=sysv}.
10477
10478 @item -msdata-data
10479 @opindex msdata-data
10480 On System V.4 and embedded PowerPC systems, put small global and static
10481 data in the @samp{.sdata} section.  Put small uninitialized global and
10482 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10483 to address small data however.  This is the default behavior unless
10484 other @option{-msdata} options are used.
10485
10486 @item -msdata=none
10487 @itemx -mno-sdata
10488 @opindex msdata=none
10489 @opindex mno-sdata
10490 On embedded PowerPC systems, put all initialized global and static data
10491 in the @samp{.data} section, and all uninitialized data in the
10492 @samp{.bss} section.
10493
10494 @item -G @var{num}
10495 @opindex G
10496 @cindex smaller data references (PowerPC)
10497 @cindex .sdata/.sdata2 references (PowerPC)
10498 On embedded PowerPC systems, put global and static items less than or
10499 equal to @var{num} bytes into the small data or bss sections instead of
10500 the normal data or bss section.  By default, @var{num} is 8.  The
10501 @option{-G @var{num}} switch is also passed to the linker.
10502 All modules should be compiled with the same @option{-G @var{num}} value.
10503
10504 @item -mregnames
10505 @itemx -mno-regnames
10506 @opindex mregnames
10507 @opindex mno-regnames
10508 On System V.4 and embedded PowerPC systems do (do not) emit register
10509 names in the assembly language output using symbolic forms.
10510
10511 @item -mlongcall
10512 @itemx -mno-longcall
10513 @opindex mlongcall
10514 @opindex mno-longcall
10515 Default to making all function calls indirectly, using a register, so
10516 that functions which reside further than 32 megabytes (33,554,432
10517 bytes) from the current location can be called.  This setting can be
10518 overridden by the @code{shortcall} function attribute, or by
10519 @code{#pragma longcall(0)}.
10520
10521 Some linkers are capable of detecting out-of-range calls and generating
10522 glue code on the fly.  On these systems, long calls are unnecessary and
10523 generate slower code.  As of this writing, the AIX linker can do this,
10524 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10525 to the GNU linker for 32-bit PowerPC systems as well.
10526
10527 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10528 callee, L42'', plus a ``branch island'' (glue code).  The two target
10529 addresses represent the callee and the ``branch island.'' The
10530 Darwin/PPC linker will prefer the first address and generate a ``bl
10531 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10532 otherwise, the linker will generate ``bl L42'' to call the ``branch
10533 island.''  The ``branch island'' is appended to the body of the
10534 calling function; it computes the full 32-bit address of the callee
10535 and jumps to it.
10536
10537 On Mach-O (Darwin) systems, this option directs the compiler emit to
10538 the glue for every direct call, and the Darwin linker decides whether
10539 to use or discard it.
10540
10541 In the future, we may cause GCC to ignore all longcall specifications
10542 when the linker is known to generate glue.
10543
10544 @item -pthread
10545 @opindex pthread
10546 Adds support for multithreading with the @dfn{pthreads} library.
10547 This option sets flags for both the preprocessor and linker.
10548
10549 @end table
10550
10551 @node S/390 and zSeries Options
10552 @subsection S/390 and zSeries Options
10553 @cindex S/390 and zSeries Options
10554
10555 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10556
10557 @table @gcctabopt
10558 @item -mhard-float
10559 @itemx -msoft-float
10560 @opindex mhard-float
10561 @opindex msoft-float
10562 Use (do not use) the hardware floating-point instructions and registers
10563 for floating-point operations.  When @option{-msoft-float} is specified,
10564 functions in @file{libgcc.a} will be used to perform floating-point
10565 operations.  When @option{-mhard-float} is specified, the compiler
10566 generates IEEE floating-point instructions.  This is the default.
10567
10568 @item -mbackchain
10569 @itemx -mno-backchain
10570 @itemx -mkernel-backchain
10571 @opindex mbackchain
10572 @opindex mno-backchain
10573 @opindex mkernel-backchain
10574 In order to provide a backchain the address of the caller's frame
10575 is stored within the callee's stack frame.
10576 A backchain may be needed to allow debugging using tools that do not understand
10577 DWARF-2 call frame information.
10578 For @option{-mno-backchain} no backchain is maintained at all which is the 
10579 default. 
10580 If one of the other options is present the backchain pointer is placed either 
10581 on top of the stack frame  (@option{-mkernel-backchain}) or on
10582 the bottom (@option{-mbackchain}).
10583 Beside the different backchain location @option{-mkernel-backchain}
10584 also changes stack frame layout breaking the ABI. This option
10585 is intended to be used for code which internally needs a backchain but has
10586 to get by with a limited stack size e.g. the linux kernel. 
10587 Internal unwinding code not using DWARF-2 info has to be able to locate the
10588 return address of a function. That will be eased be the fact that
10589 the return address of a function is placed two words below the backchain 
10590 pointer.
10591
10592 @item -msmall-exec
10593 @itemx -mno-small-exec
10594 @opindex msmall-exec
10595 @opindex mno-small-exec
10596 Generate (or do not generate) code using the @code{bras} instruction
10597 to do subroutine calls.
10598 This only works reliably if the total executable size does not
10599 exceed 64k.  The default is to use the @code{basr} instruction instead,
10600 which does not have this limitation.
10601
10602 @item -m64
10603 @itemx -m31
10604 @opindex m64
10605 @opindex m31
10606 When @option{-m31} is specified, generate code compliant to the
10607 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10608 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10609 particular to generate 64-bit instructions.  For the @samp{s390}
10610 targets, the default is @option{-m31}, while the @samp{s390x}
10611 targets default to @option{-m64}.
10612
10613 @item -mzarch
10614 @itemx -mesa
10615 @opindex mzarch
10616 @opindex mesa
10617 When @option{-mzarch} is specified, generate code using the
10618 instructions available on z/Architecture.
10619 When @option{-mesa} is specified, generate code using the
10620 instructions available on ESA/390. Note that @option{-mesa} is
10621 not possible with @option{-m64}.
10622 When generating code compliant to the GNU/Linux for S/390 ABI,
10623 the default is @option{-mesa}.  When generating code compliant
10624 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10625
10626 @item -mmvcle
10627 @itemx -mno-mvcle
10628 @opindex mmvcle
10629 @opindex mno-mvcle
10630 Generate (or do not generate) code using the @code{mvcle} instruction
10631 to perform block moves.  When @option{-mno-mvcle} is specified,
10632 use a @code{mvc} loop instead.  This is the default.
10633
10634 @item -mdebug
10635 @itemx -mno-debug
10636 @opindex mdebug
10637 @opindex mno-debug
10638 Print (or do not print) additional debug information when compiling.
10639 The default is to not print debug information.
10640
10641 @item -march=@var{cpu-type}
10642 @opindex march
10643 Generate code that will run on @var{cpu-type}, which is the name of a system
10644 representing a certain processor type. Possible values for
10645 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10646 When generating code using the instructions available on z/Architecture,
10647 the default is @option{-march=z900}.  Otherwise, the default is
10648 @option{-march=g5}.
10649
10650 @item -mtune=@var{cpu-type}
10651 @opindex mtune
10652 Tune to @var{cpu-type} everything applicable about the generated code,
10653 except for the ABI and the set of available instructions.
10654 The list of @var{cpu-type} values is the same as for @option{-march}.
10655 The default is the value used for @option{-march}.
10656
10657 @item -mtpf-trace
10658 @itemx -mno-tpf-trace
10659 @opindex mtpf-trace
10660 @opindex mno-tpf-trace
10661 Generate code that adds (does not add) in TPF OS specific branches to trace
10662 routines in the operating system.  This option is off by default, even
10663 when compiling for the TPF OS.
10664
10665 @item -mfused-madd
10666 @itemx -mno-fused-madd
10667 @opindex mfused-madd
10668 @opindex mno-fused-madd
10669 Generate code that uses (does not use) the floating point multiply and
10670 accumulate instructions.  These instructions are generated by default if
10671 hardware floating point is used.
10672
10673 @item -mwarn-framesize=@var{framesize}
10674 @opindex mwarn-framesize
10675 Emit a warning if the current function exceeds the given frame size.  Because
10676 this is a compile time check it doesn't need to be a real problem when the program
10677 runs.  It is intended to identify functions which most probably cause 
10678 a stack overflow.  It is useful to be used in an environment with limited stack 
10679 size e.g. the linux kernel.
10680
10681 @item -mwarn-dynamicstack
10682 @opindex mwarn-dynamicstack
10683 Emit a warning if the function calls alloca or uses dynamically
10684 sized arrays.  This is generally a bad idea with a limited stack size.
10685
10686 @item -mstack-guard=@var{stack-guard}
10687 @item -mstack-size=@var{stack-size}
10688 @opindex mstack-guard
10689 @opindex mstack-size
10690 These arguments always have to be used in conjunction.  If they are present the s390
10691 back end emits additional instructions in the function prologue which trigger a trap
10692 if the stack size is @var{stack-guard} bytes above the @var{stack-size} 
10693 (remember that the stack on s390 grows downward).  These options are intended to 
10694 be used to help debugging stack overflow problems.  The additionally emitted code 
10695 cause only little overhead and hence can also be used in production like systems 
10696 without greater performance degradation.  The given values have to be exact 
10697 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
10698 In order to be efficient the extra code makes the assumption that the stack starts
10699 at an address aligned to the value given by @var{stack-size}.
10700 @end table
10701
10702 @node SH Options
10703 @subsection SH Options
10704
10705 These @samp{-m} options are defined for the SH implementations:
10706
10707 @table @gcctabopt
10708 @item -m1
10709 @opindex m1
10710 Generate code for the SH1.
10711
10712 @item -m2
10713 @opindex m2
10714 Generate code for the SH2.
10715
10716 @item -m2e
10717 Generate code for the SH2e.
10718
10719 @item -m3
10720 @opindex m3
10721 Generate code for the SH3.
10722
10723 @item -m3e
10724 @opindex m3e
10725 Generate code for the SH3e.
10726
10727 @item -m4-nofpu
10728 @opindex m4-nofpu
10729 Generate code for the SH4 without a floating-point unit.
10730
10731 @item -m4-single-only
10732 @opindex m4-single-only
10733 Generate code for the SH4 with a floating-point unit that only
10734 supports single-precision arithmetic.
10735
10736 @item -m4-single
10737 @opindex m4-single
10738 Generate code for the SH4 assuming the floating-point unit is in
10739 single-precision mode by default.
10740
10741 @item -m4
10742 @opindex m4
10743 Generate code for the SH4.
10744
10745 @item -m4a-nofpu
10746 @opindex m4a-nofpu
10747 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
10748 floating-point unit is not used.
10749
10750 @item -m4a-single-only
10751 @opindex m4a-single-only
10752 Generate code for the SH4a, in such a way that no double-precision
10753 floating point operations are used.
10754
10755 @item -m4a-single
10756 @opindex m4a-single
10757 Generate code for the SH4a assuming the floating-point unit is in
10758 single-precision mode by default.
10759
10760 @item -m4a
10761 @opindex m4a
10762 Generate code for the SH4a.
10763
10764 @item -m4al
10765 @opindex m4al
10766 Same as @option{-m4a-nofpu}, except that it implicitly passes
10767 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
10768 instructions at the moment.
10769
10770 @item -mb
10771 @opindex mb
10772 Compile code for the processor in big endian mode.
10773
10774 @item -ml
10775 @opindex ml
10776 Compile code for the processor in little endian mode.
10777
10778 @item -mdalign
10779 @opindex mdalign
10780 Align doubles at 64-bit boundaries.  Note that this changes the calling
10781 conventions, and thus some functions from the standard C library will
10782 not work unless you recompile it first with @option{-mdalign}.
10783
10784 @item -mrelax
10785 @opindex mrelax
10786 Shorten some address references at link time, when possible; uses the
10787 linker option @option{-relax}.
10788
10789 @item -mbigtable
10790 @opindex mbigtable
10791 Use 32-bit offsets in @code{switch} tables.  The default is to use
10792 16-bit offsets.
10793
10794 @item -mfmovd
10795 @opindex mfmovd
10796 Enable the use of the instruction @code{fmovd}.
10797
10798 @item -mhitachi
10799 @opindex mhitachi
10800 Comply with the calling conventions defined by Renesas.
10801
10802 @item -mrenesas
10803 @opindex mhitachi
10804 Comply with the calling conventions defined by Renesas.
10805
10806 @item -mno-renesas
10807 @opindex mhitachi
10808 Comply with the calling conventions defined for GCC before the Renesas
10809 conventions were available.  This option is the default for all
10810 targets of the SH toolchain except for @samp{sh-symbianelf}.
10811
10812 @item -mnomacsave
10813 @opindex mnomacsave
10814 Mark the @code{MAC} register as call-clobbered, even if
10815 @option{-mhitachi} is given.
10816
10817 @item -mieee
10818 @opindex mieee
10819 Increase IEEE-compliance of floating-point code.
10820
10821 @item -misize
10822 @opindex misize
10823 Dump instruction size and location in the assembly code.
10824
10825 @item -mpadstruct
10826 @opindex mpadstruct
10827 This option is deprecated.  It pads structures to multiple of 4 bytes,
10828 which is incompatible with the SH ABI@.
10829
10830 @item -mspace
10831 @opindex mspace
10832 Optimize for space instead of speed.  Implied by @option{-Os}.
10833
10834 @item -mprefergot
10835 @opindex mprefergot
10836 When generating position-independent code, emit function calls using
10837 the Global Offset Table instead of the Procedure Linkage Table.
10838
10839 @item -musermode
10840 @opindex musermode
10841 Generate a library function call to invalidate instruction cache
10842 entries, after fixing up a trampoline.  This library function call
10843 doesn't assume it can write to the whole memory address space.  This
10844 is the default when the target is @code{sh-*-linux*}.
10845 @end table
10846
10847 @node SPARC Options
10848 @subsection SPARC Options
10849 @cindex SPARC options
10850
10851 These @samp{-m} options are supported on the SPARC:
10852
10853 @table @gcctabopt
10854 @item -mno-app-regs
10855 @itemx -mapp-regs
10856 @opindex mno-app-regs
10857 @opindex mapp-regs
10858 Specify @option{-mapp-regs} to generate output using the global registers
10859 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
10860 is the default.
10861
10862 To be fully SVR4 ABI compliant at the cost of some performance loss,
10863 specify @option{-mno-app-regs}.  You should compile libraries and system
10864 software with this option.
10865
10866 @item -mfpu
10867 @itemx -mhard-float
10868 @opindex mfpu
10869 @opindex mhard-float
10870 Generate output containing floating point instructions.  This is the
10871 default.
10872
10873 @item -mno-fpu
10874 @itemx -msoft-float
10875 @opindex mno-fpu
10876 @opindex msoft-float
10877 Generate output containing library calls for floating point.
10878 @strong{Warning:} the requisite libraries are not available for all SPARC
10879 targets.  Normally the facilities of the machine's usual C compiler are
10880 used, but this cannot be done directly in cross-compilation.  You must make
10881 your own arrangements to provide suitable library functions for
10882 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
10883 @samp{sparclite-*-*} do provide software floating point support.
10884
10885 @option{-msoft-float} changes the calling convention in the output file;
10886 therefore, it is only useful if you compile @emph{all} of a program with
10887 this option.  In particular, you need to compile @file{libgcc.a}, the
10888 library that comes with GCC, with @option{-msoft-float} in order for
10889 this to work.
10890
10891 @item -mhard-quad-float
10892 @opindex mhard-quad-float
10893 Generate output containing quad-word (long double) floating point
10894 instructions.
10895
10896 @item -msoft-quad-float
10897 @opindex msoft-quad-float
10898 Generate output containing library calls for quad-word (long double)
10899 floating point instructions.  The functions called are those specified
10900 in the SPARC ABI@.  This is the default.
10901
10902 As of this writing, there are no SPARC implementations that have hardware
10903 support for the quad-word floating point instructions.  They all invoke
10904 a trap handler for one of these instructions, and then the trap handler
10905 emulates the effect of the instruction.  Because of the trap handler overhead,
10906 this is much slower than calling the ABI library routines.  Thus the
10907 @option{-msoft-quad-float} option is the default.
10908
10909 @item -mno-unaligned-doubles
10910 @itemx -munaligned-doubles
10911 @opindex mno-unaligned-doubles
10912 @opindex munaligned-doubles
10913 Assume that doubles have 8 byte alignment.  This is the default.
10914
10915 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
10916 alignment only if they are contained in another type, or if they have an
10917 absolute address.  Otherwise, it assumes they have 4 byte alignment.
10918 Specifying this option avoids some rare compatibility problems with code
10919 generated by other compilers.  It is not the default because it results
10920 in a performance loss, especially for floating point code.
10921
10922 @item -mno-faster-structs
10923 @itemx -mfaster-structs
10924 @opindex mno-faster-structs
10925 @opindex mfaster-structs
10926 With @option{-mfaster-structs}, the compiler assumes that structures
10927 should have 8 byte alignment.  This enables the use of pairs of
10928 @code{ldd} and @code{std} instructions for copies in structure
10929 assignment, in place of twice as many @code{ld} and @code{st} pairs.
10930 However, the use of this changed alignment directly violates the SPARC
10931 ABI@.  Thus, it's intended only for use on targets where the developer
10932 acknowledges that their resulting code will not be directly in line with
10933 the rules of the ABI@.
10934
10935 @item -mimpure-text
10936 @opindex mimpure-text
10937 @option{-mimpure-text}, used in addition to @option{-shared}, tells
10938 the compiler to not pass @option{-z text} to the linker when linking a
10939 shared object.  Using this option, you can link position-dependent
10940 code into a shared object.
10941
10942 @option{-mimpure-text} suppresses the ``relocations remain against
10943 allocatable but non-writable sections'' linker error message.
10944 However, the necessary relocations will trigger copy-on-write, and the
10945 shared object is not actually shared across processes.  Instead of
10946 using @option{-mimpure-text}, you should compile all source code with
10947 @option{-fpic} or @option{-fPIC}.
10948
10949 This option is only available on SunOS and Solaris.
10950
10951 @item -mcpu=@var{cpu_type}
10952 @opindex mcpu
10953 Set the instruction set, register set, and instruction scheduling parameters
10954 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
10955 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
10956 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
10957 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
10958 @samp{ultrasparc3}.
10959
10960 Default instruction scheduling parameters are used for values that select
10961 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
10962 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
10963
10964 Here is a list of each supported architecture and their supported
10965 implementations.
10966
10967 @smallexample
10968     v7:             cypress
10969     v8:             supersparc, hypersparc
10970     sparclite:      f930, f934, sparclite86x
10971     sparclet:       tsc701
10972     v9:             ultrasparc, ultrasparc3
10973 @end smallexample
10974
10975 By default (unless configured otherwise), GCC generates code for the V7
10976 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
10977 additionally optimizes it for the Cypress CY7C602 chip, as used in the
10978 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
10979 SPARCStation 1, 2, IPX etc.
10980
10981 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
10982 architecture.  The only difference from V7 code is that the compiler emits
10983 the integer multiply and integer divide instructions which exist in SPARC-V8
10984 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
10985 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
10986 2000 series.
10987
10988 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
10989 the SPARC architecture.  This adds the integer multiply, integer divide step
10990 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
10991 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
10992 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
10993 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
10994 MB86934 chip, which is the more recent SPARClite with FPU.
10995
10996 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
10997 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
10998 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
10999 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11000 optimizes it for the TEMIC SPARClet chip.
11001
11002 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11003 architecture.  This adds 64-bit integer and floating-point move instructions,
11004 3 additional floating-point condition code registers and conditional move
11005 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11006 optimizes it for the Sun UltraSPARC I/II chips.  With
11007 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11008 Sun UltraSPARC III chip.
11009
11010 @item -mtune=@var{cpu_type}
11011 @opindex mtune
11012 Set the instruction scheduling parameters for machine type
11013 @var{cpu_type}, but do not set the instruction set or register set that the
11014 option @option{-mcpu=@var{cpu_type}} would.
11015
11016 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11017 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11018 that select a particular cpu implementation.  Those are @samp{cypress},
11019 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11020 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11021 @samp{ultrasparc3}.
11022
11023 @item -mv8plus
11024 @itemx -mno-v8plus
11025 @opindex mv8plus
11026 @opindex mno-v8plus
11027 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
11028 difference from the V8 ABI is that the global and out registers are
11029 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11030 mode for all SPARC-V9 processors.
11031
11032 @item -mvis
11033 @itemx -mno-vis
11034 @opindex mvis
11035 @opindex mno-vis
11036 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11037 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11038 @end table
11039
11040 These @samp{-m} options are supported in addition to the above
11041 on SPARC-V9 processors in 64-bit environments:
11042
11043 @table @gcctabopt
11044 @item -mlittle-endian
11045 @opindex mlittle-endian
11046 Generate code for a processor running in little-endian mode. It is only
11047 available for a few configurations and most notably not on Solaris.
11048
11049 @item -m32
11050 @itemx -m64
11051 @opindex m32
11052 @opindex m64
11053 Generate code for a 32-bit or 64-bit environment.
11054 The 32-bit environment sets int, long and pointer to 32 bits.
11055 The 64-bit environment sets int to 32 bits and long and pointer
11056 to 64 bits.
11057
11058 @item -mcmodel=medlow
11059 @opindex mcmodel=medlow
11060 Generate code for the Medium/Low code model: 64-bit addresses, programs
11061 must be linked in the low 32 bits of memory.  Programs can be statically
11062 or dynamically linked.
11063
11064 @item -mcmodel=medmid
11065 @opindex mcmodel=medmid
11066 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11067 must be linked in the low 44 bits of memory, the text and data segments must
11068 be less than 2GB in size and the data segment must be located within 2GB of
11069 the text segment.
11070
11071 @item -mcmodel=medany
11072 @opindex mcmodel=medany
11073 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11074 may be linked anywhere in memory, the text and data segments must be less
11075 than 2GB in size and the data segment must be located within 2GB of the
11076 text segment.
11077
11078 @item -mcmodel=embmedany
11079 @opindex mcmodel=embmedany
11080 Generate code for the Medium/Anywhere code model for embedded systems:
11081 64-bit addresses, the text and data segments must be less than 2GB in
11082 size, both starting anywhere in memory (determined at link time).  The
11083 global register %g4 points to the base of the data segment.  Programs
11084 are statically linked and PIC is not supported.
11085
11086 @item -mstack-bias
11087 @itemx -mno-stack-bias
11088 @opindex mstack-bias
11089 @opindex mno-stack-bias
11090 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11091 frame pointer if present, are offset by @minus{}2047 which must be added back
11092 when making stack frame references.  This is the default in 64-bit mode.
11093 Otherwise, assume no such offset is present.
11094 @end table
11095
11096 These switches are supported in addition to the above on Solaris:
11097
11098 @table @gcctabopt
11099 @item -threads
11100 @opindex threads
11101 Add support for multithreading using the Solaris threads library.  This
11102 option sets flags for both the preprocessor and linker.  This option does
11103 not affect the thread safety of object code produced by the compiler or
11104 that of libraries supplied with it.
11105
11106 @item -pthreads
11107 @opindex pthreads
11108 Add support for multithreading using the POSIX threads library.  This
11109 option sets flags for both the preprocessor and linker.  This option does
11110 not affect the thread safety of object code produced  by the compiler or
11111 that of libraries supplied with it.
11112 @end table
11113
11114 @node System V Options
11115 @subsection Options for System V
11116
11117 These additional options are available on System V Release 4 for
11118 compatibility with other compilers on those systems:
11119
11120 @table @gcctabopt
11121 @item -G
11122 @opindex G
11123 Create a shared object.
11124 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11125
11126 @item -Qy
11127 @opindex Qy
11128 Identify the versions of each tool used by the compiler, in a
11129 @code{.ident} assembler directive in the output.
11130
11131 @item -Qn
11132 @opindex Qn
11133 Refrain from adding @code{.ident} directives to the output file (this is
11134 the default).
11135
11136 @item -YP,@var{dirs}
11137 @opindex YP
11138 Search the directories @var{dirs}, and no others, for libraries
11139 specified with @option{-l}.
11140
11141 @item -Ym,@var{dir}
11142 @opindex Ym
11143 Look in the directory @var{dir} to find the M4 preprocessor.
11144 The assembler uses this option.
11145 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11146 @c the generic assembler that comes with Solaris takes just -Ym.
11147 @end table
11148
11149 @node TMS320C3x/C4x Options
11150 @subsection TMS320C3x/C4x Options
11151 @cindex TMS320C3x/C4x Options
11152
11153 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11154
11155 @table @gcctabopt
11156
11157 @item -mcpu=@var{cpu_type}
11158 @opindex mcpu
11159 Set the instruction set, register set, and instruction scheduling
11160 parameters for machine type @var{cpu_type}.  Supported values for
11161 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11162 @samp{c44}.  The default is @samp{c40} to generate code for the
11163 TMS320C40.
11164
11165 @item -mbig-memory
11166 @itemx -mbig
11167 @itemx -msmall-memory
11168 @itemx -msmall
11169 @opindex mbig-memory
11170 @opindex mbig
11171 @opindex msmall-memory
11172 @opindex msmall
11173 Generates code for the big or small memory model.  The small memory
11174 model assumed that all data fits into one 64K word page.  At run-time
11175 the data page (DP) register must be set to point to the 64K page
11176 containing the .bss and .data program sections.  The big memory model is
11177 the default and requires reloading of the DP register for every direct
11178 memory access.
11179
11180 @item -mbk
11181 @itemx -mno-bk
11182 @opindex mbk
11183 @opindex mno-bk
11184 Allow (disallow) allocation of general integer operands into the block
11185 count register BK@.
11186
11187 @item -mdb
11188 @itemx -mno-db
11189 @opindex mdb
11190 @opindex mno-db
11191 Enable (disable) generation of code using decrement and branch,
11192 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11193 on the safe side, this is disabled for the C3x, since the maximum
11194 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11195 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11196 that it can utilize the decrement and branch instruction, but will give
11197 up if there is more than one memory reference in the loop.  Thus a loop
11198 where the loop counter is decremented can generate slightly more
11199 efficient code, in cases where the RPTB instruction cannot be utilized.
11200
11201 @item -mdp-isr-reload
11202 @itemx -mparanoid
11203 @opindex mdp-isr-reload
11204 @opindex mparanoid
11205 Force the DP register to be saved on entry to an interrupt service
11206 routine (ISR), reloaded to point to the data section, and restored on
11207 exit from the ISR@.  This should not be required unless someone has
11208 violated the small memory model by modifying the DP register, say within
11209 an object library.
11210
11211 @item -mmpyi
11212 @itemx -mno-mpyi
11213 @opindex mmpyi
11214 @opindex mno-mpyi
11215 For the C3x use the 24-bit MPYI instruction for integer multiplies
11216 instead of a library call to guarantee 32-bit results.  Note that if one
11217 of the operands is a constant, then the multiplication will be performed
11218 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11219 then squaring operations are performed inline instead of a library call.
11220
11221 @item -mfast-fix
11222 @itemx -mno-fast-fix
11223 @opindex mfast-fix
11224 @opindex mno-fast-fix
11225 The C3x/C4x FIX instruction to convert a floating point value to an
11226 integer value chooses the nearest integer less than or equal to the
11227 floating point value rather than to the nearest integer.  Thus if the
11228 floating point number is negative, the result will be incorrectly
11229 truncated an additional code is necessary to detect and correct this
11230 case.  This option can be used to disable generation of the additional
11231 code required to correct the result.
11232
11233 @item -mrptb
11234 @itemx -mno-rptb
11235 @opindex mrptb
11236 @opindex mno-rptb
11237 Enable (disable) generation of repeat block sequences using the RPTB
11238 instruction for zero overhead looping.  The RPTB construct is only used
11239 for innermost loops that do not call functions or jump across the loop
11240 boundaries.  There is no advantage having nested RPTB loops due to the
11241 overhead required to save and restore the RC, RS, and RE registers.
11242 This is enabled by default with @option{-O2}.
11243
11244 @item -mrpts=@var{count}
11245 @itemx -mno-rpts
11246 @opindex mrpts
11247 @opindex mno-rpts
11248 Enable (disable) the use of the single instruction repeat instruction
11249 RPTS@.  If a repeat block contains a single instruction, and the loop
11250 count can be guaranteed to be less than the value @var{count}, GCC will
11251 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11252 then a RPTS will be emitted even if the loop count cannot be determined
11253 at compile time.  Note that the repeated instruction following RPTS does
11254 not have to be reloaded from memory each iteration, thus freeing up the
11255 CPU buses for operands.  However, since interrupts are blocked by this
11256 instruction, it is disabled by default.
11257
11258 @item -mloop-unsigned
11259 @itemx -mno-loop-unsigned
11260 @opindex mloop-unsigned
11261 @opindex mno-loop-unsigned
11262 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11263 is @math{2^{31} + 1} since these instructions test if the iteration count is
11264 negative to terminate the loop.  If the iteration count is unsigned
11265 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11266 exceeded.  This switch allows an unsigned iteration count.
11267
11268 @item -mti
11269 @opindex mti
11270 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11271 with.  This also enforces compatibility with the API employed by the TI
11272 C3x C compiler.  For example, long doubles are passed as structures
11273 rather than in floating point registers.
11274
11275 @item -mregparm
11276 @itemx -mmemparm
11277 @opindex mregparm
11278 @opindex mmemparm
11279 Generate code that uses registers (stack) for passing arguments to functions.
11280 By default, arguments are passed in registers where possible rather
11281 than by pushing arguments on to the stack.
11282
11283 @item -mparallel-insns
11284 @itemx -mno-parallel-insns
11285 @opindex mparallel-insns
11286 @opindex mno-parallel-insns
11287 Allow the generation of parallel instructions.  This is enabled by
11288 default with @option{-O2}.
11289
11290 @item -mparallel-mpy
11291 @itemx -mno-parallel-mpy
11292 @opindex mparallel-mpy
11293 @opindex mno-parallel-mpy
11294 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11295 provided @option{-mparallel-insns} is also specified.  These instructions have
11296 tight register constraints which can pessimize the code generation
11297 of large functions.
11298
11299 @end table
11300
11301 @node V850 Options
11302 @subsection V850 Options
11303 @cindex V850 Options
11304
11305 These @samp{-m} options are defined for V850 implementations:
11306
11307 @table @gcctabopt
11308 @item -mlong-calls
11309 @itemx -mno-long-calls
11310 @opindex mlong-calls
11311 @opindex mno-long-calls
11312 Treat all calls as being far away (near).  If calls are assumed to be
11313 far away, the compiler will always load the functions address up into a
11314 register, and call indirect through the pointer.
11315
11316 @item -mno-ep
11317 @itemx -mep
11318 @opindex mno-ep
11319 @opindex mep
11320 Do not optimize (do optimize) basic blocks that use the same index
11321 pointer 4 or more times to copy pointer into the @code{ep} register, and
11322 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11323 option is on by default if you optimize.
11324
11325 @item -mno-prolog-function
11326 @itemx -mprolog-function
11327 @opindex mno-prolog-function
11328 @opindex mprolog-function
11329 Do not use (do use) external functions to save and restore registers
11330 at the prologue and epilogue of a function.  The external functions
11331 are slower, but use less code space if more than one function saves
11332 the same number of registers.  The @option{-mprolog-function} option
11333 is on by default if you optimize.
11334
11335 @item -mspace
11336 @opindex mspace
11337 Try to make the code as small as possible.  At present, this just turns
11338 on the @option{-mep} and @option{-mprolog-function} options.
11339
11340 @item -mtda=@var{n}
11341 @opindex mtda
11342 Put static or global variables whose size is @var{n} bytes or less into
11343 the tiny data area that register @code{ep} points to.  The tiny data
11344 area can hold up to 256 bytes in total (128 bytes for byte references).
11345
11346 @item -msda=@var{n}
11347 @opindex msda
11348 Put static or global variables whose size is @var{n} bytes or less into
11349 the small data area that register @code{gp} points to.  The small data
11350 area can hold up to 64 kilobytes.
11351
11352 @item -mzda=@var{n}
11353 @opindex mzda
11354 Put static or global variables whose size is @var{n} bytes or less into
11355 the first 32 kilobytes of memory.
11356
11357 @item -mv850
11358 @opindex mv850
11359 Specify that the target processor is the V850.
11360
11361 @item -mbig-switch
11362 @opindex mbig-switch
11363 Generate code suitable for big switch tables.  Use this option only if
11364 the assembler/linker complain about out of range branches within a switch
11365 table.
11366
11367 @item -mapp-regs
11368 @opindex mapp-regs
11369 This option will cause r2 and r5 to be used in the code generated by
11370 the compiler.  This setting is the default.
11371
11372 @item -mno-app-regs
11373 @opindex mno-app-regs
11374 This option will cause r2 and r5 to be treated as fixed registers.
11375
11376 @item -mv850e1
11377 @opindex mv850e1
11378 Specify that the target processor is the V850E1.  The preprocessor
11379 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11380 this option is used.
11381
11382 @item -mv850e
11383 @opindex mv850e
11384 Specify that the target processor is the V850E.  The preprocessor
11385 constant @samp{__v850e__} will be defined if this option is used.
11386
11387 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11388 are defined then a default target processor will be chosen and the
11389 relevant @samp{__v850*__} preprocessor constant will be defined.
11390
11391 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11392 defined, regardless of which processor variant is the target.
11393
11394 @item -mdisable-callt
11395 @opindex mdisable-callt
11396 This option will suppress generation of the CALLT instruction for the
11397 v850e and v850e1 flavors of the v850 architecture.  The default is
11398 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11399
11400 @end table
11401
11402 @node VAX Options
11403 @subsection VAX Options
11404 @cindex VAX options
11405
11406 These @samp{-m} options are defined for the VAX:
11407
11408 @table @gcctabopt
11409 @item -munix
11410 @opindex munix
11411 Do not output certain jump instructions (@code{aobleq} and so on)
11412 that the Unix assembler for the VAX cannot handle across long
11413 ranges.
11414
11415 @item -mgnu
11416 @opindex mgnu
11417 Do output those jump instructions, on the assumption that you
11418 will assemble with the GNU assembler.
11419
11420 @item -mg
11421 @opindex mg
11422 Output code for g-format floating point numbers instead of d-format.
11423 @end table
11424
11425 @node x86-64 Options
11426 @subsection x86-64 Options
11427 @cindex x86-64 options
11428
11429 These are listed under @xref{i386 and x86-64 Options}.
11430
11431 @node Xstormy16 Options
11432 @subsection Xstormy16 Options
11433 @cindex Xstormy16 Options
11434
11435 These options are defined for Xstormy16:
11436
11437 @table @gcctabopt
11438 @item -msim
11439 @opindex msim
11440 Choose startup files and linker script suitable for the simulator.
11441 @end table
11442
11443 @node Xtensa Options
11444 @subsection Xtensa Options
11445 @cindex Xtensa Options
11446
11447 These options are supported for Xtensa targets:
11448
11449 @table @gcctabopt
11450 @item -mconst16
11451 @itemx -mno-const16
11452 @opindex mconst16
11453 @opindex mno-const16
11454 Enable or disable use of @code{CONST16} instructions for loading
11455 constant values.  The @code{CONST16} instruction is currently not a
11456 standard option from Tensilica.  When enabled, @code{CONST16}
11457 instructions are always used in place of the standard @code{L32R}
11458 instructions.  The use of @code{CONST16} is enabled by default only if
11459 the @code{L32R} instruction is not available.
11460
11461 @item -mfused-madd
11462 @itemx -mno-fused-madd
11463 @opindex mfused-madd
11464 @opindex mno-fused-madd
11465 Enable or disable use of fused multiply/add and multiply/subtract
11466 instructions in the floating-point option.  This has no effect if the
11467 floating-point option is not also enabled.  Disabling fused multiply/add
11468 and multiply/subtract instructions forces the compiler to use separate
11469 instructions for the multiply and add/subtract operations.  This may be
11470 desirable in some cases where strict IEEE 754-compliant results are
11471 required: the fused multiply add/subtract instructions do not round the
11472 intermediate result, thereby producing results with @emph{more} bits of
11473 precision than specified by the IEEE standard.  Disabling fused multiply
11474 add/subtract instructions also ensures that the program output is not
11475 sensitive to the compiler's ability to combine multiply and add/subtract
11476 operations.
11477
11478 @item -mtext-section-literals
11479 @itemx -mno-text-section-literals
11480 @opindex mtext-section-literals
11481 @opindex mno-text-section-literals
11482 Control the treatment of literal pools.  The default is
11483 @option{-mno-text-section-literals}, which places literals in a separate
11484 section in the output file.  This allows the literal pool to be placed
11485 in a data RAM/ROM, and it also allows the linker to combine literal
11486 pools from separate object files to remove redundant literals and
11487 improve code size.  With @option{-mtext-section-literals}, the literals
11488 are interspersed in the text section in order to keep them as close as
11489 possible to their references.  This may be necessary for large assembly
11490 files.
11491
11492 @item -mtarget-align
11493 @itemx -mno-target-align
11494 @opindex mtarget-align
11495 @opindex mno-target-align
11496 When this option is enabled, GCC instructs the assembler to
11497 automatically align instructions to reduce branch penalties at the
11498 expense of some code density.  The assembler attempts to widen density
11499 instructions to align branch targets and the instructions following call
11500 instructions.  If there are not enough preceding safe density
11501 instructions to align a target, no widening will be performed.  The
11502 default is @option{-mtarget-align}.  These options do not affect the
11503 treatment of auto-aligned instructions like @code{LOOP}, which the
11504 assembler will always align, either by widening density instructions or
11505 by inserting no-op instructions.
11506
11507 @item -mlongcalls
11508 @itemx -mno-longcalls
11509 @opindex mlongcalls
11510 @opindex mno-longcalls
11511 When this option is enabled, GCC instructs the assembler to translate
11512 direct calls to indirect calls unless it can determine that the target
11513 of a direct call is in the range allowed by the call instruction.  This
11514 translation typically occurs for calls to functions in other source
11515 files.  Specifically, the assembler translates a direct @code{CALL}
11516 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11517 The default is @option{-mno-longcalls}.  This option should be used in
11518 programs where the call target can potentially be out of range.  This
11519 option is implemented in the assembler, not the compiler, so the
11520 assembly code generated by GCC will still show direct call
11521 instructions---look at the disassembled object code to see the actual
11522 instructions.  Note that the assembler will use an indirect call for
11523 every cross-file call, not just those that really will be out of range.
11524 @end table
11525
11526 @node zSeries Options
11527 @subsection zSeries Options
11528 @cindex zSeries options
11529
11530 These are listed under @xref{S/390 and zSeries Options}.
11531
11532 @node Code Gen Options
11533 @section Options for Code Generation Conventions
11534 @cindex code generation conventions
11535 @cindex options, code generation
11536 @cindex run-time options
11537
11538 These machine-independent options control the interface conventions
11539 used in code generation.
11540
11541 Most of them have both positive and negative forms; the negative form
11542 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11543 one of the forms is listed---the one which is not the default.  You
11544 can figure out the other form by either removing @samp{no-} or adding
11545 it.
11546
11547 @table @gcctabopt
11548 @item -fbounds-check
11549 @opindex fbounds-check
11550 For front-ends that support it, generate additional code to check that
11551 indices used to access arrays are within the declared range.  This is
11552 currently only supported by the Java and Fortran 77 front-ends, where
11553 this option defaults to true and false respectively.
11554
11555 @item -ftrapv
11556 @opindex ftrapv
11557 This option generates traps for signed overflow on addition, subtraction,
11558 multiplication operations.
11559
11560 @item -fwrapv
11561 @opindex fwrapv
11562 This option instructs the compiler to assume that signed arithmetic
11563 overflow of addition, subtraction and multiplication wraps around
11564 using twos-complement representation.  This flag enables some optimizations
11565 and disables other.  This option is enabled by default for the Java
11566 front-end, as required by the Java language specification.
11567
11568 @item -fexceptions
11569 @opindex fexceptions
11570 Enable exception handling.  Generates extra code needed to propagate
11571 exceptions.  For some targets, this implies GCC will generate frame
11572 unwind information for all functions, which can produce significant data
11573 size overhead, although it does not affect execution.  If you do not
11574 specify this option, GCC will enable it by default for languages like
11575 C++ which normally require exception handling, and disable it for
11576 languages like C that do not normally require it.  However, you may need
11577 to enable this option when compiling C code that needs to interoperate
11578 properly with exception handlers written in C++.  You may also wish to
11579 disable this option if you are compiling older C++ programs that don't
11580 use exception handling.
11581
11582 @item -fnon-call-exceptions
11583 @opindex fnon-call-exceptions
11584 Generate code that allows trapping instructions to throw exceptions.
11585 Note that this requires platform-specific runtime support that does
11586 not exist everywhere.  Moreover, it only allows @emph{trapping}
11587 instructions to throw exceptions, i.e.@: memory references or floating
11588 point instructions.  It does not allow exceptions to be thrown from
11589 arbitrary signal handlers such as @code{SIGALRM}.
11590
11591 @item -funwind-tables
11592 @opindex funwind-tables
11593 Similar to @option{-fexceptions}, except that it will just generate any needed
11594 static data, but will not affect the generated code in any other way.
11595 You will normally not enable this option; instead, a language processor
11596 that needs this handling would enable it on your behalf.
11597
11598 @item -fasynchronous-unwind-tables
11599 @opindex fasynchronous-unwind-tables
11600 Generate unwind table in dwarf2 format, if supported by target machine.  The
11601 table is exact at each instruction boundary, so it can be used for stack
11602 unwinding from asynchronous events (such as debugger or garbage collector).
11603
11604 @item -fpcc-struct-return
11605 @opindex fpcc-struct-return
11606 Return ``short'' @code{struct} and @code{union} values in memory like
11607 longer ones, rather than in registers.  This convention is less
11608 efficient, but it has the advantage of allowing intercallability between
11609 GCC-compiled files and files compiled with other compilers, particularly
11610 the Portable C Compiler (pcc).
11611
11612 The precise convention for returning structures in memory depends
11613 on the target configuration macros.
11614
11615 Short structures and unions are those whose size and alignment match
11616 that of some integer type.
11617
11618 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11619 switch is not binary compatible with code compiled with the
11620 @option{-freg-struct-return} switch.
11621 Use it to conform to a non-default application binary interface.
11622
11623 @item -freg-struct-return
11624 @opindex freg-struct-return
11625 Return @code{struct} and @code{union} values in registers when possible.
11626 This is more efficient for small structures than
11627 @option{-fpcc-struct-return}.
11628
11629 If you specify neither @option{-fpcc-struct-return} nor
11630 @option{-freg-struct-return}, GCC defaults to whichever convention is
11631 standard for the target.  If there is no standard convention, GCC
11632 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11633 the principal compiler.  In those cases, we can choose the standard, and
11634 we chose the more efficient register return alternative.
11635
11636 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11637 switch is not binary compatible with code compiled with the
11638 @option{-fpcc-struct-return} switch.
11639 Use it to conform to a non-default application binary interface.
11640
11641 @item -fshort-enums
11642 @opindex fshort-enums
11643 Allocate to an @code{enum} type only as many bytes as it needs for the
11644 declared range of possible values.  Specifically, the @code{enum} type
11645 will be equivalent to the smallest integer type which has enough room.
11646
11647 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11648 code that is not binary compatible with code generated without that switch.
11649 Use it to conform to a non-default application binary interface.
11650
11651 @item -fshort-double
11652 @opindex fshort-double
11653 Use the same size for @code{double} as for @code{float}.
11654
11655 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11656 code that is not binary compatible with code generated without that switch.
11657 Use it to conform to a non-default application binary interface.
11658
11659 @item -fshort-wchar
11660 @opindex fshort-wchar
11661 Override the underlying type for @samp{wchar_t} to be @samp{short
11662 unsigned int} instead of the default for the target.  This option is
11663 useful for building programs to run under WINE@.
11664
11665 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11666 code that is not binary compatible with code generated without that switch.
11667 Use it to conform to a non-default application binary interface.
11668
11669 @item -fshared-data
11670 @opindex fshared-data
11671 Requests that the data and non-@code{const} variables of this
11672 compilation be shared data rather than private data.  The distinction
11673 makes sense only on certain operating systems, where shared data is
11674 shared between processes running the same program, while private data
11675 exists in one copy per process.
11676
11677 @item -fno-common
11678 @opindex fno-common
11679 In C, allocate even uninitialized global variables in the data section of the
11680 object file, rather than generating them as common blocks.  This has the
11681 effect that if the same variable is declared (without @code{extern}) in
11682 two different compilations, you will get an error when you link them.
11683 The only reason this might be useful is if you wish to verify that the
11684 program will work on other systems which always work this way.
11685
11686 @item -fno-ident
11687 @opindex fno-ident
11688 Ignore the @samp{#ident} directive.
11689
11690 @item -finhibit-size-directive
11691 @opindex finhibit-size-directive
11692 Don't output a @code{.size} assembler directive, or anything else that
11693 would cause trouble if the function is split in the middle, and the
11694 two halves are placed at locations far apart in memory.  This option is
11695 used when compiling @file{crtstuff.c}; you should not need to use it
11696 for anything else.
11697
11698 @item -fverbose-asm
11699 @opindex fverbose-asm
11700 Put extra commentary information in the generated assembly code to
11701 make it more readable.  This option is generally only of use to those
11702 who actually need to read the generated assembly code (perhaps while
11703 debugging the compiler itself).
11704
11705 @option{-fno-verbose-asm}, the default, causes the
11706 extra information to be omitted and is useful when comparing two assembler
11707 files.
11708
11709 @item -fpic
11710 @opindex fpic
11711 @cindex global offset table
11712 @cindex PIC
11713 Generate position-independent code (PIC) suitable for use in a shared
11714 library, if supported for the target machine.  Such code accesses all
11715 constant addresses through a global offset table (GOT)@.  The dynamic
11716 loader resolves the GOT entries when the program starts (the dynamic
11717 loader is not part of GCC; it is part of the operating system).  If
11718 the GOT size for the linked executable exceeds a machine-specific
11719 maximum size, you get an error message from the linker indicating that
11720 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11721 instead.  (These maximums are 8k on the SPARC and 32k
11722 on the m68k and RS/6000.  The 386 has no such limit.)
11723
11724 Position-independent code requires special support, and therefore works
11725 only on certain machines.  For the 386, GCC supports PIC for System V
11726 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11727 position-independent.
11728
11729 @item -fPIC
11730 @opindex fPIC
11731 If supported for the target machine, emit position-independent code,
11732 suitable for dynamic linking and avoiding any limit on the size of the
11733 global offset table.  This option makes a difference on the m68k
11734 and the SPARC.
11735
11736 Position-independent code requires special support, and therefore works
11737 only on certain machines.
11738
11739 @item -fpie
11740 @itemx -fPIE
11741 @opindex fpie
11742 @opindex fPIE
11743 These options are similar to @option{-fpic} and @option{-fPIC}, but
11744 generated position independent code can be only linked into executables.
11745 Usually these options are used when @option{-pie} GCC option will be
11746 used during linking.
11747
11748 @item -ffixed-@var{reg}
11749 @opindex ffixed
11750 Treat the register named @var{reg} as a fixed register; generated code
11751 should never refer to it (except perhaps as a stack pointer, frame
11752 pointer or in some other fixed role).
11753
11754 @var{reg} must be the name of a register.  The register names accepted
11755 are machine-specific and are defined in the @code{REGISTER_NAMES}
11756 macro in the machine description macro file.
11757
11758 This flag does not have a negative form, because it specifies a
11759 three-way choice.
11760
11761 @item -fcall-used-@var{reg}
11762 @opindex fcall-used
11763 Treat the register named @var{reg} as an allocable register that is
11764 clobbered by function calls.  It may be allocated for temporaries or
11765 variables that do not live across a call.  Functions compiled this way
11766 will not save and restore the register @var{reg}.
11767
11768 It is an error to used this flag with the frame pointer or stack pointer.
11769 Use of this flag for other registers that have fixed pervasive roles in
11770 the machine's execution model will produce disastrous results.
11771
11772 This flag does not have a negative form, because it specifies a
11773 three-way choice.
11774
11775 @item -fcall-saved-@var{reg}
11776 @opindex fcall-saved
11777 Treat the register named @var{reg} as an allocable register saved by
11778 functions.  It may be allocated even for temporaries or variables that
11779 live across a call.  Functions compiled this way will save and restore
11780 the register @var{reg} if they use it.
11781
11782 It is an error to used this flag with the frame pointer or stack pointer.
11783 Use of this flag for other registers that have fixed pervasive roles in
11784 the machine's execution model will produce disastrous results.
11785
11786 A different sort of disaster will result from the use of this flag for
11787 a register in which function values may be returned.
11788
11789 This flag does not have a negative form, because it specifies a
11790 three-way choice.
11791
11792 @item -fpack-struct
11793 @opindex fpack-struct
11794 Pack all structure members together without holes.
11795
11796 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11797 code that is not binary compatible with code generated without that switch.
11798 Additionally, it makes the code suboptimal.
11799 Use it to conform to a non-default application binary interface.
11800
11801 @item -finstrument-functions
11802 @opindex finstrument-functions
11803 Generate instrumentation calls for entry and exit to functions.  Just
11804 after function entry and just before function exit, the following
11805 profiling functions will be called with the address of the current
11806 function and its call site.  (On some platforms,
11807 @code{__builtin_return_address} does not work beyond the current
11808 function, so the call site information may not be available to the
11809 profiling functions otherwise.)
11810
11811 @smallexample
11812 void __cyg_profile_func_enter (void *this_fn,
11813                                void *call_site);
11814 void __cyg_profile_func_exit  (void *this_fn,
11815                                void *call_site);
11816 @end smallexample
11817
11818 The first argument is the address of the start of the current function,
11819 which may be looked up exactly in the symbol table.
11820
11821 This instrumentation is also done for functions expanded inline in other
11822 functions.  The profiling calls will indicate where, conceptually, the
11823 inline function is entered and exited.  This means that addressable
11824 versions of such functions must be available.  If all your uses of a
11825 function are expanded inline, this may mean an additional expansion of
11826 code size.  If you use @samp{extern inline} in your C code, an
11827 addressable version of such functions must be provided.  (This is
11828 normally the case anyways, but if you get lucky and the optimizer always
11829 expands the functions inline, you might have gotten away without
11830 providing static copies.)
11831
11832 A function may be given the attribute @code{no_instrument_function}, in
11833 which case this instrumentation will not be done.  This can be used, for
11834 example, for the profiling functions listed above, high-priority
11835 interrupt routines, and any functions from which the profiling functions
11836 cannot safely be called (perhaps signal handlers, if the profiling
11837 routines generate output or allocate memory).
11838
11839 @item -fstack-check
11840 @opindex fstack-check
11841 Generate code to verify that you do not go beyond the boundary of the
11842 stack.  You should specify this flag if you are running in an
11843 environment with multiple threads, but only rarely need to specify it in
11844 a single-threaded environment since stack overflow is automatically
11845 detected on nearly all systems if there is only one stack.
11846
11847 Note that this switch does not actually cause checking to be done; the
11848 operating system must do that.  The switch causes generation of code
11849 to ensure that the operating system sees the stack being extended.
11850
11851 @item -fstack-limit-register=@var{reg}
11852 @itemx -fstack-limit-symbol=@var{sym}
11853 @itemx -fno-stack-limit
11854 @opindex fstack-limit-register
11855 @opindex fstack-limit-symbol
11856 @opindex fno-stack-limit
11857 Generate code to ensure that the stack does not grow beyond a certain value,
11858 either the value of a register or the address of a symbol.  If the stack
11859 would grow beyond the value, a signal is raised.  For most targets,
11860 the signal is raised before the stack overruns the boundary, so
11861 it is possible to catch the signal without taking special precautions.
11862
11863 For instance, if the stack starts at absolute address @samp{0x80000000}
11864 and grows downwards, you can use the flags
11865 @option{-fstack-limit-symbol=__stack_limit} and
11866 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11867 of 128KB@.  Note that this may only work with the GNU linker.
11868
11869 @cindex aliasing of parameters
11870 @cindex parameters, aliased
11871 @item -fargument-alias
11872 @itemx -fargument-noalias
11873 @itemx -fargument-noalias-global
11874 @opindex fargument-alias
11875 @opindex fargument-noalias
11876 @opindex fargument-noalias-global
11877 Specify the possible relationships among parameters and between
11878 parameters and global data.
11879
11880 @option{-fargument-alias} specifies that arguments (parameters) may
11881 alias each other and may alias global storage.@*
11882 @option{-fargument-noalias} specifies that arguments do not alias
11883 each other, but may alias global storage.@*
11884 @option{-fargument-noalias-global} specifies that arguments do not
11885 alias each other and do not alias global storage.
11886
11887 Each language will automatically use whatever option is required by
11888 the language standard.  You should not need to use these options yourself.
11889
11890 @item -fleading-underscore
11891 @opindex fleading-underscore
11892 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11893 change the way C symbols are represented in the object file.  One use
11894 is to help link with legacy assembly code.
11895
11896 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11897 generate code that is not binary compatible with code generated without that
11898 switch.  Use it to conform to a non-default application binary interface.
11899 Not all targets provide complete support for this switch.
11900
11901 @item -ftls-model=@var{model}
11902 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11903 The @var{model} argument should be one of @code{global-dynamic},
11904 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11905
11906 The default without @option{-fpic} is @code{initial-exec}; with
11907 @option{-fpic} the default is @code{global-dynamic}.
11908
11909 @item -fvisibility=@var{default|internal|hidden|protected}
11910 @opindex fvisibility
11911 Set the default ELF image symbol visibility to the specified option - all
11912 symbols will be marked with this unless overrided within the code.
11913 Using this feature can very substantially improve linking and
11914 load times of shared object libraries, produce more optimised
11915 code, provide near-perfect API export and prevent symbol clashes.
11916 It is @strong{strongly} recommended that you use this in any shared objects
11917 you distribute.
11918      
11919 Despite the nomenclature, @code{default} always means public ie;
11920 available to be linked against from outside the shared object.
11921 @code{protected} and @code{internal} are pretty useless in real-world
11922 usage so the only other commonly used option will be @code{hidden}.
11923 The default if -fvisibility isn't specified is @code{default} ie; make every
11924 symbol public - this causes the same behaviour as previous versions of
11925 GCC.
11926      
11927 A good explanation of the benefits offered by ensuring ELF
11928 symbols have the correct visibility is given by ``How To Write
11929 Shared Libraries'' by Ulrich Drepper (which can be found at
11930 @w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
11931 solution made possible by this option to marking things hidden when
11932 the default is public is to make the default hidden and mark things
11933 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
11934 and @code{__attribute__ ((visibility("default")))} instead of
11935 @code{__declspec(dllexport)} you get almost identical semantics with
11936 identical syntax. This is a great boon to those working with
11937 cross-platform projects.
11938
11939 For those adding visibility support to existing code, you may find
11940 @samp{#pragma GCC visibility} of use. This works by you enclosing
11941 the declarations you wish to set visibility for with (for example)
11942 @samp{#pragma GCC visibility push(hidden)} and
11943 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
11944 times. Bear in mind that symbol visibility should be viewed @strong{as
11945 part of the API interface contract} and thus all new code should
11946 always specify visibility when it is not the default ie; declarations
11947 only for use within the local DSO should @strong{always} be marked explicitly
11948 as hidden as so to avoid PLT indirection overheads - making this
11949 abundantly clear also aids readability and self-documentation of the code.
11950 Note that due to ISO C++ specification requirements, operator new and
11951 operator delete must always be of default visibility.
11952
11953 An overview of these techniques, their benefits and how to use them
11954 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
11955
11956 @end table
11957
11958 @c man end
11959
11960 @node Environment Variables
11961 @section Environment Variables Affecting GCC
11962 @cindex environment variables
11963
11964 @c man begin ENVIRONMENT
11965 This section describes several environment variables that affect how GCC
11966 operates.  Some of them work by specifying directories or prefixes to use
11967 when searching for various kinds of files.  Some are used to specify other
11968 aspects of the compilation environment.
11969
11970 Note that you can also specify places to search using options such as
11971 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11972 take precedence over places specified using environment variables, which
11973 in turn take precedence over those specified by the configuration of GCC@.
11974 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11975 GNU Compiler Collection (GCC) Internals}.
11976
11977 @table @env
11978 @item LANG
11979 @itemx LC_CTYPE
11980 @c @itemx LC_COLLATE
11981 @itemx LC_MESSAGES
11982 @c @itemx LC_MONETARY
11983 @c @itemx LC_NUMERIC
11984 @c @itemx LC_TIME
11985 @itemx LC_ALL
11986 @findex LANG
11987 @findex LC_CTYPE
11988 @c @findex LC_COLLATE
11989 @findex LC_MESSAGES
11990 @c @findex LC_MONETARY
11991 @c @findex LC_NUMERIC
11992 @c @findex LC_TIME
11993 @findex LC_ALL
11994 @cindex locale
11995 These environment variables control the way that GCC uses
11996 localization information that allow GCC to work with different
11997 national conventions.  GCC inspects the locale categories
11998 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11999 so.  These locale categories can be set to any value supported by your
12000 installation.  A typical value is @samp{en_UK} for English in the United
12001 Kingdom.
12002
12003 The @env{LC_CTYPE} environment variable specifies character
12004 classification.  GCC uses it to determine the character boundaries in
12005 a string; this is needed for some multibyte encodings that contain quote
12006 and escape characters that would otherwise be interpreted as a string
12007 end or escape.
12008
12009 The @env{LC_MESSAGES} environment variable specifies the language to
12010 use in diagnostic messages.
12011
12012 If the @env{LC_ALL} environment variable is set, it overrides the value
12013 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12014 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12015 environment variable.  If none of these variables are set, GCC
12016 defaults to traditional C English behavior.
12017
12018 @item TMPDIR
12019 @findex TMPDIR
12020 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12021 files.  GCC uses temporary files to hold the output of one stage of
12022 compilation which is to be used as input to the next stage: for example,
12023 the output of the preprocessor, which is the input to the compiler
12024 proper.
12025
12026 @item GCC_EXEC_PREFIX
12027 @findex GCC_EXEC_PREFIX
12028 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12029 names of the subprograms executed by the compiler.  No slash is added
12030 when this prefix is combined with the name of a subprogram, but you can
12031 specify a prefix that ends with a slash if you wish.
12032
12033 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12034 an appropriate prefix to use based on the pathname it was invoked with.
12035
12036 If GCC cannot find the subprogram using the specified prefix, it
12037 tries looking in the usual places for the subprogram.
12038
12039 The default value of @env{GCC_EXEC_PREFIX} is
12040 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12041 of @code{prefix} when you ran the @file{configure} script.
12042
12043 Other prefixes specified with @option{-B} take precedence over this prefix.
12044
12045 This prefix is also used for finding files such as @file{crt0.o} that are
12046 used for linking.
12047
12048 In addition, the prefix is used in an unusual way in finding the
12049 directories to search for header files.  For each of the standard
12050 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12051 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12052 replacing that beginning with the specified prefix to produce an
12053 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12054 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12055 These alternate directories are searched first; the standard directories
12056 come next.
12057
12058 @item COMPILER_PATH
12059 @findex COMPILER_PATH
12060 The value of @env{COMPILER_PATH} is a colon-separated list of
12061 directories, much like @env{PATH}.  GCC tries the directories thus
12062 specified when searching for subprograms, if it can't find the
12063 subprograms using @env{GCC_EXEC_PREFIX}.
12064
12065 @item LIBRARY_PATH
12066 @findex LIBRARY_PATH
12067 The value of @env{LIBRARY_PATH} is a colon-separated list of
12068 directories, much like @env{PATH}.  When configured as a native compiler,
12069 GCC tries the directories thus specified when searching for special
12070 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12071 using GCC also uses these directories when searching for ordinary
12072 libraries for the @option{-l} option (but directories specified with
12073 @option{-L} come first).
12074
12075 @item LANG
12076 @findex LANG
12077 @cindex locale definition
12078 This variable is used to pass locale information to the compiler.  One way in
12079 which this information is used is to determine the character set to be used
12080 when character literals, string literals and comments are parsed in C and C++.
12081 When the compiler is configured to allow multibyte characters,
12082 the following values for @env{LANG} are recognized:
12083
12084 @table @samp
12085 @item C-JIS
12086 Recognize JIS characters.
12087 @item C-SJIS
12088 Recognize SJIS characters.
12089 @item C-EUCJP
12090 Recognize EUCJP characters.
12091 @end table
12092
12093 If @env{LANG} is not defined, or if it has some other value, then the
12094 compiler will use mblen and mbtowc as defined by the default locale to
12095 recognize and translate multibyte characters.
12096 @end table
12097
12098 @noindent
12099 Some additional environments variables affect the behavior of the
12100 preprocessor.
12101
12102 @include cppenv.texi
12103
12104 @c man end
12105
12106 @node Precompiled Headers
12107 @section Using Precompiled Headers
12108 @cindex precompiled headers
12109 @cindex speed of compilation
12110
12111 Often large projects have many header files that are included in every
12112 source file.  The time the compiler takes to process these header files
12113 over and over again can account for nearly all of the time required to
12114 build the project.  To make builds faster, GCC allows users to
12115 `precompile' a header file; then, if builds can use the precompiled
12116 header file they will be much faster.
12117
12118 @strong{Caution:} There are a few known situations where GCC will
12119 crash when trying to use a precompiled header.  If you have trouble
12120 with a precompiled header, you should remove the precompiled header
12121 and compile without it.  In addition, please use GCC's on-line
12122 defect-tracking system to report any problems you encounter with
12123 precompiled headers.  @xref{Bugs}.
12124
12125 To create a precompiled header file, simply compile it as you would any
12126 other file, if necessary using the @option{-x} option to make the driver
12127 treat it as a C or C++ header file.  You will probably want to use a
12128 tool like @command{make} to keep the precompiled header up-to-date when
12129 the headers it contains change.
12130
12131 A precompiled header file will be searched for when @code{#include} is
12132 seen in the compilation.  As it searches for the included file
12133 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12134 compiler looks for a precompiled header in each directory just before it
12135 looks for the include file in that directory.  The name searched for is
12136 the name specified in the @code{#include} with @samp{.gch} appended.  If
12137 the precompiled header file can't be used, it is ignored.
12138
12139 For instance, if you have @code{#include "all.h"}, and you have
12140 @file{all.h.gch} in the same directory as @file{all.h}, then the
12141 precompiled header file will be used if possible, and the original
12142 header will be used otherwise.
12143
12144 Alternatively, you might decide to put the precompiled header file in a
12145 directory and use @option{-I} to ensure that directory is searched
12146 before (or instead of) the directory containing the original header.
12147 Then, if you want to check that the precompiled header file is always
12148 used, you can put a file of the same name as the original header in this
12149 directory containing an @code{#error} command.
12150
12151 This also works with @option{-include}.  So yet another way to use
12152 precompiled headers, good for projects not designed with precompiled
12153 header files in mind, is to simply take most of the header files used by
12154 a project, include them from another header file, precompile that header
12155 file, and @option{-include} the precompiled header.  If the header files
12156 have guards against multiple inclusion, they will be skipped because
12157 they've already been included (in the precompiled header).
12158
12159 If you need to precompile the same header file for different
12160 languages, targets, or compiler options, you can instead make a
12161 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12162 header in the directory, perhaps using @option{-o}.  It doesn't matter
12163 what you call the files in the directory, every precompiled header in
12164 the directory will be considered.  The first precompiled header
12165 encountered in the directory that is valid for this compilation will
12166 be used; they're searched in no particular order.
12167
12168 There are many other possibilities, limited only by your imagination,
12169 good sense, and the constraints of your build system.
12170
12171 A precompiled header file can be used only when these conditions apply:
12172
12173 @itemize
12174 @item
12175 Only one precompiled header can be used in a particular compilation.
12176
12177 @item
12178 A precompiled header can't be used once the first C token is seen.  You
12179 can have preprocessor directives before a precompiled header; you can
12180 even include a precompiled header from inside another header, so long as
12181 there are no C tokens before the @code{#include}.
12182
12183 @item
12184 The precompiled header file must be produced for the same language as
12185 the current compilation.  You can't use a C precompiled header for a C++
12186 compilation.
12187
12188 @item
12189 The precompiled header file must be produced by the same compiler
12190 version and configuration as the current compilation is using.
12191 The easiest way to guarantee this is to use the same compiler binary
12192 for creating and using precompiled headers.
12193
12194 @item
12195 Any macros defined before the precompiled header is included must
12196 either be defined in the same way as when the precompiled header was
12197 generated, or must not affect the precompiled header, which usually
12198 means that the they don't appear in the precompiled header at all.
12199
12200 The @option{-D} option is one way to define a macro before a
12201 precompiled header is included; using a @code{#define} can also do it.
12202 There are also some options that define macros implicitly, like
12203 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12204 defined this way.
12205
12206 @item If debugging information is output when using the precompiled
12207 header, using @option{-g} or similar, the same kind of debugging information
12208 must have been output when building the precompiled header.  However,
12209 a precompiled header built using @option{-g} can be used in a compilation
12210 when no debugging information is being output.
12211
12212 @item The same @option{-m} options must generally be used when building
12213 and using the precompiled header.  @xref{Submodel Options},
12214 for any cases where this rule is relaxed.
12215
12216 @item Each of the following options must be the same when building and using
12217 the precompiled header:
12218
12219 @gccoptlist{-fexceptions -funit-at-a-time}
12220
12221 @item
12222 Some other command-line options starting with @option{-f},
12223 @option{-p}, or @option{-O} must be defined in the same way as when
12224 the precompiled header was generated.  At present, it's not clear
12225 which options are safe to change and which are not; the safest choice
12226 is to use exactly the same options when generating and using the
12227 precompiled header.  The following are known to be safe:
12228
12229 @gccoptlist{-fpreprocessed -pedantic-errors}
12230
12231 @end itemize
12232
12233 For all of these except the last, the compiler will automatically
12234 ignore the precompiled header if the conditions aren't met.  If you
12235 find an option combination that doesn't work and doesn't cause the
12236 precompiled header to be ignored, please consider filing a bug report,
12237 see @ref{Bugs}.
12238
12239 If you do use differing options when generating and using the
12240 precompiled header, the actual behaviour will be a mixture of the
12241 behaviour for the options.  For instance, if you use @option{-g} to
12242 generate the precompiled header but not when using it, you may or may
12243 not get debugging information for routines in the precompiled header.
12244
12245 @node Running Protoize
12246 @section Running Protoize
12247
12248 The program @code{protoize} is an optional part of GCC@.  You can use
12249 it to add prototypes to a program, thus converting the program to ISO
12250 C in one respect.  The companion program @code{unprotoize} does the
12251 reverse: it removes argument types from any prototypes that are found.
12252
12253 When you run these programs, you must specify a set of source files as
12254 command line arguments.  The conversion programs start out by compiling
12255 these files to see what functions they define.  The information gathered
12256 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12257
12258 After scanning comes actual conversion.  The specified files are all
12259 eligible to be converted; any files they include (whether sources or
12260 just headers) are eligible as well.
12261
12262 But not all the eligible files are converted.  By default,
12263 @code{protoize} and @code{unprotoize} convert only source and header
12264 files in the current directory.  You can specify additional directories
12265 whose files should be converted with the @option{-d @var{directory}}
12266 option.  You can also specify particular files to exclude with the
12267 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12268 directory name matches one of the specified directory names, and its
12269 name within the directory has not been excluded.
12270
12271 Basic conversion with @code{protoize} consists of rewriting most
12272 function definitions and function declarations to specify the types of
12273 the arguments.  The only ones not rewritten are those for varargs
12274 functions.
12275
12276 @code{protoize} optionally inserts prototype declarations at the
12277 beginning of the source file, to make them available for any calls that
12278 precede the function's definition.  Or it can insert prototype
12279 declarations with block scope in the blocks where undeclared functions
12280 are called.
12281
12282 Basic conversion with @code{unprotoize} consists of rewriting most
12283 function declarations to remove any argument types, and rewriting
12284 function definitions to the old-style pre-ISO form.
12285
12286 Both conversion programs print a warning for any function declaration or
12287 definition that they can't convert.  You can suppress these warnings
12288 with @option{-q}.
12289
12290 The output from @code{protoize} or @code{unprotoize} replaces the
12291 original source file.  The original file is renamed to a name ending
12292 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12293 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12294 for DOS) file already exists, then the source file is simply discarded.
12295
12296 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12297 scan the program and collect information about the functions it uses.
12298 So neither of these programs will work until GCC is installed.
12299
12300 Here is a table of the options you can use with @code{protoize} and
12301 @code{unprotoize}.  Each option works with both programs unless
12302 otherwise stated.
12303
12304 @table @code
12305 @item -B @var{directory}
12306 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12307 usual directory (normally @file{/usr/local/lib}).  This file contains
12308 prototype information about standard system functions.  This option
12309 applies only to @code{protoize}.
12310
12311 @item -c @var{compilation-options}
12312 Use @var{compilation-options} as the options when running @command{gcc} to
12313 produce the @samp{.X} files.  The special option @option{-aux-info} is
12314 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12315
12316 Note that the compilation options must be given as a single argument to
12317 @code{protoize} or @code{unprotoize}.  If you want to specify several
12318 @command{gcc} options, you must quote the entire set of compilation options
12319 to make them a single word in the shell.
12320
12321 There are certain @command{gcc} arguments that you cannot use, because they
12322 would produce the wrong kind of output.  These include @option{-g},
12323 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12324 the @var{compilation-options}, they are ignored.
12325
12326 @item -C
12327 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12328 systems) instead of @samp{.c}.  This is convenient if you are converting
12329 a C program to C++.  This option applies only to @code{protoize}.
12330
12331 @item -g
12332 Add explicit global declarations.  This means inserting explicit
12333 declarations at the beginning of each source file for each function
12334 that is called in the file and was not declared.  These declarations
12335 precede the first function definition that contains a call to an
12336 undeclared function.  This option applies only to @code{protoize}.
12337
12338 @item -i @var{string}
12339 Indent old-style parameter declarations with the string @var{string}.
12340 This option applies only to @code{protoize}.
12341
12342 @code{unprotoize} converts prototyped function definitions to old-style
12343 function definitions, where the arguments are declared between the
12344 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12345 uses five spaces as the indentation.  If you want to indent with just
12346 one space instead, use @option{-i " "}.
12347
12348 @item -k
12349 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12350 is finished.
12351
12352 @item -l
12353 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12354 a prototype declaration for each function in each block which calls the
12355 function without any declaration.  This option applies only to
12356 @code{protoize}.
12357
12358 @item -n
12359 Make no real changes.  This mode just prints information about the conversions
12360 that would have been done without @option{-n}.
12361
12362 @item -N
12363 Make no @samp{.save} files.  The original files are simply deleted.
12364 Use this option with caution.
12365
12366 @item -p @var{program}
12367 Use the program @var{program} as the compiler.  Normally, the name
12368 @file{gcc} is used.
12369
12370 @item -q
12371 Work quietly.  Most warnings are suppressed.
12372
12373 @item -v
12374 Print the version number, just like @option{-v} for @command{gcc}.
12375 @end table
12376
12377 If you need special compiler options to compile one of your program's
12378 source files, then you should generate that file's @samp{.X} file
12379 specially, by running @command{gcc} on that source file with the
12380 appropriate options and the option @option{-aux-info}.  Then run
12381 @code{protoize} on the entire set of files.  @code{protoize} will use
12382 the existing @samp{.X} file because it is newer than the source file.
12383 For example:
12384
12385 @smallexample
12386 gcc -Dfoo=bar file1.c -aux-info file1.X
12387 protoize *.c
12388 @end smallexample
12389
12390 @noindent
12391 You need to include the special files along with the rest in the
12392 @code{protoize} command, even though their @samp{.X} files already
12393 exist, because otherwise they won't get converted.
12394
12395 @xref{Protoize Caveats}, for more information on how to use
12396 @code{protoize} successfully.