Include option as item for -Wp description to match the rest of the
[netbsd-mini2440.git] / gnu / dist / gcc4 / gcc / doc / invoke.texi
blob4e8e8d93d9d4ad38fc079e6b86c8cfe6c5fc1b33
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
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.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
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{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
164 -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}
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  -ffriend-injection  -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  -Wstrict-null-sentinel @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo}
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-call-cxx-cdtors @gol
202 -fobjc-direct-dispatch @gol
203 -fobjc-exceptions @gol
204 -fobjc-gc @gol
205 -freplace-objc-classes @gol
206 -fzero-link @gol
207 -gen-decls @gol
208 -Wassign-intercept @gol
209 -Wno-protocol  -Wselector @gol
210 -Wstrict-selector-match @gol
211 -Wundeclared-selector}
213 @item Language Independent Options
214 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
215 @gccoptlist{-fmessage-length=@var{n}  @gol
216 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} @gol
217 -fdiagnostics-show-options}
219 @item Warning Options
220 @xref{Warning Options,,Options to Request or Suppress Warnings}.
221 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
222 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
223 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
224 -Wconversion  -Wno-deprecated-declarations @gol
225 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
226 -Werror  -Werror-implicit-function-declaration @gol
227 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
228 -Wno-format-extra-args -Wformat-nonliteral @gol
229 -Wformat-security  -Wformat-y2k @gol
230 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
231 -Wimport  -Wno-import  -Winit-self  -Winline @gol
232 -Wno-int-to-pointer-cast @gol
233 -Wno-invalid-offsetof  -Winvalid-pch @gol
234 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
235 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
236 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
237 -Wmissing-noreturn @gol
238 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
239 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
240 -Wredundant-decls @gol
241 -Wreturn-type  -Wsequence-point  -Wshadow @gol
242 -Wsign-compare  -Wstack-protector @gol
243 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
244 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
245 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
246 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
247 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
248 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
249 -Wvolatile-register-var  -Wwrite-strings}
251 @item C-only Warning Options
252 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
253 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
254 -Wstrict-prototypes  -Wtraditional @gol
255 -Wdeclaration-after-statement -Wpointer-sign}
257 @item Debugging Options
258 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
259 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
260 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
261 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
262 -fdump-ipa-all -fdump-ipa-cgraph @gol
263 -fdump-tree-all @gol
264 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
265 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
268 -fdump-tree-ch @gol
269 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-nrv -fdump-tree-vect @gol
278 -fdump-tree-sink @gol
279 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-salias @gol
281 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
283 -ftree-vectorizer-verbose=@var{n} @gol
284 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
285 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
286 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
287 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
288 -ftest-coverage  -ftime-report -fvar-tracking @gol
289 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
290 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
291 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
292 -print-multi-directory  -print-multi-lib @gol
293 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
294 -save-temps  -time}
296 @item Optimization Options
297 @xref{Optimize Options,,Options that Control Optimization}.
298 @gccoptlist{-falign-functions[=@var{n}]  -falign-jumps[=@var{n}] @gol
299 -falign-labels[=@var{n}]  -falign-loops[=@var{n}]  @gol
300 -fmudflap -fmudflapth -fmudflapir @gol
301 -fbranch-probabilities -fprofile-values -fvpt @gol
302 -fbranch-target-load-optimize @gol
303 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
304 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
305 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
306 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
307 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
308 -fforce-addr  -ffunction-sections @gol
309 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
310 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
311 -finline-functions  -finline-functions-called-once @gol
312 -finline-limit=@var{n}  -fkeep-inline-functions @gol
313 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
314 -fmodulo-sched -fno-branch-count-reg @gol
315 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
316 -fno-function-cse  -fno-guess-branch-probability @gol
317 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
318 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
319 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
320 -fomit-frame-pointer  -foptimize-register-move @gol
321 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
322 -fprofile-generate -fprofile-use @gol
323 -fregmove  -frename-registers @gol
324 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
325 -frerun-cse-after-loop  -frerun-loop-opt @gol
326 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
327 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
328 -fsched-spec-load-dangerous  @gol
329 -fsched-stalled-insns[=@var{n}] -fsched-stalled-insns-dep[=@var{n}] @gol
330 -fsched2-use-superblocks @gol
331 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
332 -fsignaling-nans -fsingle-precision-constant  @gol
333 -fstack-protector  -fstack-protector-all @gol
334 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
335 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
336 -fsplit-ivs-in-unroller -funswitch-loops @gol
337 -fvariable-expansion-in-unroller @gol
338 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
339 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
340 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
341 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
342 -ftree-vect-loop-version -ftree-salias -fweb @gol
343 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -ftree-vrp @gol
344 -funit-at-a-time -fwhole-program @gol
345 --param @var{name}=@var{value}
346 -O  -O0  -O1  -O2  -O3  -Os}
348 @item Preprocessor Options
349 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
350 @gccoptlist{-A@var{question}=@var{answer} @gol
351 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
352 -C  -dD  -dI  -dM  -dN @gol
353 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
354 -idirafter @var{dir} @gol
355 -include @var{file}  -imacros @var{file} @gol
356 -iprefix @var{file}  -iwithprefix @var{dir} @gol
357 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
358 -cxx-isystem @var{dir} @gol
359 -isysroot @var{dir} @gol
360 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
361 -P  -fworking-directory  -remap @gol
362 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
363 -Xpreprocessor @var{option}}
365 @item Assembler Option
366 @xref{Assembler Options,,Passing Options to the Assembler}.
367 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
369 @item Linker Options
370 @xref{Link Options,,Options for Linking}.
371 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
372 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
373 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
374 -Wl,@var{option}  -Xlinker @var{option} @gol
375 -u @var{symbol}}
377 @item Directory Options
378 @xref{Directory Options,,Options for Directory Search}.
379 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
380 -specs=@var{file}  -I- --sysroot=@var{dir}}
382 @item Target Options
383 @c I wrote this xref this way to avoid overfull hbox. -- rms
384 @xref{Target Options}.
385 @gccoptlist{-V @var{version}  -b @var{machine}}
387 @item Machine Dependent Options
388 @xref{Submodel Options,,Hardware Models and Configurations}.
389 @c This list is ordered alphanumerically by subsection name.
390 @c Try and put the significant identifier (CPU or system) first,
391 @c so users have a clue at guessing where the ones they want will be.
393 @emph{ARC Options}
394 @gccoptlist{-EB  -EL @gol
395 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
396 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
398 @emph{ARM Options}
399 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
400 -mabi=@var{name} @gol
401 -mapcs-stack-check  -mno-apcs-stack-check @gol
402 -mapcs-float  -mno-apcs-float @gol
403 -mapcs-reentrant  -mno-apcs-reentrant @gol
404 -msched-prolog  -mno-sched-prolog @gol
405 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
406 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
407 -mthumb-interwork  -mno-thumb-interwork @gol
408 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
409 -mstructure-size-boundary=@var{n} @gol
410 -mabort-on-noreturn @gol
411 -mlong-calls  -mno-long-calls @gol
412 -msingle-pic-base  -mno-single-pic-base @gol
413 -mpic-register=@var{reg} @gol
414 -mnop-fun-dllimport @gol
415 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
416 -mpoke-function-name @gol
417 -mthumb  -marm @gol
418 -mtpcs-frame  -mtpcs-leaf-frame @gol
419 -mcaller-super-interworking  -mcallee-super-interworking @gol
420 -mtp=@var{name}}
422 @emph{AVR Options}
423 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
424 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
426 @emph{Blackfin Options}
427 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
428 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
429 -mlow-64k -mno-low64k -mid-shared-library @gol
430 -mno-id-shared-library -mshared-library-id=@var{n} @gol
431 -mlong-calls  -mno-long-calls}
433 @emph{CRIS Options}
434 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
435 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
436 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
437 -mstack-align  -mdata-align  -mconst-align @gol
438 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
439 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
440 -mmul-bug-workaround  -mno-mul-bug-workaround}
442 @emph{CRX Options}
443 @gccoptlist{-mmac -mpush-args}
445 @emph{Darwin Options}
446 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
447 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
448 -client_name  -compatibility_version  -current_version @gol
449 -dead_strip @gol
450 -dependency-file  -dylib_file  -dylinker_install_name @gol
451 -dynamic  -dynamiclib  -exported_symbols_list @gol
452 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
453 -force_flat_namespace  -headerpad_max_install_names @gol
454 -image_base  -init  -install_name  -keep_private_externs @gol
455 -multi_module  -multiply_defined  -multiply_defined_unused @gol
456 -noall_load   -no_dead_strip_inits_and_terms @gol
457 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
458 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
459 -private_bundle  -read_only_relocs  -sectalign @gol
460 -sectobjectsymbols  -whyload  -seg1addr @gol
461 -sectcreate  -sectobjectsymbols  -sectorder @gol
462 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
463 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
464 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
465 -single_module  -static  -sub_library  -sub_umbrella @gol
466 -twolevel_namespace  -umbrella  -undefined @gol
467 -unexported_symbols_list  -weak_reference_mismatches @gol
468 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
469 -mone-byte-bool}
471 @emph{DEC Alpha Options}
472 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
473 -mieee  -mieee-with-inexact  -mieee-conformant @gol
474 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
475 -mtrap-precision=@var{mode}  -mbuild-constants @gol
476 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
477 -mbwx  -mmax  -mfix  -mcix @gol
478 -mfloat-vax  -mfloat-ieee @gol
479 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
480 -msmall-text  -mlarge-text @gol
481 -mmemory-latency=@var{time}}
483 @emph{DEC Alpha/VMS Options}
484 @gccoptlist{-mvms-return-codes}
486 @emph{FRV Options}
487 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
488 -mhard-float  -msoft-float @gol
489 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
490 -mdouble  -mno-double @gol
491 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
492 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
493 -mlinked-fp  -mlong-calls  -malign-labels @gol
494 -mlibrary-pic  -macc-4  -macc-8 @gol
495 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
496 -moptimize-membar -mno-optimize-membar @gol
497 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
498 -mvliw-branch  -mno-vliw-branch @gol
499 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
500 -mno-nested-cond-exec  -mtomcat-stats @gol
501 -mTLS -mtls @gol
502 -mcpu=@var{cpu}}
504 @emph{H8/300 Options}
505 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
507 @emph{HPPA Options}
508 @gccoptlist{-march=@var{architecture-type} @gol
509 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
510 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
511 -mfixed-range=@var{register-range} @gol
512 -mjump-in-delay -mlinker-opt -mlong-calls @gol
513 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
514 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
515 -mno-jump-in-delay  -mno-long-load-store @gol
516 -mno-portable-runtime  -mno-soft-float @gol
517 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
518 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
519 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
520 -munix=@var{unix-std}  -nolibdld  -static  -threads}
522 @emph{i386 and x86-64 Options}
523 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
524 -mfpmath=@var{unit} @gol
525 -masm=@var{dialect}  -mno-fancy-math-387 @gol
526 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
527 -mno-wide-multiply  -mrtd  -malign-double @gol
528 -mpreferred-stack-boundary=@var{num} @gol
529 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
530 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
531 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
532 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
533 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
534 -mcmodel=@var{code-model} @gol
535 -m32  -m64 -mlarge-data-threshold=@var{num}}
537 @emph{IA-64 Options}
538 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
539 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
540 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
541 -minline-float-divide-max-throughput @gol
542 -minline-int-divide-min-latency @gol
543 -minline-int-divide-max-throughput  @gol
544 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
545 -mno-dwarf2-asm -mearly-stop-bits @gol
546 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
547 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
549 @emph{M32R/D Options}
550 @gccoptlist{-m32r2 -m32rx -m32r @gol
551 -mdebug @gol
552 -malign-loops -mno-align-loops @gol
553 -missue-rate=@var{number} @gol
554 -mbranch-cost=@var{number} @gol
555 -mmodel=@var{code-size-model-type} @gol
556 -msdata=@var{sdata-type} @gol
557 -mno-flush-func -mflush-func=@var{name} @gol
558 -mno-flush-trap -mflush-trap=@var{number} @gol
559 -G @var{num}}
561 @emph{M32C Options}
562 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
564 @emph{M680x0 Options}
565 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
566 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
567 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
568 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
569 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
571 @emph{M68hc1x Options}
572 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
573 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
574 -msoft-reg-count=@var{count}}
576 @emph{MCore Options}
577 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
578 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
579 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
580 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
581 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
583 @emph{MIPS Options}
584 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
585 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
586 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
587 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
588 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
589 -mdsp  -mpaired-single  -mips3d @gol
590 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
591 -G@var{num}  -membedded-data  -mno-embedded-data @gol
592 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
593 -msplit-addresses  -mno-split-addresses  @gol
594 -mexplicit-relocs  -mno-explicit-relocs  @gol
595 -mcheck-zero-division  -mno-check-zero-division @gol
596 -mdivide-traps  -mdivide-breaks @gol
597 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
598 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
599 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
600 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
601 -mfix-sb1  -mno-fix-sb1 @gol
602 -mflush-func=@var{func}  -mno-flush-func @gol
603 -mbranch-likely  -mno-branch-likely @gol
604 -mfp-exceptions -mno-fp-exceptions @gol
605 -mvr4130-align -mno-vr4130-align}
607 @emph{MMIX Options}
608 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
609 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
610 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
611 -mno-base-addresses  -msingle-exit  -mno-single-exit}
613 @emph{MN10300 Options}
614 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
615 -mam33  -mno-am33 @gol
616 -mam33-2  -mno-am33-2 @gol
617 -mreturn-pointer-on-d0 @gol
618 -mno-crt0  -mrelax}
620 @emph{MT Options}
621 @gccoptlist{-mno-crt0 -mbacc -msim @gol
622 -march=@var{cpu-type} }
624 @emph{PDP-11 Options}
625 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
626 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
627 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
628 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
629 -mbranch-expensive  -mbranch-cheap @gol
630 -msplit  -mno-split  -munix-asm  -mdec-asm}
632 @emph{PowerPC Options}
633 See RS/6000 and PowerPC Options.
635 @emph{RS/6000 and PowerPC Options}
636 @gccoptlist{-mcpu=@var{cpu-type} @gol
637 -mtune=@var{cpu-type} @gol
638 -mpower  -mno-power  -mpower2  -mno-power2 @gol
639 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
640 -maltivec  -mno-altivec @gol
641 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
642 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
643 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
644 -mnew-mnemonics  -mold-mnemonics @gol
645 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
646 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
647 -malign-power  -malign-natural @gol
648 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
649 -mstring  -mno-string  -mupdate  -mno-update @gol
650 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
651 -mstrict-align  -mno-strict-align  -mrelocatable @gol
652 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
653 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
654 -mdynamic-no-pic  -maltivec  -mswdiv @gol
655 -mprioritize-restricted-insns=@var{priority} @gol
656 -msched-costly-dep=@var{dependence_type} @gol
657 -minsert-sched-nops=@var{scheme} @gol
658 -mcall-sysv  -mcall-netbsd @gol
659 -maix-struct-return  -msvr4-struct-return @gol
660 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
661 -misel -mno-isel @gol
662 -misel=yes  -misel=no @gol
663 -mspe -mno-spe @gol
664 -mspe=yes  -mspe=no @gol
665 -mvrsave -mno-vrsave @gol
666 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
667 -mprototype  -mno-prototype @gol
668 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
669 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
671 @emph{S/390 and zSeries Options}
672 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
673 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
674 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
675 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
676 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
677 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
678 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
680 @emph{SH Options}
681 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
682 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
683 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
684 -m5-64media  -m5-64media-nofpu @gol
685 -m5-32media  -m5-32media-nofpu @gol
686 -m5-compact  -m5-compact-nofpu @gol
687 -mb  -ml  -mdalign  -mrelax @gol
688 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
689 -mieee  -misize  -mpadstruct  -mspace @gol
690 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
691 -mdivsi3_libfunc=@var{name}  @gol
692 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
693  -minvalid-symbols}
695 @emph{SPARC Options}
696 @gccoptlist{-mcpu=@var{cpu-type} @gol
697 -mtune=@var{cpu-type} @gol
698 -mcmodel=@var{code-model} @gol
699 -m32  -m64  -mapp-regs  -mno-app-regs @gol
700 -mfaster-structs  -mno-faster-structs @gol
701 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
702 -mhard-quad-float  -msoft-quad-float @gol
703 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
704 -mstack-bias  -mno-stack-bias @gol
705 -munaligned-doubles  -mno-unaligned-doubles @gol
706 -mv8plus  -mno-v8plus  -mvis  -mno-vis
707 -threads -pthreads -pthread}
709 @emph{System V Options}
710 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
712 @emph{TMS320C3x/C4x Options}
713 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
714 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
715 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
716 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
718 @emph{V850 Options}
719 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
720 -mprolog-function  -mno-prolog-function  -mspace @gol
721 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
722 -mapp-regs  -mno-app-regs @gol
723 -mdisable-callt  -mno-disable-callt @gol
724 -mv850e1 @gol
725 -mv850e @gol
726 -mv850  -mbig-switch}
728 @emph{VAX Options}
729 @gccoptlist{-mg  -mgnu  -munix}
731 @emph{x86-64 Options}
732 See i386 and x86-64 Options.
734 @emph{Xstormy16 Options}
735 @gccoptlist{-msim}
737 @emph{Xtensa Options}
738 @gccoptlist{-mconst16 -mno-const16 @gol
739 -mfused-madd  -mno-fused-madd @gol
740 -mtext-section-literals  -mno-text-section-literals @gol
741 -mtarget-align  -mno-target-align @gol
742 -mlongcalls  -mno-longcalls}
744 @emph{zSeries Options}
745 See S/390 and zSeries Options.
747 @item Code Generation Options
748 @xref{Code Gen Options,,Options for Code Generation Conventions}.
749 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
750 -ffixed-@var{reg}  -fexceptions @gol
751 -fnon-call-exceptions  -funwind-tables @gol
752 -fasynchronous-unwind-tables @gol
753 -finhibit-size-directive  -finstrument-functions @gol
754 -fno-common  -fno-ident @gol
755 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
756 -fno-jump-tables @gol
757 -freg-struct-return  -fshared-data  -fshort-enums @gol
758 -fshort-double  -fshort-wchar @gol
759 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
760 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
761 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
762 -fargument-noalias-global  -fleading-underscore @gol
763 -ftls-model=@var{model} @gol
764 -ftrapv  -fwrapv  -fbounds-check @gol
765 -fvisibility}
766 @end table
768 @menu
769 * Overall Options::     Controlling the kind of output:
770                         an executable, object files, assembler files,
771                         or preprocessed source.
772 * C Dialect Options::   Controlling the variant of C language compiled.
773 * C++ Dialect Options:: Variations on C++.
774 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
775                         and Objective-C++.
776 * Language Independent Options:: Controlling how diagnostics should be
777                         formatted.
778 * Warning Options::     How picky should the compiler be?
779 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
780 * Optimize Options::    How much optimization?
781 * Preprocessor Options:: Controlling header files and macro definitions.
782                          Also, getting dependency information for Make.
783 * Assembler Options::   Passing options to the assembler.
784 * Link Options::        Specifying libraries and so on.
785 * Directory Options::   Where to find header files and libraries.
786                         Where to find the compiler executable files.
787 * Spec Files::          How to pass switches to sub-processes.
788 * Target Options::      Running a cross-compiler, or an old version of GCC.
789 @end menu
791 @node Overall Options
792 @section Options Controlling the Kind of Output
794 Compilation can involve up to four stages: preprocessing, compilation
795 proper, assembly and linking, always in that order.  GCC is capable of
796 preprocessing and compiling several files either into several
797 assembler input files, or into one assembler input file; then each
798 assembler input file produces an object file, and linking combines all
799 the object files (those newly compiled, and those specified as input)
800 into an executable file.
802 @cindex file name suffix
803 For any given input file, the file name suffix determines what kind of
804 compilation is done:
806 @table @gcctabopt
807 @item @var{file}.c
808 C source code which must be preprocessed.
810 @item @var{file}.i
811 C source code which should not be preprocessed.
813 @item @var{file}.ii
814 C++ source code which should not be preprocessed.
816 @item @var{file}.m
817 Objective-C source code.  Note that you must link with the @file{libobjc}
818 library to make an Objective-C program work.
820 @item @var{file}.mi
821 Objective-C source code which should not be preprocessed.
823 @item @var{file}.mm
824 @itemx @var{file}.M
825 Objective-C++ source code.  Note that you must link with the @file{libobjc}
826 library to make an Objective-C++ program work.  Note that @samp{.M} refers
827 to a literal capital M@.
829 @item @var{file}.mii
830 Objective-C++ source code which should not be preprocessed.
832 @item @var{file}.h
833 C, C++, Objective-C or Objective-C++ header file to be turned into a
834 precompiled header.
836 @item @var{file}.cc
837 @itemx @var{file}.cp
838 @itemx @var{file}.cxx
839 @itemx @var{file}.cpp
840 @itemx @var{file}.CPP
841 @itemx @var{file}.c++
842 @itemx @var{file}.C
843 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
844 the last two letters must both be literally @samp{x}.  Likewise,
845 @samp{.C} refers to a literal capital C@.
847 @item @var{file}.mm
848 @itemx @var{file}.M
849 Objective-C++ source code which must be preprocessed.
851 @item @var{file}.mii
852 Objective-C++ source code which should not be preprocessed.
854 @item @var{file}.hh
855 @itemx @var{file}.H
856 C++ header file to be turned into a precompiled header.
858 @item @var{file}.f
859 @itemx @var{file}.for
860 @itemx @var{file}.FOR
861 Fixed form Fortran source code which should not be preprocessed.
863 @item @var{file}.F
864 @itemx @var{file}.fpp
865 @itemx @var{file}.FPP
866 Fixed form Fortran source code which must be preprocessed (with the traditional
867 preprocessor).
869 @item @var{file}.f90
870 @itemx @var{file}.f95
871 Free form Fortran source code which should not be preprocessed.
873 @item @var{file}.F90
874 @itemx @var{file}.F95
875 Free form Fortran source code which must be preprocessed (with the
876 traditional preprocessor).
878 @c FIXME: Descriptions of Java file types.
879 @c @var{file}.java
880 @c @var{file}.class
881 @c @var{file}.zip
882 @c @var{file}.jar
884 @item @var{file}.ads
885 Ada source code file which contains a library unit declaration (a
886 declaration of a package, subprogram, or generic, or a generic
887 instantiation), or a library unit renaming declaration (a package,
888 generic, or subprogram renaming declaration).  Such files are also
889 called @dfn{specs}.
891 @itemx @var{file}.adb
892 Ada source code file containing a library unit body (a subprogram or
893 package body).  Such files are also called @dfn{bodies}.
895 @c GCC also knows about some suffixes for languages not yet included:
896 @c Pascal:
897 @c @var{file}.p
898 @c @var{file}.pas
899 @c Ratfor:
900 @c @var{file}.r
902 @item @var{file}.s
903 Assembler code.
905 @item @var{file}.S
906 Assembler code which must be preprocessed.
908 @item @var{other}
909 An object file to be fed straight into linking.
910 Any file name with no recognized suffix is treated this way.
911 @end table
913 @opindex x
914 You can specify the input language explicitly with the @option{-x} option:
916 @table @gcctabopt
917 @item -x @var{language}
918 Specify explicitly the @var{language} for the following input files
919 (rather than letting the compiler choose a default based on the file
920 name suffix).  This option applies to all following input files until
921 the next @option{-x} option.  Possible values for @var{language} are:
922 @smallexample
923 c  c-header  c-cpp-output
924 c++  c++-header  c++-cpp-output
925 objective-c  objective-c-header  objective-c-cpp-output
926 objective-c++ objective-c++-header objective-c++-cpp-output
927 assembler  assembler-with-cpp
929 f95  f95-cpp-input
930 java
931 treelang
932 @end smallexample
934 @item -x none
935 Turn off any specification of a language, so that subsequent files are
936 handled according to their file name suffixes (as they are if @option{-x}
937 has not been used at all).
939 @item -pass-exit-codes
940 @opindex pass-exit-codes
941 Normally the @command{gcc} program will exit with the code of 1 if any
942 phase of the compiler returns a non-success return code.  If you specify
943 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
944 numerically highest error produced by any phase that returned an error
945 indication.
946 @end table
948 If you only want some of the stages of compilation, you can use
949 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
950 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
951 @command{gcc} is to stop.  Note that some combinations (for example,
952 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
954 @table @gcctabopt
955 @item -c
956 @opindex c
957 Compile or assemble the source files, but do not link.  The linking
958 stage simply is not done.  The ultimate output is in the form of an
959 object file for each source file.
961 By default, the object file name for a source file is made by replacing
962 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
964 Unrecognized input files, not requiring compilation or assembly, are
965 ignored.
967 @item -S
968 @opindex S
969 Stop after the stage of compilation proper; do not assemble.  The output
970 is in the form of an assembler code file for each non-assembler input
971 file specified.
973 By default, the assembler file name for a source file is made by
974 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
976 Input files that don't require compilation are ignored.
978 @item -E
979 @opindex E
980 Stop after the preprocessing stage; do not run the compiler proper.  The
981 output is in the form of preprocessed source code, which is sent to the
982 standard output.
984 Input files which don't require preprocessing are ignored.
986 @cindex output file option
987 @item -o @var{file}
988 @opindex o
989 Place output in file @var{file}.  This applies regardless to whatever
990 sort of output is being produced, whether it be an executable file,
991 an object file, an assembler file or preprocessed C code.
993 If @option{-o} is not specified, the default is to put an executable
994 file in @file{a.out}, the object file for
995 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
996 assembler file in @file{@var{source}.s}, a precompiled header file in
997 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
998 standard output.
1000 @item -v
1001 @opindex v
1002 Print (on standard error output) the commands executed to run the stages
1003 of compilation.  Also print the version number of the compiler driver
1004 program and of the preprocessor and the compiler proper.
1006 @item -###
1007 @opindex ###
1008 Like @option{-v} except the commands are not executed and all command
1009 arguments are quoted.  This is useful for shell scripts to capture the
1010 driver-generated command lines.
1012 @item -pipe
1013 @opindex pipe
1014 Use pipes rather than temporary files for communication between the
1015 various stages of compilation.  This fails to work on some systems where
1016 the assembler is unable to read from a pipe; but the GNU assembler has
1017 no trouble.
1019 @item -combine
1020 @opindex combine
1021 If you are compiling multiple source files, this option tells the driver
1022 to pass all the source files to the compiler at once (for those
1023 languages for which the compiler can handle this).  This will allow
1024 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1025 language for which this is supported is C@.  If you pass source files for
1026 multiple languages to the driver, using this option, the driver will invoke
1027 the compiler(s) that support IMA once each, passing each compiler all the
1028 source files appropriate for it.  For those languages that do not support
1029 IMA this option will be ignored, and the compiler will be invoked once for
1030 each source file in that language.  If you use this option in conjunction
1031 with @option{-save-temps}, the compiler will generate multiple
1032 pre-processed files
1033 (one for each source file), but only one (combined) @file{.o} or
1034 @file{.s} file.
1036 @item --help
1037 @opindex help
1038 Print (on the standard output) a description of the command line options
1039 understood by @command{gcc}.  If the @option{-v} option is also specified
1040 then @option{--help} will also be passed on to the various processes
1041 invoked by @command{gcc}, so that they can display the command line options
1042 they accept.  If the @option{-Wextra} option is also specified then command
1043 line options which have no documentation associated with them will also
1044 be displayed.
1046 @item --target-help
1047 @opindex target-help
1048 Print (on the standard output) a description of target specific command
1049 line options for each tool.
1051 @item --version
1052 @opindex version
1053 Display the version number and copyrights of the invoked GCC@.
1054 @end table
1056 @node Invoking G++
1057 @section Compiling C++ Programs
1059 @cindex suffixes for C++ source
1060 @cindex C++ source file suffixes
1061 C++ source files conventionally use one of the suffixes @samp{.C},
1062 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1063 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1064 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1065 files with these names and compiles them as C++ programs even if you
1066 call the compiler the same way as for compiling C programs (usually
1067 with the name @command{gcc}).
1069 @findex g++
1070 @findex c++
1071 However, C++ programs often require class libraries as well as a
1072 compiler that understands the C++ language---and under some
1073 circumstances, you might want to compile programs or header files from
1074 standard input, or otherwise without a suffix that flags them as C++
1075 programs.  You might also like to precompile a C header file with a
1076 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1077 program that calls GCC with the default language set to C++, and
1078 automatically specifies linking against the C++ library.  On many
1079 systems, @command{g++} is also installed with the name @command{c++}.
1081 @cindex invoking @command{g++}
1082 When you compile C++ programs, you may specify many of the same
1083 command-line options that you use for compiling programs in any
1084 language; or command-line options meaningful for C and related
1085 languages; or options that are meaningful only for C++ programs.
1086 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1087 explanations of options for languages related to C@.
1088 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1089 explanations of options that are meaningful only for C++ programs.
1091 @node C Dialect Options
1092 @section Options Controlling C Dialect
1093 @cindex dialect options
1094 @cindex language dialect options
1095 @cindex options, dialect
1097 The following options control the dialect of C (or languages derived
1098 from C, such as C++, Objective-C and Objective-C++) that the compiler
1099 accepts:
1101 @table @gcctabopt
1102 @cindex ANSI support
1103 @cindex ISO support
1104 @item -ansi
1105 @opindex ansi
1106 In C mode, support all ISO C90 programs.  In C++ mode,
1107 remove GNU extensions that conflict with ISO C++.
1109 This turns off certain features of GCC that are incompatible with ISO
1110 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1111 such as the @code{asm} and @code{typeof} keywords, and
1112 predefined macros such as @code{unix} and @code{vax} that identify the
1113 type of system you are using.  It also enables the undesirable and
1114 rarely used ISO trigraph feature.  For the C compiler,
1115 it disables recognition of C++ style @samp{//} comments as well as
1116 the @code{inline} keyword.
1118 The alternate keywords @code{__asm__}, @code{__extension__},
1119 @code{__inline__} and @code{__typeof__} continue to work despite
1120 @option{-ansi}.  You would not want to use them in an ISO C program, of
1121 course, but it is useful to put them in header files that might be included
1122 in compilations done with @option{-ansi}.  Alternate predefined macros
1123 such as @code{__unix__} and @code{__vax__} are also available, with or
1124 without @option{-ansi}.
1126 The @option{-ansi} option does not cause non-ISO programs to be
1127 rejected gratuitously.  For that, @option{-pedantic} is required in
1128 addition to @option{-ansi}.  @xref{Warning Options}.
1130 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1131 option is used.  Some header files may notice this macro and refrain
1132 from declaring certain functions or defining certain macros that the
1133 ISO standard doesn't call for; this is to avoid interfering with any
1134 programs that might use these names for other things.
1136 Functions which would normally be built in but do not have semantics
1137 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1138 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1139 built-in functions provided by GCC}, for details of the functions
1140 affected.
1142 @item -std=
1143 @opindex std
1144 Determine the language standard.  This option is currently only
1145 supported when compiling C or C++.  A value for this option must be
1146 provided; possible values are
1148 @table @samp
1149 @item c89
1150 @itemx iso9899:1990
1151 ISO C90 (same as @option{-ansi}).
1153 @item iso9899:199409
1154 ISO C90 as modified in amendment 1.
1156 @item c99
1157 @itemx c9x
1158 @itemx iso9899:1999
1159 @itemx iso9899:199x
1160 ISO C99.  Note that this standard is not yet fully supported; see
1161 @w{@uref{http://gcc.gnu.org/gcc-4.1/c99status.html}} for more information.  The
1162 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1164 @item gnu89
1165 Default, ISO C90 plus GNU extensions (including some C99 features).
1167 @item gnu99
1168 @itemx gnu9x
1169 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1170 this will become the default.  The name @samp{gnu9x} is deprecated.
1172 @item c++98
1173 The 1998 ISO C++ standard plus amendments.
1175 @item gnu++98
1176 The same as @option{-std=c++98} plus GNU extensions.  This is the
1177 default for C++ code.
1178 @end table
1180 Even when this option is not specified, you can still use some of the
1181 features of newer standards in so far as they do not conflict with
1182 previous C standards.  For example, you may use @code{__restrict__} even
1183 when @option{-std=c99} is not specified.
1185 The @option{-std} options specifying some version of ISO C have the same
1186 effects as @option{-ansi}, except that features that were not in ISO C90
1187 but are in the specified version (for example, @samp{//} comments and
1188 the @code{inline} keyword in ISO C99) are not disabled.
1190 @xref{Standards,,Language Standards Supported by GCC}, for details of
1191 these standard versions.
1193 @item -fgnu89-inline
1194 @opindex fgnu89-inline
1195 The option @option{-fgnu89-inline} tells GCC to use the traditional
1196 GNU semantics for @code{inline} functions when in C99 mode.
1197 @xref{Inline,,An Inline Function is As Fast As a Macro}.  Using this
1198 option is roughly equivalent to adding the @code{gnu_inline} function
1199 attribute to all inline functions (@pxref{Function Attributes}).
1201 This option is accepted by GCC versions 4.1.3 and up.  In GCC versions
1202 prior to 4.3, C99 inline semantics are not supported, and thus this
1203 option is effectively assumed to be present regardless of whether or not
1204 it is specified; the only effect of specifying it explicitly is to
1205 disable warnings about using inline functions in C99 mode.  Likewise,
1206 the option @option{-fno-gnu89-inline} is not supported in versions of
1207 GCC before 4.3.  It will be supported only in C99 or gnu99 mode, not in
1208 C89 or gnu89 mode.
1210 The preprocesor macros @code{__GNUC_GNU_INLINE__} and
1211 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1212 in effect for @code{inline} functions.  @xref{Common Predefined
1213 Macros,,,cpp,The C Preprocessor}.
1215 @item -aux-info @var{filename}
1216 @opindex aux-info
1217 Output to the given filename prototyped declarations for all functions
1218 declared and/or defined in a translation unit, including those in header
1219 files.  This option is silently ignored in any language other than C@.
1221 Besides declarations, the file indicates, in comments, the origin of
1222 each declaration (source file and line), whether the declaration was
1223 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1224 @samp{O} for old, respectively, in the first character after the line
1225 number and the colon), and whether it came from a declaration or a
1226 definition (@samp{C} or @samp{F}, respectively, in the following
1227 character).  In the case of function definitions, a K&R-style list of
1228 arguments followed by their declarations is also provided, inside
1229 comments, after the declaration.
1231 @item -fno-asm
1232 @opindex fno-asm
1233 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1234 keyword, so that code can use these words as identifiers.  You can use
1235 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1236 instead.  @option{-ansi} implies @option{-fno-asm}.
1238 In C++, this switch only affects the @code{typeof} keyword, since
1239 @code{asm} and @code{inline} are standard keywords.  You may want to
1240 use the @option{-fno-gnu-keywords} flag instead, which has the same
1241 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1242 switch only affects the @code{asm} and @code{typeof} keywords, since
1243 @code{inline} is a standard keyword in ISO C99.
1245 @item -fno-builtin
1246 @itemx -fno-builtin-@var{function}
1247 @opindex fno-builtin
1248 @cindex built-in functions
1249 Don't recognize built-in functions that do not begin with
1250 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1251 functions provided by GCC}, for details of the functions affected,
1252 including those which are not built-in functions when @option{-ansi} or
1253 @option{-std} options for strict ISO C conformance are used because they
1254 do not have an ISO standard meaning.
1256 GCC normally generates special code to handle certain built-in functions
1257 more efficiently; for instance, calls to @code{alloca} may become single
1258 instructions that adjust the stack directly, and calls to @code{memcpy}
1259 may become inline copy loops.  The resulting code is often both smaller
1260 and faster, but since the function calls no longer appear as such, you
1261 cannot set a breakpoint on those calls, nor can you change the behavior
1262 of the functions by linking with a different library.  In addition,
1263 when a function is recognized as a built-in function, GCC may use
1264 information about that function to warn about problems with calls to
1265 that function, or to generate more efficient code, even if the
1266 resulting code still contains calls to that function.  For example,
1267 warnings are given with @option{-Wformat} for bad calls to
1268 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1269 known not to modify global memory.
1271 With the @option{-fno-builtin-@var{function}} option
1272 only the built-in function @var{function} is
1273 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1274 function is named this is not built-in in this version of GCC, this
1275 option is ignored.  There is no corresponding
1276 @option{-fbuiltin-@var{function}} option; if you wish to enable
1277 built-in functions selectively when using @option{-fno-builtin} or
1278 @option{-ffreestanding}, you may define macros such as:
1280 @smallexample
1281 #define abs(n)          __builtin_abs ((n))
1282 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1283 @end smallexample
1285 @item -fhosted
1286 @opindex fhosted
1287 @cindex hosted environment
1289 Assert that compilation takes place in a hosted environment.  This implies
1290 @option{-fbuiltin}.  A hosted environment is one in which the
1291 entire standard library is available, and in which @code{main} has a return
1292 type of @code{int}.  Examples are nearly everything except a kernel.
1293 This is equivalent to @option{-fno-freestanding}.
1295 @item -ffreestanding
1296 @opindex ffreestanding
1297 @cindex hosted environment
1299 Assert that compilation takes place in a freestanding environment.  This
1300 implies @option{-fno-builtin}.  A freestanding environment
1301 is one in which the standard library may not exist, and program startup may
1302 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1303 This is equivalent to @option{-fno-hosted}.
1305 @xref{Standards,,Language Standards Supported by GCC}, for details of
1306 freestanding and hosted environments.
1308 @item -fms-extensions
1309 @opindex fms-extensions
1310 Accept some non-standard constructs used in Microsoft header files.
1312 Some cases of unnamed fields in structures and unions are only
1313 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1314 fields within structs/unions}, for details.
1316 @item -trigraphs
1317 @opindex trigraphs
1318 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1319 options for strict ISO C conformance) implies @option{-trigraphs}.
1321 @item -no-integrated-cpp
1322 @opindex no-integrated-cpp
1323 Performs a compilation in two passes: preprocessing and compiling.  This
1324 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1325 @option{-B} option.  The user supplied compilation step can then add in
1326 an additional preprocessing step after normal preprocessing but before
1327 compiling.  The default is to use the integrated cpp (internal cpp)
1329 The semantics of this option will change if "cc1", "cc1plus", and
1330 "cc1obj" are merged.
1332 @cindex traditional C language
1333 @cindex C language, traditional
1334 @item -traditional
1335 @itemx -traditional-cpp
1336 @opindex traditional-cpp
1337 @opindex traditional
1338 Formerly, these options caused GCC to attempt to emulate a pre-standard
1339 C compiler.  They are now only supported with the @option{-E} switch.
1340 The preprocessor continues to support a pre-standard mode.  See the GNU
1341 CPP manual for details.
1343 @item -fcond-mismatch
1344 @opindex fcond-mismatch
1345 Allow conditional expressions with mismatched types in the second and
1346 third arguments.  The value of such an expression is void.  This option
1347 is not supported for C++.
1349 @item -funsigned-char
1350 @opindex funsigned-char
1351 Let the type @code{char} be unsigned, like @code{unsigned char}.
1353 Each kind of machine has a default for what @code{char} should
1354 be.  It is either like @code{unsigned char} by default or like
1355 @code{signed char} by default.
1357 Ideally, a portable program should always use @code{signed char} or
1358 @code{unsigned char} when it depends on the signedness of an object.
1359 But many programs have been written to use plain @code{char} and
1360 expect it to be signed, or expect it to be unsigned, depending on the
1361 machines they were written for.  This option, and its inverse, let you
1362 make such a program work with the opposite default.
1364 The type @code{char} is always a distinct type from each of
1365 @code{signed char} or @code{unsigned char}, even though its behavior
1366 is always just like one of those two.
1368 @item -fsigned-char
1369 @opindex fsigned-char
1370 Let the type @code{char} be signed, like @code{signed char}.
1372 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1373 the negative form of @option{-funsigned-char}.  Likewise, the option
1374 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1376 @item -fsigned-bitfields
1377 @itemx -funsigned-bitfields
1378 @itemx -fno-signed-bitfields
1379 @itemx -fno-unsigned-bitfields
1380 @opindex fsigned-bitfields
1381 @opindex funsigned-bitfields
1382 @opindex fno-signed-bitfields
1383 @opindex fno-unsigned-bitfields
1384 These options control whether a bit-field is signed or unsigned, when the
1385 declaration does not use either @code{signed} or @code{unsigned}.  By
1386 default, such a bit-field is signed, because this is consistent: the
1387 basic integer types such as @code{int} are signed types.
1388 @end table
1390 @node C++ Dialect Options
1391 @section Options Controlling C++ Dialect
1393 @cindex compiler options, C++
1394 @cindex C++ options, command line
1395 @cindex options, C++
1396 This section describes the command-line options that are only meaningful
1397 for C++ programs; but you can also use most of the GNU compiler options
1398 regardless of what language your program is in.  For example, you
1399 might compile a file @code{firstClass.C} like this:
1401 @smallexample
1402 g++ -g -frepo -O -c firstClass.C
1403 @end smallexample
1405 @noindent
1406 In this example, only @option{-frepo} is an option meant
1407 only for C++ programs; you can use the other options with any
1408 language supported by GCC@.
1410 Here is a list of options that are @emph{only} for compiling C++ programs:
1412 @table @gcctabopt
1414 @item -fabi-version=@var{n}
1415 @opindex fabi-version
1416 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1417 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1418 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1419 the version that conforms most closely to the C++ ABI specification.
1420 Therefore, the ABI obtained using version 0 will change as ABI bugs
1421 are fixed.
1423 The default is version 2.
1425 @item -fno-access-control
1426 @opindex fno-access-control
1427 Turn off all access checking.  This switch is mainly useful for working
1428 around bugs in the access control code.
1430 @item -fcheck-new
1431 @opindex fcheck-new
1432 Check that the pointer returned by @code{operator new} is non-null
1433 before attempting to modify the storage allocated.  This check is
1434 normally unnecessary because the C++ standard specifies that
1435 @code{operator new} will only return @code{0} if it is declared
1436 @samp{throw()}, in which case the compiler will always check the
1437 return value even without this option.  In all other cases, when
1438 @code{operator new} has a non-empty exception specification, memory
1439 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1440 @samp{new (nothrow)}.
1442 @item -fconserve-space
1443 @opindex fconserve-space
1444 Put uninitialized or runtime-initialized global variables into the
1445 common segment, as C does.  This saves space in the executable at the
1446 cost of not diagnosing duplicate definitions.  If you compile with this
1447 flag and your program mysteriously crashes after @code{main()} has
1448 completed, you may have an object that is being destroyed twice because
1449 two definitions were merged.
1451 This option is no longer useful on most targets, now that support has
1452 been added for putting variables into BSS without making them common.
1454 @item -ffriend-injection
1455 @opindex ffriend-injection
1456 Inject friend functions into the enclosing namespace, so that they are
1457 visible outside the scope of the class in which they are declared.
1458 Friend functions were documented to work this way in the old Annotated
1459 C++ Reference Manual, and versions of G++ before 4.1 always worked
1460 that way.  However, in ISO C++ a friend function which is not declared
1461 in an enclosing scope can only be found using argument dependent
1462 lookup.  This option causes friends to be injected as they were in
1463 earlier releases.
1465 This option is for compatibility, and may be removed in a future
1466 release of G++.
1468 @item -fno-const-strings
1469 @opindex fno-const-strings
1470 Give string constants type @code{char *} instead of type @code{const
1471 char *}.  By default, G++ uses type @code{const char *} as required by
1472 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1473 actually modify the value of a string constant.
1475 This option might be removed in a future release of G++.  For maximum
1476 portability, you should structure your code so that it works with
1477 string constants that have type @code{const char *}.
1479 @item -fno-elide-constructors
1480 @opindex fno-elide-constructors
1481 The C++ standard allows an implementation to omit creating a temporary
1482 which is only used to initialize another object of the same type.
1483 Specifying this option disables that optimization, and forces G++ to
1484 call the copy constructor in all cases.
1486 @item -fno-enforce-eh-specs
1487 @opindex fno-enforce-eh-specs
1488 Don't generate code to check for violation of exception specifications
1489 at runtime.  This option violates the C++ standard, but may be useful
1490 for reducing code size in production builds, much like defining
1491 @samp{NDEBUG}.  This does not give user code permission to throw
1492 exceptions in violation of the exception specifications; the compiler
1493 will still optimize based on the specifications, so throwing an
1494 unexpected exception will result in undefined behavior.
1496 @item -ffor-scope
1497 @itemx -fno-for-scope
1498 @opindex ffor-scope
1499 @opindex fno-for-scope
1500 If @option{-ffor-scope} is specified, the scope of variables declared in
1501 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1502 as specified by the C++ standard.
1503 If @option{-fno-for-scope} is specified, the scope of variables declared in
1504 a @i{for-init-statement} extends to the end of the enclosing scope,
1505 as was the case in old versions of G++, and other (traditional)
1506 implementations of C++.
1508 The default if neither flag is given to follow the standard,
1509 but to allow and give a warning for old-style code that would
1510 otherwise be invalid, or have different behavior.
1512 @item -fno-gnu-keywords
1513 @opindex fno-gnu-keywords
1514 Do not recognize @code{typeof} as a keyword, so that code can use this
1515 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1516 @option{-ansi} implies @option{-fno-gnu-keywords}.
1518 @item -fno-implicit-templates
1519 @opindex fno-implicit-templates
1520 Never emit code for non-inline templates which are instantiated
1521 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1522 @xref{Template Instantiation}, for more information.
1524 @item -fno-implicit-inline-templates
1525 @opindex fno-implicit-inline-templates
1526 Don't emit code for implicit instantiations of inline templates, either.
1527 The default is to handle inlines differently so that compiles with and
1528 without optimization will need the same set of explicit instantiations.
1530 @item -fno-implement-inlines
1531 @opindex fno-implement-inlines
1532 To save space, do not emit out-of-line copies of inline functions
1533 controlled by @samp{#pragma implementation}.  This will cause linker
1534 errors if these functions are not inlined everywhere they are called.
1536 @item -fms-extensions
1537 @opindex fms-extensions
1538 Disable pedantic warnings about constructs used in MFC, such as implicit
1539 int and getting a pointer to member function via non-standard syntax.
1541 @item -fno-nonansi-builtins
1542 @opindex fno-nonansi-builtins
1543 Disable built-in declarations of functions that are not mandated by
1544 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1545 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1547 @item -fno-operator-names
1548 @opindex fno-operator-names
1549 Do not treat the operator name keywords @code{and}, @code{bitand},
1550 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1551 synonyms as keywords.
1553 @item -fno-optional-diags
1554 @opindex fno-optional-diags
1555 Disable diagnostics that the standard says a compiler does not need to
1556 issue.  Currently, the only such diagnostic issued by G++ is the one for
1557 a name having multiple meanings within a class.
1559 @item -fpermissive
1560 @opindex fpermissive
1561 Downgrade some diagnostics about nonconformant code from errors to
1562 warnings.  Thus, using @option{-fpermissive} will allow some
1563 nonconforming code to compile.
1565 @item -frepo
1566 @opindex frepo
1567 Enable automatic template instantiation at link time.  This option also
1568 implies @option{-fno-implicit-templates}.  @xref{Template
1569 Instantiation}, for more information.
1571 @item -fno-rtti
1572 @opindex fno-rtti
1573 Disable generation of information about every class with virtual
1574 functions for use by the C++ runtime type identification features
1575 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1576 of the language, you can save some space by using this flag.  Note that
1577 exception handling uses the same information, but it will generate it as
1578 needed.
1580 @item -fstats
1581 @opindex fstats
1582 Emit statistics about front-end processing at the end of the compilation.
1583 This information is generally only useful to the G++ development team.
1585 @item -ftemplate-depth-@var{n}
1586 @opindex ftemplate-depth
1587 Set the maximum instantiation depth for template classes to @var{n}.
1588 A limit on the template instantiation depth is needed to detect
1589 endless recursions during template class instantiation.  ANSI/ISO C++
1590 conforming programs must not rely on a maximum depth greater than 17.
1592 @item -fno-threadsafe-statics
1593 @opindex fno-threadsafe-statics
1594 Do not emit the extra code to use the routines specified in the C++
1595 ABI for thread-safe initialization of local statics.  You can use this
1596 option to reduce code size slightly in code that doesn't need to be
1597 thread-safe.
1599 @item -fuse-cxa-atexit
1600 @opindex fuse-cxa-atexit
1601 Register destructors for objects with static storage duration with the
1602 @code{__cxa_atexit} function rather than the @code{atexit} function.
1603 This option is required for fully standards-compliant handling of static
1604 destructors, but will only work if your C library supports
1605 @code{__cxa_atexit}.
1607 @item -fvisibility-inlines-hidden
1608 @opindex fvisibility-inlines-hidden
1609 Causes all inlined methods to be marked with
1610 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1611 appear in the export table of a DSO and do not require a PLT indirection
1612 when used within the DSO@.  Enabling this option can have a dramatic effect
1613 on load and link times of a DSO as it massively reduces the size of the
1614 dynamic export table when the library makes heavy use of templates.  While
1615 it can cause bloating through duplication of code within each DSO where
1616 it is used, often the wastage is less than the considerable space occupied
1617 by a long symbol name in the export table which is typical when using
1618 templates and namespaces.  For even more savings, combine with the
1619 @option{-fvisibility=hidden} switch.
1621 @item -fno-weak
1622 @opindex fno-weak
1623 Do not use weak symbol support, even if it is provided by the linker.
1624 By default, G++ will use weak symbols if they are available.  This
1625 option exists only for testing, and should not be used by end-users;
1626 it will result in inferior code and has no benefits.  This option may
1627 be removed in a future release of G++.
1629 @item -nostdinc++
1630 @opindex nostdinc++
1631 Do not search for header files in the standard directories specific to
1632 C++, but do still search the other standard directories.  (This option
1633 is used when building the C++ library.)
1634 @end table
1636 In addition, these optimization, warning, and code generation options
1637 have meanings only for C++ programs:
1639 @table @gcctabopt
1640 @item -fno-default-inline
1641 @opindex fno-default-inline
1642 Do not assume @samp{inline} for functions defined inside a class scope.
1643 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1644 functions will have linkage like inline functions; they just won't be
1645 inlined by default.
1647 @item -Wabi @r{(C++ only)}
1648 @opindex Wabi
1649 Warn when G++ generates code that is probably not compatible with the
1650 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1651 all such cases, there are probably some cases that are not warned about,
1652 even though G++ is generating incompatible code.  There may also be
1653 cases where warnings are emitted even though the code that is generated
1654 will be compatible.
1656 You should rewrite your code to avoid these warnings if you are
1657 concerned about the fact that code generated by G++ may not be binary
1658 compatible with code generated by other compilers.
1660 The known incompatibilities at this point include:
1662 @itemize @bullet
1664 @item
1665 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1666 pack data into the same byte as a base class.  For example:
1668 @smallexample
1669 struct A @{ virtual void f(); int f1 : 1; @};
1670 struct B : public A @{ int f2 : 1; @};
1671 @end smallexample
1673 @noindent
1674 In this case, G++ will place @code{B::f2} into the same byte
1675 as@code{A::f1}; other compilers will not.  You can avoid this problem
1676 by explicitly padding @code{A} so that its size is a multiple of the
1677 byte size on your platform; that will cause G++ and other compilers to
1678 layout @code{B} identically.
1680 @item
1681 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1682 tail padding when laying out virtual bases.  For example:
1684 @smallexample
1685 struct A @{ virtual void f(); char c1; @};
1686 struct B @{ B(); char c2; @};
1687 struct C : public A, public virtual B @{@};
1688 @end smallexample
1690 @noindent
1691 In this case, G++ will not place @code{B} into the tail-padding for
1692 @code{A}; other compilers will.  You can avoid this problem by
1693 explicitly padding @code{A} so that its size is a multiple of its
1694 alignment (ignoring virtual base classes); that will cause G++ and other
1695 compilers to layout @code{C} identically.
1697 @item
1698 Incorrect handling of bit-fields with declared widths greater than that
1699 of their underlying types, when the bit-fields appear in a union.  For
1700 example:
1702 @smallexample
1703 union U @{ int i : 4096; @};
1704 @end smallexample
1706 @noindent
1707 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1708 union too small by the number of bits in an @code{int}.
1710 @item
1711 Empty classes can be placed at incorrect offsets.  For example:
1713 @smallexample
1714 struct A @{@};
1716 struct B @{
1717   A a;
1718   virtual void f ();
1721 struct C : public B, public A @{@};
1722 @end smallexample
1724 @noindent
1725 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1726 it should be placed at offset zero.  G++ mistakenly believes that the
1727 @code{A} data member of @code{B} is already at offset zero.
1729 @item
1730 Names of template functions whose types involve @code{typename} or
1731 template template parameters can be mangled incorrectly.
1733 @smallexample
1734 template <typename Q>
1735 void f(typename Q::X) @{@}
1737 template <template <typename> class Q>
1738 void f(typename Q<int>::X) @{@}
1739 @end smallexample
1741 @noindent
1742 Instantiations of these templates may be mangled incorrectly.
1744 @end itemize
1746 @item -Wctor-dtor-privacy @r{(C++ only)}
1747 @opindex Wctor-dtor-privacy
1748 Warn when a class seems unusable because all the constructors or
1749 destructors in that class are private, and it has neither friends nor
1750 public static member functions.
1752 @item -Wnon-virtual-dtor @r{(C++ only)}
1753 @opindex Wnon-virtual-dtor
1754 Warn when a class appears to be polymorphic, thereby requiring a virtual
1755 destructor, yet it declares a non-virtual one.
1756 This warning is enabled by @option{-Wall}.
1758 @item -Wreorder @r{(C++ only)}
1759 @opindex Wreorder
1760 @cindex reordering, warning
1761 @cindex warning for reordering of member initializers
1762 Warn when the order of member initializers given in the code does not
1763 match the order in which they must be executed.  For instance:
1765 @smallexample
1766 struct A @{
1767   int i;
1768   int j;
1769   A(): j (0), i (1) @{ @}
1771 @end smallexample
1773 The compiler will rearrange the member initializers for @samp{i}
1774 and @samp{j} to match the declaration order of the members, emitting
1775 a warning to that effect.  This warning is enabled by @option{-Wall}.
1776 @end table
1778 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1780 @table @gcctabopt
1781 @item -Weffc++ @r{(C++ only)}
1782 @opindex Weffc++
1783 Warn about violations of the following style guidelines from Scott Meyers'
1784 @cite{Effective C++} book:
1786 @itemize @bullet
1787 @item
1788 Item 11:  Define a copy constructor and an assignment operator for classes
1789 with dynamically allocated memory.
1791 @item
1792 Item 12:  Prefer initialization to assignment in constructors.
1794 @item
1795 Item 14:  Make destructors virtual in base classes.
1797 @item
1798 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1800 @item
1801 Item 23:  Don't try to return a reference when you must return an object.
1803 @end itemize
1805 Also warn about violations of the following style guidelines from
1806 Scott Meyers' @cite{More Effective C++} book:
1808 @itemize @bullet
1809 @item
1810 Item 6:  Distinguish between prefix and postfix forms of increment and
1811 decrement operators.
1813 @item
1814 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1816 @end itemize
1818 When selecting this option, be aware that the standard library
1819 headers do not obey all of these guidelines; use @samp{grep -v}
1820 to filter out those warnings.
1822 @item -Wno-deprecated @r{(C++ only)}
1823 @opindex Wno-deprecated
1824 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1826 @item -Wstrict-null-sentinel @r{(C++ only)}
1827 @opindex Wstrict-null-sentinel
1828 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1829 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1830 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1831 it is guaranteed to of the same size as a pointer.  But this use is
1832 not portable across different compilers.
1834 @item -Wno-non-template-friend @r{(C++ only)}
1835 @opindex Wno-non-template-friend
1836 Disable warnings when non-templatized friend functions are declared
1837 within a template.  Since the advent of explicit template specification
1838 support in G++, if the name of the friend is an unqualified-id (i.e.,
1839 @samp{friend foo(int)}), the C++ language specification demands that the
1840 friend declare or define an ordinary, nontemplate function.  (Section
1841 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1842 could be interpreted as a particular specialization of a templatized
1843 function.  Because this non-conforming behavior is no longer the default
1844 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1845 check existing code for potential trouble spots and is on by default.
1846 This new compiler behavior can be turned off with
1847 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1848 but disables the helpful warning.
1850 @item -Wold-style-cast @r{(C++ only)}
1851 @opindex Wold-style-cast
1852 Warn if an old-style (C-style) cast to a non-void type is used within
1853 a C++ program.  The new-style casts (@samp{dynamic_cast},
1854 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1855 less vulnerable to unintended effects and much easier to search for.
1857 @item -Woverloaded-virtual @r{(C++ only)}
1858 @opindex Woverloaded-virtual
1859 @cindex overloaded virtual fn, warning
1860 @cindex warning for overloaded virtual fn
1861 Warn when a function declaration hides virtual functions from a
1862 base class.  For example, in:
1864 @smallexample
1865 struct A @{
1866   virtual void f();
1869 struct B: public A @{
1870   void f(int);
1872 @end smallexample
1874 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1875 like:
1877 @smallexample
1878 B* b;
1879 b->f();
1880 @end smallexample
1882 will fail to compile.
1884 @item -Wno-pmf-conversions @r{(C++ only)}
1885 @opindex Wno-pmf-conversions
1886 Disable the diagnostic for converting a bound pointer to member function
1887 to a plain pointer.
1889 @item -Wsign-promo @r{(C++ only)}
1890 @opindex Wsign-promo
1891 Warn when overload resolution chooses a promotion from unsigned or
1892 enumerated type to a signed type, over a conversion to an unsigned type of
1893 the same size.  Previous versions of G++ would try to preserve
1894 unsignedness, but the standard mandates the current behavior.
1896 @smallexample
1897 struct A @{
1898   operator int ();
1899   A& operator = (int);
1902 main ()
1904   A a,b;
1905   a = b;
1907 @end smallexample
1909 In this example, G++ will synthesize a default @samp{A& operator =
1910 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1911 @end table
1913 @node Objective-C and Objective-C++ Dialect Options
1914 @section Options Controlling Objective-C and Objective-C++ Dialects
1916 @cindex compiler options, Objective-C and Objective-C++
1917 @cindex Objective-C and Objective-C++ options, command line
1918 @cindex options, Objective-C and Objective-C++
1919 (NOTE: This manual does not describe the Objective-C and Objective-C++
1920 languages themselves.  See @xref{Standards,,Language Standards
1921 Supported by GCC}, for references.)
1923 This section describes the command-line options that are only meaningful
1924 for Objective-C and Objective-C++ programs, but you can also use most of
1925 the language-independent GNU compiler options.
1926 For example, you might compile a file @code{some_class.m} like this:
1928 @smallexample
1929 gcc -g -fgnu-runtime -O -c some_class.m
1930 @end smallexample
1932 @noindent
1933 In this example, @option{-fgnu-runtime} is an option meant only for
1934 Objective-C and Objective-C++ programs; you can use the other options with
1935 any language supported by GCC@.
1937 Note that since Objective-C is an extension of the C language, Objective-C
1938 compilations may also use options specific to the C front-end (e.g.,
1939 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1940 C++-specific options (e.g., @option{-Wabi}).
1942 Here is a list of options that are @emph{only} for compiling Objective-C
1943 and Objective-C++ programs:
1945 @table @gcctabopt
1946 @item -fconstant-string-class=@var{class-name}
1947 @opindex fconstant-string-class
1948 Use @var{class-name} as the name of the class to instantiate for each
1949 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1950 class name is @code{NXConstantString} if the GNU runtime is being used, and
1951 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1952 @option{-fconstant-cfstrings} option, if also present, will override the
1953 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1954 to be laid out as constant CoreFoundation strings.
1956 @item -fgnu-runtime
1957 @opindex fgnu-runtime
1958 Generate object code compatible with the standard GNU Objective-C
1959 runtime.  This is the default for most types of systems.
1961 @item -fnext-runtime
1962 @opindex fnext-runtime
1963 Generate output compatible with the NeXT runtime.  This is the default
1964 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1965 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1966 used.
1968 @item -fno-nil-receivers
1969 @opindex fno-nil-receivers
1970 Assume that all Objective-C message dispatches (e.g.,
1971 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1972 is not @code{nil}.  This allows for more efficient entry points in the runtime
1973 to be used.  Currently, this option is only available in conjunction with
1974 the NeXT runtime on Mac OS X 10.3 and later.
1976 @item -fobjc-call-cxx-cdtors
1977 @opindex fobjc-call-cxx-cdtors
1978 For each Objective-C class, check if any of its instance variables is a
1979 C++ object with a non-trivial default constructor.  If so, synthesize a
1980 special @code{- (id) .cxx_construct} instance method that will run
1981 non-trivial default constructors on any such instance variables, in order,
1982 and then return @code{self}.  Similarly, check if any instance variable
1983 is a C++ object with a non-trivial destructor, and if so, synthesize a
1984 special @code{- (void) .cxx_destruct} method that will run
1985 all such default destructors, in reverse order.
1987 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1988 thusly generated will only operate on instance variables declared in the
1989 current Objective-C class, and not those inherited from superclasses.  It
1990 is the responsibility of the Objective-C runtime to invoke all such methods
1991 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1992 will be invoked by the runtime immediately after a new object
1993 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1994 be invoked immediately before the runtime deallocates an object instance.
1996 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1997 support for invoking the @code{- (id) .cxx_construct} and
1998 @code{- (void) .cxx_destruct} methods.
2000 @item -fobjc-direct-dispatch
2001 @opindex fobjc-direct-dispatch
2002 Allow fast jumps to the message dispatcher.  On Darwin this is
2003 accomplished via the comm page.
2005 @item -fobjc-exceptions
2006 @opindex fobjc-exceptions
2007 Enable syntactic support for structured exception handling in Objective-C,
2008 similar to what is offered by C++ and Java.  Currently, this option is only
2009 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
2011 @smallexample
2012   @@try @{
2013     @dots{}
2014        @@throw expr;
2015     @dots{}
2016   @}
2017   @@catch (AnObjCClass *exc) @{
2018     @dots{}
2019       @@throw expr;
2020     @dots{}
2021       @@throw;
2022     @dots{}
2023   @}
2024   @@catch (AnotherClass *exc) @{
2025     @dots{}
2026   @}
2027   @@catch (id allOthers) @{
2028     @dots{}
2029   @}
2030   @@finally @{
2031     @dots{}
2032       @@throw expr;
2033     @dots{}
2034   @}
2035 @end smallexample
2037 The @code{@@throw} statement may appear anywhere in an Objective-C or
2038 Objective-C++ program; when used inside of a @code{@@catch} block, the
2039 @code{@@throw} may appear without an argument (as shown above), in which case
2040 the object caught by the @code{@@catch} will be rethrown.
2042 Note that only (pointers to) Objective-C objects may be thrown and
2043 caught using this scheme.  When an object is thrown, it will be caught
2044 by the nearest @code{@@catch} clause capable of handling objects of that type,
2045 analogously to how @code{catch} blocks work in C++ and Java.  A
2046 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2047 any and all Objective-C exceptions not caught by previous @code{@@catch}
2048 clauses (if any).
2050 The @code{@@finally} clause, if present, will be executed upon exit from the
2051 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2052 regardless of whether any exceptions are thrown, caught or rethrown
2053 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2054 of the @code{finally} clause in Java.
2056 There are several caveats to using the new exception mechanism:
2058 @itemize @bullet
2059 @item
2060 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2061 idioms provided by the @code{NSException} class, the new
2062 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2063 systems, due to additional functionality needed in the (NeXT) Objective-C
2064 runtime.
2066 @item
2067 As mentioned above, the new exceptions do not support handling
2068 types other than Objective-C objects.   Furthermore, when used from
2069 Objective-C++, the Objective-C exception model does not interoperate with C++
2070 exceptions at this time.  This means you cannot @code{@@throw} an exception
2071 from Objective-C and @code{catch} it in C++, or vice versa
2072 (i.e., @code{throw @dots{} @@catch}).
2073 @end itemize
2075 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2076 blocks for thread-safe execution:
2078 @smallexample
2079   @@synchronized (ObjCClass *guard) @{
2080     @dots{}
2081   @}
2082 @end smallexample
2084 Upon entering the @code{@@synchronized} block, a thread of execution shall
2085 first check whether a lock has been placed on the corresponding @code{guard}
2086 object by another thread.  If it has, the current thread shall wait until
2087 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2088 the current thread will place its own lock on it, execute the code contained in
2089 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2090 making @code{guard} available to other threads).
2092 Unlike Java, Objective-C does not allow for entire methods to be marked
2093 @code{@@synchronized}.  Note that throwing exceptions out of
2094 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2095 to be unlocked properly.
2097 @item -fobjc-gc
2098 @opindex fobjc-gc
2099 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2101 @item -freplace-objc-classes
2102 @opindex freplace-objc-classes
2103 Emit a special marker instructing @command{ld(1)} not to statically link in
2104 the resulting object file, and allow @command{dyld(1)} to load it in at
2105 run time instead.  This is used in conjunction with the Fix-and-Continue
2106 debugging mode, where the object file in question may be recompiled and
2107 dynamically reloaded in the course of program execution, without the need
2108 to restart the program itself.  Currently, Fix-and-Continue functionality
2109 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2110 and later.
2112 @item -fzero-link
2113 @opindex fzero-link
2114 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2115 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2116 compile time) with static class references that get initialized at load time,
2117 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2118 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2119 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2120 for individual class implementations to be modified during program execution.
2122 @item -gen-decls
2123 @opindex gen-decls
2124 Dump interface declarations for all classes seen in the source file to a
2125 file named @file{@var{sourcename}.decl}.
2127 @item -Wassign-intercept
2128 @opindex Wassign-intercept
2129 Warn whenever an Objective-C assignment is being intercepted by the
2130 garbage collector.
2132 @item -Wno-protocol
2133 @opindex Wno-protocol
2134 If a class is declared to implement a protocol, a warning is issued for
2135 every method in the protocol that is not implemented by the class.  The
2136 default behavior is to issue a warning for every method not explicitly
2137 implemented in the class, even if a method implementation is inherited
2138 from the superclass.  If you use the @option{-Wno-protocol} option, then
2139 methods inherited from the superclass are considered to be implemented,
2140 and no warning is issued for them.
2142 @item -Wselector
2143 @opindex Wselector
2144 Warn if multiple methods of different types for the same selector are
2145 found during compilation.  The check is performed on the list of methods
2146 in the final stage of compilation.  Additionally, a check is performed
2147 for each selector appearing in a @code{@@selector(@dots{})}
2148 expression, and a corresponding method for that selector has been found
2149 during compilation.  Because these checks scan the method table only at
2150 the end of compilation, these warnings are not produced if the final
2151 stage of compilation is not reached, for example because an error is
2152 found during compilation, or because the @option{-fsyntax-only} option is
2153 being used.
2155 @item -Wstrict-selector-match
2156 @opindex Wstrict-selector-match
2157 Warn if multiple methods with differing argument and/or return types are
2158 found for a given selector when attempting to send a message using this
2159 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2160 is off (which is the default behavior), the compiler will omit such warnings
2161 if any differences found are confined to types which share the same size
2162 and alignment.
2164 @item -Wundeclared-selector
2165 @opindex Wundeclared-selector
2166 Warn if a @code{@@selector(@dots{})} expression referring to an
2167 undeclared selector is found.  A selector is considered undeclared if no
2168 method with that name has been declared before the
2169 @code{@@selector(@dots{})} expression, either explicitly in an
2170 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2171 an @code{@@implementation} section.  This option always performs its
2172 checks as soon as a @code{@@selector(@dots{})} expression is found,
2173 while @option{-Wselector} only performs its checks in the final stage of
2174 compilation.  This also enforces the coding style convention
2175 that methods and selectors must be declared before being used.
2177 @item -print-objc-runtime-info
2178 @opindex print-objc-runtime-info
2179 Generate C header describing the largest structure that is passed by
2180 value, if any.
2182 @end table
2184 @node Language Independent Options
2185 @section Options to Control Diagnostic Messages Formatting
2186 @cindex options to control diagnostics formatting
2187 @cindex diagnostic messages
2188 @cindex message formatting
2190 Traditionally, diagnostic messages have been formatted irrespective of
2191 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2192 below can be used to control the diagnostic messages formatting
2193 algorithm, e.g.@: how many characters per line, how often source location
2194 information should be reported.  Right now, only the C++ front end can
2195 honor these options.  However it is expected, in the near future, that
2196 the remaining front ends would be able to digest them correctly.
2198 @table @gcctabopt
2199 @item -fmessage-length=@var{n}
2200 @opindex fmessage-length
2201 Try to format error messages so that they fit on lines of about @var{n}
2202 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2203 the front ends supported by GCC@.  If @var{n} is zero, then no
2204 line-wrapping will be done; each error message will appear on a single
2205 line.
2207 @opindex fdiagnostics-show-location
2208 @item -fdiagnostics-show-location=once
2209 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2210 reporter to emit @emph{once} source location information; that is, in
2211 case the message is too long to fit on a single physical line and has to
2212 be wrapped, the source location won't be emitted (as prefix) again,
2213 over and over, in subsequent continuation lines.  This is the default
2214 behavior.
2216 @item -fdiagnostics-show-location=every-line
2217 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2218 messages reporter to emit the same source location information (as
2219 prefix) for physical lines that result from the process of breaking
2220 a message which is too long to fit on a single line.
2222 @item -fdiagnostics-show-options
2223 @opindex fdiagnostics-show-options
2224 This option instructs the diagnostic machinery to add text to each
2225 diagnostic emitted, which indicates which command line option directly
2226 controls that diagnostic, when such an option is known to the
2227 diagnostic machinery.
2229 @end table
2231 @node Warning Options
2232 @section Options to Request or Suppress Warnings
2233 @cindex options to control warnings
2234 @cindex warning messages
2235 @cindex messages, warning
2236 @cindex suppressing warnings
2238 Warnings are diagnostic messages that report constructions which
2239 are not inherently erroneous but which are risky or suggest there
2240 may have been an error.
2242 You can request many specific warnings with options beginning @samp{-W},
2243 for example @option{-Wimplicit} to request warnings on implicit
2244 declarations.  Each of these specific warning options also has a
2245 negative form beginning @samp{-Wno-} to turn off warnings;
2246 for example, @option{-Wno-implicit}.  This manual lists only one of the
2247 two forms, whichever is not the default.
2249 The following options control the amount and kinds of warnings produced
2250 by GCC; for further, language-specific options also refer to
2251 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2252 Options}.
2254 @table @gcctabopt
2255 @cindex syntax checking
2256 @item -fsyntax-only
2257 @opindex fsyntax-only
2258 Check the code for syntax errors, but don't do anything beyond that.
2260 @item -pedantic
2261 @opindex pedantic
2262 Issue all the warnings demanded by strict ISO C and ISO C++;
2263 reject all programs that use forbidden extensions, and some other
2264 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2265 version of the ISO C standard specified by any @option{-std} option used.
2267 Valid ISO C and ISO C++ programs should compile properly with or without
2268 this option (though a rare few will require @option{-ansi} or a
2269 @option{-std} option specifying the required version of ISO C)@.  However,
2270 without this option, certain GNU extensions and traditional C and C++
2271 features are supported as well.  With this option, they are rejected.
2273 @option{-pedantic} does not cause warning messages for use of the
2274 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2275 warnings are also disabled in the expression that follows
2276 @code{__extension__}.  However, only system header files should use
2277 these escape routes; application programs should avoid them.
2278 @xref{Alternate Keywords}.
2280 Some users try to use @option{-pedantic} to check programs for strict ISO
2281 C conformance.  They soon find that it does not do quite what they want:
2282 it finds some non-ISO practices, but not all---only those for which
2283 ISO C @emph{requires} a diagnostic, and some others for which
2284 diagnostics have been added.
2286 A feature to report any failure to conform to ISO C might be useful in
2287 some instances, but would require considerable additional work and would
2288 be quite different from @option{-pedantic}.  We don't have plans to
2289 support such a feature in the near future.
2291 Where the standard specified with @option{-std} represents a GNU
2292 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2293 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2294 extended dialect is based.  Warnings from @option{-pedantic} are given
2295 where they are required by the base standard.  (It would not make sense
2296 for such warnings to be given only for features not in the specified GNU
2297 C dialect, since by definition the GNU dialects of C include all
2298 features the compiler supports with the given option, and there would be
2299 nothing to warn about.)
2301 @item -pedantic-errors
2302 @opindex pedantic-errors
2303 Like @option{-pedantic}, except that errors are produced rather than
2304 warnings.
2306 @item -w
2307 @opindex w
2308 Inhibit all warning messages.
2310 @item -Wno-import
2311 @opindex Wno-import
2312 Inhibit warning messages about the use of @samp{#import}.
2314 @item -Wchar-subscripts
2315 @opindex Wchar-subscripts
2316 Warn if an array subscript has type @code{char}.  This is a common cause
2317 of error, as programmers often forget that this type is signed on some
2318 machines.
2319 This warning is enabled by @option{-Wall}.
2321 @item -Wcomment
2322 @opindex Wcomment
2323 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2324 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2325 This warning is enabled by @option{-Wall}.
2327 @item -Wfatal-errors
2328 @opindex Wfatal-errors
2329 This option causes the compiler to abort compilation on the first error
2330 occurred rather than trying to keep going and printing further error
2331 messages.
2333 @item -Wformat
2334 @opindex Wformat
2335 @opindex ffreestanding
2336 @opindex fno-builtin
2337 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2338 the arguments supplied have types appropriate to the format string
2339 specified, and that the conversions specified in the format string make
2340 sense.  This includes standard functions, and others specified by format
2341 attributes (@pxref{Function Attributes}), in the @code{printf},
2342 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2343 not in the C standard) families (or other target-specific families).
2344 Which functions are checked without format attributes having been
2345 specified depends on the standard version selected, and such checks of
2346 functions without the attribute specified are disabled by
2347 @option{-ffreestanding} or @option{-fno-builtin}.
2349 The formats are checked against the format features supported by GNU
2350 libc version 2.2.  These include all ISO C90 and C99 features, as well
2351 as features from the Single Unix Specification and some BSD and GNU
2352 extensions.  Other library implementations may not support all these
2353 features; GCC does not support warning about features that go beyond a
2354 particular library's limitations.  However, if @option{-pedantic} is used
2355 with @option{-Wformat}, warnings will be given about format features not
2356 in the selected standard version (but not for @code{strfmon} formats,
2357 since those are not in any version of the C standard).  @xref{C Dialect
2358 Options,,Options Controlling C Dialect}.
2360 Since @option{-Wformat} also checks for null format arguments for
2361 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2363 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2364 aspects of format checking, the options @option{-Wformat-y2k},
2365 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2366 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2367 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2369 @item -Wformat-y2k
2370 @opindex Wformat-y2k
2371 If @option{-Wformat} is specified, also warn about @code{strftime}
2372 formats which may yield only a two-digit year.
2374 @item -Wno-format-extra-args
2375 @opindex Wno-format-extra-args
2376 If @option{-Wformat} is specified, do not warn about excess arguments to a
2377 @code{printf} or @code{scanf} format function.  The C standard specifies
2378 that such arguments are ignored.
2380 Where the unused arguments lie between used arguments that are
2381 specified with @samp{$} operand number specifications, normally
2382 warnings are still given, since the implementation could not know what
2383 type to pass to @code{va_arg} to skip the unused arguments.  However,
2384 in the case of @code{scanf} formats, this option will suppress the
2385 warning if the unused arguments are all pointers, since the Single
2386 Unix Specification says that such unused arguments are allowed.
2388 @item -Wno-format-zero-length
2389 @opindex Wno-format-zero-length
2390 If @option{-Wformat} is specified, do not warn about zero-length formats.
2391 The C standard specifies that zero-length formats are allowed.
2393 @item -Wformat-nonliteral
2394 @opindex Wformat-nonliteral
2395 If @option{-Wformat} is specified, also warn if the format string is not a
2396 string literal and so cannot be checked, unless the format function
2397 takes its format arguments as a @code{va_list}.
2399 @item -Wformat-security
2400 @opindex Wformat-security
2401 If @option{-Wformat} is specified, also warn about uses of format
2402 functions that represent possible security problems.  At present, this
2403 warns about calls to @code{printf} and @code{scanf} functions where the
2404 format string is not a string literal and there are no format arguments,
2405 as in @code{printf (foo);}.  This may be a security hole if the format
2406 string came from untrusted input and contains @samp{%n}.  (This is
2407 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2408 in future warnings may be added to @option{-Wformat-security} that are not
2409 included in @option{-Wformat-nonliteral}.)
2411 @item -Wformat=2
2412 @opindex Wformat=2
2413 Enable @option{-Wformat} plus format checks not included in
2414 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2415 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2417 @item -Wnonnull
2418 @opindex Wnonnull
2419 Warn about passing a null pointer for arguments marked as
2420 requiring a non-null value by the @code{nonnull} function attribute.
2422 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2423 can be disabled with the @option{-Wno-nonnull} option.
2425 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2426 @opindex Winit-self
2427 Warn about uninitialized variables which are initialized with themselves.
2428 Note this option can only be used with the @option{-Wuninitialized} option,
2429 which in turn only works with @option{-O1} and above.
2431 For example, GCC will warn about @code{i} being uninitialized in the
2432 following snippet only when @option{-Winit-self} has been specified:
2433 @smallexample
2434 @group
2435 int f()
2437   int i = i;
2438   return i;
2440 @end group
2441 @end smallexample
2443 @item -Wimplicit-int
2444 @opindex Wimplicit-int
2445 Warn when a declaration does not specify a type.
2446 This warning is enabled by @option{-Wall}.
2448 @item -Wimplicit-function-declaration
2449 @itemx -Werror-implicit-function-declaration
2450 @opindex Wimplicit-function-declaration
2451 @opindex Werror-implicit-function-declaration
2452 Give a warning (or error) whenever a function is used before being
2453 declared.  The form @option{-Wno-error-implicit-function-declaration}
2454 is not supported.
2455 This warning is enabled by @option{-Wall} (as a warning, not an error).
2457 @item -Wimplicit
2458 @opindex Wimplicit
2459 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2460 This warning is enabled by @option{-Wall}.
2462 @item -Wmain
2463 @opindex Wmain
2464 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2465 function with external linkage, returning int, taking either zero
2466 arguments, two, or three arguments of appropriate types.
2467 This warning is enabled by @option{-Wall}.
2469 @item -Wmissing-braces
2470 @opindex Wmissing-braces
2471 Warn if an aggregate or union initializer is not fully bracketed.  In
2472 the following example, the initializer for @samp{a} is not fully
2473 bracketed, but that for @samp{b} is fully bracketed.
2475 @smallexample
2476 int a[2][2] = @{ 0, 1, 2, 3 @};
2477 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2478 @end smallexample
2480 This warning is enabled by @option{-Wall}.
2482 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2483 @opindex Wmissing-include-dirs
2484 Warn if a user-supplied include directory does not exist.
2486 @item -Wparentheses
2487 @opindex Wparentheses
2488 Warn if parentheses are omitted in certain contexts, such
2489 as when there is an assignment in a context where a truth value
2490 is expected, or when operators are nested whose precedence people
2491 often get confused about.  Only the warning for an assignment used as
2492 a truth value is supported when compiling C++; the other warnings are
2493 only supported when compiling C@.
2495 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2496 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2497 interpretation from that of ordinary mathematical notation.
2499 Also warn about constructions where there may be confusion to which
2500 @code{if} statement an @code{else} branch belongs.  Here is an example of
2501 such a case:
2503 @smallexample
2504 @group
2506   if (a)
2507     if (b)
2508       foo ();
2509   else
2510     bar ();
2512 @end group
2513 @end smallexample
2515 In C, every @code{else} branch belongs to the innermost possible @code{if}
2516 statement, which in this example is @code{if (b)}.  This is often not
2517 what the programmer expected, as illustrated in the above example by
2518 indentation the programmer chose.  When there is the potential for this
2519 confusion, GCC will issue a warning when this flag is specified.
2520 To eliminate the warning, add explicit braces around the innermost
2521 @code{if} statement so there is no way the @code{else} could belong to
2522 the enclosing @code{if}.  The resulting code would look like this:
2524 @smallexample
2525 @group
2527   if (a)
2528     @{
2529       if (b)
2530         foo ();
2531       else
2532         bar ();
2533     @}
2535 @end group
2536 @end smallexample
2538 This warning is enabled by @option{-Wall}.
2540 @item -Wsequence-point
2541 @opindex Wsequence-point
2542 Warn about code that may have undefined semantics because of violations
2543 of sequence point rules in the C standard.
2545 The C standard defines the order in which expressions in a C program are
2546 evaluated in terms of @dfn{sequence points}, which represent a partial
2547 ordering between the execution of parts of the program: those executed
2548 before the sequence point, and those executed after it.  These occur
2549 after the evaluation of a full expression (one which is not part of a
2550 larger expression), after the evaluation of the first operand of a
2551 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2552 function is called (but after the evaluation of its arguments and the
2553 expression denoting the called function), and in certain other places.
2554 Other than as expressed by the sequence point rules, the order of
2555 evaluation of subexpressions of an expression is not specified.  All
2556 these rules describe only a partial order rather than a total order,
2557 since, for example, if two functions are called within one expression
2558 with no sequence point between them, the order in which the functions
2559 are called is not specified.  However, the standards committee have
2560 ruled that function calls do not overlap.
2562 It is not specified when between sequence points modifications to the
2563 values of objects take effect.  Programs whose behavior depends on this
2564 have undefined behavior; the C standard specifies that ``Between the
2565 previous and next sequence point an object shall have its stored value
2566 modified at most once by the evaluation of an expression.  Furthermore,
2567 the prior value shall be read only to determine the value to be
2568 stored.''.  If a program breaks these rules, the results on any
2569 particular implementation are entirely unpredictable.
2571 Examples of code with undefined behavior are @code{a = a++;},
2572 @code{a[n] = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases
2573 are not diagnosed by this option, and it may give an occasional false
2574 positive result, but in general it has been found fairly effective at
2575 detecting this sort of problem in programs.
2577 The present implementation of this option only works for C programs.  A
2578 future implementation may also work for C++ programs.
2580 The C standard is worded confusingly, therefore there is some debate
2581 over the precise meaning of the sequence point rules in subtle cases.
2582 Links to discussions of the problem, including proposed formal
2583 definitions, may be found on the GCC readings page, at
2584 @w{@uref{http://gcc.gnu.org/readings.html}}.
2586 This warning is enabled by @option{-Wall}.
2588 @item -Wreturn-type
2589 @opindex Wreturn-type
2590 Warn whenever a function is defined with a return-type that defaults to
2591 @code{int}.  Also warn about any @code{return} statement with no
2592 return-value in a function whose return-type is not @code{void}.
2594 For C, also warn if the return type of a function has a type qualifier
2595 such as @code{const}.  Such a type qualifier has no effect, since the
2596 value returned by a function is not an lvalue.  ISO C prohibits
2597 qualified @code{void} return types on function definitions, so such
2598 return types always receive a warning even without this option.
2600 For C++, a function without return type always produces a diagnostic
2601 message, even when @option{-Wno-return-type} is specified.  The only
2602 exceptions are @samp{main} and functions defined in system headers.
2604 This warning is enabled by @option{-Wall}.
2606 @item -Wswitch
2607 @opindex Wswitch
2608 Warn whenever a @code{switch} statement has an index of enumerated type
2609 and lacks a @code{case} for one or more of the named codes of that
2610 enumeration.  (The presence of a @code{default} label prevents this
2611 warning.)  @code{case} labels outside the enumeration range also
2612 provoke warnings when this option is used.
2613 This warning is enabled by @option{-Wall}.
2615 @item -Wswitch-default
2616 @opindex Wswitch-switch
2617 Warn whenever a @code{switch} statement does not have a @code{default}
2618 case.
2620 @item -Wswitch-enum
2621 @opindex Wswitch-enum
2622 Warn whenever a @code{switch} statement has an index of enumerated type
2623 and lacks a @code{case} for one or more of the named codes of that
2624 enumeration.  @code{case} labels outside the enumeration range also
2625 provoke warnings when this option is used.
2627 @item -Wtrigraphs
2628 @opindex Wtrigraphs
2629 Warn if any trigraphs are encountered that might change the meaning of
2630 the program (trigraphs within comments are not warned about).
2631 This warning is enabled by @option{-Wall}.
2633 @item -Wunused-function
2634 @opindex Wunused-function
2635 Warn whenever a static function is declared but not defined or a
2636 non-inline static function is unused.
2637 This warning is enabled by @option{-Wall}.
2639 @item -Wunused-label
2640 @opindex Wunused-label
2641 Warn whenever a label is declared but not used.
2642 This warning is enabled by @option{-Wall}.
2644 To suppress this warning use the @samp{unused} attribute
2645 (@pxref{Variable Attributes}).
2647 @item -Wunused-parameter
2648 @opindex Wunused-parameter
2649 Warn whenever a function parameter is unused aside from its declaration.
2651 To suppress this warning use the @samp{unused} attribute
2652 (@pxref{Variable Attributes}).
2654 @item -Wunused-variable
2655 @opindex Wunused-variable
2656 Warn whenever a local variable or non-constant static variable is unused
2657 aside from its declaration.
2658 This warning is enabled by @option{-Wall}.
2660 To suppress this warning use the @samp{unused} attribute
2661 (@pxref{Variable Attributes}).
2663 @item -Wunused-value
2664 @opindex Wunused-value
2665 Warn whenever a statement computes a result that is explicitly not used.
2666 This warning is enabled by @option{-Wall}.
2668 To suppress this warning cast the expression to @samp{void}.
2670 @item -Wunused
2671 @opindex Wunused
2672 All the above @option{-Wunused} options combined.
2674 In order to get a warning about an unused function parameter, you must
2675 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2676 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2678 @item -Wuninitialized
2679 @opindex Wuninitialized
2680 Warn if an automatic variable is used without first being initialized or
2681 if a variable may be clobbered by a @code{setjmp} call.
2683 These warnings are possible only in optimizing compilation,
2684 because they require data flow information that is computed only
2685 when optimizing.  If you don't specify @option{-O}, you simply won't
2686 get these warnings.
2688 If you want to warn about code which uses the uninitialized value of the
2689 variable in its own initializer, use the @option{-Winit-self} option.
2691 These warnings occur for individual uninitialized or clobbered
2692 elements of structure, union or array variables as well as for
2693 variables which are uninitialized or clobbered as a whole.  They do
2694 not occur for variables or elements declared @code{volatile}.  Because
2695 these warnings depend on optimization, the exact variables or elements
2696 for which there are warnings will depend on the precise optimization
2697 options and version of GCC used.
2699 Note that there may be no warning about a variable that is used only
2700 to compute a value that itself is never used, because such
2701 computations may be deleted by data flow analysis before the warnings
2702 are printed.
2704 These warnings are made optional because GCC is not smart
2705 enough to see all the reasons why the code might be correct
2706 despite appearing to have an error.  Here is one example of how
2707 this can happen:
2709 @smallexample
2710 @group
2712   int x;
2713   switch (y)
2714     @{
2715     case 1: x = 1;
2716       break;
2717     case 2: x = 4;
2718       break;
2719     case 3: x = 5;
2720     @}
2721   foo (x);
2723 @end group
2724 @end smallexample
2726 @noindent
2727 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2728 always initialized, but GCC doesn't know this.  Here is
2729 another common case:
2731 @smallexample
2733   int save_y;
2734   if (change_y) save_y = y, y = new_y;
2735   @dots{}
2736   if (change_y) y = save_y;
2738 @end smallexample
2740 @noindent
2741 This has no bug because @code{save_y} is used only if it is set.
2743 @cindex @code{longjmp} warnings
2744 This option also warns when a non-volatile automatic variable might be
2745 changed by a call to @code{longjmp}.  These warnings as well are possible
2746 only in optimizing compilation.
2748 The compiler sees only the calls to @code{setjmp}.  It cannot know
2749 where @code{longjmp} will be called; in fact, a signal handler could
2750 call it at any point in the code.  As a result, you may get a warning
2751 even when there is in fact no problem because @code{longjmp} cannot
2752 in fact be called at the place which would cause a problem.
2754 Some spurious warnings can be avoided if you declare all the functions
2755 you use that never return as @code{noreturn}.  @xref{Function
2756 Attributes}.
2758 This warning is enabled by @option{-Wall}.
2760 @item -Wunknown-pragmas
2761 @opindex Wunknown-pragmas
2762 @cindex warning for unknown pragmas
2763 @cindex unknown pragmas, warning
2764 @cindex pragmas, warning of unknown
2765 Warn when a #pragma directive is encountered which is not understood by
2766 GCC@.  If this command line option is used, warnings will even be issued
2767 for unknown pragmas in system header files.  This is not the case if
2768 the warnings were only enabled by the @option{-Wall} command line option.
2770 @item -Wno-pragmas
2771 @opindex Wno-pragmas
2772 @opindex Wpragmas
2773 Do not warn about misuses of pragmas, such as incorrect parameters,
2774 invalid syntax, or conflicts between pragmas.  See also
2775 @samp{-Wunknown-pragmas}.
2777 @item -Wstrict-aliasing
2778 @opindex Wstrict-aliasing
2779 This option is only active when @option{-fstrict-aliasing} is active.
2780 It warns about code which might break the strict aliasing rules that the
2781 compiler is using for optimization.  The warning does not catch all
2782 cases, but does attempt to catch the more common pitfalls.  It is
2783 included in @option{-Wall}.
2785 @item -Wstrict-aliasing=2
2786 @opindex Wstrict-aliasing=2
2787 This option is only active when @option{-fstrict-aliasing} is active.
2788 It warns about code which might break the strict aliasing rules that the
2789 compiler is using for optimization.  This warning catches more cases than
2790 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2791 cases that are safe.
2793 @item -Wall
2794 @opindex Wall
2795 All of the above @samp{-W} options combined.  This enables all the
2796 warnings about constructions that some users consider questionable, and
2797 that are easy to avoid (or modify to prevent the warning), even in
2798 conjunction with macros.  This also enables some language-specific
2799 warnings described in @ref{C++ Dialect Options} and
2800 @ref{Objective-C and Objective-C++ Dialect Options}.
2801 @end table
2803 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2804 Some of them warn about constructions that users generally do not
2805 consider questionable, but which occasionally you might wish to check
2806 for; others warn about constructions that are necessary or hard to avoid
2807 in some cases, and there is no simple way to modify the code to suppress
2808 the warning.
2810 @table @gcctabopt
2811 @item -Wextra
2812 @opindex W
2813 @opindex Wextra
2814 (This option used to be called @option{-W}.  The older name is still
2815 supported, but the newer name is more descriptive.)  Print extra warning
2816 messages for these events:
2818 @itemize @bullet
2819 @item
2820 A function can return either with or without a value.  (Falling
2821 off the end of the function body is considered returning without
2822 a value.)  For example, this function would evoke such a
2823 warning:
2825 @smallexample
2826 @group
2827 foo (a)
2829   if (a > 0)
2830     return a;
2832 @end group
2833 @end smallexample
2835 @item
2836 An expression-statement or the left-hand side of a comma expression
2837 contains no side effects.
2838 To suppress the warning, cast the unused expression to void.
2839 For example, an expression such as @samp{x[i,j]} will cause a warning,
2840 but @samp{x[(void)i,j]} will not.
2842 @item
2843 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2845 @item
2846 Storage-class specifiers like @code{static} are not the first things in
2847 a declaration.  According to the C Standard, this usage is obsolescent.
2849 @item
2850 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2851 arguments.
2853 @item
2854 A comparison between signed and unsigned values could produce an
2855 incorrect result when the signed value is converted to unsigned.
2856 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2858 @item
2859 An aggregate has an initializer which does not initialize all members.
2860 This warning can be independently controlled by
2861 @option{-Wmissing-field-initializers}.
2863 @item
2864 A function parameter is declared without a type specifier in K&R-style
2865 functions:
2867 @smallexample
2868 void foo(bar) @{ @}
2869 @end smallexample
2871 @item
2872 An empty body occurs in an @samp{if} or @samp{else} statement.
2874 @item
2875 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2876 @samp{>}, or @samp{>=}.
2878 @item
2879 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2881 @item
2882 Any of several floating-point events that often indicate errors, such as
2883 overflow, underflow, loss of precision, etc.
2885 @item @r{(C++ only)}
2886 An enumerator and a non-enumerator both appear in a conditional expression.
2888 @item @r{(C++ only)}
2889 A non-static reference or non-static @samp{const} member appears in a
2890 class without constructors.
2892 @item @r{(C++ only)}
2893 Ambiguous virtual bases.
2895 @item @r{(C++ only)}
2896 Subscripting an array which has been declared @samp{register}.
2898 @item @r{(C++ only)}
2899 Taking the address of a variable which has been declared @samp{register}.
2901 @item @r{(C++ only)}
2902 A base class is not initialized in a derived class' copy constructor.
2903 @end itemize
2905 @item -Wno-div-by-zero
2906 @opindex Wno-div-by-zero
2907 @opindex Wdiv-by-zero
2908 Do not warn about compile-time integer division by zero.  Floating point
2909 division by zero is not warned about, as it can be a legitimate way of
2910 obtaining infinities and NaNs.
2912 @item -Wsystem-headers
2913 @opindex Wsystem-headers
2914 @cindex warnings from system headers
2915 @cindex system headers, warnings from
2916 Print warning messages for constructs found in system header files.
2917 Warnings from system headers are normally suppressed, on the assumption
2918 that they usually do not indicate real problems and would only make the
2919 compiler output harder to read.  Using this command line option tells
2920 GCC to emit warnings from system headers as if they occurred in user
2921 code.  However, note that using @option{-Wall} in conjunction with this
2922 option will @emph{not} warn about unknown pragmas in system
2923 headers---for that, @option{-Wunknown-pragmas} must also be used.
2925 @item -Wfloat-equal
2926 @opindex Wfloat-equal
2927 Warn if floating point values are used in equality comparisons.
2929 The idea behind this is that sometimes it is convenient (for the
2930 programmer) to consider floating-point values as approximations to
2931 infinitely precise real numbers.  If you are doing this, then you need
2932 to compute (by analyzing the code, or in some other way) the maximum or
2933 likely maximum error that the computation introduces, and allow for it
2934 when performing comparisons (and when producing output, but that's a
2935 different problem).  In particular, instead of testing for equality, you
2936 would check to see whether the two values have ranges that overlap; and
2937 this is done with the relational operators, so equality comparisons are
2938 probably mistaken.
2940 @item -Wtraditional @r{(C only)}
2941 @opindex Wtraditional
2942 Warn about certain constructs that behave differently in traditional and
2943 ISO C@.  Also warn about ISO C constructs that have no traditional C
2944 equivalent, and/or problematic constructs which should be avoided.
2946 @itemize @bullet
2947 @item
2948 Macro parameters that appear within string literals in the macro body.
2949 In traditional C macro replacement takes place within string literals,
2950 but does not in ISO C@.
2952 @item
2953 In traditional C, some preprocessor directives did not exist.
2954 Traditional preprocessors would only consider a line to be a directive
2955 if the @samp{#} appeared in column 1 on the line.  Therefore
2956 @option{-Wtraditional} warns about directives that traditional C
2957 understands but would ignore because the @samp{#} does not appear as the
2958 first character on the line.  It also suggests you hide directives like
2959 @samp{#pragma} not understood by traditional C by indenting them.  Some
2960 traditional implementations would not recognize @samp{#elif}, so it
2961 suggests avoiding it altogether.
2963 @item
2964 A function-like macro that appears without arguments.
2966 @item
2967 The unary plus operator.
2969 @item
2970 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2971 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2972 constants.)  Note, these suffixes appear in macros defined in the system
2973 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2974 Use of these macros in user code might normally lead to spurious
2975 warnings, however GCC's integrated preprocessor has enough context to
2976 avoid warning in these cases.
2978 @item
2979 A function declared external in one block and then used after the end of
2980 the block.
2982 @item
2983 A @code{switch} statement has an operand of type @code{long}.
2985 @item
2986 A non-@code{static} function declaration follows a @code{static} one.
2987 This construct is not accepted by some traditional C compilers.
2989 @item
2990 The ISO type of an integer constant has a different width or
2991 signedness from its traditional type.  This warning is only issued if
2992 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2993 typically represent bit patterns, are not warned about.
2995 @item
2996 Usage of ISO string concatenation is detected.
2998 @item
2999 Initialization of automatic aggregates.
3001 @item
3002 Identifier conflicts with labels.  Traditional C lacks a separate
3003 namespace for labels.
3005 @item
3006 Initialization of unions.  If the initializer is zero, the warning is
3007 omitted.  This is done under the assumption that the zero initializer in
3008 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3009 initializer warnings and relies on default initialization to zero in the
3010 traditional C case.
3012 @item
3013 Conversions by prototypes between fixed/floating point values and vice
3014 versa.  The absence of these prototypes when compiling with traditional
3015 C would cause serious problems.  This is a subset of the possible
3016 conversion warnings, for the full set use @option{-Wconversion}.
3018 @item
3019 Use of ISO C style function definitions.  This warning intentionally is
3020 @emph{not} issued for prototype declarations or variadic functions
3021 because these ISO C features will appear in your code when using
3022 libiberty's traditional C compatibility macros, @code{PARAMS} and
3023 @code{VPARAMS}.  This warning is also bypassed for nested functions
3024 because that feature is already a GCC extension and thus not relevant to
3025 traditional C compatibility.
3026 @end itemize
3028 @item -Wdeclaration-after-statement @r{(C only)}
3029 @opindex Wdeclaration-after-statement
3030 Warn when a declaration is found after a statement in a block.  This
3031 construct, known from C++, was introduced with ISO C99 and is by default
3032 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3033 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3035 @item -Wundef
3036 @opindex Wundef
3037 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3039 @item -Wno-endif-labels
3040 @opindex Wno-endif-labels
3041 @opindex Wendif-labels
3042 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3044 @item -Wshadow
3045 @opindex Wshadow
3046 Warn whenever a local variable shadows another local variable, parameter or
3047 global variable or whenever a built-in function is shadowed.
3049 @item -Wlarger-than-@var{len}
3050 @opindex Wlarger-than
3051 Warn whenever an object of larger than @var{len} bytes is defined.
3053 @item -Wunsafe-loop-optimizations
3054 @opindex Wunsafe-loop-optimizations
3055 Warn if the loop cannot be optimized because the compiler could not
3056 assume anything on the bounds of the loop indices.  With
3057 @option{-funsafe-loop-optimizations} warn if the compiler made
3058 such assumptions.
3060 @item -Wpointer-arith
3061 @opindex Wpointer-arith
3062 Warn about anything that depends on the ``size of'' a function type or
3063 of @code{void}.  GNU C assigns these types a size of 1, for
3064 convenience in calculations with @code{void *} pointers and pointers
3065 to functions.
3067 @item -Wbad-function-cast @r{(C only)}
3068 @opindex Wbad-function-cast
3069 Warn whenever a function call is cast to a non-matching type.
3070 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3072 @item -Wc++-compat
3073 Warn about ISO C constructs that are outside of the common subset of
3074 ISO C and ISO C++, e.g.@: request for implicit conversion from
3075 @code{void *} to a pointer to non-@code{void} type.
3077 @item -Wcast-qual
3078 @opindex Wcast-qual
3079 Warn whenever a pointer is cast so as to remove a type qualifier from
3080 the target type.  For example, warn if a @code{const char *} is cast
3081 to an ordinary @code{char *}.
3083 @item -Wcast-align
3084 @opindex Wcast-align
3085 Warn whenever a pointer is cast such that the required alignment of the
3086 target is increased.  For example, warn if a @code{char *} is cast to
3087 an @code{int *} on machines where integers can only be accessed at
3088 two- or four-byte boundaries.
3090 @item -Wwrite-strings
3091 @opindex Wwrite-strings
3092 When compiling C, give string constants the type @code{const
3093 char[@var{length}]} so that
3094 copying the address of one into a non-@code{const} @code{char *}
3095 pointer will get a warning; when compiling C++, warn about the
3096 deprecated conversion from string constants to @code{char *}.
3097 These warnings will help you find at
3098 compile time code that can try to write into a string constant, but
3099 only if you have been very careful about using @code{const} in
3100 declarations and prototypes.  Otherwise, it will just be a nuisance;
3101 this is why we did not make @option{-Wall} request these warnings.
3103 @item -Wconversion
3104 @opindex Wconversion
3105 Warn if a prototype causes a type conversion that is different from what
3106 would happen to the same argument in the absence of a prototype.  This
3107 includes conversions of fixed point to floating and vice versa, and
3108 conversions changing the width or signedness of a fixed point argument
3109 except when the same as the default promotion.
3111 Also, warn if a negative integer constant expression is implicitly
3112 converted to an unsigned type.  For example, warn about the assignment
3113 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3114 casts like @code{(unsigned) -1}.
3116 @item -Wsign-compare
3117 @opindex Wsign-compare
3118 @cindex warning for comparison of signed and unsigned values
3119 @cindex comparison of signed and unsigned values, warning
3120 @cindex signed and unsigned values, comparison warning
3121 Warn when a comparison between signed and unsigned values could produce
3122 an incorrect result when the signed value is converted to unsigned.
3123 This warning is also enabled by @option{-Wextra}; to get the other warnings
3124 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3126 @item -Waggregate-return
3127 @opindex Waggregate-return
3128 Warn if any functions that return structures or unions are defined or
3129 called.  (In languages where you can return an array, this also elicits
3130 a warning.)
3132 @item -Wno-attributes
3133 @opindex Wno-attributes
3134 @opindex Wattributes
3135 Do not warn if an unexpected @code{__attribute__} is used, such as
3136 unrecognized attributes, function attributes applied to variables,
3137 etc.  This will not stop errors for incorrect use of supported
3138 attributes.
3140 @item -Wstrict-prototypes @r{(C only)}
3141 @opindex Wstrict-prototypes
3142 Warn if a function is declared or defined without specifying the
3143 argument types.  (An old-style function definition is permitted without
3144 a warning if preceded by a declaration which specifies the argument
3145 types.)
3147 @item -Wold-style-definition @r{(C only)}
3148 @opindex Wold-style-definition
3149 Warn if an old-style function definition is used.  A warning is given
3150 even if there is a previous prototype.
3152 @item -Wmissing-prototypes @r{(C only)}
3153 @opindex Wmissing-prototypes
3154 Warn if a global function is defined without a previous prototype
3155 declaration.  This warning is issued even if the definition itself
3156 provides a prototype.  The aim is to detect global functions that fail
3157 to be declared in header files.
3159 @item -Wmissing-declarations @r{(C only)}
3160 @opindex Wmissing-declarations
3161 Warn if a global function is defined without a previous declaration.
3162 Do so even if the definition itself provides a prototype.
3163 Use this option to detect global functions that are not declared in
3164 header files.
3166 @item -Wmissing-field-initializers
3167 @opindex Wmissing-field-initializers
3168 @opindex W
3169 @opindex Wextra
3170 Warn if a structure's initializer has some fields missing.  For
3171 example, the following code would cause such a warning, because
3172 @code{x.h} is implicitly zero:
3174 @smallexample
3175 struct s @{ int f, g, h; @};
3176 struct s x = @{ 3, 4 @};
3177 @end smallexample
3179 This option does not warn about designated initializers, so the following
3180 modification would not trigger a warning:
3182 @smallexample
3183 struct s @{ int f, g, h; @};
3184 struct s x = @{ .f = 3, .g = 4 @};
3185 @end smallexample
3187 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3188 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3190 @item -Wmissing-noreturn
3191 @opindex Wmissing-noreturn
3192 Warn about functions which might be candidates for attribute @code{noreturn}.
3193 Note these are only possible candidates, not absolute ones.  Care should
3194 be taken to manually verify functions actually do not ever return before
3195 adding the @code{noreturn} attribute, otherwise subtle code generation
3196 bugs could be introduced.  You will not get a warning for @code{main} in
3197 hosted C environments.
3199 @item -Wmissing-format-attribute
3200 @opindex Wmissing-format-attribute
3201 @opindex Wformat
3202 Warn about function pointers which might be candidates for @code{format}
3203 attributes.  Note these are only possible candidates, not absolute ones.
3204 GCC will guess that function pointers with @code{format} attributes that
3205 are used in assignment, initialization, parameter passing or return
3206 statements should have a corresponding @code{format} attribute in the
3207 resulting type.  I.e.@: the left-hand side of the assignment or
3208 initialization, the type of the parameter variable, or the return type
3209 of the containing function respectively should also have a @code{format}
3210 attribute to avoid the warning.
3212 GCC will also warn about function definitions which might be
3213 candidates for @code{format} attributes.  Again, these are only
3214 possible candidates.  GCC will guess that @code{format} attributes
3215 might be appropriate for any function that calls a function like
3216 @code{vprintf} or @code{vscanf}, but this might not always be the
3217 case, and some functions for which @code{format} attributes are
3218 appropriate may not be detected.
3220 @item -Wno-multichar
3221 @opindex Wno-multichar
3222 @opindex Wmultichar
3223 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3224 Usually they indicate a typo in the user's code, as they have
3225 implementation-defined values, and should not be used in portable code.
3227 @item -Wnormalized=<none|id|nfc|nfkc>
3228 @opindex Wnormalized
3229 @cindex NFC
3230 @cindex NFKC
3231 @cindex character set, input normalization
3232 In ISO C and ISO C++, two identifiers are different if they are
3233 different sequences of characters.  However, sometimes when characters
3234 outside the basic ASCII character set are used, you can have two
3235 different character sequences that look the same.  To avoid confusion,
3236 the ISO 10646 standard sets out some @dfn{normalization rules} which
3237 when applied ensure that two sequences that look the same are turned into
3238 the same sequence.  GCC can warn you if you are using identifiers which
3239 have not been normalized; this option controls that warning.
3241 There are four levels of warning that GCC supports.  The default is
3242 @option{-Wnormalized=nfc}, which warns about any identifier which is
3243 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3244 recommended form for most uses.
3246 Unfortunately, there are some characters which ISO C and ISO C++ allow
3247 in identifiers that when turned into NFC aren't allowable as
3248 identifiers.  That is, there's no way to use these symbols in portable
3249 ISO C or C++ and have all your identifiers in NFC.
3250 @option{-Wnormalized=id} suppresses the warning for these characters.
3251 It is hoped that future versions of the standards involved will correct
3252 this, which is why this option is not the default.
3254 You can switch the warning off for all characters by writing
3255 @option{-Wnormalized=none}.  You would only want to do this if you
3256 were using some other normalization scheme (like ``D''), because
3257 otherwise you can easily create bugs that are literally impossible to see.
3259 Some characters in ISO 10646 have distinct meanings but look identical
3260 in some fonts or display methodologies, especially once formatting has
3261 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3262 LETTER N'', will display just like a regular @code{n} which has been
3263 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3264 normalisation scheme to convert all these into a standard form as
3265 well, and GCC will warn if your code is not in NFKC if you use
3266 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3267 about every identifier that contains the letter O because it might be
3268 confused with the digit 0, and so is not the default, but may be
3269 useful as a local coding convention if the programming environment is
3270 unable to be fixed to display these characters distinctly.
3272 @item -Wno-deprecated-declarations
3273 @opindex Wno-deprecated-declarations
3274 Do not warn about uses of functions, variables, and types marked as
3275 deprecated by using the @code{deprecated} attribute.
3276 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3277 @pxref{Type Attributes}.)
3279 @item -Wpacked
3280 @opindex Wpacked
3281 Warn if a structure is given the packed attribute, but the packed
3282 attribute has no effect on the layout or size of the structure.
3283 Such structures may be mis-aligned for little benefit.  For
3284 instance, in this code, the variable @code{f.x} in @code{struct bar}
3285 will be misaligned even though @code{struct bar} does not itself
3286 have the packed attribute:
3288 @smallexample
3289 @group
3290 struct foo @{
3291   int x;
3292   char a, b, c, d;
3293 @} __attribute__((packed));
3294 struct bar @{
3295   char z;
3296   struct foo f;
3298 @end group
3299 @end smallexample
3301 @item -Wpadded
3302 @opindex Wpadded
3303 Warn if padding is included in a structure, either to align an element
3304 of the structure or to align the whole structure.  Sometimes when this
3305 happens it is possible to rearrange the fields of the structure to
3306 reduce the padding and so make the structure smaller.
3308 @item -Wredundant-decls
3309 @opindex Wredundant-decls
3310 Warn if anything is declared more than once in the same scope, even in
3311 cases where multiple declaration is valid and changes nothing.
3313 @item -Wnested-externs @r{(C only)}
3314 @opindex Wnested-externs
3315 Warn if an @code{extern} declaration is encountered within a function.
3317 @item -Wunreachable-code
3318 @opindex Wunreachable-code
3319 Warn if the compiler detects that code will never be executed.
3321 This option is intended to warn when the compiler detects that at
3322 least a whole line of source code will never be executed, because
3323 some condition is never satisfied or because it is after a
3324 procedure that never returns.
3326 It is possible for this option to produce a warning even though there
3327 are circumstances under which part of the affected line can be executed,
3328 so care should be taken when removing apparently-unreachable code.
3330 For instance, when a function is inlined, a warning may mean that the
3331 line is unreachable in only one inlined copy of the function.
3333 This option is not made part of @option{-Wall} because in a debugging
3334 version of a program there is often substantial code which checks
3335 correct functioning of the program and is, hopefully, unreachable
3336 because the program does work.  Another common use of unreachable
3337 code is to provide behavior which is selectable at compile-time.
3339 @item -Winline
3340 @opindex Winline
3341 Warn if a function can not be inlined and it was declared as inline.
3342 Even with this option, the compiler will not warn about failures to
3343 inline functions declared in system headers.
3345 The compiler uses a variety of heuristics to determine whether or not
3346 to inline a function.  For example, the compiler takes into account
3347 the size of the function being inlined and the amount of inlining
3348 that has already been done in the current function.  Therefore,
3349 seemingly insignificant changes in the source program can cause the
3350 warnings produced by @option{-Winline} to appear or disappear.
3352 @item -Wno-invalid-offsetof @r{(C++ only)}
3353 @opindex Wno-invalid-offsetof
3354 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3355 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3356 to a non-POD type is undefined.  In existing C++ implementations,
3357 however, @samp{offsetof} typically gives meaningful results even when
3358 applied to certain kinds of non-POD types. (Such as a simple
3359 @samp{struct} that fails to be a POD type only by virtue of having a
3360 constructor.)  This flag is for users who are aware that they are
3361 writing nonportable code and who have deliberately chosen to ignore the
3362 warning about it.
3364 The restrictions on @samp{offsetof} may be relaxed in a future version
3365 of the C++ standard.
3367 @item -Wno-int-to-pointer-cast @r{(C only)}
3368 @opindex Wno-int-to-pointer-cast
3369 Suppress warnings from casts to pointer type of an integer of a
3370 different size.
3372 @item -Wno-pointer-to-int-cast @r{(C only)}
3373 @opindex Wno-pointer-to-int-cast
3374 Suppress warnings from casts from a pointer to an integer type of a
3375 different size.
3377 @item -Winvalid-pch
3378 @opindex Winvalid-pch
3379 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3380 the search path but can't be used.
3382 @item -Wlong-long
3383 @opindex Wlong-long
3384 @opindex Wno-long-long
3385 Warn if @samp{long long} type is used.  This is default.  To inhibit
3386 the warning messages, use @option{-Wno-long-long}.  Flags
3387 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3388 only when @option{-pedantic} flag is used.
3390 @item -Wvariadic-macros
3391 @opindex Wvariadic-macros
3392 @opindex Wno-variadic-macros
3393 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3394 alternate syntax when in pedantic ISO C99 mode.  This is default.
3395 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3397 @item -Wvolatile-register-var
3398 @opindex Wvolatile-register-var
3399 @opindex Wno-volatile-register-var
3400 Warn if a register variable is declared volatile.  The volatile
3401 modifier does not inhibit all optimizations that may eliminate reads
3402 and/or writes to register variables.
3404 @item -Wdisabled-optimization
3405 @opindex Wdisabled-optimization
3406 Warn if a requested optimization pass is disabled.  This warning does
3407 not generally indicate that there is anything wrong with your code; it
3408 merely indicates that GCC's optimizers were unable to handle the code
3409 effectively.  Often, the problem is that your code is too big or too
3410 complex; GCC will refuse to optimize programs when the optimization
3411 itself is likely to take inordinate amounts of time.
3413 @item -Wpointer-sign
3414 @opindex Wpointer-sign
3415 @opindex Wno-pointer-sign
3416 Warn for pointer argument passing or assignment with different signedness.
3417 This option is only supported for C and Objective-C@.  It is implied by
3418 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3419 @option{-Wno-pointer-sign}.
3421 @item -Werror
3422 @opindex Werror
3423 Make all warnings into errors.
3425 @item -Wstack-protector
3426 This option is only active when @option{-fstack-protector} is active.  It
3427 warns about functions that will not be protected against stack smashing.
3429 @end table
3431 @node Debugging Options
3432 @section Options for Debugging Your Program or GCC
3433 @cindex options, debugging
3434 @cindex debugging information options
3436 GCC has various special options that are used for debugging
3437 either your program or GCC:
3439 @table @gcctabopt
3440 @item -g
3441 @opindex g
3442 Produce debugging information in the operating system's native format
3443 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3444 information.
3446 On most systems that use stabs format, @option{-g} enables use of extra
3447 debugging information that only GDB can use; this extra information
3448 makes debugging work better in GDB but will probably make other debuggers
3449 crash or
3450 refuse to read the program.  If you want to control for certain whether
3451 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3452 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3454 GCC allows you to use @option{-g} with
3455 @option{-O}.  The shortcuts taken by optimized code may occasionally
3456 produce surprising results: some variables you declared may not exist
3457 at all; flow of control may briefly move where you did not expect it;
3458 some statements may not be executed because they compute constant
3459 results or their values were already at hand; some statements may
3460 execute in different places because they were moved out of loops.
3462 Nevertheless it proves possible to debug optimized output.  This makes
3463 it reasonable to use the optimizer for programs that might have bugs.
3465 The following options are useful when GCC is generated with the
3466 capability for more than one debugging format.
3468 @item -ggdb
3469 @opindex ggdb
3470 Produce debugging information for use by GDB@.  This means to use the
3471 most expressive format available (DWARF 2, stabs, or the native format
3472 if neither of those are supported), including GDB extensions if at all
3473 possible.
3475 @item -gstabs
3476 @opindex gstabs
3477 Produce debugging information in stabs format (if that is supported),
3478 without GDB extensions.  This is the format used by DBX on most BSD
3479 systems.  On MIPS, Alpha and System V Release 4 systems this option
3480 produces stabs debugging output which is not understood by DBX or SDB@.
3481 On System V Release 4 systems this option requires the GNU assembler.
3483 @item -feliminate-unused-debug-symbols
3484 @opindex feliminate-unused-debug-symbols
3485 Produce debugging information in stabs format (if that is supported),
3486 for only symbols that are actually used.
3488 @item -gstabs+
3489 @opindex gstabs+
3490 Produce debugging information in stabs format (if that is supported),
3491 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3492 use of these extensions is likely to make other debuggers crash or
3493 refuse to read the program.
3495 @item -gcoff
3496 @opindex gcoff
3497 Produce debugging information in COFF format (if that is supported).
3498 This is the format used by SDB on most System V systems prior to
3499 System V Release 4.
3501 @item -gxcoff
3502 @opindex gxcoff
3503 Produce debugging information in XCOFF format (if that is supported).
3504 This is the format used by the DBX debugger on IBM RS/6000 systems.
3506 @item -gxcoff+
3507 @opindex gxcoff+
3508 Produce debugging information in XCOFF format (if that is supported),
3509 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3510 use of these extensions is likely to make other debuggers crash or
3511 refuse to read the program, and may cause assemblers other than the GNU
3512 assembler (GAS) to fail with an error.
3514 @item -gdwarf-2
3515 @opindex gdwarf-2
3516 Produce debugging information in DWARF version 2 format (if that is
3517 supported).  This is the format used by DBX on IRIX 6.  With this
3518 option, GCC uses features of DWARF version 3 when they are useful;
3519 version 3 is upward compatible with version 2, but may still cause
3520 problems for older debuggers.
3522 @item -gvms
3523 @opindex gvms
3524 Produce debugging information in VMS debug format (if that is
3525 supported).  This is the format used by DEBUG on VMS systems.
3527 @item -g@var{level}
3528 @itemx -ggdb@var{level}
3529 @itemx -gstabs@var{level}
3530 @itemx -gcoff@var{level}
3531 @itemx -gxcoff@var{level}
3532 @itemx -gvms@var{level}
3533 Request debugging information and also use @var{level} to specify how
3534 much information.  The default level is 2.
3536 Level 1 produces minimal information, enough for making backtraces in
3537 parts of the program that you don't plan to debug.  This includes
3538 descriptions of functions and external variables, but no information
3539 about local variables and no line numbers.
3541 Level 3 includes extra information, such as all the macro definitions
3542 present in the program.  Some debuggers support macro expansion when
3543 you use @option{-g3}.
3545 @option{-gdwarf-2} does not accept a concatenated debug level, because
3546 GCC used to support an option @option{-gdwarf} that meant to generate
3547 debug information in version 1 of the DWARF format (which is very
3548 different from version 2), and it would have been too confusing.  That
3549 debug format is long obsolete, but the option cannot be changed now.
3550 Instead use an additional @option{-g@var{level}} option to change the
3551 debug level for DWARF2.
3553 @item -feliminate-dwarf2-dups
3554 @opindex feliminate-dwarf2-dups
3555 Compress DWARF2 debugging information by eliminating duplicated
3556 information about each symbol.  This option only makes sense when
3557 generating DWARF2 debugging information with @option{-gdwarf-2}.
3559 @cindex @command{prof}
3560 @item -p
3561 @opindex p
3562 Generate extra code to write profile information suitable for the
3563 analysis program @command{prof}.  You must use this option when compiling
3564 the source files you want data about, and you must also use it when
3565 linking.
3567 @cindex @command{gprof}
3568 @item -pg
3569 @opindex pg
3570 Generate extra code to write profile information suitable for the
3571 analysis program @command{gprof}.  You must use this option when compiling
3572 the source files you want data about, and you must also use it when
3573 linking.
3575 @item -Q
3576 @opindex Q
3577 Makes the compiler print out each function name as it is compiled, and
3578 print some statistics about each pass when it finishes.
3580 @item -ftime-report
3581 @opindex ftime-report
3582 Makes the compiler print some statistics about the time consumed by each
3583 pass when it finishes.
3585 @item -fmem-report
3586 @opindex fmem-report
3587 Makes the compiler print some statistics about permanent memory
3588 allocation when it finishes.
3590 @item -fprofile-arcs
3591 @opindex fprofile-arcs
3592 Add code so that program flow @dfn{arcs} are instrumented.  During
3593 execution the program records how many times each branch and call is
3594 executed and how many times it is taken or returns.  When the compiled
3595 program exits it saves this data to a file called
3596 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3597 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3598 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3599 @var{auxname} is generated from the name of the output file, if
3600 explicitly specified and it is not the final executable, otherwise it is
3601 the basename of the source file.  In both cases any suffix is removed
3602 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3603 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3604 @xref{Cross-profiling}.
3606 @cindex @command{gcov}
3607 @item --coverage
3608 @opindex coverage
3610 This option is used to compile and link code instrumented for coverage
3611 analysis.  The option is a synonym for @option{-fprofile-arcs}
3612 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3613 linking).  See the documentation for those options for more details.
3615 @itemize
3617 @item
3618 Compile the source files with @option{-fprofile-arcs} plus optimization
3619 and code generation options.  For test coverage analysis, use the
3620 additional @option{-ftest-coverage} option.  You do not need to profile
3621 every source file in a program.
3623 @item
3624 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3625 (the latter implies the former).
3627 @item
3628 Run the program on a representative workload to generate the arc profile
3629 information.  This may be repeated any number of times.  You can run
3630 concurrent instances of your program, and provided that the file system
3631 supports locking, the data files will be correctly updated.  Also
3632 @code{fork} calls are detected and correctly handled (double counting
3633 will not happen).
3635 @item
3636 For profile-directed optimizations, compile the source files again with
3637 the same optimization and code generation options plus
3638 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3639 Control Optimization}).
3641 @item
3642 For test coverage analysis, use @command{gcov} to produce human readable
3643 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3644 @command{gcov} documentation for further information.
3646 @end itemize
3648 With @option{-fprofile-arcs}, for each function of your program GCC
3649 creates a program flow graph, then finds a spanning tree for the graph.
3650 Only arcs that are not on the spanning tree have to be instrumented: the
3651 compiler adds code to count the number of times that these arcs are
3652 executed.  When an arc is the only exit or only entrance to a block, the
3653 instrumentation code can be added to the block; otherwise, a new basic
3654 block must be created to hold the instrumentation code.
3656 @need 2000
3657 @item -ftest-coverage
3658 @opindex ftest-coverage
3659 Produce a notes file that the @command{gcov} code-coverage utility
3660 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3661 show program coverage.  Each source file's note file is called
3662 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3663 above for a description of @var{auxname} and instructions on how to
3664 generate test coverage data.  Coverage data will match the source files
3665 more closely, if you do not optimize.
3667 @item -d@var{letters}
3668 @item -fdump-rtl-@var{pass}
3669 @opindex d
3670 Says to make debugging dumps during compilation at times specified by
3671 @var{letters}.    This is used for debugging the RTL-based passes of the
3672 compiler.  The file names for most of the dumps are made by appending a
3673 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3674 from the name of the output file, if explicitly specified and it is not
3675 an executable, otherwise it is the basename of the source file.
3677 Most debug dumps can be enabled either passing a letter to the @option{-d}
3678 option, or with a long @option{-fdump-rtl} switch; here are the possible
3679 letters for use in @var{letters} and @var{pass}, and their meanings:
3681 @table @gcctabopt
3682 @item -dA
3683 @opindex dA
3684 Annotate the assembler output with miscellaneous debugging information.
3686 @item -db
3687 @itemx -fdump-rtl-bp
3688 @opindex db
3689 @opindex fdump-rtl-bp
3690 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3692 @item -dB
3693 @itemx -fdump-rtl-bbro
3694 @opindex dB
3695 @opindex fdump-rtl-bbro
3696 Dump after block reordering, to @file{@var{file}.30.bbro}.
3698 @item -dc
3699 @itemx -fdump-rtl-combine
3700 @opindex dc
3701 @opindex fdump-rtl-combine
3702 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3704 @item -dC
3705 @itemx -fdump-rtl-ce1
3706 @itemx -fdump-rtl-ce2
3707 @opindex dC
3708 @opindex fdump-rtl-ce1
3709 @opindex fdump-rtl-ce2
3710 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3711 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3712 and @option{-fdump-rtl-ce2} enable dumping after the second if
3713 conversion, to the file @file{@var{file}.18.ce2}.
3715 @item -dd
3716 @itemx -fdump-rtl-btl
3717 @itemx -fdump-rtl-dbr
3718 @opindex dd
3719 @opindex fdump-rtl-btl
3720 @opindex fdump-rtl-dbr
3721 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3722 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3723 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3724 scheduling, to @file{@var{file}.36.dbr}.
3726 @item -dD
3727 @opindex dD
3728 Dump all macro definitions, at the end of preprocessing, in addition to
3729 normal output.
3731 @item -dE
3732 @itemx -fdump-rtl-ce3
3733 @opindex dE
3734 @opindex fdump-rtl-ce3
3735 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3737 @item -df
3738 @itemx -fdump-rtl-cfg
3739 @itemx -fdump-rtl-life
3740 @opindex df
3741 @opindex fdump-rtl-cfg
3742 @opindex fdump-rtl-life
3743 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3744 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3745 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3746 to @file{@var{file}.16.life}.
3748 @item -dg
3749 @itemx -fdump-rtl-greg
3750 @opindex dg
3751 @opindex fdump-rtl-greg
3752 Dump after global register allocation, to @file{@var{file}.23.greg}.
3754 @item -dG
3755 @itemx -fdump-rtl-gcse
3756 @itemx -fdump-rtl-bypass
3757 @opindex dG
3758 @opindex fdump-rtl-gcse
3759 @opindex fdump-rtl-bypass
3760 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3761 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3762 enable dumping after jump bypassing and control flow optimizations, to
3763 @file{@var{file}.07.bypass}.
3765 @item -dh
3766 @itemx -fdump-rtl-eh
3767 @opindex dh
3768 @opindex fdump-rtl-eh
3769 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3771 @item -di
3772 @itemx -fdump-rtl-sibling
3773 @opindex di
3774 @opindex fdump-rtl-sibling
3775 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3777 @item -dj
3778 @itemx -fdump-rtl-jump
3779 @opindex dj
3780 @opindex fdump-rtl-jump
3781 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3783 @item -dk
3784 @itemx -fdump-rtl-stack
3785 @opindex dk
3786 @opindex fdump-rtl-stack
3787 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3789 @item -dl
3790 @itemx -fdump-rtl-lreg
3791 @opindex dl
3792 @opindex fdump-rtl-lreg
3793 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3795 @item -dL
3796 @itemx -fdump-rtl-loop
3797 @itemx -fdump-rtl-loop2
3798 @opindex dL
3799 @opindex fdump-rtl-loop
3800 @opindex fdump-rtl-loop2
3801 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3802 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3803 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3804 @file{@var{file}.13.loop2}.
3806 @item -dm
3807 @itemx -fdump-rtl-sms
3808 @opindex dm
3809 @opindex fdump-rtl-sms
3810 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3812 @item -dM
3813 @itemx -fdump-rtl-mach
3814 @opindex dM
3815 @opindex fdump-rtl-mach
3816 Dump after performing the machine dependent reorganization pass, to
3817 @file{@var{file}.35.mach}.
3819 @item -dn
3820 @itemx -fdump-rtl-rnreg
3821 @opindex dn
3822 @opindex fdump-rtl-rnreg
3823 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3825 @item -dN
3826 @itemx -fdump-rtl-regmove
3827 @opindex dN
3828 @opindex fdump-rtl-regmove
3829 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3831 @item -do
3832 @itemx -fdump-rtl-postreload
3833 @opindex do
3834 @opindex fdump-rtl-postreload
3835 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3837 @item -dr
3838 @itemx -fdump-rtl-expand
3839 @opindex dr
3840 @opindex fdump-rtl-expand
3841 Dump after RTL generation, to @file{@var{file}.00.expand}.
3843 @item -dR
3844 @itemx -fdump-rtl-sched2
3845 @opindex dR
3846 @opindex fdump-rtl-sched2
3847 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3849 @item -ds
3850 @itemx -fdump-rtl-cse
3851 @opindex ds
3852 @opindex fdump-rtl-cse
3853 Dump after CSE (including the jump optimization that sometimes follows
3854 CSE), to @file{@var{file}.04.cse}.
3856 @item -dS
3857 @itemx -fdump-rtl-sched
3858 @opindex dS
3859 @opindex fdump-rtl-sched
3860 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3862 @item -dt
3863 @itemx -fdump-rtl-cse2
3864 @opindex dt
3865 @opindex fdump-rtl-cse2
3866 Dump after the second CSE pass (including the jump optimization that
3867 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3869 @item -dT
3870 @itemx -fdump-rtl-tracer
3871 @opindex dT
3872 @opindex fdump-rtl-tracer
3873 Dump after running tracer, to @file{@var{file}.12.tracer}.
3875 @item -dV
3876 @itemx -fdump-rtl-vpt
3877 @itemx -fdump-rtl-vartrack
3878 @opindex dV
3879 @opindex fdump-rtl-vpt
3880 @opindex fdump-rtl-vartrack
3881 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3882 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3883 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3884 to @file{@var{file}.34.vartrack}.
3886 @item -dw
3887 @itemx -fdump-rtl-flow2
3888 @opindex dw
3889 @opindex fdump-rtl-flow2
3890 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3892 @item -dz
3893 @itemx -fdump-rtl-peephole2
3894 @opindex dz
3895 @opindex fdump-rtl-peephole2
3896 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3898 @item -dZ
3899 @itemx -fdump-rtl-web
3900 @opindex dZ
3901 @opindex fdump-rtl-web
3902 Dump after live range splitting, to @file{@var{file}.14.web}.
3904 @item -da
3905 @itemx -fdump-rtl-all
3906 @opindex da
3907 @opindex fdump-rtl-all
3908 Produce all the dumps listed above.
3910 @item -dH
3911 @opindex dH
3912 Produce a core dump whenever an error occurs.
3914 @item -dm
3915 @opindex dm
3916 Print statistics on memory usage, at the end of the run, to
3917 standard error.
3919 @item -dp
3920 @opindex dp
3921 Annotate the assembler output with a comment indicating which
3922 pattern and alternative was used.  The length of each instruction is
3923 also printed.
3925 @item -dP
3926 @opindex dP
3927 Dump the RTL in the assembler output as a comment before each instruction.
3928 Also turns on @option{-dp} annotation.
3930 @item -dv
3931 @opindex dv
3932 For each of the other indicated dump files (either with @option{-d} or
3933 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3934 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3936 @item -dx
3937 @opindex dx
3938 Just generate RTL for a function instead of compiling it.  Usually used
3939 with @samp{r} (@option{-fdump-rtl-expand}).
3941 @item -dy
3942 @opindex dy
3943 Dump debugging information during parsing, to standard error.
3944 @end table
3946 @item -fdump-unnumbered
3947 @opindex fdump-unnumbered
3948 When doing debugging dumps (see @option{-d} option above), suppress instruction
3949 numbers and line number note output.  This makes it more feasible to
3950 use diff on debugging dumps for compiler invocations with different
3951 options, in particular with and without @option{-g}.
3953 @item -fdump-translation-unit @r{(C++ only)}
3954 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3955 @opindex fdump-translation-unit
3956 Dump a representation of the tree structure for the entire translation
3957 unit to a file.  The file name is made by appending @file{.tu} to the
3958 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3959 controls the details of the dump as described for the
3960 @option{-fdump-tree} options.
3962 @item -fdump-class-hierarchy @r{(C++ only)}
3963 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3964 @opindex fdump-class-hierarchy
3965 Dump a representation of each class's hierarchy and virtual function
3966 table layout to a file.  The file name is made by appending @file{.class}
3967 to the source file name.  If the @samp{-@var{options}} form is used,
3968 @var{options} controls the details of the dump as described for the
3969 @option{-fdump-tree} options.
3971 @item -fdump-ipa-@var{switch}
3972 @opindex fdump-ipa
3973 Control the dumping at various stages of inter-procedural analysis
3974 language tree to a file.  The file name is generated by appending a switch
3975 specific suffix to the source file name.  The following dumps are possible:
3977 @table @samp
3978 @item all
3979 Enables all inter-procedural analysis dumps; currently the only produced
3980 dump is the @samp{cgraph} dump.
3982 @item cgraph
3983 Dumps information about call-graph optimization, unused function removal,
3984 and inlining decisions.
3985 @end table
3987 @item -fdump-tree-@var{switch}
3988 @itemx -fdump-tree-@var{switch}-@var{options}
3989 @opindex fdump-tree
3990 Control the dumping at various stages of processing the intermediate
3991 language tree to a file.  The file name is generated by appending a switch
3992 specific suffix to the source file name.  If the @samp{-@var{options}}
3993 form is used, @var{options} is a list of @samp{-} separated options that
3994 control the details of the dump.  Not all options are applicable to all
3995 dumps, those which are not meaningful will be ignored.  The following
3996 options are available
3998 @table @samp
3999 @item address
4000 Print the address of each node.  Usually this is not meaningful as it
4001 changes according to the environment and source file.  Its primary use
4002 is for tying up a dump file with a debug environment.
4003 @item slim
4004 Inhibit dumping of members of a scope or body of a function merely
4005 because that scope has been reached.  Only dump such items when they
4006 are directly reachable by some other path.  When dumping pretty-printed
4007 trees, this option inhibits dumping the bodies of control structures.
4008 @item raw
4009 Print a raw representation of the tree.  By default, trees are
4010 pretty-printed into a C-like representation.
4011 @item details
4012 Enable more detailed dumps (not honored by every dump option).
4013 @item stats
4014 Enable dumping various statistics about the pass (not honored by every dump
4015 option).
4016 @item blocks
4017 Enable showing basic block boundaries (disabled in raw dumps).
4018 @item vops
4019 Enable showing virtual operands for every statement.
4020 @item lineno
4021 Enable showing line numbers for statements.
4022 @item uid
4023 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4024 @item all
4025 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4026 @end table
4028 The following tree dumps are possible:
4029 @table @samp
4031 @item original
4032 Dump before any tree based optimization, to @file{@var{file}.original}.
4034 @item optimized
4035 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4037 @item inlined
4038 Dump after function inlining, to @file{@var{file}.inlined}.
4040 @item gimple
4041 @opindex fdump-tree-gimple
4042 Dump each function before and after the gimplification pass to a file.  The
4043 file name is made by appending @file{.gimple} to the source file name.
4045 @item cfg
4046 @opindex fdump-tree-cfg
4047 Dump the control flow graph of each function to a file.  The file name is
4048 made by appending @file{.cfg} to the source file name.
4050 @item vcg
4051 @opindex fdump-tree-vcg
4052 Dump the control flow graph of each function to a file in VCG format.  The
4053 file name is made by appending @file{.vcg} to the source file name.  Note
4054 that if the file contains more than one function, the generated file cannot
4055 be used directly by VCG@.  You will need to cut and paste each function's
4056 graph into its own separate file first.
4058 @item ch
4059 @opindex fdump-tree-ch
4060 Dump each function after copying loop headers.  The file name is made by
4061 appending @file{.ch} to the source file name.
4063 @item ssa
4064 @opindex fdump-tree-ssa
4065 Dump SSA related information to a file.  The file name is made by appending
4066 @file{.ssa} to the source file name.
4068 @item salias
4069 @opindex fdump-tree-salias
4070 Dump structure aliasing variable information to a file.  This file name
4071 is made by appending @file{.salias} to the source file name.
4073 @item alias
4074 @opindex fdump-tree-alias
4075 Dump aliasing information for each function.  The file name is made by
4076 appending @file{.alias} to the source file name.
4078 @item ccp
4079 @opindex fdump-tree-ccp
4080 Dump each function after CCP@.  The file name is made by appending
4081 @file{.ccp} to the source file name.
4083 @item storeccp
4084 @opindex fdump-tree-storeccp
4085 Dump each function after STORE-CCP.  The file name is made by appending
4086 @file{.storeccp} to the source file name.
4088 @item pre
4089 @opindex fdump-tree-pre
4090 Dump trees after partial redundancy elimination.  The file name is made
4091 by appending @file{.pre} to the source file name.
4093 @item fre
4094 @opindex fdump-tree-fre
4095 Dump trees after full redundancy elimination.  The file name is made
4096 by appending @file{.fre} to the source file name.
4098 @item copyprop
4099 @opindex fdump-tree-copyprop
4100 Dump trees after copy propagation.  The file name is made
4101 by appending @file{.copyprop} to the source file name.
4103 @item store_copyprop
4104 @opindex fdump-tree-store_copyprop
4105 Dump trees after store copy-propagation.  The file name is made
4106 by appending @file{.store_copyprop} to the source file name.
4108 @item dce
4109 @opindex fdump-tree-dce
4110 Dump each function after dead code elimination.  The file name is made by
4111 appending @file{.dce} to the source file name.
4113 @item mudflap
4114 @opindex fdump-tree-mudflap
4115 Dump each function after adding mudflap instrumentation.  The file name is
4116 made by appending @file{.mudflap} to the source file name.
4118 @item sra
4119 @opindex fdump-tree-sra
4120 Dump each function after performing scalar replacement of aggregates.  The
4121 file name is made by appending @file{.sra} to the source file name.
4123 @item sink
4124 @opindex fdump-tree-sink
4125 Dump each function after performing code sinking.  The file name is made
4126 by appending @file{.sink} to the source file name. 
4128 @item dom
4129 @opindex fdump-tree-dom
4130 Dump each function after applying dominator tree optimizations.  The file
4131 name is made by appending @file{.dom} to the source file name.
4133 @item dse
4134 @opindex fdump-tree-dse
4135 Dump each function after applying dead store elimination.  The file
4136 name is made by appending @file{.dse} to the source file name.
4138 @item phiopt
4139 @opindex fdump-tree-phiopt
4140 Dump each function after optimizing PHI nodes into straightline code.  The file
4141 name is made by appending @file{.phiopt} to the source file name.
4143 @item forwprop
4144 @opindex fdump-tree-forwprop
4145 Dump each function after forward propagating single use variables.  The file
4146 name is made by appending @file{.forwprop} to the source file name.
4148 @item copyrename
4149 @opindex fdump-tree-copyrename
4150 Dump each function after applying the copy rename optimization.  The file
4151 name is made by appending @file{.copyrename} to the source file name.
4153 @item nrv
4154 @opindex fdump-tree-nrv
4155 Dump each function after applying the named return value optimization on
4156 generic trees.  The file name is made by appending @file{.nrv} to the source
4157 file name.
4159 @item vect
4160 @opindex fdump-tree-vect
4161 Dump each function after applying vectorization of loops.  The file name is
4162 made by appending @file{.vect} to the source file name.
4164 @item vrp
4165 @opindex fdump-tree-vrp
4166 Dump each function after Value Range Propagation (VRP).  The file name
4167 is made by appending @file{.vrp} to the source file name.
4169 @item all
4170 @opindex fdump-tree-all
4171 Enable all the available tree dumps with the flags provided in this option.
4172 @end table
4174 @item -ftree-vectorizer-verbose=@var{n}
4175 @opindex ftree-vectorizer-verbose
4176 This option controls the amount of debugging output the vectorizer prints.
4177 This information is written to standard error, unless @option{-fdump-tree-all}
4178 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4179 usual dump listing file, @file{.vect}.
4181 @item -frandom-seed=@var{string}
4182 @opindex frandom-string
4183 This option provides a seed that GCC uses when it would otherwise use
4184 random numbers.  It is used to generate certain symbol names
4185 that have to be different in every compiled file.  It is also used to
4186 place unique stamps in coverage data files and the object files that
4187 produce them.  You can use the @option{-frandom-seed} option to produce
4188 reproducibly identical object files.
4190 The @var{string} should be different for every file you compile.
4192 @item -fsched-verbose=@var{n}
4193 @opindex fsched-verbose
4194 On targets that use instruction scheduling, this option controls the
4195 amount of debugging output the scheduler prints.  This information is
4196 written to standard error, unless @option{-dS} or @option{-dR} is
4197 specified, in which case it is output to the usual dump
4198 listing file, @file{.sched} or @file{.sched2} respectively.  However
4199 for @var{n} greater than nine, the output is always printed to standard
4200 error.
4202 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4203 same information as @option{-dRS}.  For @var{n} greater than one, it
4204 also output basic block probabilities, detailed ready list information
4205 and unit/insn info.  For @var{n} greater than two, it includes RTL
4206 at abort point, control-flow and regions info.  And for @var{n} over
4207 four, @option{-fsched-verbose} also includes dependence info.
4209 @item -save-temps
4210 @opindex save-temps
4211 Store the usual ``temporary'' intermediate files permanently; place them
4212 in the current directory and name them based on the source file.  Thus,
4213 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4214 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4215 preprocessed @file{foo.i} output file even though the compiler now
4216 normally uses an integrated preprocessor.
4218 When used in combination with the @option{-x} command line option,
4219 @option{-save-temps} is sensible enough to avoid over writing an
4220 input source file with the same extension as an intermediate file.
4221 The corresponding intermediate file may be obtained by renaming the
4222 source file before using @option{-save-temps}.
4224 @item -time
4225 @opindex time
4226 Report the CPU time taken by each subprocess in the compilation
4227 sequence.  For C source files, this is the compiler proper and assembler
4228 (plus the linker if linking is done).  The output looks like this:
4230 @smallexample
4231 # cc1 0.12 0.01
4232 # as 0.00 0.01
4233 @end smallexample
4235 The first number on each line is the ``user time'', that is time spent
4236 executing the program itself.  The second number is ``system time'',
4237 time spent executing operating system routines on behalf of the program.
4238 Both numbers are in seconds.
4240 @item -fvar-tracking
4241 @opindex fvar-tracking
4242 Run variable tracking pass.  It computes where variables are stored at each
4243 position in code.  Better debugging information is then generated
4244 (if the debugging information format supports this information).
4246 It is enabled by default when compiling with optimization (@option{-Os},
4247 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4248 the debug info format supports it.
4250 @item -print-file-name=@var{library}
4251 @opindex print-file-name
4252 Print the full absolute name of the library file @var{library} that
4253 would be used when linking---and don't do anything else.  With this
4254 option, GCC does not compile or link anything; it just prints the
4255 file name.
4257 @item -print-multi-directory
4258 @opindex print-multi-directory
4259 Print the directory name corresponding to the multilib selected by any
4260 other switches present in the command line.  This directory is supposed
4261 to exist in @env{GCC_EXEC_PREFIX}.
4263 @item -print-multi-lib
4264 @opindex print-multi-lib
4265 Print the mapping from multilib directory names to compiler switches
4266 that enable them.  The directory name is separated from the switches by
4267 @samp{;}, and each switch starts with an @samp{@@} instead of the
4268 @samp{-}, without spaces between multiple switches.  This is supposed to
4269 ease shell-processing.
4271 @item -print-prog-name=@var{program}
4272 @opindex print-prog-name
4273 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4275 @item -print-libgcc-file-name
4276 @opindex print-libgcc-file-name
4277 Same as @option{-print-file-name=libgcc.a}.
4279 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4280 but you do want to link with @file{libgcc.a}.  You can do
4282 @smallexample
4283 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4284 @end smallexample
4286 @item -print-search-dirs
4287 @opindex print-search-dirs
4288 Print the name of the configured installation directory and a list of
4289 program and library directories @command{gcc} will search---and don't do anything else.
4291 This is useful when @command{gcc} prints the error message
4292 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4293 To resolve this you either need to put @file{cpp0} and the other compiler
4294 components where @command{gcc} expects to find them, or you can set the environment
4295 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4296 Don't forget the trailing @samp{/}.
4297 @xref{Environment Variables}.
4299 @item -dumpmachine
4300 @opindex dumpmachine
4301 Print the compiler's target machine (for example,
4302 @samp{i686-pc-linux-gnu})---and don't do anything else.
4304 @item -dumpversion
4305 @opindex dumpversion
4306 Print the compiler version (for example, @samp{3.0})---and don't do
4307 anything else.
4309 @item -dumpspecs
4310 @opindex dumpspecs
4311 Print the compiler's built-in specs---and don't do anything else.  (This
4312 is used when GCC itself is being built.)  @xref{Spec Files}.
4314 @item -feliminate-unused-debug-types
4315 @opindex feliminate-unused-debug-types
4316 Normally, when producing DWARF2 output, GCC will emit debugging
4317 information for all types declared in a compilation
4318 unit, regardless of whether or not they are actually used
4319 in that compilation unit.  Sometimes this is useful, such as
4320 if, in the debugger, you want to cast a value to a type that is
4321 not actually used in your program (but is declared).  More often,
4322 however, this results in a significant amount of wasted space.
4323 With this option, GCC will avoid producing debug symbol output
4324 for types that are nowhere used in the source file being compiled.
4325 @end table
4327 @node Optimize Options
4328 @section Options That Control Optimization
4329 @cindex optimize options
4330 @cindex options, optimization
4332 These options control various sorts of optimizations.
4334 Without any optimization option, the compiler's goal is to reduce the
4335 cost of compilation and to make debugging produce the expected
4336 results.  Statements are independent: if you stop the program with a
4337 breakpoint between statements, you can then assign a new value to any
4338 variable or change the program counter to any other statement in the
4339 function and get exactly the results you would expect from the source
4340 code.
4342 Turning on optimization flags makes the compiler attempt to improve
4343 the performance and/or code size at the expense of compilation time
4344 and possibly the ability to debug the program.
4346 The compiler performs optimization based on the knowledge it has of
4347 the program.  Optimization levels @option{-O} and above, in
4348 particular, enable @emph{unit-at-a-time} mode, which allows the
4349 compiler to consider information gained from later functions in
4350 the file when compiling a function.  Compiling multiple files at
4351 once to a single output file in @emph{unit-at-a-time} mode allows
4352 the compiler to use information gained from all of the files when
4353 compiling each of them.
4355 Not all optimizations are controlled directly by a flag.  Only
4356 optimizations that have a flag are listed.
4358 @table @gcctabopt
4359 @item -O
4360 @itemx -O1
4361 @opindex O
4362 @opindex O1
4363 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4364 more memory for a large function.
4366 With @option{-O}, the compiler tries to reduce code size and execution
4367 time, without performing any optimizations that take a great deal of
4368 compilation time.
4370 @option{-O} turns on the following optimization flags:
4371 @gccoptlist{-fdefer-pop @gol
4372 -fdelayed-branch @gol
4373 -fguess-branch-probability @gol
4374 -fcprop-registers @gol
4375 -floop-optimize @gol
4376 -fif-conversion @gol
4377 -fif-conversion2 @gol
4378 -ftree-ccp @gol
4379 -ftree-dce @gol
4380 -ftree-dominator-opts @gol
4381 -ftree-dse @gol
4382 -ftree-ter @gol
4383 -ftree-lrs @gol
4384 -ftree-sra @gol
4385 -ftree-copyrename @gol
4386 -ftree-fre @gol
4387 -ftree-ch @gol
4388 -funit-at-a-time @gol
4389 -fmerge-constants}
4391 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4392 where doing so does not interfere with debugging.
4394 @option{-O} doesn't turn on @option{-ftree-sra} for the Ada compiler.
4395 This option must be explicitly specified on the command line to be
4396 enabled for the Ada compiler.
4398 @item -O2
4399 @opindex O2
4400 Optimize even more.  GCC performs nearly all supported optimizations
4401 that do not involve a space-speed tradeoff.  The compiler does not
4402 perform loop unrolling or function inlining when you specify @option{-O2}.
4403 As compared to @option{-O}, this option increases both compilation time
4404 and the performance of the generated code.
4406 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4407 also turns on the following optimization flags:
4408 @gccoptlist{-fthread-jumps @gol
4409 -fcrossjumping @gol
4410 -foptimize-sibling-calls @gol
4411 -fcse-follow-jumps  -fcse-skip-blocks @gol
4412 -fgcse  -fgcse-lm  @gol
4413 -fexpensive-optimizations @gol
4414 -fstrength-reduce @gol
4415 -frerun-cse-after-loop  -frerun-loop-opt @gol
4416 -fcaller-saves @gol
4417 -fpeephole2 @gol
4418 -fschedule-insns  -fschedule-insns2 @gol
4419 -fsched-interblock  -fsched-spec @gol
4420 -fregmove @gol
4421 -fstrict-aliasing @gol
4422 -fdelete-null-pointer-checks @gol
4423 -freorder-blocks  -freorder-functions @gol
4424 -falign-functions  -falign-jumps @gol
4425 -falign-loops  -falign-labels @gol
4426 -ftree-vrp @gol
4427 -ftree-pre}
4429 Please note the warning under @option{-fgcse} about
4430 invoking @option{-O2} on programs that use computed gotos.
4432 @item -O3
4433 @opindex O3
4434 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4435 @option{-O2} and also turns on the @option{-finline-functions},
4436 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4438 @item -O0
4439 @opindex O0
4440 Do not optimize.  This is the default.
4442 @item -Os
4443 @opindex Os
4444 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4445 do not typically increase code size.  It also performs further
4446 optimizations designed to reduce code size.
4448 @option{-Os} disables the following optimization flags:
4449 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4450 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4451 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4453 If you use multiple @option{-O} options, with or without level numbers,
4454 the last such option is the one that is effective.
4455 @end table
4457 Options of the form @option{-f@var{flag}} specify machine-independent
4458 flags.  Most flags have both positive and negative forms; the negative
4459 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4460 below, only one of the forms is listed---the one you typically will
4461 use.  You can figure out the other form by either removing @samp{no-}
4462 or adding it.
4464 The following options control specific optimizations.  They are either
4465 activated by @option{-O} options or are related to ones that are.  You
4466 can use the following flags in the rare cases when ``fine-tuning'' of
4467 optimizations to be performed is desired.
4469 @table @gcctabopt
4470 @item -fno-default-inline
4471 @opindex fno-default-inline
4472 Do not make member functions inline by default merely because they are
4473 defined inside the class scope (C++ only).  Otherwise, when you specify
4474 @w{@option{-O}}, member functions defined inside class scope are compiled
4475 inline by default; i.e., you don't need to add @samp{inline} in front of
4476 the member function name.
4478 @item -fno-defer-pop
4479 @opindex fno-defer-pop
4480 Always pop the arguments to each function call as soon as that function
4481 returns.  For machines which must pop arguments after a function call,
4482 the compiler normally lets arguments accumulate on the stack for several
4483 function calls and pops them all at once.
4485 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4487 @item -fforce-mem
4488 @opindex fforce-mem
4489 Force memory operands to be copied into registers before doing
4490 arithmetic on them.  This produces better code by making all memory
4491 references potential common subexpressions.  When they are not common
4492 subexpressions, instruction combination should eliminate the separate
4493 register-load.  This option is now a nop and will be removed in 4.2.
4495 @item -fforce-addr
4496 @opindex fforce-addr
4497 Force memory address constants to be copied into registers before
4498 doing arithmetic on them.
4500 @item -fomit-frame-pointer
4501 @opindex fomit-frame-pointer
4502 Don't keep the frame pointer in a register for functions that
4503 don't need one.  This avoids the instructions to save, set up and
4504 restore frame pointers; it also makes an extra register available
4505 in many functions.  @strong{It also makes debugging impossible on
4506 some machines.}
4508 On some machines, such as the VAX, this flag has no effect, because
4509 the standard calling sequence automatically handles the frame pointer
4510 and nothing is saved by pretending it doesn't exist.  The
4511 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4512 whether a target machine supports this flag.  @xref{Registers,,Register
4513 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4515 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4517 @item -foptimize-sibling-calls
4518 @opindex foptimize-sibling-calls
4519 Optimize sibling and tail recursive calls.
4521 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4523 @item -fno-inline
4524 @opindex fno-inline
4525 Don't pay attention to the @code{inline} keyword.  Normally this option
4526 is used to keep the compiler from expanding any functions inline.
4527 Note that if you are not optimizing, no functions can be expanded inline.
4529 @item -finline-functions
4530 @opindex finline-functions
4531 Integrate all simple functions into their callers.  The compiler
4532 heuristically decides which functions are simple enough to be worth
4533 integrating in this way.
4535 If all calls to a given function are integrated, and the function is
4536 declared @code{static}, then the function is normally not output as
4537 assembler code in its own right.
4539 Enabled at level @option{-O3}.
4541 @item -finline-functions-called-once
4542 @opindex finline-functions-called-once
4543 Consider all @code{static} functions called once for inlining into their
4544 caller even if they are not marked @code{inline}.  If a call to a given
4545 function is integrated, then the function is not output as assembler code
4546 in its own right.
4548 Enabled if @option{-funit-at-a-time} is enabled.
4550 @item -fearly-inlining
4551 @opindex fearly-inlining
4552 Inline functions marked by @code{always_inline} and functions whose body seems
4553 smaller than the function call overhead early before doing
4554 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4555 makes profiling significantly cheaper and usually inlining faster on programs
4556 having large chains of nested wrapper functions.
4558 Enabled by default.
4560 @item -finline-limit=@var{n}
4561 @opindex finline-limit
4562 By default, GCC limits the size of functions that can be inlined.  This flag
4563 allows the control of this limit for functions that are explicitly marked as
4564 inline (i.e., marked with the inline keyword or defined within the class
4565 definition in c++).  @var{n} is the size of functions that can be inlined in
4566 number of pseudo instructions (not counting parameter handling).  The default
4567 value of @var{n} is 600.
4568 Increasing this value can result in more inlined code at
4569 the cost of compilation time and memory consumption.  Decreasing usually makes
4570 the compilation faster and less code will be inlined (which presumably
4571 means slower programs).  This option is particularly useful for programs that
4572 use inlining heavily such as those based on recursive templates with C++.
4574 Inlining is actually controlled by a number of parameters, which may be
4575 specified individually by using @option{--param @var{name}=@var{value}}.
4576 The @option{-finline-limit=@var{n}} option sets some of these parameters
4577 as follows:
4579 @table @gcctabopt
4580 @item max-inline-insns-single
4581  is set to @var{n}/2.
4582 @item max-inline-insns-auto
4583  is set to @var{n}/2.
4584 @item min-inline-insns
4585  is set to 130 or @var{n}/4, whichever is smaller.
4586 @item max-inline-insns-rtl
4587  is set to @var{n}.
4588 @end table
4590 See below for a documentation of the individual
4591 parameters controlling inlining.
4593 @emph{Note:} pseudo instruction represents, in this particular context, an
4594 abstract measurement of function's size.  In no way does it represent a count
4595 of assembly instructions and as such its exact meaning might change from one
4596 release to an another.
4598 @item -fkeep-inline-functions
4599 @opindex fkeep-inline-functions
4600 In C, emit @code{static} functions that are declared @code{inline}
4601 into the object file, even if the function has been inlined into all
4602 of its callers.  This switch does not affect functions using the
4603 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4604 inline functions into the object file.
4606 @item -fkeep-static-consts
4607 @opindex fkeep-static-consts
4608 Emit variables declared @code{static const} when optimization isn't turned
4609 on, even if the variables aren't referenced.
4611 GCC enables this option by default.  If you want to force the compiler to
4612 check if the variable was referenced, regardless of whether or not
4613 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4615 @item -fmerge-constants
4616 @opindex fmerge-constants
4617 Attempt to merge identical constants (string constants and floating point
4618 constants) across compilation units.
4620 This option is the default for optimized compilation if the assembler and
4621 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4622 behavior.
4624 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4626 @item -fmerge-all-constants
4627 @opindex fmerge-all-constants
4628 Attempt to merge identical constants and identical variables.
4630 This option implies @option{-fmerge-constants}.  In addition to
4631 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4632 arrays or initialized constant variables with integral or floating point
4633 types.  Languages like C or C++ require each non-automatic variable to
4634 have distinct location, so using this option will result in non-conforming
4635 behavior.
4637 @item -fmodulo-sched
4638 @opindex fmodulo-sched
4639 Perform swing modulo scheduling immediately before the first scheduling
4640 pass.  This pass looks at innermost loops and reorders their
4641 instructions by overlapping different iterations.
4643 @item -fno-branch-count-reg
4644 @opindex fno-branch-count-reg
4645 Do not use ``decrement and branch'' instructions on a count register,
4646 but instead generate a sequence of instructions that decrement a
4647 register, compare it against zero, then branch based upon the result.
4648 This option is only meaningful on architectures that support such
4649 instructions, which include x86, PowerPC, IA-64 and S/390.
4651 The default is @option{-fbranch-count-reg}, enabled when
4652 @option{-fstrength-reduce} is enabled.
4654 @item -fno-function-cse
4655 @opindex fno-function-cse
4656 Do not put function addresses in registers; make each instruction that
4657 calls a constant function contain the function's address explicitly.
4659 This option results in less efficient code, but some strange hacks
4660 that alter the assembler output may be confused by the optimizations
4661 performed when this option is not used.
4663 The default is @option{-ffunction-cse}
4665 @item -fno-zero-initialized-in-bss
4666 @opindex fno-zero-initialized-in-bss
4667 If the target supports a BSS section, GCC by default puts variables that
4668 are initialized to zero into BSS@.  This can save space in the resulting
4669 code.
4671 This option turns off this behavior because some programs explicitly
4672 rely on variables going to the data section.  E.g., so that the
4673 resulting executable can find the beginning of that section and/or make
4674 assumptions based on that.
4676 The default is @option{-fzero-initialized-in-bss}.
4678 @item -fmudflap -fmudflapth -fmudflapir
4679 @opindex fmudflap
4680 @opindex fmudflapth
4681 @opindex fmudflapir
4682 @cindex bounds checking
4683 @cindex mudflap
4684 For front-ends that support it (C and C++), instrument all risky
4685 pointer/array dereferencing operations, some standard library
4686 string/heap functions, and some other associated constructs with
4687 range/validity tests.  Modules so instrumented should be immune to
4688 buffer overflows, invalid heap use, and some other classes of C/C++
4689 programming errors.  The instrumentation relies on a separate runtime
4690 library (@file{libmudflap}), which will be linked into a program if
4691 @option{-fmudflap} is given at link time.  Run-time behavior of the
4692 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4693 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4694 for its options.
4696 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4697 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4698 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4699 instrumentation should ignore pointer reads.  This produces less
4700 instrumentation (and therefore faster execution) and still provides
4701 some protection against outright memory corrupting writes, but allows
4702 erroneously read data to propagate within a program.
4704 @item -fstrength-reduce
4705 @opindex fstrength-reduce
4706 Perform the optimizations of loop strength reduction and
4707 elimination of iteration variables.
4709 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4711 @item -fthread-jumps
4712 @opindex fthread-jumps
4713 Perform optimizations where we check to see if a jump branches to a
4714 location where another comparison subsumed by the first is found.  If
4715 so, the first branch is redirected to either the destination of the
4716 second branch or a point immediately following it, depending on whether
4717 the condition is known to be true or false.
4719 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4721 @item -fcse-follow-jumps
4722 @opindex fcse-follow-jumps
4723 In common subexpression elimination, scan through jump instructions
4724 when the target of the jump is not reached by any other path.  For
4725 example, when CSE encounters an @code{if} statement with an
4726 @code{else} clause, CSE will follow the jump when the condition
4727 tested is false.
4729 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4731 @item -fcse-skip-blocks
4732 @opindex fcse-skip-blocks
4733 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4734 follow jumps which conditionally skip over blocks.  When CSE
4735 encounters a simple @code{if} statement with no else clause,
4736 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4737 body of the @code{if}.
4739 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4741 @item -frerun-cse-after-loop
4742 @opindex frerun-cse-after-loop
4743 Re-run common subexpression elimination after loop optimizations has been
4744 performed.
4746 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4748 @item -frerun-loop-opt
4749 @opindex frerun-loop-opt
4750 Run the loop optimizer twice.
4752 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4754 @item -fgcse
4755 @opindex fgcse
4756 Perform a global common subexpression elimination pass.
4757 This pass also performs global constant and copy propagation.
4759 @emph{Note:} When compiling a program using computed gotos, a GCC
4760 extension, you may get better runtime performance if you disable
4761 the global common subexpression elimination pass by adding
4762 @option{-fno-gcse} to the command line.
4764 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4766 @item -fgcse-lm
4767 @opindex fgcse-lm
4768 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4769 attempt to move loads which are only killed by stores into themselves.  This
4770 allows a loop containing a load/store sequence to be changed to a load outside
4771 the loop, and a copy/store within the loop.
4773 Enabled by default when gcse is enabled.
4775 @item -fgcse-sm
4776 @opindex fgcse-sm
4777 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4778 global common subexpression elimination.  This pass will attempt to move
4779 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4780 loops containing a load/store sequence can be changed to a load before
4781 the loop and a store after the loop.
4783 Not enabled at any optimization level.
4785 @item -fgcse-las
4786 @opindex fgcse-las
4787 When @option{-fgcse-las} is enabled, the global common subexpression
4788 elimination pass eliminates redundant loads that come after stores to the
4789 same memory location (both partial and full redundancies).
4791 Not enabled at any optimization level.
4793 @item -fgcse-after-reload
4794 @opindex fgcse-after-reload
4795 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4796 pass is performed after reload.  The purpose of this pass is to cleanup
4797 redundant spilling.
4799 @item -floop-optimize
4800 @opindex floop-optimize
4801 Perform loop optimizations: move constant expressions out of loops, simplify
4802 exit test conditions and optionally do strength-reduction as well.
4804 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4806 @item -floop-optimize2
4807 @opindex floop-optimize2
4808 Perform loop optimizations using the new loop optimizer.  The optimizations
4809 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4810 by separate flags.
4812 @item -funsafe-loop-optimizations
4813 @opindex funsafe-loop-optimizations
4814 If given, the loop optimizer will assume that loop indices do not
4815 overflow, and that the loops with nontrivial exit condition are not
4816 infinite.  This enables a wider range of loop optimizations even if
4817 the loop optimizer itself cannot prove that these assumptions are valid.
4818 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4819 if it finds this kind of loop.
4821 @item -fcrossjumping
4822 @opindex fcrossjumping
4823 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4824 resulting code may or may not perform better than without cross-jumping.
4826 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4828 @item -fif-conversion
4829 @opindex fif-conversion
4830 Attempt to transform conditional jumps into branch-less equivalents.  This
4831 include use of conditional moves, min, max, set flags and abs instructions, and
4832 some tricks doable by standard arithmetics.  The use of conditional execution
4833 on chips where it is available is controlled by @code{if-conversion2}.
4835 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4837 @item -fif-conversion2
4838 @opindex fif-conversion2
4839 Use conditional execution (where available) to transform conditional jumps into
4840 branch-less equivalents.
4842 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4844 @item -fdelete-null-pointer-checks
4845 @opindex fdelete-null-pointer-checks
4846 Use global dataflow analysis to identify and eliminate useless checks
4847 for null pointers.  The compiler assumes that dereferencing a null
4848 pointer would have halted the program.  If a pointer is checked after
4849 it has already been dereferenced, it cannot be null.
4851 In some environments, this assumption is not true, and programs can
4852 safely dereference null pointers.  Use
4853 @option{-fno-delete-null-pointer-checks} to disable this optimization
4854 for programs which depend on that behavior.
4856 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4858 @item -fexpensive-optimizations
4859 @opindex fexpensive-optimizations
4860 Perform a number of minor optimizations that are relatively expensive.
4862 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4864 @item -foptimize-register-move
4865 @itemx -fregmove
4866 @opindex foptimize-register-move
4867 @opindex fregmove
4868 Attempt to reassign register numbers in move instructions and as
4869 operands of other simple instructions in order to maximize the amount of
4870 register tying.  This is especially helpful on machines with two-operand
4871 instructions.
4873 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4874 optimization.
4876 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4878 @item -fdelayed-branch
4879 @opindex fdelayed-branch
4880 If supported for the target machine, attempt to reorder instructions
4881 to exploit instruction slots available after delayed branch
4882 instructions.
4884 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4886 @item -fschedule-insns
4887 @opindex fschedule-insns
4888 If supported for the target machine, attempt to reorder instructions to
4889 eliminate execution stalls due to required data being unavailable.  This
4890 helps machines that have slow floating point or memory load instructions
4891 by allowing other instructions to be issued until the result of the load
4892 or floating point instruction is required.
4894 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4896 @item -fschedule-insns2
4897 @opindex fschedule-insns2
4898 Similar to @option{-fschedule-insns}, but requests an additional pass of
4899 instruction scheduling after register allocation has been done.  This is
4900 especially useful on machines with a relatively small number of
4901 registers and where memory load instructions take more than one cycle.
4903 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4905 @item -fno-sched-interblock
4906 @opindex fno-sched-interblock
4907 Don't schedule instructions across basic blocks.  This is normally
4908 enabled by default when scheduling before register allocation, i.e.@:
4909 with @option{-fschedule-insns} or at @option{-O2} or higher.
4911 @item -fno-sched-spec
4912 @opindex fno-sched-spec
4913 Don't allow speculative motion of non-load instructions.  This is normally
4914 enabled by default when scheduling before register allocation, i.e.@:
4915 with @option{-fschedule-insns} or at @option{-O2} or higher.
4917 @item -fsched-spec-load
4918 @opindex fsched-spec-load
4919 Allow speculative motion of some load instructions.  This only makes
4920 sense when scheduling before register allocation, i.e.@: with
4921 @option{-fschedule-insns} or at @option{-O2} or higher.
4923 @item -fsched-spec-load-dangerous
4924 @opindex fsched-spec-load-dangerous
4925 Allow speculative motion of more load instructions.  This only makes
4926 sense when scheduling before register allocation, i.e.@: with
4927 @option{-fschedule-insns} or at @option{-O2} or higher.
4929 @item -fsched-stalled-insns
4930 @itemx -fsched-stalled-insns=@var{n}
4931 @opindex fsched-stalled-insns
4932 Define how many insns (if any) can be moved prematurely from the queue
4933 of stalled insns into the ready list, during the second scheduling pass.
4934 @option{-fno-fsched-stalled-insns} and @option{-fsched-stalled-insns=0}
4935 are equivalent and mean that no insns will be moved prematurely.
4936 If @var{n} is unspecified then there is no limit on how many queued
4937 insns can be moved prematurely.
4939 @item -fsched-stalled-insns-dep
4940 @itemx -fsched-stalled-insns-dep=@var{n}
4941 @opindex fsched-stalled-insns-dep
4942 Define how many insn groups (cycles) will be examined for a dependency
4943 on a stalled insn that is candidate for premature removal from the queue
4944 of stalled insns.  This has an effect only during the second scheduling pass,
4945 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4946 +@option{-fno-sched-stalled-insns-dep} is equivalent to
4947 +@option{-fsched-stalled-insns-dep=0}.
4948 +@option{-fsched-stalled-insns-dep} without a value is equivalent to
4949 +@option{-fsched-stalled-insns-dep=1}.
4951 @item -fsched2-use-superblocks
4952 @opindex fsched2-use-superblocks
4953 When scheduling after register allocation, do use superblock scheduling
4954 algorithm.  Superblock scheduling allows motion across basic block boundaries
4955 resulting on faster schedules.  This option is experimental, as not all machine
4956 descriptions used by GCC model the CPU closely enough to avoid unreliable
4957 results from the algorithm.
4959 This only makes sense when scheduling after register allocation, i.e.@: with
4960 @option{-fschedule-insns2} or at @option{-O2} or higher.
4962 @item -fsched2-use-traces
4963 @opindex fsched2-use-traces
4964 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4965 allocation and additionally perform code duplication in order to increase the
4966 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4967 trace formation.
4969 This mode should produce faster but significantly longer programs.  Also
4970 without @option{-fbranch-probabilities} the traces constructed may not
4971 match the reality and hurt the performance.  This only makes
4972 sense when scheduling after register allocation, i.e.@: with
4973 @option{-fschedule-insns2} or at @option{-O2} or higher.
4975 @item -freschedule-modulo-scheduled-loops
4976 @opindex freschedule-modulo-scheduled-loops
4977 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4978 we may want to prevent the later scheduling passes from changing its schedule, we use this
4979 option to control that.
4981 @item -fcaller-saves
4982 @opindex fcaller-saves
4983 Enable values to be allocated in registers that will be clobbered by
4984 function calls, by emitting extra instructions to save and restore the
4985 registers around such calls.  Such allocation is done only when it
4986 seems to result in better code than would otherwise be produced.
4988 This option is always enabled by default on certain machines, usually
4989 those which have no call-preserved registers to use instead.
4991 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4993 @item -ftree-pre
4994 @opindex ftree-pre
4995 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4996 enabled by default at @option{-O2} and @option{-O3}.
4998 @item -ftree-fre
4999 @opindex ftree-fre
5000 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5001 between FRE and PRE is that FRE only considers expressions
5002 that are computed on all paths leading to the redundant computation.
5003 This analysis faster than PRE, though it exposes fewer redundancies.
5004 This flag is enabled by default at @option{-O} and higher.
5006 @item -ftree-copy-prop
5007 @opindex ftree-copy-prop
5008 Perform copy propagation on trees.  This pass eliminates unnecessary
5009 copy operations.  This flag is enabled by default at @option{-O} and
5010 higher.
5012 @item -ftree-store-copy-prop
5013 @opindex ftree-store-copy-prop
5014 Perform copy propagation of memory loads and stores.  This pass
5015 eliminates unnecessary copy operations in memory references
5016 (structures, global variables, arrays, etc).  This flag is enabled by
5017 default at @option{-O2} and higher.
5019 @item -ftree-salias
5020 @opindex ftree-salias
5021 Perform structural alias analysis on trees.  This flag
5022 is enabled by default at @option{-O} and higher.
5024 @item -ftree-sink
5025 @opindex ftree-sink
5026 Perform forward store motion  on trees.  This flag is
5027 enabled by default at @option{-O} and higher.
5029 @item -ftree-ccp
5030 @opindex ftree-ccp
5031 Perform sparse conditional constant propagation (CCP) on trees.  This
5032 pass only operates on local scalar variables and is enabled by default
5033 at @option{-O} and higher.
5035 @item -ftree-store-ccp
5036 @opindex ftree-store-ccp
5037 Perform sparse conditional constant propagation (CCP) on trees.  This
5038 pass operates on both local scalar variables and memory stores and
5039 loads (global variables, structures, arrays, etc).  This flag is
5040 enabled by default at @option{-O2} and higher.
5042 @item -ftree-dce
5043 @opindex ftree-dce
5044 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5045 default at @option{-O} and higher.
5047 @item -ftree-dominator-opts
5048 @opindex ftree-dominator-opts
5049 Perform a variety of simple scalar cleanups (constant/copy
5050 propagation, redundancy elimination, range propagation and expression
5051 simplification) based on a dominator tree traversal.  This also
5052 performs jump threading (to reduce jumps to jumps).  This flag is
5053 enabled by default at @option{-O} and higher.
5055 @item -ftree-ch
5056 @opindex ftree-ch
5057 Perform loop header copying on trees.  This is beneficial since it increases
5058 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5059 is enabled by default at @option{-O} and higher.  It is not enabled
5060 for @option{-Os}, since it usually increases code size.
5062 @item -ftree-loop-optimize
5063 @opindex ftree-loop-optimize
5064 Perform loop optimizations on trees.  This flag is enabled by default
5065 at @option{-O} and higher.
5067 @item -ftree-loop-linear
5068 @opindex ftree-loop-linear
5069 Perform linear loop transformations on tree.  This flag can improve cache
5070 performance and allow further loop optimizations to take place.
5072 @item -ftree-loop-im
5073 @opindex ftree-loop-im
5074 Perform loop invariant motion on trees.  This pass moves only invariants that
5075 would be hard to handle at RTL level (function calls, operations that expand to
5076 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5077 operands of conditions that are invariant out of the loop, so that we can use
5078 just trivial invariantness analysis in loop unswitching.  The pass also includes
5079 store motion.
5081 @item -ftree-loop-ivcanon
5082 @opindex ftree-loop-ivcanon
5083 Create a canonical counter for number of iterations in the loop for that
5084 determining number of iterations requires complicated analysis.  Later
5085 optimizations then may determine the number easily.  Useful especially
5086 in connection with unrolling.
5088 @item -fivopts
5089 @opindex fivopts
5090 Perform induction variable optimizations (strength reduction, induction
5091 variable merging and induction variable elimination) on trees.
5093 @item -ftree-sra
5094 @opindex ftree-sra
5095 Perform scalar replacement of aggregates.  This pass replaces structure
5096 references with scalars to prevent committing structures to memory too
5097 early.  This flag is enabled by default at @option{-O} and higher.
5099 @item -ftree-copyrename
5100 @opindex ftree-copyrename
5101 Perform copy renaming on trees.  This pass attempts to rename compiler
5102 temporaries to other variables at copy locations, usually resulting in
5103 variable names which more closely resemble the original variables.  This flag
5104 is enabled by default at @option{-O} and higher.
5106 @item -ftree-ter
5107 @opindex ftree-ter
5108 Perform temporary expression replacement during the SSA->normal phase.  Single
5109 use/single def temporaries are replaced at their use location with their
5110 defining expression.  This results in non-GIMPLE code, but gives the expanders
5111 much more complex trees to work on resulting in better RTL generation.  This is
5112 enabled by default at @option{-O} and higher.
5114 @item -ftree-lrs
5115 @opindex ftree-lrs
5116 Perform live range splitting during the SSA->normal phase.  Distinct live
5117 ranges of a variable are split into unique variables, allowing for better
5118 optimization later.  This is enabled by default at @option{-O} and higher.
5120 @item -ftree-vectorize
5121 @opindex ftree-vectorize
5122 Perform loop vectorization on trees.
5124 @item -ftree-vect-loop-version
5125 @opindex ftree-vect-loop-version
5126 Perform loop versioning when doing loop vectorization on trees.  When a loop
5127 appears to be vectorizable except that data alignment or data dependence cannot
5128 be determined at compile time then vectorized and non-vectorized versions of
5129 the loop are generated along with runtime checks for alignment or dependence
5130 to control which version is executed.  This option is enabled by default
5131 except at level @option{-Os} where it is disabled.
5133 @item -ftree-vrp
5134 @opindex ftree-vrp
5135 Perform Value Range Propagation on trees.  This is similar to the
5136 constant propagation pass, but instead of values, ranges of values are
5137 propagated.  This allows the optimizers to remove unnecessary range
5138 checks like array bound checks and null pointer checks.  This is
5139 enabled by default at @option{-O2} and higher.  Null pointer check
5140 elimination is only done if @option{-fdelete-null-pointer-checks} is
5141 enabled.
5143 @item -ftracer
5144 @opindex ftracer
5145 Perform tail duplication to enlarge superblock size.  This transformation
5146 simplifies the control flow of the function allowing other optimizations to do
5147 better job.
5149 @item -funroll-loops
5150 @opindex funroll-loops
5151 Unroll loops whose number of iterations can be determined at compile
5152 time or upon entry to the loop.  @option{-funroll-loops} implies both
5153 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5154 option makes code larger, and may or may not make it run faster.
5156 @item -funroll-all-loops
5157 @opindex funroll-all-loops
5158 Unroll all loops, even if their number of iterations is uncertain when
5159 the loop is entered.  This usually makes programs run more slowly.
5160 @option{-funroll-all-loops} implies the same options as
5161 @option{-funroll-loops},
5163 @item -fsplit-ivs-in-unroller
5164 @opindex fsplit-ivs-in-unroller
5165 Enables expressing of values of induction variables in later iterations
5166 of the unrolled loop using the value in the first iteration.  This breaks
5167 long dependency chains, thus improving efficiency of the scheduling passes.
5169 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5170 same effect.  However in cases the loop body is more complicated than
5171 a single basic block, this is not reliable.  It also does not work at all
5172 on some of the architectures due to restrictions in the CSE pass.
5174 This optimization is enabled by default.
5176 @item -fvariable-expansion-in-unroller
5177 @opindex fvariable-expansion-in-unroller
5178 With this option, the compiler will create multiple copies of some
5179 local variables when unrolling a loop which can result in superior code.
5181 @item -fprefetch-loop-arrays
5182 @opindex fprefetch-loop-arrays
5183 If supported by the target machine, generate instructions to prefetch
5184 memory to improve the performance of loops that access large arrays.
5186 These options may generate better or worse code; results are highly
5187 dependent on the structure of loops within the source code.
5189 @item -fno-peephole
5190 @itemx -fno-peephole2
5191 @opindex fno-peephole
5192 @opindex fno-peephole2
5193 Disable any machine-specific peephole optimizations.  The difference
5194 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5195 are implemented in the compiler; some targets use one, some use the
5196 other, a few use both.
5198 @option{-fpeephole} is enabled by default.
5199 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5201 @item -fno-guess-branch-probability
5202 @opindex fno-guess-branch-probability
5203 Do not guess branch probabilities using heuristics.
5205 GCC will use heuristics to guess branch probabilities if they are
5206 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5207 heuristics are based on the control flow graph.  If some branch probabilities
5208 are specified by @samp{__builtin_expect}, then the heuristics will be
5209 used to guess branch probabilities for the rest of the control flow graph,
5210 taking the @samp{__builtin_expect} info into account.  The interactions
5211 between the heuristics and @samp{__builtin_expect} can be complex, and in
5212 some cases, it may be useful to disable the heuristics so that the effects
5213 of @samp{__builtin_expect} are easier to understand.
5215 The default is @option{-fguess-branch-probability} at levels
5216 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5218 @item -freorder-blocks
5219 @opindex freorder-blocks
5220 Reorder basic blocks in the compiled function in order to reduce number of
5221 taken branches and improve code locality.
5223 Enabled at levels @option{-O2}, @option{-O3}.
5225 @item -freorder-blocks-and-partition
5226 @opindex freorder-blocks-and-partition
5227 In addition to reordering basic blocks in the compiled function, in order
5228 to reduce number of taken branches, partitions hot and cold basic blocks
5229 into separate sections of the assembly and .o files, to improve
5230 paging and cache locality performance.
5232 This optimization is automatically turned off in the presence of
5233 exception handling, for linkonce sections, for functions with a user-defined
5234 section attribute and on any architecture that does not support named
5235 sections.
5237 @item -freorder-functions
5238 @opindex freorder-functions
5239 Reorder functions in the object file in order to
5240 improve code locality.  This is implemented by using special
5241 subsections @code{.text.hot} for most frequently executed functions and
5242 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5243 the linker so object file format must support named sections and linker must
5244 place them in a reasonable way.
5246 Also profile feedback must be available in to make this option effective.  See
5247 @option{-fprofile-arcs} for details.
5249 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5251 @item -fstrict-aliasing
5252 @opindex fstrict-aliasing
5253 Allows the compiler to assume the strictest aliasing rules applicable to
5254 the language being compiled.  For C (and C++), this activates
5255 optimizations based on the type of expressions.  In particular, an
5256 object of one type is assumed never to reside at the same address as an
5257 object of a different type, unless the types are almost the same.  For
5258 example, an @code{unsigned int} can alias an @code{int}, but not a
5259 @code{void*} or a @code{double}.  A character type may alias any other
5260 type.
5262 Pay special attention to code like this:
5263 @smallexample
5264 union a_union @{
5265   int i;
5266   double d;
5269 int f() @{
5270   a_union t;
5271   t.d = 3.0;
5272   return t.i;
5274 @end smallexample
5275 The practice of reading from a different union member than the one most
5276 recently written to (called ``type-punning'') is common.  Even with
5277 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5278 is accessed through the union type.  So, the code above will work as
5279 expected.  However, this code might not:
5280 @smallexample
5281 int f() @{
5282   a_union t;
5283   int* ip;
5284   t.d = 3.0;
5285   ip = &t.i;
5286   return *ip;
5288 @end smallexample
5290 Every language that wishes to perform language-specific alias analysis
5291 should define a function that computes, given an @code{tree}
5292 node, an alias set for the node.  Nodes in different alias sets are not
5293 allowed to alias.  For an example, see the C front-end function
5294 @code{c_get_alias_set}.
5296 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5298 @item -falign-functions
5299 @itemx -falign-functions=@var{n}
5300 @opindex falign-functions
5301 Align the start of functions to the next power-of-two greater than
5302 @var{n}, skipping up to @var{n} bytes.  For instance,
5303 @option{-falign-functions=32} aligns functions to the next 32-byte
5304 boundary, but @option{-falign-functions=24} would align to the next
5305 32-byte boundary only if this can be done by skipping 23 bytes or less.
5307 @option{-fno-align-functions} and @option{-falign-functions=1} are
5308 equivalent and mean that functions will not be aligned.
5310 Some assemblers only support this flag when @var{n} is a power of two;
5311 in that case, it is rounded up.
5313 If @var{n} is not specified or is zero, use a machine-dependent default.
5315 Enabled at levels @option{-O2}, @option{-O3}.
5317 @item -falign-labels
5318 @itemx -falign-labels=@var{n}
5319 @opindex falign-labels
5320 Align all branch targets to a power-of-two boundary, skipping up to
5321 @var{n} bytes like @option{-falign-functions}.  This option can easily
5322 make code slower, because it must insert dummy operations for when the
5323 branch target is reached in the usual flow of the code.
5325 @option{-fno-align-labels} and @option{-falign-labels=1} are
5326 equivalent and mean that labels will not be aligned.
5328 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5329 are greater than this value, then their values are used instead.
5331 If @var{n} is not specified or is zero, use a machine-dependent default
5332 which is very likely to be @samp{1}, meaning no alignment.
5334 Enabled at levels @option{-O2}, @option{-O3}.
5336 @item -falign-loops
5337 @itemx -falign-loops=@var{n}
5338 @opindex falign-loops
5339 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5340 like @option{-falign-functions}.  The hope is that the loop will be
5341 executed many times, which will make up for any execution of the dummy
5342 operations.
5344 @option{-fno-align-loops} and @option{-falign-loops=1} are
5345 equivalent and mean that loops will not be aligned.
5347 If @var{n} is not specified or is zero, use a machine-dependent default.
5349 Enabled at levels @option{-O2}, @option{-O3}.
5351 @item -falign-jumps
5352 @itemx -falign-jumps=@var{n}
5353 @opindex falign-jumps
5354 Align branch targets to a power-of-two boundary, for branch targets
5355 where the targets can only be reached by jumping, skipping up to @var{n}
5356 bytes like @option{-falign-functions}.  In this case, no dummy operations
5357 need be executed.
5359 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5360 equivalent and mean that loops will not be aligned.
5362 If @var{n} is not specified or is zero, use a machine-dependent default.
5364 Enabled at levels @option{-O2}, @option{-O3}.
5366 @item -funit-at-a-time
5367 @opindex funit-at-a-time
5368 Parse the whole compilation unit before starting to produce code.
5369 This allows some extra optimizations to take place but consumes
5370 more memory (in general).  There are some compatibility issues
5371 with @emph{unit-at-at-time} mode:
5372 @itemize @bullet
5373 @item
5374 enabling @emph{unit-at-a-time} mode may change the order
5375 in which functions, variables, and top-level @code{asm} statements
5376 are emitted, and will likely break code relying on some particular
5377 ordering.  The majority of such top-level @code{asm} statements,
5378 though, can be replaced by @code{section} attributes.
5380 @item
5381 @emph{unit-at-a-time} mode removes unreferenced static variables
5382 and functions.  This may result in undefined references
5383 when an @code{asm} statement refers directly to variables or functions
5384 that are otherwise unused.  In that case either the variable/function
5385 shall be listed as an operand of the @code{asm} statement operand or,
5386 in the case of top-level @code{asm} statements the attribute @code{used}
5387 shall be used on the declaration.
5389 @item
5390 Static functions now can use non-standard passing conventions that
5391 may break @code{asm} statements calling functions directly.  Again,
5392 attribute @code{used} will prevent this behavior.
5393 @end itemize
5395 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5396 but this scheme may not be supported by future releases of GCC@.
5398 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5400 @item -fweb
5401 @opindex fweb
5402 Constructs webs as commonly used for register allocation purposes and assign
5403 each web individual pseudo register.  This allows the register allocation pass
5404 to operate on pseudos directly, but also strengthens several other optimization
5405 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5406 however, make debugging impossible, since variables will no longer stay in a
5407 ``home register''.
5409 Enabled by default with @option{-funroll-loops}.
5411 @item -fwhole-program
5412 @opindex fwhole-program
5413 Assume that the current compilation unit represents whole program being
5414 compiled.  All public functions and variables with the exception of @code{main}
5415 and those merged by attribute @code{externally_visible} become static functions
5416 and in a affect gets more aggressively optimized by interprocedural optimizers.
5417 While this option is equivalent to proper use of @code{static} keyword for
5418 programs consisting of single file, in combination with option
5419 @option{--combine} this flag can be used to compile most of smaller scale C
5420 programs since the functions and variables become local for the whole combined
5421 compilation unit, not for the single source file itself.
5424 @item -fcprop-registers
5425 @opindex fcprop-registers
5426 After register allocation and post-register allocation instruction splitting,
5427 we perform a copy-propagation pass to try to reduce scheduling dependencies
5428 and occasionally eliminate the copy.
5430 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5432 @item -fprofile-generate
5433 @opindex fprofile-generate
5435 Enable options usually used for instrumenting application to produce
5436 profile useful for later recompilation with profile feedback based
5437 optimization.  You must use @option{-fprofile-generate} both when
5438 compiling and when linking your program.
5440 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5442 @item -fprofile-use
5443 @opindex fprofile-use
5444 Enable profile feedback directed optimizations, and optimizations
5445 generally profitable only with profile feedback available.
5447 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5448 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5449 @code{-fno-loop-optimize}.
5451 @end table
5453 The following options control compiler behavior regarding floating
5454 point arithmetic.  These options trade off between speed and
5455 correctness.  All must be specifically enabled.
5457 @table @gcctabopt
5458 @item -ffloat-store
5459 @opindex ffloat-store
5460 Do not store floating point variables in registers, and inhibit other
5461 options that might change whether a floating point value is taken from a
5462 register or memory.
5464 @cindex floating point precision
5465 This option prevents undesirable excess precision on machines such as
5466 the 68000 where the floating registers (of the 68881) keep more
5467 precision than a @code{double} is supposed to have.  Similarly for the
5468 x86 architecture.  For most programs, the excess precision does only
5469 good, but a few programs rely on the precise definition of IEEE floating
5470 point.  Use @option{-ffloat-store} for such programs, after modifying
5471 them to store all pertinent intermediate computations into variables.
5473 @item -ffast-math
5474 @opindex ffast-math
5475 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5476 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5477 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5478 and @option{fcx-limited-range}.
5480 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5482 This option should never be turned on by any @option{-O} option since
5483 it can result in incorrect output for programs which depend on
5484 an exact implementation of IEEE or ISO rules/specifications for
5485 math functions.
5487 @item -fno-math-errno
5488 @opindex fno-math-errno
5489 Do not set ERRNO after calling math functions that are executed
5490 with a single instruction, e.g., sqrt.  A program that relies on
5491 IEEE exceptions for math error handling may want to use this flag
5492 for speed while maintaining IEEE arithmetic compatibility.
5494 This option should never be turned on by any @option{-O} option since
5495 it can result in incorrect output for programs which depend on
5496 an exact implementation of IEEE or ISO rules/specifications for
5497 math functions.
5499 The default is @option{-fmath-errno}.
5501 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5502 no reason for the compiler to consider the possibility that it might,
5503 and @option{-fno-math-errno} is the default.
5505 @item -funsafe-math-optimizations
5506 @opindex funsafe-math-optimizations
5507 Allow optimizations for floating-point arithmetic that (a) assume
5508 that arguments and results are valid and (b) may violate IEEE or
5509 ANSI standards.  When used at link-time, it may include libraries
5510 or startup files that change the default FPU control word or other
5511 similar optimizations.
5513 This option should never be turned on by any @option{-O} option since
5514 it can result in incorrect output for programs which depend on
5515 an exact implementation of IEEE or ISO rules/specifications for
5516 math functions.
5518 The default is @option{-fno-unsafe-math-optimizations}.
5520 @item -ffinite-math-only
5521 @opindex ffinite-math-only
5522 Allow optimizations for floating-point arithmetic that assume
5523 that arguments and results are not NaNs or +-Infs.
5525 This option should never be turned on by any @option{-O} option since
5526 it can result in incorrect output for programs which depend on
5527 an exact implementation of IEEE or ISO rules/specifications.
5529 The default is @option{-fno-finite-math-only}.
5531 @item -fno-trapping-math
5532 @opindex fno-trapping-math
5533 Compile code assuming that floating-point operations cannot generate
5534 user-visible traps.  These traps include division by zero, overflow,
5535 underflow, inexact result and invalid operation.  This option implies
5536 @option{-fno-signaling-nans}.  Setting this option may allow faster
5537 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5539 This option should never be turned on by any @option{-O} option since
5540 it can result in incorrect output for programs which depend on
5541 an exact implementation of IEEE or ISO rules/specifications for
5542 math functions.
5544 The default is @option{-ftrapping-math}.
5546 @item -frounding-math
5547 @opindex frounding-math
5548 Disable transformations and optimizations that assume default floating
5549 point rounding behavior.  This is round-to-zero for all floating point
5550 to integer conversions, and round-to-nearest for all other arithmetic
5551 truncations.  This option should be specified for programs that change
5552 the FP rounding mode dynamically, or that may be executed with a
5553 non-default rounding mode.  This option disables constant folding of
5554 floating point expressions at compile-time (which may be affected by
5555 rounding mode) and arithmetic transformations that are unsafe in the
5556 presence of sign-dependent rounding modes.
5558 The default is @option{-fno-rounding-math}.
5560 This option is experimental and does not currently guarantee to
5561 disable all GCC optimizations that are affected by rounding mode.
5562 Future versions of GCC may provide finer control of this setting
5563 using C99's @code{FENV_ACCESS} pragma.  This command line option
5564 will be used to specify the default state for @code{FENV_ACCESS}.
5566 @item -fsignaling-nans
5567 @opindex fsignaling-nans
5568 Compile code assuming that IEEE signaling NaNs may generate user-visible
5569 traps during floating-point operations.  Setting this option disables
5570 optimizations that may change the number of exceptions visible with
5571 signaling NaNs.  This option implies @option{-ftrapping-math}.
5573 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5574 be defined.
5576 The default is @option{-fno-signaling-nans}.
5578 This option is experimental and does not currently guarantee to
5579 disable all GCC optimizations that affect signaling NaN behavior.
5581 @item -fsingle-precision-constant
5582 @opindex fsingle-precision-constant
5583 Treat floating point constant as single precision constant instead of
5584 implicitly converting it to double precision constant.
5586 @item -fcx-limited-range
5587 @opindex fcx-limited-range
5588 When enabled, this option states that a range reduction step is not
5589 needed when performing complex division.  The default is
5590 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5592 This option controls the default setting of the ISO C99 
5593 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5594 all languages.
5596 @end table
5598 The following options control optimizations that may improve
5599 performance, but are not enabled by any @option{-O} options.  This
5600 section includes experimental options that may produce broken code.
5602 @table @gcctabopt
5603 @item -fbranch-probabilities
5604 @opindex fbranch-probabilities
5605 After running a program compiled with @option{-fprofile-arcs}
5606 (@pxref{Debugging Options,, Options for Debugging Your Program or
5607 @command{gcc}}), you can compile it a second time using
5608 @option{-fbranch-probabilities}, to improve optimizations based on
5609 the number of times each branch was taken.  When the program
5610 compiled with @option{-fprofile-arcs} exits it saves arc execution
5611 counts to a file called @file{@var{sourcename}.gcda} for each source
5612 file  The information in this data file is very dependent on the
5613 structure of the generated code, so you must use the same source code
5614 and the same optimization options for both compilations.
5616 With @option{-fbranch-probabilities}, GCC puts a
5617 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5618 These can be used to improve optimization.  Currently, they are only
5619 used in one place: in @file{reorg.c}, instead of guessing which path a
5620 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5621 exactly determine which path is taken more often.
5623 @item -fprofile-values
5624 @opindex fprofile-values
5625 If combined with @option{-fprofile-arcs}, it adds code so that some
5626 data about values of expressions in the program is gathered.
5628 With @option{-fbranch-probabilities}, it reads back the data gathered
5629 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5630 notes to instructions for their later usage in optimizations.
5632 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5634 @item -fvpt
5635 @opindex fvpt
5636 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5637 a code to gather information about values of expressions.
5639 With @option{-fbranch-probabilities}, it reads back the data gathered
5640 and actually performs the optimizations based on them.
5641 Currently the optimizations include specialization of division operation
5642 using the knowledge about the value of the denominator.
5644 @item -frename-registers
5645 @opindex frename-registers
5646 Attempt to avoid false dependencies in scheduled code by making use
5647 of registers left over after register allocation.  This optimization
5648 will most benefit processors with lots of registers.  Depending on the
5649 debug information format adopted by the target, however, it can
5650 make debugging impossible, since variables will no longer stay in
5651 a ``home register''.
5653 Enabled by default with @option{-funroll-loops}.
5655 @item -ftracer
5656 @opindex ftracer
5657 Perform tail duplication to enlarge superblock size.  This transformation
5658 simplifies the control flow of the function allowing other optimizations to do
5659 better job.
5661 Enabled with @option{-fprofile-use}.
5663 @item -funroll-loops
5664 @opindex funroll-loops
5665 Unroll loops whose number of iterations can be determined at compile time or
5666 upon entry to the loop.  @option{-funroll-loops} implies
5667 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5668 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5669 small constant number of iterations).  This option makes code larger, and may
5670 or may not make it run faster.
5672 Enabled with @option{-fprofile-use}.
5674 @item -funroll-all-loops
5675 @opindex funroll-all-loops
5676 Unroll all loops, even if their number of iterations is uncertain when
5677 the loop is entered.  This usually makes programs run more slowly.
5678 @option{-funroll-all-loops} implies the same options as
5679 @option{-funroll-loops}.
5681 @item -fpeel-loops
5682 @opindex fpeel-loops
5683 Peels the loops for that there is enough information that they do not
5684 roll much (from profile feedback).  It also turns on complete loop peeling
5685 (i.e.@: complete removal of loops with small constant number of iterations).
5687 Enabled with @option{-fprofile-use}.
5689 @item -fmove-loop-invariants
5690 @opindex fmove-loop-invariants
5691 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5692 at level @option{-O1}
5694 @item -funswitch-loops
5695 @opindex funswitch-loops
5696 Move branches with loop invariant conditions out of the loop, with duplicates
5697 of the loop on both branches (modified according to result of the condition).
5699 @item -fprefetch-loop-arrays
5700 @opindex fprefetch-loop-arrays
5701 If supported by the target machine, generate instructions to prefetch
5702 memory to improve the performance of loops that access large arrays.
5704 Disabled at level @option{-Os}.
5706 @item -ffunction-sections
5707 @itemx -fdata-sections
5708 @opindex ffunction-sections
5709 @opindex fdata-sections
5710 Place each function or data item into its own section in the output
5711 file if the target supports arbitrary sections.  The name of the
5712 function or the name of the data item determines the section's name
5713 in the output file.
5715 Use these options on systems where the linker can perform optimizations
5716 to improve locality of reference in the instruction space.  Most systems
5717 using the ELF object format and SPARC processors running Solaris 2 have
5718 linkers with such optimizations.  AIX may have these optimizations in
5719 the future.
5721 Only use these options when there are significant benefits from doing
5722 so.  When you specify these options, the assembler and linker will
5723 create larger object and executable files and will also be slower.
5724 You will not be able to use @code{gprof} on all systems if you
5725 specify this option and you may have problems with debugging if
5726 you specify both this option and @option{-g}.
5728 @item -fbranch-target-load-optimize
5729 @opindex fbranch-target-load-optimize
5730 Perform branch target register load optimization before prologue / epilogue
5731 threading.
5732 The use of target registers can typically be exposed only during reload,
5733 thus hoisting loads out of loops and doing inter-block scheduling needs
5734 a separate optimization pass.
5736 @item -fbranch-target-load-optimize2
5737 @opindex fbranch-target-load-optimize2
5738 Perform branch target register load optimization after prologue / epilogue
5739 threading.
5741 @item -fbtr-bb-exclusive
5742 @opindex fbtr-bb-exclusive
5743 When performing branch target register load optimization, don't reuse
5744 branch target registers in within any basic block.
5746 @item -fstack-protector
5747 @opindex fstack-protector
5748 Emit extra code to check for buffer overflows, such as stack smashing
5749 attacks.  This is done by adding a guard variable to functions with
5750 vulnerable objects.  This includes functions that call alloca, and
5751 functions with buffers larger than 8 bytes.  The guards are initialized
5752 when a function is entered and then checked when the function exits.
5753 If a guard check fails, an error message is printed and the program exits.
5755 @item -fstack-protector-all
5756 @opindex fstack-protector-all
5757 Like @option{-fstack-protector} except that all functions are protected.
5759 @item --param @var{name}=@var{value}
5760 @opindex param
5761 In some places, GCC uses various constants to control the amount of
5762 optimization that is done.  For example, GCC will not inline functions
5763 that contain more that a certain number of instructions.  You can
5764 control some of these constants on the command-line using the
5765 @option{--param} option.
5767 The names of specific parameters, and the meaning of the values, are
5768 tied to the internals of the compiler, and are subject to change
5769 without notice in future releases.
5771 In each case, the @var{value} is an integer.  The allowable choices for
5772 @var{name} are given in the following table:
5774 @table @gcctabopt
5775 @item salias-max-implicit-fields
5776 The maximum number of fields in a variable without direct
5777 structure accesses for which structure aliasing will consider trying 
5778 to track each field.  The default is 5
5780 @item sra-max-structure-size
5781 The maximum structure size, in bytes, at which the scalar replacement
5782 of aggregates (SRA) optimization will perform block copies.  The
5783 default value, 0, implies that GCC will select the most appropriate
5784 size itself.
5786 @item sra-field-structure-ratio
5787 The threshold ratio (as a percentage) between instantiated fields and
5788 the complete structure size.  We say that if the ratio of the number
5789 of bytes in instantiated fields to the number of bytes in the complete
5790 structure exceeds this parameter, then block copies are not used.  The
5791 default is 75.
5793 @item max-crossjump-edges
5794 The maximum number of incoming edges to consider for crossjumping.
5795 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5796 the number of edges incoming to each block.  Increasing values mean
5797 more aggressive optimization, making the compile time increase with
5798 probably small improvement in executable size.
5800 @item min-crossjump-insns
5801 The minimum number of instructions which must be matched at the end
5802 of two blocks before crossjumping will be performed on them.  This
5803 value is ignored in the case where all instructions in the block being
5804 crossjumped from are matched.  The default value is 5.
5806 @item max-grow-copy-bb-insns
5807 The maximum code size expansion factor when copying basic blocks
5808 instead of jumping.  The expansion is relative to a jump instruction.
5809 The default value is 8.
5811 @item max-goto-duplication-insns
5812 The maximum number of instructions to duplicate to a block that jumps
5813 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5814 passes, GCC factors computed gotos early in the compilation process,
5815 and unfactors them as late as possible.  Only computed jumps at the
5816 end of a basic blocks with no more than max-goto-duplication-insns are
5817 unfactored.  The default value is 8.
5819 @item max-delay-slot-insn-search
5820 The maximum number of instructions to consider when looking for an
5821 instruction to fill a delay slot.  If more than this arbitrary number of
5822 instructions is searched, the time savings from filling the delay slot
5823 will be minimal so stop searching.  Increasing values mean more
5824 aggressive optimization, making the compile time increase with probably
5825 small improvement in executable run time.
5827 @item max-delay-slot-live-search
5828 When trying to fill delay slots, the maximum number of instructions to
5829 consider when searching for a block with valid live register
5830 information.  Increasing this arbitrarily chosen value means more
5831 aggressive optimization, increasing the compile time.  This parameter
5832 should be removed when the delay slot code is rewritten to maintain the
5833 control-flow graph.
5835 @item max-gcse-memory
5836 The approximate maximum amount of memory that will be allocated in
5837 order to perform the global common subexpression elimination
5838 optimization.  If more memory than specified is required, the
5839 optimization will not be done.
5841 @item max-gcse-passes
5842 The maximum number of passes of GCSE to run.  The default is 1.
5844 @item max-pending-list-length
5845 The maximum number of pending dependencies scheduling will allow
5846 before flushing the current state and starting over.  Large functions
5847 with few branches or calls can create excessively large lists which
5848 needlessly consume memory and resources.
5850 @item max-inline-insns-single
5851 Several parameters control the tree inliner used in gcc.
5852 This number sets the maximum number of instructions (counted in GCC's
5853 internal representation) in a single function that the tree inliner
5854 will consider for inlining.  This only affects functions declared
5855 inline and methods implemented in a class declaration (C++).
5856 The default value is 450.
5858 @item max-inline-insns-auto
5859 When you use @option{-finline-functions} (included in @option{-O3}),
5860 a lot of functions that would otherwise not be considered for inlining
5861 by the compiler will be investigated.  To those functions, a different
5862 (more restrictive) limit compared to functions declared inline can
5863 be applied.
5864 The default value is 90.
5866 @item large-function-insns
5867 The limit specifying really large functions.  For functions larger than this
5868 limit after inlining inlining is constrained by
5869 @option{--param large-function-growth}.  This parameter is useful primarily
5870 to avoid extreme compilation time caused by non-linear algorithms used by the
5871 backend.
5872 This parameter is ignored when @option{-funit-at-a-time} is not used.
5873 The default value is 2700.
5875 @item large-function-growth
5876 Specifies maximal growth of large function caused by inlining in percents.
5877 This parameter is ignored when @option{-funit-at-a-time} is not used.
5878 The default value is 100 which limits large function growth to 2.0 times
5879 the original size.
5881 @item large-unit-insns
5882 The limit specifying large translation unit.  Growth caused by inlining of
5883 units larger than this limit is limited by @option{--param inline-unit-growth}.
5884 For small units this might be too tight (consider unit consisting of function A
5885 that is inline and B that just calls A three time.  If B is small relative to
5886 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5887 large units consisting of small inlininable functions however the overall unit
5888 growth limit is needed to avoid exponential explosion of code size.  Thus for
5889 smaller units, the size is increased to @option{--param large-unit-insns}
5890 before aplying @option{--param inline-unit-growth}.  The default is 10000
5892 @item inline-unit-growth
5893 Specifies maximal overall growth of the compilation unit caused by inlining.
5894 This parameter is ignored when @option{-funit-at-a-time} is not used.
5895 The default value is 50 which limits unit growth to 1.5 times the original
5896 size.
5898 @item max-inline-insns-recursive
5899 @itemx max-inline-insns-recursive-auto
5900 Specifies maximum number of instructions out-of-line copy of self recursive inline
5901 function can grow into by performing recursive inlining.
5903 For functions declared inline @option{--param max-inline-insns-recursive} is
5904 taken into account.  For function not declared inline, recursive inlining
5905 happens only when @option{-finline-functions} (included in @option{-O3}) is
5906 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5907 default value is 450.
5909 @item max-inline-recursive-depth
5910 @itemx max-inline-recursive-depth-auto
5911 Specifies maximum recursion depth used by the recursive inlining.
5913 For functions declared inline @option{--param max-inline-recursive-depth} is
5914 taken into account.  For function not declared inline, recursive inlining
5915 happens only when @option{-finline-functions} (included in @option{-O3}) is
5916 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5917 default value is 450.
5919 @item min-inline-recursive-probability
5920 Recursive inlining is profitable only for function having deep recursion
5921 in average and can hurt for function having little recursion depth by
5922 increasing the prologue size or complexity of function body to other
5923 optimizers.
5925 When profile feedback is available (see @option{-fprofile-generate}) the actual
5926 recursion depth can be guessed from probability that function will recurse via
5927 given call expression.  This parameter limits inlining only to call expression
5928 whose probability exceeds given threshold (in percents).  The default value is
5931 @item inline-call-cost
5932 Specify cost of call instruction relative to simple arithmetics operations
5933 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5934 functions and at the same time increases size of leaf function that is believed to
5935 reduce function size by being inlined.  In effect it increases amount of
5936 inlining for code having large abstraction penalty (many functions that just
5937 pass the arguments to other functions) and decrease inlining for code with low
5938 abstraction penalty.  The default value is 16.
5940 @item max-unrolled-insns
5941 The maximum number of instructions that a loop should have if that loop
5942 is unrolled, and if the loop is unrolled, it determines how many times
5943 the loop code is unrolled.
5945 @item max-average-unrolled-insns
5946 The maximum number of instructions biased by probabilities of their execution
5947 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5948 it determines how many times the loop code is unrolled.
5950 @item max-unroll-times
5951 The maximum number of unrollings of a single loop.
5953 @item max-peeled-insns
5954 The maximum number of instructions that a loop should have if that loop
5955 is peeled, and if the loop is peeled, it determines how many times
5956 the loop code is peeled.
5958 @item max-peel-times
5959 The maximum number of peelings of a single loop.
5961 @item max-completely-peeled-insns
5962 The maximum number of insns of a completely peeled loop.
5964 @item max-completely-peel-times
5965 The maximum number of iterations of a loop to be suitable for complete peeling.
5967 @item max-unswitch-insns
5968 The maximum number of insns of an unswitched loop.
5970 @item max-unswitch-level
5971 The maximum number of branches unswitched in a single loop.
5973 @item lim-expensive
5974 The minimum cost of an expensive expression in the loop invariant motion.
5976 @item iv-consider-all-candidates-bound
5977 Bound on number of candidates for induction variables below that
5978 all candidates are considered for each use in induction variable
5979 optimizations.  Only the most relevant candidates are considered
5980 if there are more candidates, to avoid quadratic time complexity.
5982 @item iv-max-considered-uses
5983 The induction variable optimizations give up on loops that contain more
5984 induction variable uses.
5986 @item iv-always-prune-cand-set-bound
5987 If number of candidates in the set is smaller than this value,
5988 we always try to remove unnecessary ivs from the set during its
5989 optimization when a new iv is added to the set.
5991 @item scev-max-expr-size
5992 Bound on size of expressions used in the scalar evolutions analyzer.
5993 Large expressions slow the analyzer.
5995 @item vect-max-version-checks
5996 The maximum number of runtime checks that can be performed when doing
5997 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5998 for more information.
6000 @item max-iterations-to-track
6002 The maximum number of iterations of a loop the brute force algorithm
6003 for analysis of # of iterations of the loop tries to evaluate.
6005 @item hot-bb-count-fraction
6006 Select fraction of the maximal count of repetitions of basic block in program
6007 given basic block needs to have to be considered hot.
6009 @item hot-bb-frequency-fraction
6010 Select fraction of the maximal frequency of executions of basic block in
6011 function given basic block needs to have to be considered hot
6013 @item max-predicted-iterations
6014 The maximum number of loop iterations we predict statically.  This is useful
6015 in cases where function contain single loop with known bound and other loop
6016 with unknown.  We predict the known number of iterations correctly, while
6017 the unknown number of iterations average to roughly 10.  This means that the
6018 loop without bounds would appear artificially cold relative to the other one.
6020 @item tracer-dynamic-coverage
6021 @itemx tracer-dynamic-coverage-feedback
6023 This value is used to limit superblock formation once the given percentage of
6024 executed instructions is covered.  This limits unnecessary code size
6025 expansion.
6027 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6028 feedback is available.  The real profiles (as opposed to statically estimated
6029 ones) are much less balanced allowing the threshold to be larger value.
6031 @item tracer-max-code-growth
6032 Stop tail duplication once code growth has reached given percentage.  This is
6033 rather hokey argument, as most of the duplicates will be eliminated later in
6034 cross jumping, so it may be set to much higher values than is the desired code
6035 growth.
6037 @item tracer-min-branch-ratio
6039 Stop reverse growth when the reverse probability of best edge is less than this
6040 threshold (in percent).
6042 @item tracer-min-branch-ratio
6043 @itemx tracer-min-branch-ratio-feedback
6045 Stop forward growth if the best edge do have probability lower than this
6046 threshold.
6048 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6049 compilation for profile feedback and one for compilation without.  The value
6050 for compilation with profile feedback needs to be more conservative (higher) in
6051 order to make tracer effective.
6053 @item max-cse-path-length
6055 Maximum number of basic blocks on path that cse considers.  The default is 10.
6057 @item max-cse-insns
6058 The maximum instructions CSE process before flushing.  The default is 1000.
6060 @item global-var-threshold
6062 Counts the number of function calls (@var{n}) and the number of
6063 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6064 single artificial variable will be created to represent all the
6065 call-clobbered variables at function call sites.  This artificial
6066 variable will then be made to alias every call-clobbered variable.
6067 (done as @code{int * size_t} on the host machine; beware overflow).
6069 @item max-aliased-vops
6071 Maximum number of virtual operands allowed to represent aliases
6072 before triggering the alias grouping heuristic.  Alias grouping
6073 reduces compile times and memory consumption needed for aliasing at
6074 the expense of precision loss in alias information.
6076 @item ggc-min-expand
6078 GCC uses a garbage collector to manage its own memory allocation.  This
6079 parameter specifies the minimum percentage by which the garbage
6080 collector's heap should be allowed to expand between collections.
6081 Tuning this may improve compilation speed; it has no effect on code
6082 generation.
6084 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6085 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6086 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6087 GCC is not able to calculate RAM on a particular platform, the lower
6088 bound of 30% is used.  Setting this parameter and
6089 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6090 every opportunity.  This is extremely slow, but can be useful for
6091 debugging.
6093 @item ggc-min-heapsize
6095 Minimum size of the garbage collector's heap before it begins bothering
6096 to collect garbage.  The first collection occurs after the heap expands
6097 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6098 tuning this may improve compilation speed, and has no effect on code
6099 generation.
6101 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6102 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6103 with a lower bound of 4096 (four megabytes) and an upper bound of
6104 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6105 particular platform, the lower bound is used.  Setting this parameter
6106 very large effectively disables garbage collection.  Setting this
6107 parameter and @option{ggc-min-expand} to zero causes a full collection
6108 to occur at every opportunity.
6110 @item max-reload-search-insns
6111 The maximum number of instruction reload should look backward for equivalent
6112 register.  Increasing values mean more aggressive optimization, making the
6113 compile time increase with probably slightly better performance.  The default
6114 value is 100.
6116 @item max-cselib-memory-location
6117 The maximum number of memory locations cselib should take into account.
6118 Increasing values mean more aggressive optimization, making the compile time
6119 increase with probably slightly better performance.  The default value is 500.
6121 @item max-flow-memory-location
6122 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6123 The default value is 100.
6125 @item reorder-blocks-duplicate
6126 @itemx reorder-blocks-duplicate-feedback
6128 Used by basic block reordering pass to decide whether to use unconditional
6129 branch or duplicate the code on its destination.  Code is duplicated when its
6130 estimated size is smaller than this value multiplied by the estimated size of
6131 unconditional jump in the hot spots of the program.
6133 The @option{reorder-block-duplicate-feedback} is used only when profile
6134 feedback is available and may be set to higher values than
6135 @option{reorder-block-duplicate} since information about the hot spots is more
6136 accurate.
6138 @item max-sched-ready-insns
6139 The maximum number of instructions ready to be issued the scheduler should
6140 consider at any given time during the first scheduling pass.  Increasing
6141 values mean more thorough searches, making the compilation time increase
6142 with probably little benefit.  The default value is 100.
6144 @item max-sched-region-blocks
6145 The maximum number of blocks in a region to be considered for
6146 interblock scheduling.  The default value is 10.
6148 @item max-sched-region-insns
6149 The maximum number of insns in a region to be considered for
6150 interblock scheduling.  The default value is 100.
6152 @item min-sched-prob
6153 The minimum probability of reaching a source block for interblock
6154 speculative scheduling.  The default value is 40.
6156 @item max-last-value-rtl
6158 The maximum size measured as number of RTLs that can be recorded in an expression
6159 in combiner for a pseudo register as last known value of that register.  The default
6160 is 10000.
6162 @item integer-share-limit
6163 Small integer constants can use a shared data structure, reducing the
6164 compiler's memory usage and increasing its speed.  This sets the maximum
6165 value of a shared integer constant's.  The default value is 256.
6167 @item min-virtual-mappings
6168 Specifies the minimum number of virtual mappings in the incremental
6169 SSA updater that should be registered to trigger the virtual mappings
6170 heuristic defined by virtual-mappings-ratio.  The default value is
6171 100.
6173 @item virtual-mappings-ratio
6174 If the number of virtual mappings is virtual-mappings-ratio bigger
6175 than the number of virtual symbols to be updated, then the incremental
6176 SSA updater switches to a full update for those symbols.  The default
6177 ratio is 3.
6179 @item ssp-buffer-size
6180 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6181 protection when @option{-fstack-protection} is used.
6183 @item max-jump-thread-duplication-stmts
6184 Maximum number of statements allowed in a block that needs to be
6185 duplicated when threading jumps.
6187 @item max-fields-for-field-sensitive
6188 Maximum number of fields in a structure we will treat in
6189 a field sensitive manner during pointer analysis.
6191 @end table
6192 @end table
6194 @node Preprocessor Options
6195 @section Options Controlling the Preprocessor
6196 @cindex preprocessor options
6197 @cindex options, preprocessor
6199 These options control the C preprocessor, which is run on each C source
6200 file before actual compilation.
6202 If you use the @option{-E} option, nothing is done except preprocessing.
6203 Some of these options make sense only together with @option{-E} because
6204 they cause the preprocessor output to be unsuitable for actual
6205 compilation.
6207 @table @gcctabopt
6208 @item -Wp,@var{option}
6209 @opindex Wp
6210 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6211 and pass @var{option} directly through to the preprocessor.  If
6212 @var{option} contains commas, it is split into multiple options at the
6213 commas.  However, many options are modified, translated or interpreted
6214 by the compiler driver before being passed to the preprocessor, and
6215 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6216 interface is undocumented and subject to change, so whenever possible
6217 you should avoid using @option{-Wp} and let the driver handle the
6218 options instead.
6220 @item -Xpreprocessor @var{option}
6221 @opindex preprocessor
6222 Pass @var{option} as an option to the preprocessor.  You can use this to
6223 supply system-specific preprocessor options which GCC does not know how to
6224 recognize.
6226 If you want to pass an option that takes an argument, you must use
6227 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6228 @end table
6230 @include cppopts.texi
6232 @node Assembler Options
6233 @section Passing Options to the Assembler
6235 @c prevent bad page break with this line
6236 You can pass options to the assembler.
6238 @table @gcctabopt
6239 @item -Wa,@var{option}
6240 @opindex Wa
6241 Pass @var{option} as an option to the assembler.  If @var{option}
6242 contains commas, it is split into multiple options at the commas.
6244 @item -Xassembler @var{option}
6245 @opindex Xassembler
6246 Pass @var{option} as an option to the assembler.  You can use this to
6247 supply system-specific assembler options which GCC does not know how to
6248 recognize.
6250 If you want to pass an option that takes an argument, you must use
6251 @option{-Xassembler} twice, once for the option and once for the argument.
6253 @end table
6255 @node Link Options
6256 @section Options for Linking
6257 @cindex link options
6258 @cindex options, linking
6260 These options come into play when the compiler links object files into
6261 an executable output file.  They are meaningless if the compiler is
6262 not doing a link step.
6264 @table @gcctabopt
6265 @cindex file names
6266 @item @var{object-file-name}
6267 A file name that does not end in a special recognized suffix is
6268 considered to name an object file or library.  (Object files are
6269 distinguished from libraries by the linker according to the file
6270 contents.)  If linking is done, these object files are used as input
6271 to the linker.
6273 @item -c
6274 @itemx -S
6275 @itemx -E
6276 @opindex c
6277 @opindex S
6278 @opindex E
6279 If any of these options is used, then the linker is not run, and
6280 object file names should not be used as arguments.  @xref{Overall
6281 Options}.
6283 @cindex Libraries
6284 @item -l@var{library}
6285 @itemx -l @var{library}
6286 @opindex l
6287 Search the library named @var{library} when linking.  (The second
6288 alternative with the library as a separate argument is only for
6289 POSIX compliance and is not recommended.)
6291 It makes a difference where in the command you write this option; the
6292 linker searches and processes libraries and object files in the order they
6293 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6294 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6295 to functions in @samp{z}, those functions may not be loaded.
6297 The linker searches a standard list of directories for the library,
6298 which is actually a file named @file{lib@var{library}.a}.  The linker
6299 then uses this file as if it had been specified precisely by name.
6301 The directories searched include several standard system directories
6302 plus any that you specify with @option{-L}.
6304 Normally the files found this way are library files---archive files
6305 whose members are object files.  The linker handles an archive file by
6306 scanning through it for members which define symbols that have so far
6307 been referenced but not defined.  But if the file that is found is an
6308 ordinary object file, it is linked in the usual fashion.  The only
6309 difference between using an @option{-l} option and specifying a file name
6310 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6311 and searches several directories.
6313 @item -lobjc
6314 @opindex lobjc
6315 You need this special case of the @option{-l} option in order to
6316 link an Objective-C or Objective-C++ program.
6318 @item -nostartfiles
6319 @opindex nostartfiles
6320 Do not use the standard system startup files when linking.
6321 The standard system libraries are used normally, unless @option{-nostdlib}
6322 or @option{-nodefaultlibs} is used.
6324 @item -nodefaultlibs
6325 @opindex nodefaultlibs
6326 Do not use the standard system libraries when linking.
6327 Only the libraries you specify will be passed to the linker.
6328 The standard startup files are used normally, unless @option{-nostartfiles}
6329 is used.  The compiler may generate calls to @code{memcmp},
6330 @code{memset}, @code{memcpy} and @code{memmove}.
6331 These entries are usually resolved by entries in
6332 libc.  These entry points should be supplied through some other
6333 mechanism when this option is specified.
6335 @item -nostdlib
6336 @opindex nostdlib
6337 Do not use the standard system startup files or libraries when linking.
6338 No startup files and only the libraries you specify will be passed to
6339 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6340 @code{memcpy} and @code{memmove}.
6341 These entries are usually resolved by entries in
6342 libc.  These entry points should be supplied through some other
6343 mechanism when this option is specified.
6345 @cindex @option{-lgcc}, use with @option{-nostdlib}
6346 @cindex @option{-nostdlib} and unresolved references
6347 @cindex unresolved references and @option{-nostdlib}
6348 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6349 @cindex @option{-nodefaultlibs} and unresolved references
6350 @cindex unresolved references and @option{-nodefaultlibs}
6351 One of the standard libraries bypassed by @option{-nostdlib} and
6352 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6353 that GCC uses to overcome shortcomings of particular machines, or special
6354 needs for some languages.
6355 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6356 Collection (GCC) Internals},
6357 for more discussion of @file{libgcc.a}.)
6358 In most cases, you need @file{libgcc.a} even when you want to avoid
6359 other standard libraries.  In other words, when you specify @option{-nostdlib}
6360 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6361 This ensures that you have no unresolved references to internal GCC
6362 library subroutines.  (For example, @samp{__main}, used to ensure C++
6363 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6364 GNU Compiler Collection (GCC) Internals}.)
6366 @item -pie
6367 @opindex pie
6368 Produce a position independent executable on targets which support it.
6369 For predictable results, you must also specify the same set of options
6370 that were used to generate code (@option{-fpie}, @option{-fPIE},
6371 or model suboptions) when you specify this option.
6373 @item -rdynamic
6374 @opindex rdynamic
6375 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6376 that support it.  This instructs the linker to add all symbols, not
6377 only used ones, to the dynamic symbol table.  This option is needed
6378 for some uses of @code{dlopen} or to allow obtaining backtraces
6379 from within a program.
6381 @item -s
6382 @opindex s
6383 Remove all symbol table and relocation information from the executable.
6385 @item -static
6386 @opindex static
6387 On systems that support dynamic linking, this prevents linking with the shared
6388 libraries.  On other systems, this option has no effect.
6390 @item -shared
6391 @opindex shared
6392 Produce a shared object which can then be linked with other objects to
6393 form an executable.  Not all systems support this option.  For predictable
6394 results, you must also specify the same set of options that were used to
6395 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6396 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6397 needs to build supplementary stub code for constructors to work.  On
6398 multi-libbed systems, @samp{gcc -shared} must select the correct support
6399 libraries to link against.  Failing to supply the correct flags may lead
6400 to subtle defects.  Supplying them in cases where they are not necessary
6401 is innocuous.}
6403 @item -shared-libgcc
6404 @itemx -static-libgcc
6405 @opindex shared-libgcc
6406 @opindex static-libgcc
6407 On systems that provide @file{libgcc} as a shared library, these options
6408 force the use of either the shared or static version respectively.
6409 If no shared version of @file{libgcc} was built when the compiler was
6410 configured, these options have no effect.
6412 There are several situations in which an application should use the
6413 shared @file{libgcc} instead of the static version.  The most common
6414 of these is when the application wishes to throw and catch exceptions
6415 across different shared libraries.  In that case, each of the libraries
6416 as well as the application itself should use the shared @file{libgcc}.
6418 Therefore, the G++ and GCJ drivers automatically add
6419 @option{-shared-libgcc} whenever you build a shared library or a main
6420 executable, because C++ and Java programs typically use exceptions, so
6421 this is the right thing to do.
6423 If, instead, you use the GCC driver to create shared libraries, you may
6424 find that they will not always be linked with the shared @file{libgcc}.
6425 If GCC finds, at its configuration time, that you have a non-GNU linker
6426 or a GNU linker that does not support option @option{--eh-frame-hdr},
6427 it will link the shared version of @file{libgcc} into shared libraries
6428 by default.  Otherwise, it will take advantage of the linker and optimize
6429 away the linking with the shared version of @file{libgcc}, linking with
6430 the static version of libgcc by default.  This allows exceptions to
6431 propagate through such shared libraries, without incurring relocation
6432 costs at library load time.
6434 However, if a library or main executable is supposed to throw or catch
6435 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6436 for the languages used in the program, or using the option
6437 @option{-shared-libgcc}, such that it is linked with the shared
6438 @file{libgcc}.
6440 @item -symbolic
6441 @opindex symbolic
6442 Bind references to global symbols when building a shared object.  Warn
6443 about any unresolved references (unless overridden by the link editor
6444 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6445 this option.
6447 @item -Xlinker @var{option}
6448 @opindex Xlinker
6449 Pass @var{option} as an option to the linker.  You can use this to
6450 supply system-specific linker options which GCC does not know how to
6451 recognize.
6453 If you want to pass an option that takes an argument, you must use
6454 @option{-Xlinker} twice, once for the option and once for the argument.
6455 For example, to pass @option{-assert definitions}, you must write
6456 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6457 @option{-Xlinker "-assert definitions"}, because this passes the entire
6458 string as a single argument, which is not what the linker expects.
6460 @item -Wl,@var{option}
6461 @opindex Wl
6462 Pass @var{option} as an option to the linker.  If @var{option} contains
6463 commas, it is split into multiple options at the commas.
6465 @item -u @var{symbol}
6466 @opindex u
6467 Pretend the symbol @var{symbol} is undefined, to force linking of
6468 library modules to define it.  You can use @option{-u} multiple times with
6469 different symbols to force loading of additional library modules.
6470 @end table
6472 @node Directory Options
6473 @section Options for Directory Search
6474 @cindex directory options
6475 @cindex options, directory search
6476 @cindex search path
6478 These options specify directories to search for header files, for
6479 libraries and for parts of the compiler:
6481 @table @gcctabopt
6482 @item -I@var{dir}
6483 @opindex I
6484 Add the directory @var{dir} to the head of the list of directories to be
6485 searched for header files.  This can be used to override a system header
6486 file, substituting your own version, since these directories are
6487 searched before the system header file directories.  However, you should
6488 not use this option to add directories that contain vendor-supplied
6489 system header files (use @option{-isystem} for that).  If you use more than
6490 one @option{-I} option, the directories are scanned in left-to-right
6491 order; the standard system directories come after.
6493 If a standard system include directory, or a directory specified with
6494 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6495 option will be ignored.  The directory will still be searched but as a
6496 system directory at its normal position in the system include chain.
6497 This is to ensure that GCC's procedure to fix buggy system headers and
6498 the ordering for the include_next directive are not inadvertently changed.
6499 If you really need to change the search order for system directories,
6500 use the @option{-nostdinc} and/or @option{-isystem} options.
6502 @item -iquote@var{dir}
6503 @opindex iquote
6504 Add the directory @var{dir} to the head of the list of directories to
6505 be searched for header files only for the case of @samp{#include
6506 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6507 otherwise just like @option{-I}.
6509 @item -L@var{dir}
6510 @opindex L
6511 Add directory @var{dir} to the list of directories to be searched
6512 for @option{-l}.
6514 @item -B@var{prefix}
6515 @opindex B
6516 This option specifies where to find the executables, libraries,
6517 include files, and data files of the compiler itself.
6519 The compiler driver program runs one or more of the subprograms
6520 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6521 @var{prefix} as a prefix for each program it tries to run, both with and
6522 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6524 For each subprogram to be run, the compiler driver first tries the
6525 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6526 was not specified, the driver tries two standard prefixes, which are
6527 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6528 those results in a file name that is found, the unmodified program
6529 name is searched for using the directories specified in your
6530 @env{PATH} environment variable.
6532 The compiler will check to see if the path provided by the @option{-B}
6533 refers to a directory, and if necessary it will add a directory
6534 separator character at the end of the path.
6536 @option{-B} prefixes that effectively specify directory names also apply
6537 to libraries in the linker, because the compiler translates these
6538 options into @option{-L} options for the linker.  They also apply to
6539 includes files in the preprocessor, because the compiler translates these
6540 options into @option{-isystem} options for the preprocessor.  In this case,
6541 the compiler appends @samp{include} to the prefix.
6543 The run-time support file @file{libgcc.a} can also be searched for using
6544 the @option{-B} prefix, if needed.  If it is not found there, the two
6545 standard prefixes above are tried, and that is all.  The file is left
6546 out of the link if it is not found by those means.
6548 Another way to specify a prefix much like the @option{-B} prefix is to use
6549 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6550 Variables}.
6552 As a special kludge, if the path provided by @option{-B} is
6553 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6554 9, then it will be replaced by @file{[dir/]include}.  This is to help
6555 with boot-strapping the compiler.
6557 @item -specs=@var{file}
6558 @opindex specs
6559 Process @var{file} after the compiler reads in the standard @file{specs}
6560 file, in order to override the defaults that the @file{gcc} driver
6561 program uses when determining what switches to pass to @file{cc1},
6562 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6563 @option{-specs=@var{file}} can be specified on the command line, and they
6564 are processed in order, from left to right.
6566 @item --sysroot=@var{dir}
6567 @opindex sysroot
6568 Use @var{dir} as the logical root directory for headers and libraries.
6569 For example, if the compiler would normally search for headers in
6570 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6571 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6573 If you use both this option and the @option{-isysroot} option, then
6574 the @option{--sysroot} option will apply to libraries, but the
6575 @option{-isysroot} option will apply to header files.
6577 The GNU linker (beginning with version 2.16) has the necessary support
6578 for this option.  If your linker does not support this option, the
6579 header file aspect of @option{--sysroot} will still work, but the
6580 library aspect will not.
6582 @item -I-
6583 @opindex I-
6584 This option has been deprecated.  Please use @option{-iquote} instead for
6585 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6586 Any directories you specify with @option{-I} options before the @option{-I-}
6587 option are searched only for the case of @samp{#include "@var{file}"};
6588 they are not searched for @samp{#include <@var{file}>}.
6590 If additional directories are specified with @option{-I} options after
6591 the @option{-I-}, these directories are searched for all @samp{#include}
6592 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6593 this way.)
6595 In addition, the @option{-I-} option inhibits the use of the current
6596 directory (where the current input file came from) as the first search
6597 directory for @samp{#include "@var{file}"}.  There is no way to
6598 override this effect of @option{-I-}.  With @option{-I.} you can specify
6599 searching the directory which was current when the compiler was
6600 invoked.  That is not exactly the same as what the preprocessor does
6601 by default, but it is often satisfactory.
6603 @option{-I-} does not inhibit the use of the standard system directories
6604 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6605 independent.
6606 @end table
6608 @c man end
6610 @node Spec Files
6611 @section Specifying subprocesses and the switches to pass to them
6612 @cindex Spec Files
6614 @command{gcc} is a driver program.  It performs its job by invoking a
6615 sequence of other programs to do the work of compiling, assembling and
6616 linking.  GCC interprets its command-line parameters and uses these to
6617 deduce which programs it should invoke, and which command-line options
6618 it ought to place on their command lines.  This behavior is controlled
6619 by @dfn{spec strings}.  In most cases there is one spec string for each
6620 program that GCC can invoke, but a few programs have multiple spec
6621 strings to control their behavior.  The spec strings built into GCC can
6622 be overridden by using the @option{-specs=} command-line switch to specify
6623 a spec file.
6625 @dfn{Spec files} are plaintext files that are used to construct spec
6626 strings.  They consist of a sequence of directives separated by blank
6627 lines.  The type of directive is determined by the first non-whitespace
6628 character on the line and it can be one of the following:
6630 @table @code
6631 @item %@var{command}
6632 Issues a @var{command} to the spec file processor.  The commands that can
6633 appear here are:
6635 @table @code
6636 @item %include <@var{file}>
6637 @cindex %include
6638 Search for @var{file} and insert its text at the current point in the
6639 specs file.
6641 @item %include_noerr <@var{file}>
6642 @cindex %include_noerr
6643 Just like @samp{%include}, but do not generate an error message if the include
6644 file cannot be found.
6646 @item %rename @var{old_name} @var{new_name}
6647 @cindex %rename
6648 Rename the spec string @var{old_name} to @var{new_name}.
6650 @end table
6652 @item *[@var{spec_name}]:
6653 This tells the compiler to create, override or delete the named spec
6654 string.  All lines after this directive up to the next directive or
6655 blank line are considered to be the text for the spec string.  If this
6656 results in an empty string then the spec will be deleted.  (Or, if the
6657 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6658 does not currently exist a new spec will be created.  If the spec does
6659 exist then its contents will be overridden by the text of this
6660 directive, unless the first character of that text is the @samp{+}
6661 character, in which case the text will be appended to the spec.
6663 @item [@var{suffix}]:
6664 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6665 and up to the next directive or blank line are considered to make up the
6666 spec string for the indicated suffix.  When the compiler encounters an
6667 input file with the named suffix, it will processes the spec string in
6668 order to work out how to compile that file.  For example:
6670 @smallexample
6671 .ZZ:
6672 z-compile -input %i
6673 @end smallexample
6675 This says that any input file whose name ends in @samp{.ZZ} should be
6676 passed to the program @samp{z-compile}, which should be invoked with the
6677 command-line switch @option{-input} and with the result of performing the
6678 @samp{%i} substitution.  (See below.)
6680 As an alternative to providing a spec string, the text that follows a
6681 suffix directive can be one of the following:
6683 @table @code
6684 @item @@@var{language}
6685 This says that the suffix is an alias for a known @var{language}.  This is
6686 similar to using the @option{-x} command-line switch to GCC to specify a
6687 language explicitly.  For example:
6689 @smallexample
6690 .ZZ:
6691 @@c++
6692 @end smallexample
6694 Says that .ZZ files are, in fact, C++ source files.
6696 @item #@var{name}
6697 This causes an error messages saying:
6699 @smallexample
6700 @var{name} compiler not installed on this system.
6701 @end smallexample
6702 @end table
6704 GCC already has an extensive list of suffixes built into it.
6705 This directive will add an entry to the end of the list of suffixes, but
6706 since the list is searched from the end backwards, it is effectively
6707 possible to override earlier entries using this technique.
6709 @end table
6711 GCC has the following spec strings built into it.  Spec files can
6712 override these strings or create their own.  Note that individual
6713 targets can also add their own spec strings to this list.
6715 @smallexample
6716 asm          Options to pass to the assembler
6717 asm_final    Options to pass to the assembler post-processor
6718 cpp          Options to pass to the C preprocessor
6719 cc1          Options to pass to the C compiler
6720 cc1plus      Options to pass to the C++ compiler
6721 endfile      Object files to include at the end of the link
6722 link         Options to pass to the linker
6723 lib          Libraries to include on the command line to the linker
6724 libgcc       Decides which GCC support library to pass to the linker
6725 linker       Sets the name of the linker
6726 predefines   Defines to be passed to the C preprocessor
6727 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6728              by default
6729 startfile    Object files to include at the start of the link
6730 @end smallexample
6732 Here is a small example of a spec file:
6734 @smallexample
6735 %rename lib                 old_lib
6737 *lib:
6738 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6739 @end smallexample
6741 This example renames the spec called @samp{lib} to @samp{old_lib} and
6742 then overrides the previous definition of @samp{lib} with a new one.
6743 The new definition adds in some extra command-line options before
6744 including the text of the old definition.
6746 @dfn{Spec strings} are a list of command-line options to be passed to their
6747 corresponding program.  In addition, the spec strings can contain
6748 @samp{%}-prefixed sequences to substitute variable text or to
6749 conditionally insert text into the command line.  Using these constructs
6750 it is possible to generate quite complex command lines.
6752 Here is a table of all defined @samp{%}-sequences for spec
6753 strings.  Note that spaces are not generated automatically around the
6754 results of expanding these sequences.  Therefore you can concatenate them
6755 together or combine them with constant text in a single argument.
6757 @table @code
6758 @item %%
6759 Substitute one @samp{%} into the program name or argument.
6761 @item %i
6762 Substitute the name of the input file being processed.
6764 @item %b
6765 Substitute the basename of the input file being processed.
6766 This is the substring up to (and not including) the last period
6767 and not including the directory.
6769 @item %B
6770 This is the same as @samp{%b}, but include the file suffix (text after
6771 the last period).
6773 @item %d
6774 Marks the argument containing or following the @samp{%d} as a
6775 temporary file name, so that that file will be deleted if GCC exits
6776 successfully.  Unlike @samp{%g}, this contributes no text to the
6777 argument.
6779 @item %g@var{suffix}
6780 Substitute a file name that has suffix @var{suffix} and is chosen
6781 once per compilation, and mark the argument in the same way as
6782 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6783 name is now chosen in a way that is hard to predict even when previously
6784 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6785 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6786 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6787 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6788 was simply substituted with a file name chosen once per compilation,
6789 without regard to any appended suffix (which was therefore treated
6790 just like ordinary text), making such attacks more likely to succeed.
6792 @item %u@var{suffix}
6793 Like @samp{%g}, but generates a new temporary file name even if
6794 @samp{%u@var{suffix}} was already seen.
6796 @item %U@var{suffix}
6797 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6798 new one if there is no such last file name.  In the absence of any
6799 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6800 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6801 would involve the generation of two distinct file names, one
6802 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6803 simply substituted with a file name chosen for the previous @samp{%u},
6804 without regard to any appended suffix.
6806 @item %j@var{suffix}
6807 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6808 writable, and if save-temps is off; otherwise, substitute the name
6809 of a temporary file, just like @samp{%u}.  This temporary file is not
6810 meant for communication between processes, but rather as a junk
6811 disposal mechanism.
6813 @item %|@var{suffix}
6814 @itemx %m@var{suffix}
6815 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6816 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6817 all.  These are the two most common ways to instruct a program that it
6818 should read from standard input or write to standard output.  If you
6819 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6820 construct: see for example @file{f/lang-specs.h}.
6822 @item %.@var{SUFFIX}
6823 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6824 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6825 terminated by the next space or %.
6827 @item %w
6828 Marks the argument containing or following the @samp{%w} as the
6829 designated output file of this compilation.  This puts the argument
6830 into the sequence of arguments that @samp{%o} will substitute later.
6832 @item %o
6833 Substitutes the names of all the output files, with spaces
6834 automatically placed around them.  You should write spaces
6835 around the @samp{%o} as well or the results are undefined.
6836 @samp{%o} is for use in the specs for running the linker.
6837 Input files whose names have no recognized suffix are not compiled
6838 at all, but they are included among the output files, so they will
6839 be linked.
6841 @item %O
6842 Substitutes the suffix for object files.  Note that this is
6843 handled specially when it immediately follows @samp{%g, %u, or %U},
6844 because of the need for those to form complete file names.  The
6845 handling is such that @samp{%O} is treated exactly as if it had already
6846 been substituted, except that @samp{%g, %u, and %U} do not currently
6847 support additional @var{suffix} characters following @samp{%O} as they would
6848 following, for example, @samp{.o}.
6850 @item %p
6851 Substitutes the standard macro predefinitions for the
6852 current target machine.  Use this when running @code{cpp}.
6854 @item %P
6855 Like @samp{%p}, but puts @samp{__} before and after the name of each
6856 predefined macro, except for macros that start with @samp{__} or with
6857 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6860 @item %I
6861 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6862 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6863 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6864 as necessary.
6866 @item %s
6867 Current argument is the name of a library or startup file of some sort.
6868 Search for that file in a standard list of directories and substitute
6869 the full name found.
6871 @item %e@var{str}
6872 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6873 Use this when inconsistent options are detected.
6875 @item %(@var{name})
6876 Substitute the contents of spec string @var{name} at this point.
6878 @item %[@var{name}]
6879 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6881 @item %x@{@var{option}@}
6882 Accumulate an option for @samp{%X}.
6884 @item %X
6885 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6886 spec string.
6888 @item %Y
6889 Output the accumulated assembler options specified by @option{-Wa}.
6891 @item %Z
6892 Output the accumulated preprocessor options specified by @option{-Wp}.
6894 @item %a
6895 Process the @code{asm} spec.  This is used to compute the
6896 switches to be passed to the assembler.
6898 @item %A
6899 Process the @code{asm_final} spec.  This is a spec string for
6900 passing switches to an assembler post-processor, if such a program is
6901 needed.
6903 @item %l
6904 Process the @code{link} spec.  This is the spec for computing the
6905 command line passed to the linker.  Typically it will make use of the
6906 @samp{%L %G %S %D and %E} sequences.
6908 @item %D
6909 Dump out a @option{-L} option for each directory that GCC believes might
6910 contain startup files.  If the target supports multilibs then the
6911 current multilib directory will be prepended to each of these paths.
6913 @item %L
6914 Process the @code{lib} spec.  This is a spec string for deciding which
6915 libraries should be included on the command line to the linker.
6917 @item %G
6918 Process the @code{libgcc} spec.  This is a spec string for deciding
6919 which GCC support library should be included on the command line to the linker.
6921 @item %S
6922 Process the @code{startfile} spec.  This is a spec for deciding which
6923 object files should be the first ones passed to the linker.  Typically
6924 this might be a file named @file{crt0.o}.
6926 @item %E
6927 Process the @code{endfile} spec.  This is a spec string that specifies
6928 the last object files that will be passed to the linker.
6930 @item %C
6931 Process the @code{cpp} spec.  This is used to construct the arguments
6932 to be passed to the C preprocessor.
6934 @item %1
6935 Process the @code{cc1} spec.  This is used to construct the options to be
6936 passed to the actual C compiler (@samp{cc1}).
6938 @item %2
6939 Process the @code{cc1plus} spec.  This is used to construct the options to be
6940 passed to the actual C++ compiler (@samp{cc1plus}).
6942 @item %*
6943 Substitute the variable part of a matched option.  See below.
6944 Note that each comma in the substituted string is replaced by
6945 a single space.
6947 @item %<@code{S}
6948 Remove all occurrences of @code{-S} from the command line.  Note---this
6949 command is position dependent.  @samp{%} commands in the spec string
6950 before this one will see @code{-S}, @samp{%} commands in the spec string
6951 after this one will not.
6953 @item %:@var{function}(@var{args})
6954 Call the named function @var{function}, passing it @var{args}.
6955 @var{args} is first processed as a nested spec string, then split
6956 into an argument vector in the usual fashion.  The function returns
6957 a string which is processed as if it had appeared literally as part
6958 of the current spec.
6960 The following built-in spec functions are provided:
6962 @table @code
6963 @item @code{if-exists}
6964 The @code{if-exists} spec function takes one argument, an absolute
6965 pathname to a file.  If the file exists, @code{if-exists} returns the
6966 pathname.  Here is a small example of its usage:
6968 @smallexample
6969 *startfile:
6970 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6971 @end smallexample
6973 @item @code{if-exists-else}
6974 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6975 spec function, except that it takes two arguments.  The first argument is
6976 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6977 returns the pathname.  If it does not exist, it returns the second argument.
6978 This way, @code{if-exists-else} can be used to select one file or another,
6979 based on the existence of the first.  Here is a small example of its usage:
6981 @smallexample
6982 *startfile:
6983 crt0%O%s %:if-exists(crti%O%s) \
6984 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6985 @end smallexample
6987 @item @code{replace-outfile}
6988 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6989 first argument in the outfiles array and replaces it with the second argument.  Here
6990 is a small example of its usage:
6992 @smallexample
6993 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6994 @end smallexample
6996 @end table
6998 @item %@{@code{S}@}
6999 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7000 If that switch was not specified, this substitutes nothing.  Note that
7001 the leading dash is omitted when specifying this option, and it is
7002 automatically inserted if the substitution is performed.  Thus the spec
7003 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7004 and would output the command line option @option{-foo}.
7006 @item %W@{@code{S}@}
7007 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7008 deleted on failure.
7010 @item %@{@code{S}*@}
7011 Substitutes all the switches specified to GCC whose names start
7012 with @code{-S}, but which also take an argument.  This is used for
7013 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7014 GCC considers @option{-o foo} as being
7015 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7016 text, including the space.  Thus two arguments would be generated.
7018 @item %@{@code{S}*&@code{T}*@}
7019 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7020 (the order of @code{S} and @code{T} in the spec is not significant).
7021 There can be any number of ampersand-separated variables; for each the
7022 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7024 @item %@{@code{S}:@code{X}@}
7025 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7027 @item %@{!@code{S}:@code{X}@}
7028 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7030 @item %@{@code{S}*:@code{X}@}
7031 Substitutes @code{X} if one or more switches whose names start with
7032 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7033 once, no matter how many such switches appeared.  However, if @code{%*}
7034 appears somewhere in @code{X}, then @code{X} will be substituted once
7035 for each matching switch, with the @code{%*} replaced by the part of
7036 that switch that matched the @code{*}.
7038 @item %@{.@code{S}:@code{X}@}
7039 Substitutes @code{X}, if processing a file with suffix @code{S}.
7041 @item %@{!.@code{S}:@code{X}@}
7042 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7044 @item %@{@code{S}|@code{P}:@code{X}@}
7045 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7046 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7047 although they have a stronger binding than the @samp{|}.  If @code{%*}
7048 appears in @code{X}, all of the alternatives must be starred, and only
7049 the first matching alternative is substituted.
7051 For example, a spec string like this:
7053 @smallexample
7054 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7055 @end smallexample
7057 will output the following command-line options from the following input
7058 command-line options:
7060 @smallexample
7061 fred.c        -foo -baz
7062 jim.d         -bar -boggle
7063 -d fred.c     -foo -baz -boggle
7064 -d jim.d      -bar -baz -boggle
7065 @end smallexample
7067 @item %@{S:X; T:Y; :D@}
7069 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7070 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7071 be as many clauses as you need.  This may be combined with @code{.},
7072 @code{!}, @code{|}, and @code{*} as needed.
7075 @end table
7077 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7078 construct may contain other nested @samp{%} constructs or spaces, or
7079 even newlines.  They are processed as usual, as described above.
7080 Trailing white space in @code{X} is ignored.  White space may also
7081 appear anywhere on the left side of the colon in these constructs,
7082 except between @code{.} or @code{*} and the corresponding word.
7084 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7085 handled specifically in these constructs.  If another value of
7086 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7087 @option{-W} switch is found later in the command line, the earlier
7088 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7089 just one letter, which passes all matching options.
7091 The character @samp{|} at the beginning of the predicate text is used to
7092 indicate that a command should be piped to the following command, but
7093 only if @option{-pipe} is specified.
7095 It is built into GCC which switches take arguments and which do not.
7096 (You might think it would be useful to generalize this to allow each
7097 compiler's spec to say which switches take arguments.  But this cannot
7098 be done in a consistent fashion.  GCC cannot even decide which input
7099 files have been specified without knowing which switches take arguments,
7100 and it must know which input files to compile in order to tell which
7101 compilers to run).
7103 GCC also knows implicitly that arguments starting in @option{-l} are to be
7104 treated as compiler output files, and passed to the linker in their
7105 proper position among the other output files.
7107 @c man begin OPTIONS
7109 @node Target Options
7110 @section Specifying Target Machine and Compiler Version
7111 @cindex target options
7112 @cindex cross compiling
7113 @cindex specifying machine version
7114 @cindex specifying compiler version and target machine
7115 @cindex compiler version, specifying
7116 @cindex target machine, specifying
7118 The usual way to run GCC is to run the executable called @file{gcc}, or
7119 @file{<machine>-gcc} when cross-compiling, or
7120 @file{<machine>-gcc-<version>} to run a version other than the one that
7121 was installed last.  Sometimes this is inconvenient, so GCC provides
7122 options that will switch to another cross-compiler or version.
7124 @table @gcctabopt
7125 @item -b @var{machine}
7126 @opindex b
7127 The argument @var{machine} specifies the target machine for compilation.
7129 The value to use for @var{machine} is the same as was specified as the
7130 machine type when configuring GCC as a cross-compiler.  For
7131 example, if a cross-compiler was configured with @samp{configure
7132 arm-elf}, meaning to compile for an arm processor with elf binaries,
7133 then you would specify @option{-b arm-elf} to run that cross compiler.
7134 Because there are other options beginning with @option{-b}, the
7135 configuration must contain a hyphen. 
7137 @item -V @var{version}
7138 @opindex V
7139 The argument @var{version} specifies which version of GCC to run.
7140 This is useful when multiple versions are installed.  For example,
7141 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7142 @end table
7144 The @option{-V} and @option{-b} options work by running the
7145 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7146 use them if you can just run that directly.
7148 @node Submodel Options
7149 @section Hardware Models and Configurations
7150 @cindex submodel options
7151 @cindex specifying hardware config
7152 @cindex hardware models and configurations, specifying
7153 @cindex machine dependent options
7155 Earlier we discussed the standard option @option{-b} which chooses among
7156 different installed compilers for completely different target
7157 machines, such as VAX vs.@: 68000 vs.@: 80386.
7159 In addition, each of these target machine types can have its own
7160 special options, starting with @samp{-m}, to choose among various
7161 hardware models or configurations---for example, 68010 vs 68020,
7162 floating coprocessor or none.  A single installed version of the
7163 compiler can compile for any model or configuration, according to the
7164 options specified.
7166 Some configurations of the compiler also support additional special
7167 options, usually for compatibility with other compilers on the same
7168 platform.
7170 @c This list is ordered alphanumerically by subsection name.
7171 @c It should be the same order and spelling as these options are listed
7172 @c in Machine Dependent Options
7174 @menu
7175 * ARC Options::
7176 * ARM Options::
7177 * AVR Options::
7178 * Blackfin Options::
7179 * CRIS Options::
7180 * CRX Options::
7181 * Darwin Options::
7182 * DEC Alpha Options::
7183 * DEC Alpha/VMS Options::
7184 * FRV Options::
7185 * H8/300 Options::
7186 * HPPA Options::
7187 * i386 and x86-64 Options::
7188 * IA-64 Options::
7189 * M32C Options::
7190 * M32R/D Options::
7191 * M680x0 Options::
7192 * M68hc1x Options::
7193 * MCore Options::
7194 * MIPS Options::
7195 * MMIX Options::
7196 * MN10300 Options::
7197 * MT Options::
7198 * PDP-11 Options::
7199 * PowerPC Options::
7200 * RS/6000 and PowerPC Options::
7201 * S/390 and zSeries Options::
7202 * SH Options::
7203 * SPARC Options::
7204 * System V Options::
7205 * TMS320C3x/C4x Options::
7206 * V850 Options::
7207 * VAX Options::
7208 * x86-64 Options::
7209 * Xstormy16 Options::
7210 * Xtensa Options::
7211 * zSeries Options::
7212 @end menu
7214 @node ARC Options
7215 @subsection ARC Options
7216 @cindex ARC Options
7218 These options are defined for ARC implementations:
7220 @table @gcctabopt
7221 @item -EL
7222 @opindex EL
7223 Compile code for little endian mode.  This is the default.
7225 @item -EB
7226 @opindex EB
7227 Compile code for big endian mode.
7229 @item -mmangle-cpu
7230 @opindex mmangle-cpu
7231 Prepend the name of the cpu to all public symbol names.
7232 In multiple-processor systems, there are many ARC variants with different
7233 instruction and register set characteristics.  This flag prevents code
7234 compiled for one cpu to be linked with code compiled for another.
7235 No facility exists for handling variants that are ``almost identical''.
7236 This is an all or nothing option.
7238 @item -mcpu=@var{cpu}
7239 @opindex mcpu
7240 Compile code for ARC variant @var{cpu}.
7241 Which variants are supported depend on the configuration.
7242 All variants support @option{-mcpu=base}, this is the default.
7244 @item -mtext=@var{text-section}
7245 @itemx -mdata=@var{data-section}
7246 @itemx -mrodata=@var{readonly-data-section}
7247 @opindex mtext
7248 @opindex mdata
7249 @opindex mrodata
7250 Put functions, data, and readonly data in @var{text-section},
7251 @var{data-section}, and @var{readonly-data-section} respectively
7252 by default.  This can be overridden with the @code{section} attribute.
7253 @xref{Variable Attributes}.
7255 @end table
7257 @node ARM Options
7258 @subsection ARM Options
7259 @cindex ARM options
7261 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7262 architectures:
7264 @table @gcctabopt
7265 @item -mabi=@var{name}
7266 @opindex mabi
7267 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7268 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7270 @item -mapcs-frame
7271 @opindex mapcs-frame
7272 Generate a stack frame that is compliant with the ARM Procedure Call
7273 Standard for all functions, even if this is not strictly necessary for
7274 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7275 with this option will cause the stack frames not to be generated for
7276 leaf functions.  The default is @option{-mno-apcs-frame}.
7278 @item -mapcs
7279 @opindex mapcs
7280 This is a synonym for @option{-mapcs-frame}.
7282 @ignore
7283 @c not currently implemented
7284 @item -mapcs-stack-check
7285 @opindex mapcs-stack-check
7286 Generate code to check the amount of stack space available upon entry to
7287 every function (that actually uses some stack space).  If there is
7288 insufficient space available then either the function
7289 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7290 called, depending upon the amount of stack space required.  The run time
7291 system is required to provide these functions.  The default is
7292 @option{-mno-apcs-stack-check}, since this produces smaller code.
7294 @c not currently implemented
7295 @item -mapcs-float
7296 @opindex mapcs-float
7297 Pass floating point arguments using the float point registers.  This is
7298 one of the variants of the APCS@.  This option is recommended if the
7299 target hardware has a floating point unit or if a lot of floating point
7300 arithmetic is going to be performed by the code.  The default is
7301 @option{-mno-apcs-float}, since integer only code is slightly increased in
7302 size if @option{-mapcs-float} is used.
7304 @c not currently implemented
7305 @item -mapcs-reentrant
7306 @opindex mapcs-reentrant
7307 Generate reentrant, position independent code.  The default is
7308 @option{-mno-apcs-reentrant}.
7309 @end ignore
7311 @item -mthumb-interwork
7312 @opindex mthumb-interwork
7313 Generate code which supports calling between the ARM and Thumb
7314 instruction sets.  Without this option the two instruction sets cannot
7315 be reliably used inside one program.  The default is
7316 @option{-mno-thumb-interwork}, since slightly larger code is generated
7317 when @option{-mthumb-interwork} is specified.
7319 @item -mno-sched-prolog
7320 @opindex mno-sched-prolog
7321 Prevent the reordering of instructions in the function prolog, or the
7322 merging of those instruction with the instructions in the function's
7323 body.  This means that all functions will start with a recognizable set
7324 of instructions (or in fact one of a choice from a small set of
7325 different function prologues), and this information can be used to
7326 locate the start if functions inside an executable piece of code.  The
7327 default is @option{-msched-prolog}.
7329 @item -mhard-float
7330 @opindex mhard-float
7331 Generate output containing floating point instructions.  This is the
7332 default.
7334 @item -msoft-float
7335 @opindex msoft-float
7336 Generate output containing library calls for floating point.
7337 @strong{Warning:} the requisite libraries are not available for all ARM
7338 targets.  Normally the facilities of the machine's usual C compiler are
7339 used, but this cannot be done directly in cross-compilation.  You must make
7340 your own arrangements to provide suitable library functions for
7341 cross-compilation.
7343 @option{-msoft-float} changes the calling convention in the output file;
7344 therefore, it is only useful if you compile @emph{all} of a program with
7345 this option.  In particular, you need to compile @file{libgcc.a}, the
7346 library that comes with GCC, with @option{-msoft-float} in order for
7347 this to work.
7349 @item -mfloat-abi=@var{name}
7350 @opindex mfloat-abi
7351 Specifies which ABI to use for floating point values.  Permissible values
7352 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7354 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7355 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7356 of floating point instructions, but still uses the soft-float calling
7357 conventions.
7359 @item -mlittle-endian
7360 @opindex mlittle-endian
7361 Generate code for a processor running in little-endian mode.  This is
7362 the default for all standard configurations.
7364 @item -mbig-endian
7365 @opindex mbig-endian
7366 Generate code for a processor running in big-endian mode; the default is
7367 to compile code for a little-endian processor.
7369 @item -mwords-little-endian
7370 @opindex mwords-little-endian
7371 This option only applies when generating code for big-endian processors.
7372 Generate code for a little-endian word order but a big-endian byte
7373 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7374 option should only be used if you require compatibility with code for
7375 big-endian ARM processors generated by versions of the compiler prior to
7376 2.8.
7378 @item -mcpu=@var{name}
7379 @opindex mcpu
7380 This specifies the name of the target ARM processor.  GCC uses this name
7381 to determine what kind of instructions it can emit when generating
7382 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7383 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7384 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7385 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7386 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7387 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7388 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7389 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7390 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7391 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7392 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7393 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7394 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7395 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7396 @samp{ep9312}.
7398 @itemx -mtune=@var{name}
7399 @opindex mtune
7400 This option is very similar to the @option{-mcpu=} option, except that
7401 instead of specifying the actual target processor type, and hence
7402 restricting which instructions can be used, it specifies that GCC should
7403 tune the performance of the code as if the target were of the type
7404 specified in this option, but still choosing the instructions that it
7405 will generate based on the cpu specified by a @option{-mcpu=} option.
7406 For some ARM implementations better performance can be obtained by using
7407 this option.
7409 @item -march=@var{name}
7410 @opindex march
7411 This specifies the name of the target ARM architecture.  GCC uses this
7412 name to determine what kind of instructions it can emit when generating
7413 assembly code.  This option can be used in conjunction with or instead
7414 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7415 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7416 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7417 @samp{iwmmxt}, @samp{ep9312}.
7419 @item -mfpu=@var{name}
7420 @itemx -mfpe=@var{number}
7421 @itemx -mfp=@var{number}
7422 @opindex mfpu
7423 @opindex mfpe
7424 @opindex mfp
7425 This specifies what floating point hardware (or hardware emulation) is
7426 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7427 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7428 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7429 with older versions of GCC@.
7431 If @option{-msoft-float} is specified this specifies the format of
7432 floating point values.
7434 @item -mstructure-size-boundary=@var{n}
7435 @opindex mstructure-size-boundary
7436 The size of all structures and unions will be rounded up to a multiple
7437 of the number of bits set by this option.  Permissible values are 8, 32
7438 and 64.  The default value varies for different toolchains.  For the COFF
7439 targeted toolchain the default value is 8.  A value of 64 is only allowed
7440 if the underlying ABI supports it.
7442 Specifying the larger number can produce faster, more efficient code, but
7443 can also increase the size of the program.  Different values are potentially
7444 incompatible.  Code compiled with one value cannot necessarily expect to
7445 work with code or libraries compiled with another value, if they exchange
7446 information using structures or unions.
7448 @item -mabort-on-noreturn
7449 @opindex mabort-on-noreturn
7450 Generate a call to the function @code{abort} at the end of a
7451 @code{noreturn} function.  It will be executed if the function tries to
7452 return.
7454 @item -mlong-calls
7455 @itemx -mno-long-calls
7456 @opindex mlong-calls
7457 @opindex mno-long-calls
7458 Tells the compiler to perform function calls by first loading the
7459 address of the function into a register and then performing a subroutine
7460 call on this register.  This switch is needed if the target function
7461 will lie outside of the 64 megabyte addressing range of the offset based
7462 version of subroutine call instruction.
7464 Even if this switch is enabled, not all function calls will be turned
7465 into long calls.  The heuristic is that static functions, functions
7466 which have the @samp{short-call} attribute, functions that are inside
7467 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7468 definitions have already been compiled within the current compilation
7469 unit, will not be turned into long calls.  The exception to this rule is
7470 that weak function definitions, functions with the @samp{long-call}
7471 attribute or the @samp{section} attribute, and functions that are within
7472 the scope of a @samp{#pragma long_calls} directive, will always be
7473 turned into long calls.
7475 This feature is not enabled by default.  Specifying
7476 @option{-mno-long-calls} will restore the default behavior, as will
7477 placing the function calls within the scope of a @samp{#pragma
7478 long_calls_off} directive.  Note these switches have no effect on how
7479 the compiler generates code to handle function calls via function
7480 pointers.
7482 @item -mnop-fun-dllimport
7483 @opindex mnop-fun-dllimport
7484 Disable support for the @code{dllimport} attribute.
7486 @item -msingle-pic-base
7487 @opindex msingle-pic-base
7488 Treat the register used for PIC addressing as read-only, rather than
7489 loading it in the prologue for each function.  The run-time system is
7490 responsible for initializing this register with an appropriate value
7491 before execution begins.
7493 @item -mpic-register=@var{reg}
7494 @opindex mpic-register
7495 Specify the register to be used for PIC addressing.  The default is R10
7496 unless stack-checking is enabled, when R9 is used.
7498 @item -mcirrus-fix-invalid-insns
7499 @opindex mcirrus-fix-invalid-insns
7500 @opindex mno-cirrus-fix-invalid-insns
7501 Insert NOPs into the instruction stream to in order to work around
7502 problems with invalid Maverick instruction combinations.  This option
7503 is only valid if the @option{-mcpu=ep9312} option has been used to
7504 enable generation of instructions for the Cirrus Maverick floating
7505 point co-processor.  This option is not enabled by default, since the
7506 problem is only present in older Maverick implementations.  The default
7507 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7508 switch.
7510 @item -mpoke-function-name
7511 @opindex mpoke-function-name
7512 Write the name of each function into the text section, directly
7513 preceding the function prologue.  The generated code is similar to this:
7515 @smallexample
7516      t0
7517          .ascii "arm_poke_function_name", 0
7518          .align
7519      t1
7520          .word 0xff000000 + (t1 - t0)
7521      arm_poke_function_name
7522          mov     ip, sp
7523          stmfd   sp!, @{fp, ip, lr, pc@}
7524          sub     fp, ip, #4
7525 @end smallexample
7527 When performing a stack backtrace, code can inspect the value of
7528 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7529 location @code{pc - 12} and the top 8 bits are set, then we know that
7530 there is a function name embedded immediately preceding this location
7531 and has length @code{((pc[-3]) & 0xff000000)}.
7533 @item -mthumb
7534 @opindex mthumb
7535 Generate code for the 16-bit Thumb instruction set.  The default is to
7536 use the 32-bit ARM instruction set.
7538 @item -mtpcs-frame
7539 @opindex mtpcs-frame
7540 Generate a stack frame that is compliant with the Thumb Procedure Call
7541 Standard for all non-leaf functions.  (A leaf function is one that does
7542 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7544 @item -mtpcs-leaf-frame
7545 @opindex mtpcs-leaf-frame
7546 Generate a stack frame that is compliant with the Thumb Procedure Call
7547 Standard for all leaf functions.  (A leaf function is one that does
7548 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7550 @item -mcallee-super-interworking
7551 @opindex mcallee-super-interworking
7552 Gives all externally visible functions in the file being compiled an ARM
7553 instruction set header which switches to Thumb mode before executing the
7554 rest of the function.  This allows these functions to be called from
7555 non-interworking code.
7557 @item -mcaller-super-interworking
7558 @opindex mcaller-super-interworking
7559 Allows calls via function pointers (including virtual functions) to
7560 execute correctly regardless of whether the target code has been
7561 compiled for interworking or not.  There is a small overhead in the cost
7562 of executing a function pointer if this option is enabled.
7564 @item -mtp=@var{name}
7565 @opindex mtp
7566 Specify the access model for the thread local storage pointer.  The valid
7567 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7568 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7569 (supported in the arm6k architecture), and @option{auto}, which uses the
7570 best available method for the selected processor.  The default setting is
7571 @option{auto}.
7573 @end table
7575 @node AVR Options
7576 @subsection AVR Options
7577 @cindex AVR Options
7579 These options are defined for AVR implementations:
7581 @table @gcctabopt
7582 @item -mmcu=@var{mcu}
7583 @opindex mmcu
7584 Specify ATMEL AVR instruction set or MCU type.
7586 Instruction set avr1 is for the minimal AVR core, not supported by the C
7587 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7588 attiny11, attiny12, attiny15, attiny28).
7590 Instruction set avr2 (default) is for the classic AVR core with up to
7591 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7592 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7593 at90c8534, at90s8535).
7595 Instruction set avr3 is for the classic AVR core with up to 128K program
7596 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7598 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7599 memory space (MCU types: atmega8, atmega83, atmega85).
7601 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7602 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7603 atmega64, atmega128, at43usb355, at94k).
7605 @item -msize
7606 @opindex msize
7607 Output instruction sizes to the asm file.
7609 @item -minit-stack=@var{N}
7610 @opindex minit-stack
7611 Specify the initial stack address, which may be a symbol or numeric value,
7612 @samp{__stack} is the default.
7614 @item -mno-interrupts
7615 @opindex mno-interrupts
7616 Generated code is not compatible with hardware interrupts.
7617 Code size will be smaller.
7619 @item -mcall-prologues
7620 @opindex mcall-prologues
7621 Functions prologues/epilogues expanded as call to appropriate
7622 subroutines.  Code size will be smaller.
7624 @item -mno-tablejump
7625 @opindex mno-tablejump
7626 Do not generate tablejump insns which sometimes increase code size.
7628 @item -mtiny-stack
7629 @opindex mtiny-stack
7630 Change only the low 8 bits of the stack pointer.
7632 @item -mint8
7633 @opindex mint8
7634 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7635 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7636 and long long will be 4 bytes.  Please note that this option does not
7637 comply to the C standards, but it will provide you with smaller code
7638 size.
7639 @end table
7641 @node Blackfin Options
7642 @subsection Blackfin Options
7643 @cindex Blackfin Options
7645 @table @gcctabopt
7646 @item -momit-leaf-frame-pointer
7647 @opindex momit-leaf-frame-pointer
7648 Don't keep the frame pointer in a register for leaf functions.  This
7649 avoids the instructions to save, set up and restore frame pointers and
7650 makes an extra register available in leaf functions.  The option
7651 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7652 which might make debugging harder.
7654 @item -mspecld-anomaly
7655 @opindex mspecld-anomaly
7656 When enabled, the compiler will ensure that the generated code does not
7657 contain speculative loads after jump instructions.  This option is enabled
7658 by default.
7660 @item -mno-specld-anomaly
7661 @opindex mno-specld-anomaly
7662 Don't generate extra code to prevent speculative loads from occurring.
7664 @item -mcsync-anomaly
7665 @opindex mcsync-anomaly
7666 When enabled, the compiler will ensure that the generated code does not
7667 contain CSYNC or SSYNC instructions too soon after conditional branches.
7668 This option is enabled by default.
7670 @item -mno-csync-anomaly
7671 @opindex mno-csync-anomaly
7672 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7673 occurring too soon after a conditional branch.
7675 @item -mlow-64k
7676 @opindex mlow-64k
7677 When enabled, the compiler is free to take advantage of the knowledge that
7678 the entire program fits into the low 64k of memory.
7680 @item -mno-low-64k
7681 @opindex mno-low-64k
7682 Assume that the program is arbitrarily large.  This is the default.
7684 @item -mid-shared-library
7685 @opindex mid-shared-library
7686 Generate code that supports shared libraries via the library ID method.
7687 This allows for execute in place and shared libraries in an environment
7688 without virtual memory management.  This option implies @option{-fPIC}.
7690 @item -mno-id-shared-library
7691 @opindex mno-id-shared-library
7692 Generate code that doesn't assume ID based shared libraries are being used.
7693 This is the default.
7695 @item -mshared-library-id=n
7696 @opindex mshared-library-id
7697 Specified the identification number of the ID based shared library being
7698 compiled.  Specifying a value of 0 will generate more compact code, specifying
7699 other values will force the allocation of that number to the current
7700 library but is no more space or time efficient than omitting this option.
7702 @item -mlong-calls
7703 @itemx -mno-long-calls
7704 @opindex mlong-calls
7705 @opindex mno-long-calls
7706 Tells the compiler to perform function calls by first loading the
7707 address of the function into a register and then performing a subroutine
7708 call on this register.  This switch is needed if the target function
7709 will lie outside of the 24 bit addressing range of the offset based
7710 version of subroutine call instruction.
7712 This feature is not enabled by default.  Specifying
7713 @option{-mno-long-calls} will restore the default behavior.  Note these
7714 switches have no effect on how the compiler generates code to handle
7715 function calls via function pointers.
7716 @end table
7718 @node CRIS Options
7719 @subsection CRIS Options
7720 @cindex CRIS Options
7722 These options are defined specifically for the CRIS ports.
7724 @table @gcctabopt
7725 @item -march=@var{architecture-type}
7726 @itemx -mcpu=@var{architecture-type}
7727 @opindex march
7728 @opindex mcpu
7729 Generate code for the specified architecture.  The choices for
7730 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7731 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7732 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7733 @samp{v10}.
7735 @item -mtune=@var{architecture-type}
7736 @opindex mtune
7737 Tune to @var{architecture-type} everything applicable about the generated
7738 code, except for the ABI and the set of available instructions.  The
7739 choices for @var{architecture-type} are the same as for
7740 @option{-march=@var{architecture-type}}.
7742 @item -mmax-stack-frame=@var{n}
7743 @opindex mmax-stack-frame
7744 Warn when the stack frame of a function exceeds @var{n} bytes.
7746 @item -melinux-stacksize=@var{n}
7747 @opindex melinux-stacksize
7748 Only available with the @samp{cris-axis-aout} target.  Arranges for
7749 indications in the program to the kernel loader that the stack of the
7750 program should be set to @var{n} bytes.
7752 @item -metrax4
7753 @itemx -metrax100
7754 @opindex metrax4
7755 @opindex metrax100
7756 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7757 @option{-march=v3} and @option{-march=v8} respectively.
7759 @item -mmul-bug-workaround
7760 @itemx -mno-mul-bug-workaround
7761 @opindex mmul-bug-workaround
7762 @opindex mno-mul-bug-workaround
7763 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7764 models where it applies.  This option is active by default.
7766 @item -mpdebug
7767 @opindex mpdebug
7768 Enable CRIS-specific verbose debug-related information in the assembly
7769 code.  This option also has the effect to turn off the @samp{#NO_APP}
7770 formatted-code indicator to the assembler at the beginning of the
7771 assembly file.
7773 @item -mcc-init
7774 @opindex mcc-init
7775 Do not use condition-code results from previous instruction; always emit
7776 compare and test instructions before use of condition codes.
7778 @item -mno-side-effects
7779 @opindex mno-side-effects
7780 Do not emit instructions with side-effects in addressing modes other than
7781 post-increment.
7783 @item -mstack-align
7784 @itemx -mno-stack-align
7785 @itemx -mdata-align
7786 @itemx -mno-data-align
7787 @itemx -mconst-align
7788 @itemx -mno-const-align
7789 @opindex mstack-align
7790 @opindex mno-stack-align
7791 @opindex mdata-align
7792 @opindex mno-data-align
7793 @opindex mconst-align
7794 @opindex mno-const-align
7795 These options (no-options) arranges (eliminate arrangements) for the
7796 stack-frame, individual data and constants to be aligned for the maximum
7797 single data access size for the chosen CPU model.  The default is to
7798 arrange for 32-bit alignment.  ABI details such as structure layout are
7799 not affected by these options.
7801 @item -m32-bit
7802 @itemx -m16-bit
7803 @itemx -m8-bit
7804 @opindex m32-bit
7805 @opindex m16-bit
7806 @opindex m8-bit
7807 Similar to the stack- data- and const-align options above, these options
7808 arrange for stack-frame, writable data and constants to all be 32-bit,
7809 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7811 @item -mno-prologue-epilogue
7812 @itemx -mprologue-epilogue
7813 @opindex mno-prologue-epilogue
7814 @opindex mprologue-epilogue
7815 With @option{-mno-prologue-epilogue}, the normal function prologue and
7816 epilogue that sets up the stack-frame are omitted and no return
7817 instructions or return sequences are generated in the code.  Use this
7818 option only together with visual inspection of the compiled code: no
7819 warnings or errors are generated when call-saved registers must be saved,
7820 or storage for local variable needs to be allocated.
7822 @item -mno-gotplt
7823 @itemx -mgotplt
7824 @opindex mno-gotplt
7825 @opindex mgotplt
7826 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7827 instruction sequences that load addresses for functions from the PLT part
7828 of the GOT rather than (traditional on other architectures) calls to the
7829 PLT@.  The default is @option{-mgotplt}.
7831 @item -maout
7832 @opindex maout
7833 Legacy no-op option only recognized with the cris-axis-aout target.
7835 @item -melf
7836 @opindex melf
7837 Legacy no-op option only recognized with the cris-axis-elf and
7838 cris-axis-linux-gnu targets.
7840 @item -melinux
7841 @opindex melinux
7842 Only recognized with the cris-axis-aout target, where it selects a
7843 GNU/linux-like multilib, include files and instruction set for
7844 @option{-march=v8}.
7846 @item -mlinux
7847 @opindex mlinux
7848 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7850 @item -sim
7851 @opindex sim
7852 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7853 to link with input-output functions from a simulator library.  Code,
7854 initialized data and zero-initialized data are allocated consecutively.
7856 @item -sim2
7857 @opindex sim2
7858 Like @option{-sim}, but pass linker options to locate initialized data at
7859 0x40000000 and zero-initialized data at 0x80000000.
7860 @end table
7862 @node CRX Options
7863 @subsection CRX Options
7864 @cindex CRX Options
7866 These options are defined specifically for the CRX ports.
7868 @table @gcctabopt
7870 @item -mmac
7871 @opindex mmac
7872 Enable the use of multiply-accumulate instructions.  Disabled by default.
7874 @item -mpush-args
7875 @opindex mpush-args
7876 Push instructions will be used to pass outgoing arguments when functions
7877 are called.  Enabled by default.
7878 @end table
7880 @node Darwin Options
7881 @subsection Darwin Options
7882 @cindex Darwin options
7884 These options are defined for all architectures running the Darwin operating
7885 system.
7887 FSF GCC on Darwin does not create ``fat'' object files; it will create
7888 an object file for the single architecture that it was built to
7889 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7890 @option{-arch} options are used; it does so by running the compiler or
7891 linker multiple times and joining the results together with
7892 @file{lipo}.
7894 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7895 @samp{i686}) is determined by the flags that specify the ISA
7896 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7897 @option{-force_cpusubtype_ALL} option can be used to override this.
7899 The Darwin tools vary in their behavior when presented with an ISA
7900 mismatch.  The assembler, @file{as}, will only permit instructions to
7901 be used that are valid for the subtype of the file it is generating,
7902 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7903 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7904 and print an error if asked to create a shared library with a less
7905 restrictive subtype than its input files (for instance, trying to put
7906 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7907 for executables, @file{ld}, will quietly give the executable the most
7908 restrictive subtype of any of its input files.
7910 @table @gcctabopt
7911 @item -F@var{dir}
7912 @opindex F
7913 Add the framework directory @var{dir} to the head of the list of
7914 directories to be searched for header files.  These directories are
7915 interleaved with those specified by @option{-I} options and are
7916 scanned in a left-to-right order.
7918 A framework directory is a directory with frameworks in it.  A
7919 framework is a directory with a @samp{"Headers"} and/or
7920 @samp{"PrivateHeaders"} directory contained directly in it that ends
7921 in @samp{".framework"}.  The name of a framework is the name of this
7922 directory excluding the @samp{".framework"}.  Headers associated with
7923 the framework are found in one of those two directories, with
7924 @samp{"Headers"} being searched first.  A subframework is a framework
7925 directory that is in a framework's @samp{"Frameworks"} directory.
7926 Includes of subframework headers can only appear in a header of a
7927 framework that contains the subframework, or in a sibling subframework
7928 header.  Two subframeworks are siblings if they occur in the same
7929 framework.  A subframework should not have the same name as a
7930 framework, a warning will be issued if this is violated.  Currently a
7931 subframework cannot have subframeworks, in the future, the mechanism
7932 may be extended to support this.  The standard frameworks can be found
7933 in @samp{"/System/Library/Frameworks"} and
7934 @samp{"/Library/Frameworks"}.  An example include looks like
7935 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7936 the name of the framework and header.h is found in the
7937 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7939 @item -gused
7940 @opindex -gused
7941 Emit debugging information for symbols that are used.  For STABS
7942 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7943 This is by default ON@.
7945 @item -gfull
7946 @opindex -gfull
7947 Emit debugging information for all symbols and types.
7949 @item -mmacosx-version-min=@var{version}
7950 The earliest version of MacOS X that this executable will run on
7951 is @var{version}.  Typical values of @var{version} include @code{10.1},
7952 @code{10.2}, and @code{10.3.9}.
7954 The default for this option is to make choices that seem to be most
7955 useful.  
7957 @item -mone-byte-bool
7958 @opindex -mone-byte-bool
7959 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7960 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7961 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7962 option has no effect on x86.
7964 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7965 to generate code that is not binary compatible with code generated
7966 without that switch.  Using this switch may require recompiling all
7967 other modules in a program, including system libraries.  Use this
7968 switch to conform to a non-default data model.
7970 @item -mfix-and-continue
7971 @itemx -ffix-and-continue
7972 @itemx -findirect-data
7973 @opindex mfix-and-continue
7974 @opindex ffix-and-continue
7975 @opindex findirect-data
7976 Generate code suitable for fast turn around development.  Needed to
7977 enable gdb to dynamically load @code{.o} files into already running
7978 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7979 are provided for backwards compatibility.
7981 @item -all_load
7982 @opindex all_load
7983 Loads all members of static archive libraries.
7984 See man ld(1) for more information.
7986 @item -arch_errors_fatal
7987 @opindex arch_errors_fatal
7988 Cause the errors having to do with files that have the wrong architecture
7989 to be fatal.
7991 @item -bind_at_load
7992 @opindex bind_at_load
7993 Causes the output file to be marked such that the dynamic linker will
7994 bind all undefined references when the file is loaded or launched.
7996 @item -bundle
7997 @opindex bundle
7998 Produce a Mach-o bundle format file.
7999 See man ld(1) for more information.
8001 @item -bundle_loader @var{executable}
8002 @opindex bundle_loader
8003 This option specifies the @var{executable} that will be loading the build
8004 output file being linked.  See man ld(1) for more information.
8006 @item -dynamiclib
8007 @opindex -dynamiclib
8008 When passed this option, GCC will produce a dynamic library instead of
8009 an executable when linking, using the Darwin @file{libtool} command.
8011 @item -force_cpusubtype_ALL
8012 @opindex -force_cpusubtype_ALL
8013 This causes GCC's output file to have the @var{ALL} subtype, instead of
8014 one controlled by the @option{-mcpu} or @option{-march} option.
8016 @item -allowable_client  @var{client_name}
8017 @itemx -client_name
8018 @itemx -compatibility_version
8019 @itemx -current_version
8020 @itemx -dead_strip
8021 @itemx -dependency-file
8022 @itemx -dylib_file
8023 @itemx -dylinker_install_name
8024 @itemx -dynamic
8025 @itemx -exported_symbols_list
8026 @itemx -filelist
8027 @itemx -flat_namespace
8028 @itemx -force_flat_namespace
8029 @itemx -headerpad_max_install_names
8030 @itemx -image_base
8031 @itemx -init
8032 @itemx -install_name
8033 @itemx -keep_private_externs
8034 @itemx -multi_module
8035 @itemx -multiply_defined
8036 @itemx -multiply_defined_unused
8037 @itemx -noall_load
8038 @itemx -no_dead_strip_inits_and_terms
8039 @itemx -nofixprebinding
8040 @itemx -nomultidefs
8041 @itemx -noprebind
8042 @itemx -noseglinkedit
8043 @itemx -pagezero_size
8044 @itemx -prebind
8045 @itemx -prebind_all_twolevel_modules
8046 @itemx -private_bundle
8047 @itemx -read_only_relocs
8048 @itemx -sectalign
8049 @itemx -sectobjectsymbols
8050 @itemx -whyload
8051 @itemx -seg1addr
8052 @itemx -sectcreate
8053 @itemx -sectobjectsymbols
8054 @itemx -sectorder
8055 @itemx -segaddr
8056 @itemx -segs_read_only_addr
8057 @itemx -segs_read_write_addr
8058 @itemx -seg_addr_table
8059 @itemx -seg_addr_table_filename
8060 @itemx -seglinkedit
8061 @itemx -segprot
8062 @itemx -segs_read_only_addr
8063 @itemx -segs_read_write_addr
8064 @itemx -single_module
8065 @itemx -static
8066 @itemx -sub_library
8067 @itemx -sub_umbrella
8068 @itemx -twolevel_namespace
8069 @itemx -umbrella
8070 @itemx -undefined
8071 @itemx -unexported_symbols_list
8072 @itemx -weak_reference_mismatches
8073 @itemx -whatsloaded
8075 @opindex allowable_client
8076 @opindex client_name
8077 @opindex compatibility_version
8078 @opindex current_version
8079 @opindex dead_strip
8080 @opindex dependency-file
8081 @opindex dylib_file
8082 @opindex dylinker_install_name
8083 @opindex dynamic
8084 @opindex exported_symbols_list
8085 @opindex filelist
8086 @opindex flat_namespace
8087 @opindex force_flat_namespace
8088 @opindex headerpad_max_install_names
8089 @opindex image_base
8090 @opindex init
8091 @opindex install_name
8092 @opindex keep_private_externs
8093 @opindex multi_module
8094 @opindex multiply_defined
8095 @opindex multiply_defined_unused
8096 @opindex noall_load
8097 @opindex no_dead_strip_inits_and_terms
8098 @opindex nofixprebinding
8099 @opindex nomultidefs
8100 @opindex noprebind
8101 @opindex noseglinkedit
8102 @opindex pagezero_size
8103 @opindex prebind
8104 @opindex prebind_all_twolevel_modules
8105 @opindex private_bundle
8106 @opindex read_only_relocs
8107 @opindex sectalign
8108 @opindex sectobjectsymbols
8109 @opindex whyload
8110 @opindex seg1addr
8111 @opindex sectcreate
8112 @opindex sectobjectsymbols
8113 @opindex sectorder
8114 @opindex segaddr
8115 @opindex segs_read_only_addr
8116 @opindex segs_read_write_addr
8117 @opindex seg_addr_table
8118 @opindex seg_addr_table_filename
8119 @opindex seglinkedit
8120 @opindex segprot
8121 @opindex segs_read_only_addr
8122 @opindex segs_read_write_addr
8123 @opindex single_module
8124 @opindex static
8125 @opindex sub_library
8126 @opindex sub_umbrella
8127 @opindex twolevel_namespace
8128 @opindex umbrella
8129 @opindex undefined
8130 @opindex unexported_symbols_list
8131 @opindex weak_reference_mismatches
8132 @opindex whatsloaded
8134 These options are passed to the Darwin linker.  The Darwin linker man page
8135 describes them in detail.
8136 @end table
8138 @node DEC Alpha Options
8139 @subsection DEC Alpha Options
8141 These @samp{-m} options are defined for the DEC Alpha implementations:
8143 @table @gcctabopt
8144 @item -mno-soft-float
8145 @itemx -msoft-float
8146 @opindex mno-soft-float
8147 @opindex msoft-float
8148 Use (do not use) the hardware floating-point instructions for
8149 floating-point operations.  When @option{-msoft-float} is specified,
8150 functions in @file{libgcc.a} will be used to perform floating-point
8151 operations.  Unless they are replaced by routines that emulate the
8152 floating-point operations, or compiled in such a way as to call such
8153 emulations routines, these routines will issue floating-point
8154 operations.   If you are compiling for an Alpha without floating-point
8155 operations, you must ensure that the library is built so as not to call
8156 them.
8158 Note that Alpha implementations without floating-point operations are
8159 required to have floating-point registers.
8161 @item -mfp-reg
8162 @itemx -mno-fp-regs
8163 @opindex mfp-reg
8164 @opindex mno-fp-regs
8165 Generate code that uses (does not use) the floating-point register set.
8166 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8167 register set is not used, floating point operands are passed in integer
8168 registers as if they were integers and floating-point results are passed
8169 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8170 so any function with a floating-point argument or return value called by code
8171 compiled with @option{-mno-fp-regs} must also be compiled with that
8172 option.
8174 A typical use of this option is building a kernel that does not use,
8175 and hence need not save and restore, any floating-point registers.
8177 @item -mieee
8178 @opindex mieee
8179 The Alpha architecture implements floating-point hardware optimized for
8180 maximum performance.  It is mostly compliant with the IEEE floating
8181 point standard.  However, for full compliance, software assistance is
8182 required.  This option generates code fully IEEE compliant code
8183 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8184 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8185 defined during compilation.  The resulting code is less efficient but is
8186 able to correctly support denormalized numbers and exceptional IEEE
8187 values such as not-a-number and plus/minus infinity.  Other Alpha
8188 compilers call this option @option{-ieee_with_no_inexact}.
8190 @item -mieee-with-inexact
8191 @opindex mieee-with-inexact
8192 This is like @option{-mieee} except the generated code also maintains
8193 the IEEE @var{inexact-flag}.  Turning on this option causes the
8194 generated code to implement fully-compliant IEEE math.  In addition to
8195 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8196 macro.  On some Alpha implementations the resulting code may execute
8197 significantly slower than the code generated by default.  Since there is
8198 very little code that depends on the @var{inexact-flag}, you should
8199 normally not specify this option.  Other Alpha compilers call this
8200 option @option{-ieee_with_inexact}.
8202 @item -mfp-trap-mode=@var{trap-mode}
8203 @opindex mfp-trap-mode
8204 This option controls what floating-point related traps are enabled.
8205 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8206 The trap mode can be set to one of four values:
8208 @table @samp
8209 @item n
8210 This is the default (normal) setting.  The only traps that are enabled
8211 are the ones that cannot be disabled in software (e.g., division by zero
8212 trap).
8214 @item u
8215 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8216 as well.
8218 @item su
8219 Like @samp{su}, but the instructions are marked to be safe for software
8220 completion (see Alpha architecture manual for details).
8222 @item sui
8223 Like @samp{su}, but inexact traps are enabled as well.
8224 @end table
8226 @item -mfp-rounding-mode=@var{rounding-mode}
8227 @opindex mfp-rounding-mode
8228 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8229 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8232 @table @samp
8233 @item n
8234 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8235 the nearest machine number or towards the even machine number in case
8236 of a tie.
8238 @item m
8239 Round towards minus infinity.
8241 @item c
8242 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8244 @item d
8245 Dynamic rounding mode.  A field in the floating point control register
8246 (@var{fpcr}, see Alpha architecture reference manual) controls the
8247 rounding mode in effect.  The C library initializes this register for
8248 rounding towards plus infinity.  Thus, unless your program modifies the
8249 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8250 @end table
8252 @item -mtrap-precision=@var{trap-precision}
8253 @opindex mtrap-precision
8254 In the Alpha architecture, floating point traps are imprecise.  This
8255 means without software assistance it is impossible to recover from a
8256 floating trap and program execution normally needs to be terminated.
8257 GCC can generate code that can assist operating system trap handlers
8258 in determining the exact location that caused a floating point trap.
8259 Depending on the requirements of an application, different levels of
8260 precisions can be selected:
8262 @table @samp
8263 @item p
8264 Program precision.  This option is the default and means a trap handler
8265 can only identify which program caused a floating point exception.
8267 @item f
8268 Function precision.  The trap handler can determine the function that
8269 caused a floating point exception.
8271 @item i
8272 Instruction precision.  The trap handler can determine the exact
8273 instruction that caused a floating point exception.
8274 @end table
8276 Other Alpha compilers provide the equivalent options called
8277 @option{-scope_safe} and @option{-resumption_safe}.
8279 @item -mieee-conformant
8280 @opindex mieee-conformant
8281 This option marks the generated code as IEEE conformant.  You must not
8282 use this option unless you also specify @option{-mtrap-precision=i} and either
8283 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8284 is to emit the line @samp{.eflag 48} in the function prologue of the
8285 generated assembly file.  Under DEC Unix, this has the effect that
8286 IEEE-conformant math library routines will be linked in.
8288 @item -mbuild-constants
8289 @opindex mbuild-constants
8290 Normally GCC examines a 32- or 64-bit integer constant to
8291 see if it can construct it from smaller constants in two or three
8292 instructions.  If it cannot, it will output the constant as a literal and
8293 generate code to load it from the data segment at runtime.
8295 Use this option to require GCC to construct @emph{all} integer constants
8296 using code, even if it takes more instructions (the maximum is six).
8298 You would typically use this option to build a shared library dynamic
8299 loader.  Itself a shared library, it must relocate itself in memory
8300 before it can find the variables and constants in its own data segment.
8302 @item -malpha-as
8303 @itemx -mgas
8304 @opindex malpha-as
8305 @opindex mgas
8306 Select whether to generate code to be assembled by the vendor-supplied
8307 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8309 @item -mbwx
8310 @itemx -mno-bwx
8311 @itemx -mcix
8312 @itemx -mno-cix
8313 @itemx -mfix
8314 @itemx -mno-fix
8315 @itemx -mmax
8316 @itemx -mno-max
8317 @opindex mbwx
8318 @opindex mno-bwx
8319 @opindex mcix
8320 @opindex mno-cix
8321 @opindex mfix
8322 @opindex mno-fix
8323 @opindex mmax
8324 @opindex mno-max
8325 Indicate whether GCC should generate code to use the optional BWX,
8326 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8327 sets supported by the CPU type specified via @option{-mcpu=} option or that
8328 of the CPU on which GCC was built if none was specified.
8330 @item -mfloat-vax
8331 @itemx -mfloat-ieee
8332 @opindex mfloat-vax
8333 @opindex mfloat-ieee
8334 Generate code that uses (does not use) VAX F and G floating point
8335 arithmetic instead of IEEE single and double precision.
8337 @item -mexplicit-relocs
8338 @itemx -mno-explicit-relocs
8339 @opindex mexplicit-relocs
8340 @opindex mno-explicit-relocs
8341 Older Alpha assemblers provided no way to generate symbol relocations
8342 except via assembler macros.  Use of these macros does not allow
8343 optimal instruction scheduling.  GNU binutils as of version 2.12
8344 supports a new syntax that allows the compiler to explicitly mark
8345 which relocations should apply to which instructions.  This option
8346 is mostly useful for debugging, as GCC detects the capabilities of
8347 the assembler when it is built and sets the default accordingly.
8349 @item -msmall-data
8350 @itemx -mlarge-data
8351 @opindex msmall-data
8352 @opindex mlarge-data
8353 When @option{-mexplicit-relocs} is in effect, static data is
8354 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8355 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8356 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8357 16-bit relocations off of the @code{$gp} register.  This limits the
8358 size of the small data area to 64KB, but allows the variables to be
8359 directly accessed via a single instruction.
8361 The default is @option{-mlarge-data}.  With this option the data area
8362 is limited to just below 2GB@.  Programs that require more than 2GB of
8363 data must use @code{malloc} or @code{mmap} to allocate the data in the
8364 heap instead of in the program's data segment.
8366 When generating code for shared libraries, @option{-fpic} implies
8367 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8369 @item -msmall-text
8370 @itemx -mlarge-text
8371 @opindex msmall-text
8372 @opindex mlarge-text
8373 When @option{-msmall-text} is used, the compiler assumes that the
8374 code of the entire program (or shared library) fits in 4MB, and is
8375 thus reachable with a branch instruction.  When @option{-msmall-data}
8376 is used, the compiler can assume that all local symbols share the
8377 same @code{$gp} value, and thus reduce the number of instructions
8378 required for a function call from 4 to 1.
8380 The default is @option{-mlarge-text}.
8382 @item -mcpu=@var{cpu_type}
8383 @opindex mcpu
8384 Set the instruction set and instruction scheduling parameters for
8385 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8386 style name or the corresponding chip number.  GCC supports scheduling
8387 parameters for the EV4, EV5 and EV6 family of processors and will
8388 choose the default values for the instruction set from the processor
8389 you specify.  If you do not specify a processor type, GCC will default
8390 to the processor on which the compiler was built.
8392 Supported values for @var{cpu_type} are
8394 @table @samp
8395 @item ev4
8396 @itemx ev45
8397 @itemx 21064
8398 Schedules as an EV4 and has no instruction set extensions.
8400 @item ev5
8401 @itemx 21164
8402 Schedules as an EV5 and has no instruction set extensions.
8404 @item ev56
8405 @itemx 21164a
8406 Schedules as an EV5 and supports the BWX extension.
8408 @item pca56
8409 @itemx 21164pc
8410 @itemx 21164PC
8411 Schedules as an EV5 and supports the BWX and MAX extensions.
8413 @item ev6
8414 @itemx 21264
8415 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8417 @item ev67
8418 @itemx 21264a
8419 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8420 @end table
8422 @item -mtune=@var{cpu_type}
8423 @opindex mtune
8424 Set only the instruction scheduling parameters for machine type
8425 @var{cpu_type}.  The instruction set is not changed.
8427 @item -mmemory-latency=@var{time}
8428 @opindex mmemory-latency
8429 Sets the latency the scheduler should assume for typical memory
8430 references as seen by the application.  This number is highly
8431 dependent on the memory access patterns used by the application
8432 and the size of the external cache on the machine.
8434 Valid options for @var{time} are
8436 @table @samp
8437 @item @var{number}
8438 A decimal number representing clock cycles.
8440 @item L1
8441 @itemx L2
8442 @itemx L3
8443 @itemx main
8444 The compiler contains estimates of the number of clock cycles for
8445 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8446 (also called Dcache, Scache, and Bcache), as well as to main memory.
8447 Note that L3 is only valid for EV5.
8449 @end table
8450 @end table
8452 @node DEC Alpha/VMS Options
8453 @subsection DEC Alpha/VMS Options
8455 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8457 @table @gcctabopt
8458 @item -mvms-return-codes
8459 @opindex mvms-return-codes
8460 Return VMS condition codes from main.  The default is to return POSIX
8461 style condition (e.g.@ error) codes.
8462 @end table
8464 @node FRV Options
8465 @subsection FRV Options
8466 @cindex FRV Options
8468 @table @gcctabopt
8469 @item -mgpr-32
8470 @opindex mgpr-32
8472 Only use the first 32 general purpose registers.
8474 @item -mgpr-64
8475 @opindex mgpr-64
8477 Use all 64 general purpose registers.
8479 @item -mfpr-32
8480 @opindex mfpr-32
8482 Use only the first 32 floating point registers.
8484 @item -mfpr-64
8485 @opindex mfpr-64
8487 Use all 64 floating point registers
8489 @item -mhard-float
8490 @opindex mhard-float
8492 Use hardware instructions for floating point operations.
8494 @item -msoft-float
8495 @opindex msoft-float
8497 Use library routines for floating point operations.
8499 @item -malloc-cc
8500 @opindex malloc-cc
8502 Dynamically allocate condition code registers.
8504 @item -mfixed-cc
8505 @opindex mfixed-cc
8507 Do not try to dynamically allocate condition code registers, only
8508 use @code{icc0} and @code{fcc0}.
8510 @item -mdword
8511 @opindex mdword
8513 Change ABI to use double word insns.
8515 @item -mno-dword
8516 @opindex mno-dword
8518 Do not use double word instructions.
8520 @item -mdouble
8521 @opindex mdouble
8523 Use floating point double instructions.
8525 @item -mno-double
8526 @opindex mno-double
8528 Do not use floating point double instructions.
8530 @item -mmedia
8531 @opindex mmedia
8533 Use media instructions.
8535 @item -mno-media
8536 @opindex mno-media
8538 Do not use media instructions.
8540 @item -mmuladd
8541 @opindex mmuladd
8543 Use multiply and add/subtract instructions.
8545 @item -mno-muladd
8546 @opindex mno-muladd
8548 Do not use multiply and add/subtract instructions.
8550 @item -mfdpic
8551 @opindex mfdpic
8553 Select the FDPIC ABI, that uses function descriptors to represent
8554 pointers to functions.  Without any PIC/PIE-related options, it
8555 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8556 assumes GOT entries and small data are within a 12-bit range from the
8557 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8558 are computed with 32 bits.
8560 @item -minline-plt
8561 @opindex minline-plt
8563 Enable inlining of PLT entries in function calls to functions that are
8564 not known to bind locally.  It has no effect without @option{-mfdpic}.
8565 It's enabled by default if optimizing for speed and compiling for
8566 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8567 optimization option such as @option{-O3} or above is present in the
8568 command line.
8570 @item -mTLS
8571 @opindex TLS
8573 Assume a large TLS segment when generating thread-local code.
8575 @item -mtls
8576 @opindex tls
8578 Do not assume a large TLS segment when generating thread-local code.
8580 @item -mgprel-ro
8581 @opindex mgprel-ro
8583 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8584 that is known to be in read-only sections.  It's enabled by default,
8585 except for @option{-fpic} or @option{-fpie}: even though it may help
8586 make the global offset table smaller, it trades 1 instruction for 4.
8587 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8588 one of which may be shared by multiple symbols, and it avoids the need
8589 for a GOT entry for the referenced symbol, so it's more likely to be a
8590 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8592 @item -multilib-library-pic
8593 @opindex multilib-library-pic
8595 Link with the (library, not FD) pic libraries.  It's implied by
8596 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8597 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8598 it explicitly.
8600 @item -mlinked-fp
8601 @opindex mlinked-fp
8603 Follow the EABI requirement of always creating a frame pointer whenever
8604 a stack frame is allocated.  This option is enabled by default and can
8605 be disabled with @option{-mno-linked-fp}.
8607 @item -mlong-calls
8608 @opindex mlong-calls
8610 Use indirect addressing to call functions outside the current
8611 compilation unit.  This allows the functions to be placed anywhere
8612 within the 32-bit address space.
8614 @item -malign-labels
8615 @opindex malign-labels
8617 Try to align labels to an 8-byte boundary by inserting nops into the
8618 previous packet.  This option only has an effect when VLIW packing
8619 is enabled.  It doesn't create new packets; it merely adds nops to
8620 existing ones.
8622 @item -mlibrary-pic
8623 @opindex mlibrary-pic
8625 Generate position-independent EABI code.
8627 @item -macc-4
8628 @opindex macc-4
8630 Use only the first four media accumulator registers.
8632 @item -macc-8
8633 @opindex macc-8
8635 Use all eight media accumulator registers.
8637 @item -mpack
8638 @opindex mpack
8640 Pack VLIW instructions.
8642 @item -mno-pack
8643 @opindex mno-pack
8645 Do not pack VLIW instructions.
8647 @item -mno-eflags
8648 @opindex mno-eflags
8650 Do not mark ABI switches in e_flags.
8652 @item -mcond-move
8653 @opindex mcond-move
8655 Enable the use of conditional-move instructions (default).
8657 This switch is mainly for debugging the compiler and will likely be removed
8658 in a future version.
8660 @item -mno-cond-move
8661 @opindex mno-cond-move
8663 Disable the use of conditional-move instructions.
8665 This switch is mainly for debugging the compiler and will likely be removed
8666 in a future version.
8668 @item -mscc
8669 @opindex mscc
8671 Enable the use of conditional set instructions (default).
8673 This switch is mainly for debugging the compiler and will likely be removed
8674 in a future version.
8676 @item -mno-scc
8677 @opindex mno-scc
8679 Disable the use of conditional set instructions.
8681 This switch is mainly for debugging the compiler and will likely be removed
8682 in a future version.
8684 @item -mcond-exec
8685 @opindex mcond-exec
8687 Enable the use of conditional execution (default).
8689 This switch is mainly for debugging the compiler and will likely be removed
8690 in a future version.
8692 @item -mno-cond-exec
8693 @opindex mno-cond-exec
8695 Disable the use of conditional execution.
8697 This switch is mainly for debugging the compiler and will likely be removed
8698 in a future version.
8700 @item -mvliw-branch
8701 @opindex mvliw-branch
8703 Run a pass to pack branches into VLIW instructions (default).
8705 This switch is mainly for debugging the compiler and will likely be removed
8706 in a future version.
8708 @item -mno-vliw-branch
8709 @opindex mno-vliw-branch
8711 Do not run a pass to pack branches into VLIW instructions.
8713 This switch is mainly for debugging the compiler and will likely be removed
8714 in a future version.
8716 @item -mmulti-cond-exec
8717 @opindex mmulti-cond-exec
8719 Enable optimization of @code{&&} and @code{||} in conditional execution
8720 (default).
8722 This switch is mainly for debugging the compiler and will likely be removed
8723 in a future version.
8725 @item -mno-multi-cond-exec
8726 @opindex mno-multi-cond-exec
8728 Disable optimization of @code{&&} and @code{||} in conditional execution.
8730 This switch is mainly for debugging the compiler and will likely be removed
8731 in a future version.
8733 @item -mnested-cond-exec
8734 @opindex mnested-cond-exec
8736 Enable nested conditional execution optimizations (default).
8738 This switch is mainly for debugging the compiler and will likely be removed
8739 in a future version.
8741 @item -mno-nested-cond-exec
8742 @opindex mno-nested-cond-exec
8744 Disable nested conditional execution optimizations.
8746 This switch is mainly for debugging the compiler and will likely be removed
8747 in a future version.
8749 @item -moptimize-membar
8750 @opindex moptimize-membar
8752 This switch removes redundant @code{membar} instructions from the
8753 compiler generated code.  It is enabled by default.
8755 @item -mno-optimize-membar
8756 @opindex mno-optimize-membar
8758 This switch disables the automatic removal of redundant @code{membar}
8759 instructions from the generated code.
8761 @item -mtomcat-stats
8762 @opindex mtomcat-stats
8764 Cause gas to print out tomcat statistics.
8766 @item -mcpu=@var{cpu}
8767 @opindex mcpu
8769 Select the processor type for which to generate code.  Possible values are
8770 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8771 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8773 @end table
8775 @node H8/300 Options
8776 @subsection H8/300 Options
8778 These @samp{-m} options are defined for the H8/300 implementations:
8780 @table @gcctabopt
8781 @item -mrelax
8782 @opindex mrelax
8783 Shorten some address references at link time, when possible; uses the
8784 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8785 ld, Using ld}, for a fuller description.
8787 @item -mh
8788 @opindex mh
8789 Generate code for the H8/300H@.
8791 @item -ms
8792 @opindex ms
8793 Generate code for the H8S@.
8795 @item -mn
8796 @opindex mn
8797 Generate code for the H8S and H8/300H in the normal mode.  This switch
8798 must be used either with @option{-mh} or @option{-ms}.
8800 @item -ms2600
8801 @opindex ms2600
8802 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8804 @item -mint32
8805 @opindex mint32
8806 Make @code{int} data 32 bits by default.
8808 @item -malign-300
8809 @opindex malign-300
8810 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8811 The default for the H8/300H and H8S is to align longs and floats on 4
8812 byte boundaries.
8813 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8814 This option has no effect on the H8/300.
8815 @end table
8817 @node HPPA Options
8818 @subsection HPPA Options
8819 @cindex HPPA Options
8821 These @samp{-m} options are defined for the HPPA family of computers:
8823 @table @gcctabopt
8824 @item -march=@var{architecture-type}
8825 @opindex march
8826 Generate code for the specified architecture.  The choices for
8827 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8828 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8829 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8830 architecture option for your machine.  Code compiled for lower numbered
8831 architectures will run on higher numbered architectures, but not the
8832 other way around.
8834 @item -mpa-risc-1-0
8835 @itemx -mpa-risc-1-1
8836 @itemx -mpa-risc-2-0
8837 @opindex mpa-risc-1-0
8838 @opindex mpa-risc-1-1
8839 @opindex mpa-risc-2-0
8840 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8842 @item -mbig-switch
8843 @opindex mbig-switch
8844 Generate code suitable for big switch tables.  Use this option only if
8845 the assembler/linker complain about out of range branches within a switch
8846 table.
8848 @item -mjump-in-delay
8849 @opindex mjump-in-delay
8850 Fill delay slots of function calls with unconditional jump instructions
8851 by modifying the return pointer for the function call to be the target
8852 of the conditional jump.
8854 @item -mdisable-fpregs
8855 @opindex mdisable-fpregs
8856 Prevent floating point registers from being used in any manner.  This is
8857 necessary for compiling kernels which perform lazy context switching of
8858 floating point registers.  If you use this option and attempt to perform
8859 floating point operations, the compiler will abort.
8861 @item -mdisable-indexing
8862 @opindex mdisable-indexing
8863 Prevent the compiler from using indexing address modes.  This avoids some
8864 rather obscure problems when compiling MIG generated code under MACH@.
8866 @item -mno-space-regs
8867 @opindex mno-space-regs
8868 Generate code that assumes the target has no space registers.  This allows
8869 GCC to generate faster indirect calls and use unscaled index address modes.
8871 Such code is suitable for level 0 PA systems and kernels.
8873 @item -mfast-indirect-calls
8874 @opindex mfast-indirect-calls
8875 Generate code that assumes calls never cross space boundaries.  This
8876 allows GCC to emit code which performs faster indirect calls.
8878 This option will not work in the presence of shared libraries or nested
8879 functions.
8881 @item -mfixed-range=@var{register-range}
8882 @opindex mfixed-range
8883 Generate code treating the given register range as fixed registers.
8884 A fixed register is one that the register allocator can not use.  This is
8885 useful when compiling kernel code.  A register range is specified as
8886 two registers separated by a dash.  Multiple register ranges can be
8887 specified separated by a comma.
8889 @item -mlong-load-store
8890 @opindex mlong-load-store
8891 Generate 3-instruction load and store sequences as sometimes required by
8892 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8893 the HP compilers.
8895 @item -mportable-runtime
8896 @opindex mportable-runtime
8897 Use the portable calling conventions proposed by HP for ELF systems.
8899 @item -mgas
8900 @opindex mgas
8901 Enable the use of assembler directives only GAS understands.
8903 @item -mschedule=@var{cpu-type}
8904 @opindex mschedule
8905 Schedule code according to the constraints for the machine type
8906 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8907 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8908 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8909 proper scheduling option for your machine.  The default scheduling is
8910 @samp{8000}.
8912 @item -mlinker-opt
8913 @opindex mlinker-opt
8914 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8915 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8916 linkers in which they give bogus error messages when linking some programs.
8918 @item -msoft-float
8919 @opindex msoft-float
8920 Generate output containing library calls for floating point.
8921 @strong{Warning:} the requisite libraries are not available for all HPPA
8922 targets.  Normally the facilities of the machine's usual C compiler are
8923 used, but this cannot be done directly in cross-compilation.  You must make
8924 your own arrangements to provide suitable library functions for
8925 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8926 does provide software floating point support.
8928 @option{-msoft-float} changes the calling convention in the output file;
8929 therefore, it is only useful if you compile @emph{all} of a program with
8930 this option.  In particular, you need to compile @file{libgcc.a}, the
8931 library that comes with GCC, with @option{-msoft-float} in order for
8932 this to work.
8934 @item -msio
8935 @opindex msio
8936 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8937 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8938 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8939 options are available under HP-UX and HI-UX@.
8941 @item -mgnu-ld
8942 @opindex gnu-ld
8943 Use GNU ld specific options.  This passes @option{-shared} to ld when
8944 building a shared library.  It is the default when GCC is configured,
8945 explicitly or implicitly, with the GNU linker.  This option does not
8946 have any affect on which ld is called, it only changes what parameters
8947 are passed to that ld.  The ld that is called is determined by the
8948 @option{--with-ld} configure option, GCC's program search path, and
8949 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8950 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8951 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8953 @item -mhp-ld
8954 @opindex hp-ld
8955 Use HP ld specific options.  This passes @option{-b} to ld when building
8956 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8957 links.  It is the default when GCC is configured, explicitly or
8958 implicitly, with the HP linker.  This option does not have any affect on
8959 which ld is called, it only changes what parameters are passed to that
8960 ld.  The ld that is called is determined by the @option{--with-ld}
8961 configure option, GCC's program search path, and finally by the user's
8962 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8963 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8964 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8966 @item -mlong-calls
8967 @opindex mno-long-calls
8968 Generate code that uses long call sequences.  This ensures that a call
8969 is always able to reach linker generated stubs.  The default is to generate
8970 long calls only when the distance from the call site to the beginning
8971 of the function or translation unit, as the case may be, exceeds a
8972 predefined limit set by the branch type being used.  The limits for
8973 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8974 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8975 240,000 bytes.
8977 Distances are measured from the beginning of functions when using the
8978 @option{-ffunction-sections} option, or when using the @option{-mgas}
8979 and @option{-mno-portable-runtime} options together under HP-UX with
8980 the SOM linker.
8982 It is normally not desirable to use this option as it will degrade
8983 performance.  However, it may be useful in large applications,
8984 particularly when partial linking is used to build the application.
8986 The types of long calls used depends on the capabilities of the
8987 assembler and linker, and the type of code being generated.  The
8988 impact on systems that support long absolute calls, and long pic
8989 symbol-difference or pc-relative calls should be relatively small.
8990 However, an indirect call is used on 32-bit ELF systems in pic code
8991 and it is quite long.
8993 @item -munix=@var{unix-std}
8994 @opindex march
8995 Generate compiler predefines and select a startfile for the specified
8996 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8997 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8998 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8999 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9000 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9001 and later.
9003 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9004 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9005 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9006 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9007 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9008 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9010 It is @emph{important} to note that this option changes the interfaces
9011 for various library routines.  It also affects the operational behavior
9012 of the C library.  Thus, @emph{extreme} care is needed in using this
9013 option.
9015 Library code that is intended to operate with more than one UNIX
9016 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9017 as appropriate.  Most GNU software doesn't provide this capability.
9019 @item -nolibdld
9020 @opindex nolibdld
9021 Suppress the generation of link options to search libdld.sl when the
9022 @option{-static} option is specified on HP-UX 10 and later.
9024 @item -static
9025 @opindex static
9026 The HP-UX implementation of setlocale in libc has a dependency on
9027 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9028 when the @option{-static} option is specified, special link options
9029 are needed to resolve this dependency.
9031 On HP-UX 10 and later, the GCC driver adds the necessary options to
9032 link with libdld.sl when the @option{-static} option is specified.
9033 This causes the resulting binary to be dynamic.  On the 64-bit port,
9034 the linkers generate dynamic binaries by default in any case.  The
9035 @option{-nolibdld} option can be used to prevent the GCC driver from
9036 adding these link options.
9038 @item -threads
9039 @opindex threads
9040 Add support for multithreading with the @dfn{dce thread} library
9041 under HP-UX@.  This option sets flags for both the preprocessor and
9042 linker.
9043 @end table
9045 @node i386 and x86-64 Options
9046 @subsection Intel 386 and AMD x86-64 Options
9047 @cindex i386 Options
9048 @cindex x86-64 Options
9049 @cindex Intel 386 Options
9050 @cindex AMD x86-64 Options
9052 These @samp{-m} options are defined for the i386 and x86-64 family of
9053 computers:
9055 @table @gcctabopt
9056 @item -mtune=@var{cpu-type}
9057 @opindex mtune
9058 Tune to @var{cpu-type} everything applicable about the generated code, except
9059 for the ABI and the set of available instructions.  The choices for
9060 @var{cpu-type} are:
9061 @table @emph
9062 @item i386
9063 Original Intel's i386 CPU@.
9064 @item i486
9065 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9066 @item i586, pentium
9067 Intel Pentium CPU with no MMX support.
9068 @item pentium-mmx
9069 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9070 @item i686, pentiumpro
9071 Intel PentiumPro CPU@.
9072 @item pentium2
9073 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9074 @item pentium3, pentium3m
9075 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9076 support.
9077 @item pentium-m
9078 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9079 support.  Used by Centrino notebooks.
9080 @item pentium4, pentium4m
9081 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9082 @item prescott
9083 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9084 set support.
9085 @item nocona
9086 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9087 SSE2 and SSE3 instruction set support.
9088 @item k6
9089 AMD K6 CPU with MMX instruction set support.
9090 @item k6-2, k6-3
9091 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9092 @item athlon, athlon-tbird
9093 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9094 support.
9095 @item athlon-4, athlon-xp, athlon-mp
9096 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9097 instruction set support.
9098 @item k8, opteron, athlon64, athlon-fx
9099 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9100 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9101 @item winchip-c6
9102 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9103 set support.
9104 @item winchip2
9105 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9106 instruction set support.
9107 @item c3
9108 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9109 implemented for this chip.)
9110 @item c3-2
9111 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9112 implemented for this chip.)
9113 @end table
9115 While picking a specific @var{cpu-type} will schedule things appropriately
9116 for that particular chip, the compiler will not generate any code that
9117 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9118 being used.
9120 @item -march=@var{cpu-type}
9121 @opindex march
9122 Generate instructions for the machine type @var{cpu-type}.  The choices
9123 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9124 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9126 @item -mcpu=@var{cpu-type}
9127 @opindex mcpu
9128 A deprecated synonym for @option{-mtune}.
9130 @item -m386
9131 @itemx -m486
9132 @itemx -mpentium
9133 @itemx -mpentiumpro
9134 @opindex m386
9135 @opindex m486
9136 @opindex mpentium
9137 @opindex mpentiumpro
9138 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9139 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9140 These synonyms are deprecated.
9142 @item -mfpmath=@var{unit}
9143 @opindex march
9144 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9145 for @var{unit} are:
9147 @table @samp
9148 @item 387
9149 Use the standard 387 floating point coprocessor present majority of chips and
9150 emulated otherwise.  Code compiled with this option will run almost everywhere.
9151 The temporary results are computed in 80bit precision instead of precision
9152 specified by the type resulting in slightly different results compared to most
9153 of other chips.  See @option{-ffloat-store} for more detailed description.
9155 This is the default choice for i386 compiler.
9157 @item sse
9158 Use scalar floating point instructions present in the SSE instruction set.
9159 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9160 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9161 instruction set supports only single precision arithmetics, thus the double and
9162 extended precision arithmetics is still done using 387.  Later version, present
9163 only in Pentium4 and the future AMD x86-64 chips supports double precision
9164 arithmetics too.
9166 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9167 or @option{-msse2} switches to enable SSE extensions and make this option
9168 effective.  For the x86-64 compiler, these extensions are enabled by default.
9170 The resulting code should be considerably faster in the majority of cases and avoid
9171 the numerical instability problems of 387 code, but may break some existing
9172 code that expects temporaries to be 80bit.
9174 This is the default choice for the x86-64 compiler.
9176 @item sse,387
9177 Attempt to utilize both instruction sets at once.  This effectively double the
9178 amount of available registers and on chips with separate execution units for
9179 387 and SSE the execution resources too.  Use this option with care, as it is
9180 still experimental, because the GCC register allocator does not model separate
9181 functional units well resulting in instable performance.
9182 @end table
9184 @item -masm=@var{dialect}
9185 @opindex masm=@var{dialect}
9186 Output asm instructions using selected @var{dialect}.  Supported
9187 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9188 not support @samp{intel}.
9190 @item -mieee-fp
9191 @itemx -mno-ieee-fp
9192 @opindex mieee-fp
9193 @opindex mno-ieee-fp
9194 Control whether or not the compiler uses IEEE floating point
9195 comparisons.  These handle correctly the case where the result of a
9196 comparison is unordered.
9198 @item -msoft-float
9199 @opindex msoft-float
9200 Generate output containing library calls for floating point.
9201 @strong{Warning:} the requisite libraries are not part of GCC@.
9202 Normally the facilities of the machine's usual C compiler are used, but
9203 this can't be done directly in cross-compilation.  You must make your
9204 own arrangements to provide suitable library functions for
9205 cross-compilation.
9207 On machines where a function returns floating point results in the 80387
9208 register stack, some floating point opcodes may be emitted even if
9209 @option{-msoft-float} is used.
9211 @item -mno-fp-ret-in-387
9212 @opindex mno-fp-ret-in-387
9213 Do not use the FPU registers for return values of functions.
9215 The usual calling convention has functions return values of types
9216 @code{float} and @code{double} in an FPU register, even if there
9217 is no FPU@.  The idea is that the operating system should emulate
9218 an FPU@.
9220 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9221 in ordinary CPU registers instead.
9223 @item -mno-fancy-math-387
9224 @opindex mno-fancy-math-387
9225 Some 387 emulators do not support the @code{sin}, @code{cos} and
9226 @code{sqrt} instructions for the 387.  Specify this option to avoid
9227 generating those instructions.  This option is the default on FreeBSD,
9228 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9229 indicates that the target cpu will always have an FPU and so the
9230 instruction will not need emulation.  As of revision 2.6.1, these
9231 instructions are not generated unless you also use the
9232 @option{-funsafe-math-optimizations} switch.
9234 @item -malign-double
9235 @itemx -mno-align-double
9236 @opindex malign-double
9237 @opindex mno-align-double
9238 Control whether GCC aligns @code{double}, @code{long double}, and
9239 @code{long long} variables on a two word boundary or a one word
9240 boundary.  Aligning @code{double} variables on a two word boundary will
9241 produce code that runs somewhat faster on a @samp{Pentium} at the
9242 expense of more memory.
9244 On x86-64, @option{-malign-double} is enabled by default.
9246 @strong{Warning:} if you use the @option{-malign-double} switch,
9247 structures containing the above types will be aligned differently than
9248 the published application binary interface specifications for the 386
9249 and will not be binary compatible with structures in code compiled
9250 without that switch.
9252 @item -m96bit-long-double
9253 @itemx -m128bit-long-double
9254 @opindex m96bit-long-double
9255 @opindex m128bit-long-double
9256 These switches control the size of @code{long double} type.  The i386
9257 application binary interface specifies the size to be 96 bits,
9258 so @option{-m96bit-long-double} is the default in 32 bit mode.
9260 Modern architectures (Pentium and newer) would prefer @code{long double}
9261 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9262 conforming to the ABI, this would not be possible.  So specifying a
9263 @option{-m128bit-long-double} will align @code{long double}
9264 to a 16 byte boundary by padding the @code{long double} with an additional
9265 32 bit zero.
9267 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9268 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9270 Notice that neither of these options enable any extra precision over the x87
9271 standard of 80 bits for a @code{long double}.
9273 @strong{Warning:} if you override the default value for your target ABI, the
9274 structures and arrays containing @code{long double} variables will change
9275 their size as well as function calling convention for function taking
9276 @code{long double} will be modified.  Hence they will not be binary
9277 compatible with arrays or structures in code compiled without that switch.
9279 @item -mmlarge-data-threshold=@var{number}
9280 @opindex mlarge-data-threshold=@var{number}
9281 When @option{-mcmodel=medium} is specified, the data greater than
9282 @var{threshold} are placed in large data section.  This value must be the
9283 same across all object linked into the binary and defaults to 65535.
9285 @item -msvr3-shlib
9286 @itemx -mno-svr3-shlib
9287 @opindex msvr3-shlib
9288 @opindex mno-svr3-shlib
9289 Control whether GCC places uninitialized local variables into the
9290 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9291 into @code{bss}.  These options are meaningful only on System V Release 3.
9293 @item -mrtd
9294 @opindex mrtd
9295 Use a different function-calling convention, in which functions that
9296 take a fixed number of arguments return with the @code{ret} @var{num}
9297 instruction, which pops their arguments while returning.  This saves one
9298 instruction in the caller since there is no need to pop the arguments
9299 there.
9301 You can specify that an individual function is called with this calling
9302 sequence with the function attribute @samp{stdcall}.  You can also
9303 override the @option{-mrtd} option by using the function attribute
9304 @samp{cdecl}.  @xref{Function Attributes}.
9306 @strong{Warning:} this calling convention is incompatible with the one
9307 normally used on Unix, so you cannot use it if you need to call
9308 libraries compiled with the Unix compiler.
9310 Also, you must provide function prototypes for all functions that
9311 take variable numbers of arguments (including @code{printf});
9312 otherwise incorrect code will be generated for calls to those
9313 functions.
9315 In addition, seriously incorrect code will result if you call a
9316 function with too many arguments.  (Normally, extra arguments are
9317 harmlessly ignored.)
9319 @item -mregparm=@var{num}
9320 @opindex mregparm
9321 Control how many registers are used to pass integer arguments.  By
9322 default, no registers are used to pass arguments, and at most 3
9323 registers can be used.  You can control this behavior for a specific
9324 function by using the function attribute @samp{regparm}.
9325 @xref{Function Attributes}.
9327 @strong{Warning:} if you use this switch, and
9328 @var{num} is nonzero, then you must build all modules with the same
9329 value, including any libraries.  This includes the system libraries and
9330 startup modules.
9332 @item -msseregparm
9333 @opindex msseregparm
9334 Use SSE register passing conventions for float and double arguments
9335 and return values.  You can control this behavior for a specific
9336 function by using the function attribute @samp{sseregparm}.
9337 @xref{Function Attributes}.
9339 @strong{Warning:} if you use this switch then you must build all
9340 modules with the same value, including any libraries.  This includes
9341 the system libraries and startup modules.
9343 @item -mpreferred-stack-boundary=@var{num}
9344 @opindex mpreferred-stack-boundary
9345 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9346 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9347 the default is 4 (16 bytes or 128 bits).
9349 On Pentium and PentiumPro, @code{double} and @code{long double} values
9350 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9351 suffer significant run time performance penalties.  On Pentium III, the
9352 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9353 properly if it is not 16 byte aligned.
9355 To ensure proper alignment of this values on the stack, the stack boundary
9356 must be as aligned as that required by any value stored on the stack.
9357 Further, every function must be generated such that it keeps the stack
9358 aligned.  Thus calling a function compiled with a higher preferred
9359 stack boundary from a function compiled with a lower preferred stack
9360 boundary will most likely misalign the stack.  It is recommended that
9361 libraries that use callbacks always use the default setting.
9363 This extra alignment does consume extra stack space, and generally
9364 increases code size.  Code that is sensitive to stack space usage, such
9365 as embedded systems and operating system kernels, may want to reduce the
9366 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9368 @item -mmmx
9369 @itemx -mno-mmx
9370 @item -msse
9371 @itemx -mno-sse
9372 @item -msse2
9373 @itemx -mno-sse2
9374 @item -msse3
9375 @itemx -mno-sse3
9376 @item -m3dnow
9377 @itemx -mno-3dnow
9378 @opindex mmmx
9379 @opindex mno-mmx
9380 @opindex msse
9381 @opindex mno-sse
9382 @opindex m3dnow
9383 @opindex mno-3dnow
9384 These switches enable or disable the use of instructions in the MMX,
9385 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9386 also available as built-in functions: see @ref{X86 Built-in Functions},
9387 for details of the functions enabled and disabled by these switches.
9389 To have SSE/SSE2 instructions generated automatically from floating-point
9390 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9392 These options will enable GCC to use these extended instructions in
9393 generated code, even without @option{-mfpmath=sse}.  Applications which
9394 perform runtime CPU detection must compile separate files for each
9395 supported architecture, using the appropriate flags.  In particular,
9396 the file containing the CPU detection code should be compiled without
9397 these options.
9399 @item -mpush-args
9400 @itemx -mno-push-args
9401 @opindex mpush-args
9402 @opindex mno-push-args
9403 Use PUSH operations to store outgoing parameters.  This method is shorter
9404 and usually equally fast as method using SUB/MOV operations and is enabled
9405 by default.  In some cases disabling it may improve performance because of
9406 improved scheduling and reduced dependencies.
9408 @item -maccumulate-outgoing-args
9409 @opindex maccumulate-outgoing-args
9410 If enabled, the maximum amount of space required for outgoing arguments will be
9411 computed in the function prologue.  This is faster on most modern CPUs
9412 because of reduced dependencies, improved scheduling and reduced stack usage
9413 when preferred stack boundary is not equal to 2.  The drawback is a notable
9414 increase in code size.  This switch implies @option{-mno-push-args}.
9416 @item -mthreads
9417 @opindex mthreads
9418 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9419 on thread-safe exception handling must compile and link all code with the
9420 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9421 @option{-D_MT}; when linking, it links in a special thread helper library
9422 @option{-lmingwthrd} which cleans up per thread exception handling data.
9424 @item -mno-align-stringops
9425 @opindex mno-align-stringops
9426 Do not align destination of inlined string operations.  This switch reduces
9427 code size and improves performance in case the destination is already aligned,
9428 but GCC doesn't know about it.
9430 @item -minline-all-stringops
9431 @opindex minline-all-stringops
9432 By default GCC inlines string operations only when destination is known to be
9433 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9434 size, but may improve performance of code that depends on fast memcpy, strlen
9435 and memset for short lengths.
9437 @item -momit-leaf-frame-pointer
9438 @opindex momit-leaf-frame-pointer
9439 Don't keep the frame pointer in a register for leaf functions.  This
9440 avoids the instructions to save, set up and restore frame pointers and
9441 makes an extra register available in leaf functions.  The option
9442 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9443 which might make debugging harder.
9445 @item -mtls-direct-seg-refs
9446 @itemx -mno-tls-direct-seg-refs
9447 @opindex mtls-direct-seg-refs
9448 Controls whether TLS variables may be accessed with offsets from the
9449 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9450 or whether the thread base pointer must be added.  Whether or not this
9451 is legal depends on the operating system, and whether it maps the
9452 segment to cover the entire TLS area.
9454 For systems that use GNU libc, the default is on.
9455 @end table
9457 These @samp{-m} switches are supported in addition to the above
9458 on AMD x86-64 processors in 64-bit environments.
9460 @table @gcctabopt
9461 @item -m32
9462 @itemx -m64
9463 @opindex m32
9464 @opindex m64
9465 Generate code for a 32-bit or 64-bit environment.
9466 The 32-bit environment sets int, long and pointer to 32 bits and
9467 generates code that runs on any i386 system.
9468 The 64-bit environment sets int to 32 bits and long and pointer
9469 to 64 bits and generates code for AMD's x86-64 architecture.
9471 @item -mno-red-zone
9472 @opindex no-red-zone
9473 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9474 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9475 stack pointer that will not be modified by signal or interrupt handlers
9476 and therefore can be used for temporary data without adjusting the stack
9477 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9479 @item -mcmodel=small
9480 @opindex mcmodel=small
9481 Generate code for the small code model: the program and its symbols must
9482 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9483 Programs can be statically or dynamically linked.  This is the default
9484 code model.
9486 @item -mcmodel=kernel
9487 @opindex mcmodel=kernel
9488 Generate code for the kernel code model.  The kernel runs in the
9489 negative 2 GB of the address space.
9490 This model has to be used for Linux kernel code.
9492 @item -mcmodel=medium
9493 @opindex mcmodel=medium
9494 Generate code for the medium model: The program is linked in the lower 2
9495 GB of the address space but symbols can be located anywhere in the
9496 address space.  Programs can be statically or dynamically linked, but
9497 building of shared libraries are not supported with the medium model.
9499 @item -mcmodel=large
9500 @opindex mcmodel=large
9501 Generate code for the large model: This model makes no assumptions
9502 about addresses and sizes of sections.  Currently GCC does not implement
9503 this model.
9504 @end table
9506 @node IA-64 Options
9507 @subsection IA-64 Options
9508 @cindex IA-64 Options
9510 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9512 @table @gcctabopt
9513 @item -mbig-endian
9514 @opindex mbig-endian
9515 Generate code for a big endian target.  This is the default for HP-UX@.
9517 @item -mlittle-endian
9518 @opindex mlittle-endian
9519 Generate code for a little endian target.  This is the default for AIX5
9520 and GNU/Linux.
9522 @item -mgnu-as
9523 @itemx -mno-gnu-as
9524 @opindex mgnu-as
9525 @opindex mno-gnu-as
9526 Generate (or don't) code for the GNU assembler.  This is the default.
9527 @c Also, this is the default if the configure option @option{--with-gnu-as}
9528 @c is used.
9530 @item -mgnu-ld
9531 @itemx -mno-gnu-ld
9532 @opindex mgnu-ld
9533 @opindex mno-gnu-ld
9534 Generate (or don't) code for the GNU linker.  This is the default.
9535 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9536 @c is used.
9538 @item -mno-pic
9539 @opindex mno-pic
9540 Generate code that does not use a global pointer register.  The result
9541 is not position independent code, and violates the IA-64 ABI@.
9543 @item -mvolatile-asm-stop
9544 @itemx -mno-volatile-asm-stop
9545 @opindex mvolatile-asm-stop
9546 @opindex mno-volatile-asm-stop
9547 Generate (or don't) a stop bit immediately before and after volatile asm
9548 statements.
9550 @item -mregister-names
9551 @itemx -mno-register-names
9552 @opindex mregister-names
9553 @opindex mno-register-names
9554 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9555 the stacked registers.  This may make assembler output more readable.
9557 @item -mno-sdata
9558 @itemx -msdata
9559 @opindex mno-sdata
9560 @opindex msdata
9561 Disable (or enable) optimizations that use the small data section.  This may
9562 be useful for working around optimizer bugs.
9564 @item -mconstant-gp
9565 @opindex mconstant-gp
9566 Generate code that uses a single constant global pointer value.  This is
9567 useful when compiling kernel code.
9569 @item -mauto-pic
9570 @opindex mauto-pic
9571 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9572 This is useful when compiling firmware code.
9574 @item -minline-float-divide-min-latency
9575 @opindex minline-float-divide-min-latency
9576 Generate code for inline divides of floating point values
9577 using the minimum latency algorithm.
9579 @item -minline-float-divide-max-throughput
9580 @opindex minline-float-divide-max-throughput
9581 Generate code for inline divides of floating point values
9582 using the maximum throughput algorithm.
9584 @item -minline-int-divide-min-latency
9585 @opindex minline-int-divide-min-latency
9586 Generate code for inline divides of integer values
9587 using the minimum latency algorithm.
9589 @item -minline-int-divide-max-throughput
9590 @opindex minline-int-divide-max-throughput
9591 Generate code for inline divides of integer values
9592 using the maximum throughput algorithm.
9594 @item -minline-sqrt-min-latency
9595 @opindex minline-sqrt-min-latency
9596 Generate code for inline square roots
9597 using the minimum latency algorithm.
9599 @item -minline-sqrt-max-throughput
9600 @opindex minline-sqrt-max-throughput
9601 Generate code for inline square roots
9602 using the maximum throughput algorithm.
9604 @item -mno-dwarf2-asm
9605 @itemx -mdwarf2-asm
9606 @opindex mno-dwarf2-asm
9607 @opindex mdwarf2-asm
9608 Don't (or do) generate assembler code for the DWARF2 line number debugging
9609 info.  This may be useful when not using the GNU assembler.
9611 @item -mearly-stop-bits
9612 @itemx -mno-early-stop-bits
9613 @opindex mearly-stop-bits
9614 @opindex mno-early-stop-bits
9615 Allow stop bits to be placed earlier than immediately preceding the
9616 instruction that triggered the stop bit.  This can improve instruction
9617 scheduling, but does not always do so.
9619 @item -mfixed-range=@var{register-range}
9620 @opindex mfixed-range
9621 Generate code treating the given register range as fixed registers.
9622 A fixed register is one that the register allocator can not use.  This is
9623 useful when compiling kernel code.  A register range is specified as
9624 two registers separated by a dash.  Multiple register ranges can be
9625 specified separated by a comma.
9627 @item -mtls-size=@var{tls-size}
9628 @opindex mtls-size
9629 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9632 @item -mtune=@var{cpu-type}
9633 @opindex mtune
9634 Tune the instruction scheduling for a particular CPU, Valid values are
9635 itanium, itanium1, merced, itanium2, and mckinley.
9637 @item -mt
9638 @itemx -pthread
9639 @opindex mt
9640 @opindex pthread
9641 Add support for multithreading using the POSIX threads library.  This
9642 option sets flags for both the preprocessor and linker.  It does
9643 not affect the thread safety of object code produced by the compiler or
9644 that of libraries supplied with it.  These are HP-UX specific flags.
9646 @item -milp32
9647 @itemx -mlp64
9648 @opindex milp32
9649 @opindex mlp64
9650 Generate code for a 32-bit or 64-bit environment.
9651 The 32-bit environment sets int, long and pointer to 32 bits.
9652 The 64-bit environment sets int to 32 bits and long and pointer
9653 to 64 bits.  These are HP-UX specific flags.
9655 @end table
9657 @node M32C Options
9658 @subsection M32C Options
9659 @cindex M32C options
9661 @table @gcctabopt
9662 @item -mcpu=@var{name}
9663 @opindex mcpu=
9664 Select the CPU for which code is generated.  @var{name} may be one of
9665 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9666 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9667 the M32C/80 series.
9669 @item -msim
9670 @opindex msim
9671 Specifies that the program will be run on the simulator.  This causes
9672 an alternate runtime library to be linked in which supports, for
9673 example, file I/O.  You must not use this option when generating
9674 programs that will run on real hardware; you must provide your own
9675 runtime library for whatever I/O functions are needed.
9677 @item -memregs=@var{number}
9678 @opindex memregs=
9679 Specifies the number of memory-based pseudo-registers GCC will use
9680 during code generation.  These pseudo-registers will be used like real
9681 registers, so there is a tradeoff between GCC's ability to fit the
9682 code into available registers, and the performance penalty of using
9683 memory instead of registers.  Note that all modules in a program must
9684 be compiled with the same value for this option.  Because of that, you
9685 must not use this option with the default runtime libraries gcc
9686 builds.
9688 @end table
9690 @node M32R/D Options
9691 @subsection M32R/D Options
9692 @cindex M32R/D options
9694 These @option{-m} options are defined for Renesas M32R/D architectures:
9696 @table @gcctabopt
9697 @item -m32r2
9698 @opindex m32r2
9699 Generate code for the M32R/2@.
9701 @item -m32rx
9702 @opindex m32rx
9703 Generate code for the M32R/X@.
9705 @item -m32r
9706 @opindex m32r
9707 Generate code for the M32R@.  This is the default.
9709 @item -mmodel=small
9710 @opindex mmodel=small
9711 Assume all objects live in the lower 16MB of memory (so that their addresses
9712 can be loaded with the @code{ld24} instruction), and assume all subroutines
9713 are reachable with the @code{bl} instruction.
9714 This is the default.
9716 The addressability of a particular object can be set with the
9717 @code{model} attribute.
9719 @item -mmodel=medium
9720 @opindex mmodel=medium
9721 Assume objects may be anywhere in the 32-bit address space (the compiler
9722 will generate @code{seth/add3} instructions to load their addresses), and
9723 assume all subroutines are reachable with the @code{bl} instruction.
9725 @item -mmodel=large
9726 @opindex mmodel=large
9727 Assume objects may be anywhere in the 32-bit address space (the compiler
9728 will generate @code{seth/add3} instructions to load their addresses), and
9729 assume subroutines may not be reachable with the @code{bl} instruction
9730 (the compiler will generate the much slower @code{seth/add3/jl}
9731 instruction sequence).
9733 @item -msdata=none
9734 @opindex msdata=none
9735 Disable use of the small data area.  Variables will be put into
9736 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9737 @code{section} attribute has been specified).
9738 This is the default.
9740 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9741 Objects may be explicitly put in the small data area with the
9742 @code{section} attribute using one of these sections.
9744 @item -msdata=sdata
9745 @opindex msdata=sdata
9746 Put small global and static data in the small data area, but do not
9747 generate special code to reference them.
9749 @item -msdata=use
9750 @opindex msdata=use
9751 Put small global and static data in the small data area, and generate
9752 special instructions to reference them.
9754 @item -G @var{num}
9755 @opindex G
9756 @cindex smaller data references
9757 Put global and static objects less than or equal to @var{num} bytes
9758 into the small data or bss sections instead of the normal data or bss
9759 sections.  The default value of @var{num} is 8.
9760 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9761 for this option to have any effect.
9763 All modules should be compiled with the same @option{-G @var{num}} value.
9764 Compiling with different values of @var{num} may or may not work; if it
9765 doesn't the linker will give an error message---incorrect code will not be
9766 generated.
9768 @item -mdebug
9769 @opindex mdebug
9770 Makes the M32R specific code in the compiler display some statistics
9771 that might help in debugging programs.
9773 @item -malign-loops
9774 @opindex malign-loops
9775 Align all loops to a 32-byte boundary.
9777 @item -mno-align-loops
9778 @opindex mno-align-loops
9779 Do not enforce a 32-byte alignment for loops.  This is the default.
9781 @item -missue-rate=@var{number}
9782 @opindex missue-rate=@var{number}
9783 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9784 or 2.
9786 @item -mbranch-cost=@var{number}
9787 @opindex mbranch-cost=@var{number}
9788 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9789 preferred over conditional code, if it is 2, then the opposite will
9790 apply.
9792 @item -mflush-trap=@var{number}
9793 @opindex mflush-trap=@var{number}
9794 Specifies the trap number to use to flush the cache.  The default is
9795 12.  Valid numbers are between 0 and 15 inclusive.
9797 @item -mno-flush-trap
9798 @opindex mno-flush-trap
9799 Specifies that the cache cannot be flushed by using a trap.
9801 @item -mflush-func=@var{name}
9802 @opindex mflush-func=@var{name}
9803 Specifies the name of the operating system function to call to flush
9804 the cache.  The default is @emph{_flush_cache}, but a function call
9805 will only be used if a trap is not available.
9807 @item -mno-flush-func
9808 @opindex mno-flush-func
9809 Indicates that there is no OS function for flushing the cache.
9811 @end table
9813 @node M680x0 Options
9814 @subsection M680x0 Options
9815 @cindex M680x0 options
9817 These are the @samp{-m} options defined for the 68000 series.  The default
9818 values for these options depends on which style of 68000 was selected when
9819 the compiler was configured; the defaults for the most common choices are
9820 given below.
9822 @table @gcctabopt
9823 @item -m68000
9824 @itemx -mc68000
9825 @opindex m68000
9826 @opindex mc68000
9827 Generate output for a 68000.  This is the default
9828 when the compiler is configured for 68000-based systems.
9830 Use this option for microcontrollers with a 68000 or EC000 core,
9831 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9833 @item -m68020
9834 @itemx -mc68020
9835 @opindex m68020
9836 @opindex mc68020
9837 Generate output for a 68020.  This is the default
9838 when the compiler is configured for 68020-based systems.
9840 @item -m68881
9841 @opindex m68881
9842 Generate output containing 68881 instructions for floating point.
9843 This is the default for most 68020 systems unless @option{--nfp} was
9844 specified when the compiler was configured.
9846 @item -m68030
9847 @opindex m68030
9848 Generate output for a 68030.  This is the default when the compiler is
9849 configured for 68030-based systems.
9851 @item -m68040
9852 @opindex m68040
9853 Generate output for a 68040.  This is the default when the compiler is
9854 configured for 68040-based systems.
9856 This option inhibits the use of 68881/68882 instructions that have to be
9857 emulated by software on the 68040.  Use this option if your 68040 does not
9858 have code to emulate those instructions.
9860 @item -m68060
9861 @opindex m68060
9862 Generate output for a 68060.  This is the default when the compiler is
9863 configured for 68060-based systems.
9865 This option inhibits the use of 68020 and 68881/68882 instructions that
9866 have to be emulated by software on the 68060.  Use this option if your 68060
9867 does not have code to emulate those instructions.
9869 @item -mcpu32
9870 @opindex mcpu32
9871 Generate output for a CPU32.  This is the default
9872 when the compiler is configured for CPU32-based systems.
9874 Use this option for microcontrollers with a
9875 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9876 68336, 68340, 68341, 68349 and 68360.
9878 @item -m5200
9879 @opindex m5200
9880 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9881 when the compiler is configured for 520X-based systems.
9883 Use this option for microcontroller with a 5200 core, including
9884 the MCF5202, MCF5203, MCF5204 and MCF5202.
9887 @item -m68020-40
9888 @opindex m68020-40
9889 Generate output for a 68040, without using any of the new instructions.
9890 This results in code which can run relatively efficiently on either a
9891 68020/68881 or a 68030 or a 68040.  The generated code does use the
9892 68881 instructions that are emulated on the 68040.
9894 @item -m68020-60
9895 @opindex m68020-60
9896 Generate output for a 68060, without using any of the new instructions.
9897 This results in code which can run relatively efficiently on either a
9898 68020/68881 or a 68030 or a 68040.  The generated code does use the
9899 68881 instructions that are emulated on the 68060.
9901 @item -msoft-float
9902 @opindex msoft-float
9903 Generate output containing library calls for floating point.
9904 @strong{Warning:} the requisite libraries are not available for all m68k
9905 targets.  Normally the facilities of the machine's usual C compiler are
9906 used, but this can't be done directly in cross-compilation.  You must
9907 make your own arrangements to provide suitable library functions for
9908 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9909 @samp{m68k-*-coff} do provide software floating point support.
9911 @item -mshort
9912 @opindex mshort
9913 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9914 Additionally, parameters passed on the stack are also aligned to a
9915 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9917 @item -mnobitfield
9918 @opindex mnobitfield
9919 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9920 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9922 @item -mbitfield
9923 @opindex mbitfield
9924 Do use the bit-field instructions.  The @option{-m68020} option implies
9925 @option{-mbitfield}.  This is the default if you use a configuration
9926 designed for a 68020.
9928 @item -mrtd
9929 @opindex mrtd
9930 Use a different function-calling convention, in which functions
9931 that take a fixed number of arguments return with the @code{rtd}
9932 instruction, which pops their arguments while returning.  This
9933 saves one instruction in the caller since there is no need to pop
9934 the arguments there.
9936 This calling convention is incompatible with the one normally
9937 used on Unix, so you cannot use it if you need to call libraries
9938 compiled with the Unix compiler.
9940 Also, you must provide function prototypes for all functions that
9941 take variable numbers of arguments (including @code{printf});
9942 otherwise incorrect code will be generated for calls to those
9943 functions.
9945 In addition, seriously incorrect code will result if you call a
9946 function with too many arguments.  (Normally, extra arguments are
9947 harmlessly ignored.)
9949 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9950 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9952 @item -malign-int
9953 @itemx -mno-align-int
9954 @opindex malign-int
9955 @opindex mno-align-int
9956 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9957 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9958 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9959 Aligning variables on 32-bit boundaries produces code that runs somewhat
9960 faster on processors with 32-bit busses at the expense of more memory.
9962 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9963 align structures containing the above types  differently than
9964 most published application binary interface specifications for the m68k.
9966 @item -mpcrel
9967 @opindex mpcrel
9968 Use the pc-relative addressing mode of the 68000 directly, instead of
9969 using a global offset table.  At present, this option implies @option{-fpic},
9970 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9971 not presently supported with @option{-mpcrel}, though this could be supported for
9972 68020 and higher processors.
9974 @item -mno-strict-align
9975 @itemx -mstrict-align
9976 @opindex mno-strict-align
9977 @opindex mstrict-align
9978 Do not (do) assume that unaligned memory references will be handled by
9979 the system.
9981 @item -msep-data
9982 Generate code that allows the data segment to be located in a different
9983 area of memory from the text segment.  This allows for execute in place in
9984 an environment without virtual memory management.  This option implies
9985 @option{-fPIC}.
9987 @item -mno-sep-data
9988 Generate code that assumes that the data segment follows the text segment.
9989 This is the default.
9991 @item -mid-shared-library
9992 Generate code that supports shared libraries via the library ID method.
9993 This allows for execute in place and shared libraries in an environment
9994 without virtual memory management.  This option implies @option{-fPIC}.
9996 @item -mno-id-shared-library
9997 Generate code that doesn't assume ID based shared libraries are being used.
9998 This is the default.
10000 @item -mshared-library-id=n
10001 Specified the identification number of the ID based shared library being
10002 compiled.  Specifying a value of 0 will generate more compact code, specifying
10003 other values will force the allocation of that number to the current
10004 library but is no more space or time efficient than omitting this option.
10006 @end table
10008 @node M68hc1x Options
10009 @subsection M68hc1x Options
10010 @cindex M68hc1x options
10012 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10013 microcontrollers.  The default values for these options depends on
10014 which style of microcontroller was selected when the compiler was configured;
10015 the defaults for the most common choices are given below.
10017 @table @gcctabopt
10018 @item -m6811
10019 @itemx -m68hc11
10020 @opindex m6811
10021 @opindex m68hc11
10022 Generate output for a 68HC11.  This is the default
10023 when the compiler is configured for 68HC11-based systems.
10025 @item -m6812
10026 @itemx -m68hc12
10027 @opindex m6812
10028 @opindex m68hc12
10029 Generate output for a 68HC12.  This is the default
10030 when the compiler is configured for 68HC12-based systems.
10032 @item -m68S12
10033 @itemx -m68hcs12
10034 @opindex m68S12
10035 @opindex m68hcs12
10036 Generate output for a 68HCS12.
10038 @item -mauto-incdec
10039 @opindex mauto-incdec
10040 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10041 addressing modes.
10043 @item -minmax
10044 @itemx -nominmax
10045 @opindex minmax
10046 @opindex mnominmax
10047 Enable the use of 68HC12 min and max instructions.
10049 @item -mlong-calls
10050 @itemx -mno-long-calls
10051 @opindex mlong-calls
10052 @opindex mno-long-calls
10053 Treat all calls as being far away (near).  If calls are assumed to be
10054 far away, the compiler will use the @code{call} instruction to
10055 call a function and the @code{rtc} instruction for returning.
10057 @item -mshort
10058 @opindex mshort
10059 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10061 @item -msoft-reg-count=@var{count}
10062 @opindex msoft-reg-count
10063 Specify the number of pseudo-soft registers which are used for the
10064 code generation.  The maximum number is 32.  Using more pseudo-soft
10065 register may or may not result in better code depending on the program.
10066 The default is 4 for 68HC11 and 2 for 68HC12.
10068 @end table
10070 @node MCore Options
10071 @subsection MCore Options
10072 @cindex MCore options
10074 These are the @samp{-m} options defined for the Motorola M*Core
10075 processors.
10077 @table @gcctabopt
10079 @item -mhardlit
10080 @itemx -mno-hardlit
10081 @opindex mhardlit
10082 @opindex mno-hardlit
10083 Inline constants into the code stream if it can be done in two
10084 instructions or less.
10086 @item -mdiv
10087 @itemx -mno-div
10088 @opindex mdiv
10089 @opindex mno-div
10090 Use the divide instruction.  (Enabled by default).
10092 @item -mrelax-immediate
10093 @itemx -mno-relax-immediate
10094 @opindex mrelax-immediate
10095 @opindex mno-relax-immediate
10096 Allow arbitrary sized immediates in bit operations.
10098 @item -mwide-bitfields
10099 @itemx -mno-wide-bitfields
10100 @opindex mwide-bitfields
10101 @opindex mno-wide-bitfields
10102 Always treat bit-fields as int-sized.
10104 @item -m4byte-functions
10105 @itemx -mno-4byte-functions
10106 @opindex m4byte-functions
10107 @opindex mno-4byte-functions
10108 Force all functions to be aligned to a four byte boundary.
10110 @item -mcallgraph-data
10111 @itemx -mno-callgraph-data
10112 @opindex mcallgraph-data
10113 @opindex mno-callgraph-data
10114 Emit callgraph information.
10116 @item -mslow-bytes
10117 @itemx -mno-slow-bytes
10118 @opindex mslow-bytes
10119 @opindex mno-slow-bytes
10120 Prefer word access when reading byte quantities.
10122 @item -mlittle-endian
10123 @itemx -mbig-endian
10124 @opindex mlittle-endian
10125 @opindex mbig-endian
10126 Generate code for a little endian target.
10128 @item -m210
10129 @itemx -m340
10130 @opindex m210
10131 @opindex m340
10132 Generate code for the 210 processor.
10133 @end table
10135 @node MIPS Options
10136 @subsection MIPS Options
10137 @cindex MIPS options
10139 @table @gcctabopt
10141 @item -EB
10142 @opindex EB
10143 Generate big-endian code.
10145 @item -EL
10146 @opindex EL
10147 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10148 configurations.
10150 @item -march=@var{arch}
10151 @opindex march
10152 Generate code that will run on @var{arch}, which can be the name of a
10153 generic MIPS ISA, or the name of a particular processor.
10154 The ISA names are:
10155 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10156 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10157 The processor names are:
10158 @samp{4kc}, @samp{4km}, @samp{4kp},
10159 @samp{5kc}, @samp{5kf},
10160 @samp{20kc},
10161 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10162 @samp{m4k},
10163 @samp{orion},
10164 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10165 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10166 @samp{rm7000}, @samp{rm9000},
10167 @samp{sb1},
10168 @samp{sr71000},
10169 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10170 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10171 The special value @samp{from-abi} selects the
10172 most compatible architecture for the selected ABI (that is,
10173 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10175 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10176 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10177 @samp{vr} may be written @samp{r}.
10179 GCC defines two macros based on the value of this option.  The first
10180 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10181 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10182 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10183 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10184 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10186 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10187 above.  In other words, it will have the full prefix and will not
10188 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10189 the macro names the resolved architecture (either @samp{"mips1"} or
10190 @samp{"mips3"}).  It names the default architecture when no
10191 @option{-march} option is given.
10193 @item -mtune=@var{arch}
10194 @opindex mtune
10195 Optimize for @var{arch}.  Among other things, this option controls
10196 the way instructions are scheduled, and the perceived cost of arithmetic
10197 operations.  The list of @var{arch} values is the same as for
10198 @option{-march}.
10200 When this option is not used, GCC will optimize for the processor
10201 specified by @option{-march}.  By using @option{-march} and
10202 @option{-mtune} together, it is possible to generate code that will
10203 run on a family of processors, but optimize the code for one
10204 particular member of that family.
10206 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10207 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10208 @samp{-march} ones described above.
10210 @item -mips1
10211 @opindex mips1
10212 Equivalent to @samp{-march=mips1}.
10214 @item -mips2
10215 @opindex mips2
10216 Equivalent to @samp{-march=mips2}.
10218 @item -mips3
10219 @opindex mips3
10220 Equivalent to @samp{-march=mips3}.
10222 @item -mips4
10223 @opindex mips4
10224 Equivalent to @samp{-march=mips4}.
10226 @item -mips32
10227 @opindex mips32
10228 Equivalent to @samp{-march=mips32}.
10230 @item -mips32r2
10231 @opindex mips32r2
10232 Equivalent to @samp{-march=mips32r2}.
10234 @item -mips64
10235 @opindex mips64
10236 Equivalent to @samp{-march=mips64}.
10238 @item -mips16
10239 @itemx -mno-mips16
10240 @opindex mips16
10241 @opindex mno-mips16
10242 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10243 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10245 @item -mabi=32
10246 @itemx -mabi=o64
10247 @itemx -mabi=n32
10248 @itemx -mabi=64
10249 @itemx -mabi=eabi
10250 @opindex mabi=32
10251 @opindex mabi=o64
10252 @opindex mabi=n32
10253 @opindex mabi=64
10254 @opindex mabi=eabi
10255 Generate code for the given ABI@.
10257 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10258 generates 64-bit code when you select a 64-bit architecture, but you
10259 can use @option{-mgp32} to get 32-bit code instead.
10261 For information about the O64 ABI, see
10262 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10264 @item -mabicalls
10265 @itemx -mno-abicalls
10266 @opindex mabicalls
10267 @opindex mno-abicalls
10268 Generate (do not generate) SVR4-style position-independent code.
10269 @option{-mabicalls} is the default for SVR4-based systems.
10271 @item -mxgot
10272 @itemx -mno-xgot
10273 @opindex mxgot
10274 @opindex mno-xgot
10275 Lift (do not lift) the usual restrictions on the size of the global
10276 offset table.
10278 GCC normally uses a single instruction to load values from the GOT@.
10279 While this is relatively efficient, it will only work if the GOT
10280 is smaller than about 64k.  Anything larger will cause the linker
10281 to report an error such as:
10283 @cindex relocation truncated to fit (MIPS)
10284 @smallexample
10285 relocation truncated to fit: R_MIPS_GOT16 foobar
10286 @end smallexample
10288 If this happens, you should recompile your code with @option{-mxgot}.
10289 It should then work with very large GOTs, although it will also be
10290 less efficient, since it will take three instructions to fetch the
10291 value of a global symbol.
10293 Note that some linkers can create multiple GOTs.  If you have such a
10294 linker, you should only need to use @option{-mxgot} when a single object
10295 file accesses more than 64k's worth of GOT entries.  Very few do.
10297 These options have no effect unless GCC is generating position
10298 independent code.
10300 @item -mgp32
10301 @opindex mgp32
10302 Assume that general-purpose registers are 32 bits wide.
10304 @item -mgp64
10305 @opindex mgp64
10306 Assume that general-purpose registers are 64 bits wide.
10308 @item -mfp32
10309 @opindex mfp32
10310 Assume that floating-point registers are 32 bits wide.
10312 @item -mfp64
10313 @opindex mfp64
10314 Assume that floating-point registers are 64 bits wide.
10316 @item -mhard-float
10317 @opindex mhard-float
10318 Use floating-point coprocessor instructions.
10320 @item -msoft-float
10321 @opindex msoft-float
10322 Do not use floating-point coprocessor instructions.  Implement
10323 floating-point calculations using library calls instead.
10325 @item -msingle-float
10326 @opindex msingle-float
10327 Assume that the floating-point coprocessor only supports single-precision
10328 operations.
10330 @itemx -mdouble-float
10331 @opindex mdouble-float
10332 Assume that the floating-point coprocessor supports double-precision
10333 operations.  This is the default.
10335 @itemx -mdsp
10336 @itemx -mno-dsp
10337 @opindex mdsp
10338 @opindex mno-dsp
10339 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10341 @itemx -mpaired-single
10342 @itemx -mno-paired-single
10343 @opindex mpaired-single
10344 @opindex mno-paired-single
10345 Use (do not use) paired-single floating-point instructions.
10346 @xref{MIPS Paired-Single Support}.  This option can only be used
10347 when generating 64-bit code and requires hardware floating-point
10348 support to be enabled.
10350 @itemx -mips3d
10351 @itemx -mno-mips3d
10352 @opindex mips3d
10353 @opindex mno-mips3d
10354 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10355 The option @option{-mips3d} implies @option{-mpaired-single}.
10357 @item -mlong64
10358 @opindex mlong64
10359 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10360 an explanation of the default and the way that the pointer size is
10361 determined.
10363 @item -mlong32
10364 @opindex mlong32
10365 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10367 The default size of @code{int}s, @code{long}s and pointers depends on
10368 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10369 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10370 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10371 or the same size as integer registers, whichever is smaller.
10373 @item -msym32
10374 @itemx -mno-sym32
10375 @opindex msym32
10376 @opindex mno-sym32
10377 Assume (do not assume) that all symbols have 32-bit values, regardless
10378 of the selected ABI@.  This option is useful in combination with
10379 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10380 to generate shorter and faster references to symbolic addresses.
10382 @item -G @var{num}
10383 @opindex G
10384 @cindex smaller data references (MIPS)
10385 @cindex gp-relative references (MIPS)
10386 Put global and static items less than or equal to @var{num} bytes into
10387 the small data or bss section instead of the normal data or bss section.
10388 This allows the data to be accessed using a single instruction.
10390 All modules should be compiled with the same @option{-G @var{num}}
10391 value.
10393 @item -membedded-data
10394 @itemx -mno-embedded-data
10395 @opindex membedded-data
10396 @opindex mno-embedded-data
10397 Allocate variables to the read-only data section first if possible, then
10398 next in the small data section if possible, otherwise in data.  This gives
10399 slightly slower code than the default, but reduces the amount of RAM required
10400 when executing, and thus may be preferred for some embedded systems.
10402 @item -muninit-const-in-rodata
10403 @itemx -mno-uninit-const-in-rodata
10404 @opindex muninit-const-in-rodata
10405 @opindex mno-uninit-const-in-rodata
10406 Put uninitialized @code{const} variables in the read-only data section.
10407 This option is only meaningful in conjunction with @option{-membedded-data}.
10409 @item -msplit-addresses
10410 @itemx -mno-split-addresses
10411 @opindex msplit-addresses
10412 @opindex mno-split-addresses
10413 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10414 relocation operators.  This option has been superseded by
10415 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10417 @item -mexplicit-relocs
10418 @itemx -mno-explicit-relocs
10419 @opindex mexplicit-relocs
10420 @opindex mno-explicit-relocs
10421 Use (do not use) assembler relocation operators when dealing with symbolic
10422 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10423 is to use assembler macros instead.
10425 @option{-mexplicit-relocs} is the default if GCC was configured
10426 to use an assembler that supports relocation operators.
10428 @item -mcheck-zero-division
10429 @itemx -mno-check-zero-division
10430 @opindex mcheck-zero-division
10431 @opindex mno-check-zero-division
10432 Trap (do not trap) on integer division by zero.  The default is
10433 @option{-mcheck-zero-division}.
10435 @item -mdivide-traps
10436 @itemx -mdivide-breaks
10437 @opindex mdivide-traps
10438 @opindex mdivide-breaks
10439 MIPS systems check for division by zero by generating either a
10440 conditional trap or a break instruction.  Using traps results in
10441 smaller code, but is only supported on MIPS II and later.  Also, some
10442 versions of the Linux kernel have a bug that prevents trap from
10443 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10444 allow conditional traps on architectures that support them and
10445 @option{-mdivide-breaks} to force the use of breaks.
10447 The default is usually @option{-mdivide-traps}, but this can be
10448 overridden at configure time using @option{--with-divide=breaks}.
10449 Divide-by-zero checks can be completely disabled using
10450 @option{-mno-check-zero-division}.
10452 @item -mmemcpy
10453 @itemx -mno-memcpy
10454 @opindex mmemcpy
10455 @opindex mno-memcpy
10456 Force (do not force) the use of @code{memcpy()} for non-trivial block
10457 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10458 most constant-sized copies.
10460 @item -mlong-calls
10461 @itemx -mno-long-calls
10462 @opindex mlong-calls
10463 @opindex mno-long-calls
10464 Disable (do not disable) use of the @code{jal} instruction.  Calling
10465 functions using @code{jal} is more efficient but requires the caller
10466 and callee to be in the same 256 megabyte segment.
10468 This option has no effect on abicalls code.  The default is
10469 @option{-mno-long-calls}.
10471 @item -mmad
10472 @itemx -mno-mad
10473 @opindex mmad
10474 @opindex mno-mad
10475 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10476 instructions, as provided by the R4650 ISA@.
10478 @item -mfused-madd
10479 @itemx -mno-fused-madd
10480 @opindex mfused-madd
10481 @opindex mno-fused-madd
10482 Enable (disable) use of the floating point multiply-accumulate
10483 instructions, when they are available.  The default is
10484 @option{-mfused-madd}.
10486 When multiply-accumulate instructions are used, the intermediate
10487 product is calculated to infinite precision and is not subject to
10488 the FCSR Flush to Zero bit.  This may be undesirable in some
10489 circumstances.
10491 @item -nocpp
10492 @opindex nocpp
10493 Tell the MIPS assembler to not run its preprocessor over user
10494 assembler files (with a @samp{.s} suffix) when assembling them.
10496 @item -mfix-r4000
10497 @itemx -mno-fix-r4000
10498 @opindex mfix-r4000
10499 @opindex mno-fix-r4000
10500 Work around certain R4000 CPU errata:
10501 @itemize @minus
10502 @item
10503 A double-word or a variable shift may give an incorrect result if executed
10504 immediately after starting an integer division.
10505 @item
10506 A double-word or a variable shift may give an incorrect result if executed
10507 while an integer multiplication is in progress.
10508 @item
10509 An integer division may give an incorrect result if started in a delay slot
10510 of a taken branch or a jump.
10511 @end itemize
10513 @item -mfix-r4400
10514 @itemx -mno-fix-r4400
10515 @opindex mfix-r4400
10516 @opindex mno-fix-r4400
10517 Work around certain R4400 CPU errata:
10518 @itemize @minus
10519 @item
10520 A double-word or a variable shift may give an incorrect result if executed
10521 immediately after starting an integer division.
10522 @end itemize
10524 @item -mfix-vr4120
10525 @itemx -mno-fix-vr4120
10526 @opindex mfix-vr4120
10527 Work around certain VR4120 errata:
10528 @itemize @minus
10529 @item
10530 @code{dmultu} does not always produce the correct result.
10531 @item
10532 @code{div} and @code{ddiv} do not always produce the correct result if one
10533 of the operands is negative.
10534 @end itemize
10535 The workarounds for the division errata rely on special functions in
10536 @file{libgcc.a}.  At present, these functions are only provided by
10537 the @code{mips64vr*-elf} configurations.
10539 Other VR4120 errata require a nop to be inserted between certain pairs of
10540 instructions.  These errata are handled by the assembler, not by GCC itself.
10542 @item -mfix-vr4130
10543 @opindex mfix-vr4130
10544 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10545 workarounds are implemented by the assembler rather than by GCC,
10546 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10547 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10548 instructions are available instead.
10550 @item -mfix-sb1
10551 @itemx -mno-fix-sb1
10552 @opindex mfix-sb1
10553 Work around certain SB-1 CPU core errata.
10554 (This flag currently works around the SB-1 revision 2
10555 ``F1'' and ``F2'' floating point errata.)
10557 @item -mflush-func=@var{func}
10558 @itemx -mno-flush-func
10559 @opindex mflush-func
10560 Specifies the function to call to flush the I and D caches, or to not
10561 call any such function.  If called, the function must take the same
10562 arguments as the common @code{_flush_func()}, that is, the address of the
10563 memory range for which the cache is being flushed, the size of the
10564 memory range, and the number 3 (to flush both caches).  The default
10565 depends on the target GCC was configured for, but commonly is either
10566 @samp{_flush_func} or @samp{__cpu_flush}.
10568 @item -mbranch-likely
10569 @itemx -mno-branch-likely
10570 @opindex mbranch-likely
10571 @opindex mno-branch-likely
10572 Enable or disable use of Branch Likely instructions, regardless of the
10573 default for the selected architecture.  By default, Branch Likely
10574 instructions may be generated if they are supported by the selected
10575 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10576 and processors which implement those architectures; for those, Branch
10577 Likely instructions will not be generated by default because the MIPS32
10578 and MIPS64 architectures specifically deprecate their use.
10580 @item -mfp-exceptions
10581 @itemx -mno-fp-exceptions
10582 @opindex mfp-exceptions
10583 Specifies whether FP exceptions are enabled.  This affects how we schedule
10584 FP instructions for some processors.  The default is that FP exceptions are
10585 enabled.
10587 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10588 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10589 FP pipe.
10591 @item -mvr4130-align
10592 @itemx -mno-vr4130-align
10593 @opindex mvr4130-align
10594 The VR4130 pipeline is two-way superscalar, but can only issue two
10595 instructions together if the first one is 8-byte aligned.  When this
10596 option is enabled, GCC will align pairs of instructions that it
10597 thinks should execute in parallel.
10599 This option only has an effect when optimizing for the VR4130.
10600 It normally makes code faster, but at the expense of making it bigger.
10601 It is enabled by default at optimization level @option{-O3}.
10602 @end table
10604 @node MMIX Options
10605 @subsection MMIX Options
10606 @cindex MMIX Options
10608 These options are defined for the MMIX:
10610 @table @gcctabopt
10611 @item -mlibfuncs
10612 @itemx -mno-libfuncs
10613 @opindex mlibfuncs
10614 @opindex mno-libfuncs
10615 Specify that intrinsic library functions are being compiled, passing all
10616 values in registers, no matter the size.
10618 @item -mepsilon
10619 @itemx -mno-epsilon
10620 @opindex mepsilon
10621 @opindex mno-epsilon
10622 Generate floating-point comparison instructions that compare with respect
10623 to the @code{rE} epsilon register.
10625 @item -mabi=mmixware
10626 @itemx -mabi=gnu
10627 @opindex mabi-mmixware
10628 @opindex mabi=gnu
10629 Generate code that passes function parameters and return values that (in
10630 the called function) are seen as registers @code{$0} and up, as opposed to
10631 the GNU ABI which uses global registers @code{$231} and up.
10633 @item -mzero-extend
10634 @itemx -mno-zero-extend
10635 @opindex mzero-extend
10636 @opindex mno-zero-extend
10637 When reading data from memory in sizes shorter than 64 bits, use (do not
10638 use) zero-extending load instructions by default, rather than
10639 sign-extending ones.
10641 @item -mknuthdiv
10642 @itemx -mno-knuthdiv
10643 @opindex mknuthdiv
10644 @opindex mno-knuthdiv
10645 Make the result of a division yielding a remainder have the same sign as
10646 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10647 remainder follows the sign of the dividend.  Both methods are
10648 arithmetically valid, the latter being almost exclusively used.
10650 @item -mtoplevel-symbols
10651 @itemx -mno-toplevel-symbols
10652 @opindex mtoplevel-symbols
10653 @opindex mno-toplevel-symbols
10654 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10655 code can be used with the @code{PREFIX} assembly directive.
10657 @item -melf
10658 @opindex melf
10659 Generate an executable in the ELF format, rather than the default
10660 @samp{mmo} format used by the @command{mmix} simulator.
10662 @item -mbranch-predict
10663 @itemx -mno-branch-predict
10664 @opindex mbranch-predict
10665 @opindex mno-branch-predict
10666 Use (do not use) the probable-branch instructions, when static branch
10667 prediction indicates a probable branch.
10669 @item -mbase-addresses
10670 @itemx -mno-base-addresses
10671 @opindex mbase-addresses
10672 @opindex mno-base-addresses
10673 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10674 base address automatically generates a request (handled by the assembler
10675 and the linker) for a constant to be set up in a global register.  The
10676 register is used for one or more base address requests within the range 0
10677 to 255 from the value held in the register.  The generally leads to short
10678 and fast code, but the number of different data items that can be
10679 addressed is limited.  This means that a program that uses lots of static
10680 data may require @option{-mno-base-addresses}.
10682 @item -msingle-exit
10683 @itemx -mno-single-exit
10684 @opindex msingle-exit
10685 @opindex mno-single-exit
10686 Force (do not force) generated code to have a single exit point in each
10687 function.
10688 @end table
10690 @node MN10300 Options
10691 @subsection MN10300 Options
10692 @cindex MN10300 options
10694 These @option{-m} options are defined for Matsushita MN10300 architectures:
10696 @table @gcctabopt
10697 @item -mmult-bug
10698 @opindex mmult-bug
10699 Generate code to avoid bugs in the multiply instructions for the MN10300
10700 processors.  This is the default.
10702 @item -mno-mult-bug
10703 @opindex mno-mult-bug
10704 Do not generate code to avoid bugs in the multiply instructions for the
10705 MN10300 processors.
10707 @item -mam33
10708 @opindex mam33
10709 Generate code which uses features specific to the AM33 processor.
10711 @item -mno-am33
10712 @opindex mno-am33
10713 Do not generate code which uses features specific to the AM33 processor.  This
10714 is the default.
10716 @item -mreturn-pointer-on-d0
10717 @opindex mreturn-pointer-on-d0
10718 When generating a function which returns a pointer, return the pointer
10719 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10720 only in a0, and attempts to call such functions without a prototype
10721 would result in errors.  Note that this option is on by default; use
10722 @option{-mno-return-pointer-on-d0} to disable it.
10724 @item -mno-crt0
10725 @opindex mno-crt0
10726 Do not link in the C run-time initialization object file.
10728 @item -mrelax
10729 @opindex mrelax
10730 Indicate to the linker that it should perform a relaxation optimization pass
10731 to shorten branches, calls and absolute memory addresses.  This option only
10732 has an effect when used on the command line for the final link step.
10734 This option makes symbolic debugging impossible.
10735 @end table
10737 @node MT Options
10738 @subsection MT Options
10739 @cindex MT options
10741 These @option{-m} options are defined for Morpho MT architectures:
10743 @table @gcctabopt
10745 @item -march=@var{cpu-type}
10746 @opindex march
10747 Generate code that will run on @var{cpu-type}, which is the name of a system
10748 representing a certain processor type.  Possible values for
10749 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10750 @samp{ms1-16-003} and @samp{ms2}.
10752 When this option is not used, the default is @option{-march=ms1-16-002}.
10754 @item -mbacc
10755 @opindex mbacc
10756 Use byte loads and stores when generating code.
10758 @item -mno-bacc
10759 @opindex mno-bacc
10760 Do not use byte loads and stores when generating code.
10762 @item -msim
10763 @opindex msim
10764 Use simulator runtime
10766 @item -mno-crt0
10767 @opindex mno-crt0
10768 Do not link in the C run-time initialization object file
10769 @file{crti.o}.  Other run-time initialization and termination files
10770 such as @file{startup.o} and @file{exit.o} are still included on the
10771 linker command line.
10773 @end table
10775 @node PDP-11 Options
10776 @subsection PDP-11 Options
10777 @cindex PDP-11 Options
10779 These options are defined for the PDP-11:
10781 @table @gcctabopt
10782 @item -mfpu
10783 @opindex mfpu
10784 Use hardware FPP floating point.  This is the default.  (FIS floating
10785 point on the PDP-11/40 is not supported.)
10787 @item -msoft-float
10788 @opindex msoft-float
10789 Do not use hardware floating point.
10791 @item -mac0
10792 @opindex mac0
10793 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10795 @item -mno-ac0
10796 @opindex mno-ac0
10797 Return floating-point results in memory.  This is the default.
10799 @item -m40
10800 @opindex m40
10801 Generate code for a PDP-11/40.
10803 @item -m45
10804 @opindex m45
10805 Generate code for a PDP-11/45.  This is the default.
10807 @item -m10
10808 @opindex m10
10809 Generate code for a PDP-11/10.
10811 @item -mbcopy-builtin
10812 @opindex bcopy-builtin
10813 Use inline @code{movmemhi} patterns for copying memory.  This is the
10814 default.
10816 @item -mbcopy
10817 @opindex mbcopy
10818 Do not use inline @code{movmemhi} patterns for copying memory.
10820 @item -mint16
10821 @itemx -mno-int32
10822 @opindex mint16
10823 @opindex mno-int32
10824 Use 16-bit @code{int}.  This is the default.
10826 @item -mint32
10827 @itemx -mno-int16
10828 @opindex mint32
10829 @opindex mno-int16
10830 Use 32-bit @code{int}.
10832 @item -mfloat64
10833 @itemx -mno-float32
10834 @opindex mfloat64
10835 @opindex mno-float32
10836 Use 64-bit @code{float}.  This is the default.
10838 @item -mfloat32
10839 @itemx -mno-float64
10840 @opindex mfloat32
10841 @opindex mno-float64
10842 Use 32-bit @code{float}.
10844 @item -mabshi
10845 @opindex mabshi
10846 Use @code{abshi2} pattern.  This is the default.
10848 @item -mno-abshi
10849 @opindex mno-abshi
10850 Do not use @code{abshi2} pattern.
10852 @item -mbranch-expensive
10853 @opindex mbranch-expensive
10854 Pretend that branches are expensive.  This is for experimenting with
10855 code generation only.
10857 @item -mbranch-cheap
10858 @opindex mbranch-cheap
10859 Do not pretend that branches are expensive.  This is the default.
10861 @item -msplit
10862 @opindex msplit
10863 Generate code for a system with split I&D@.
10865 @item -mno-split
10866 @opindex mno-split
10867 Generate code for a system without split I&D@.  This is the default.
10869 @item -munix-asm
10870 @opindex munix-asm
10871 Use Unix assembler syntax.  This is the default when configured for
10872 @samp{pdp11-*-bsd}.
10874 @item -mdec-asm
10875 @opindex mdec-asm
10876 Use DEC assembler syntax.  This is the default when configured for any
10877 PDP-11 target other than @samp{pdp11-*-bsd}.
10878 @end table
10880 @node PowerPC Options
10881 @subsection PowerPC Options
10882 @cindex PowerPC options
10884 These are listed under @xref{RS/6000 and PowerPC Options}.
10886 @node RS/6000 and PowerPC Options
10887 @subsection IBM RS/6000 and PowerPC Options
10888 @cindex RS/6000 and PowerPC Options
10889 @cindex IBM RS/6000 and PowerPC Options
10891 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10892 @table @gcctabopt
10893 @item -mpower
10894 @itemx -mno-power
10895 @itemx -mpower2
10896 @itemx -mno-power2
10897 @itemx -mpowerpc
10898 @itemx -mno-powerpc
10899 @itemx -mpowerpc-gpopt
10900 @itemx -mno-powerpc-gpopt
10901 @itemx -mpowerpc-gfxopt
10902 @itemx -mno-powerpc-gfxopt
10903 @itemx -mpowerpc64
10904 @itemx -mno-powerpc64
10905 @itemx -mmfcrf
10906 @itemx -mno-mfcrf
10907 @itemx -mpopcntb
10908 @itemx -mno-popcntb
10909 @itemx -mfprnd
10910 @itemx -mno-fprnd
10911 @opindex mpower
10912 @opindex mno-power
10913 @opindex mpower2
10914 @opindex mno-power2
10915 @opindex mpowerpc
10916 @opindex mno-powerpc
10917 @opindex mpowerpc-gpopt
10918 @opindex mno-powerpc-gpopt
10919 @opindex mpowerpc-gfxopt
10920 @opindex mno-powerpc-gfxopt
10921 @opindex mpowerpc64
10922 @opindex mno-powerpc64
10923 @opindex mmfcrf
10924 @opindex mno-mfcrf
10925 @opindex mpopcntb
10926 @opindex mno-popcntb
10927 @opindex mfprnd
10928 @opindex mno-fprnd
10929 GCC supports two related instruction set architectures for the
10930 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10931 instructions supported by the @samp{rios} chip set used in the original
10932 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10933 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10934 the IBM 4xx, 6xx, and follow-on microprocessors.
10936 Neither architecture is a subset of the other.  However there is a
10937 large common subset of instructions supported by both.  An MQ
10938 register is included in processors supporting the POWER architecture.
10940 You use these options to specify which instructions are available on the
10941 processor you are using.  The default value of these options is
10942 determined when configuring GCC@.  Specifying the
10943 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10944 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10945 rather than the options listed above.
10947 The @option{-mpower} option allows GCC to generate instructions that
10948 are found only in the POWER architecture and to use the MQ register.
10949 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10950 to generate instructions that are present in the POWER2 architecture but
10951 not the original POWER architecture.
10953 The @option{-mpowerpc} option allows GCC to generate instructions that
10954 are found only in the 32-bit subset of the PowerPC architecture.
10955 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10956 GCC to use the optional PowerPC architecture instructions in the
10957 General Purpose group, including floating-point square root.  Specifying
10958 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10959 use the optional PowerPC architecture instructions in the Graphics
10960 group, including floating-point select.
10962 The @option{-mmfcrf} option allows GCC to generate the move from
10963 condition register field instruction implemented on the POWER4
10964 processor and other processors that support the PowerPC V2.01
10965 architecture.
10966 The @option{-mpopcntb} option allows GCC to generate the popcount and
10967 double precision FP reciprocal estimate instruction implemented on the
10968 POWER5 processor and other processors that support the PowerPC V2.02
10969 architecture.
10970 The @option{-mfprnd} option allows GCC to generate the FP round to
10971 integer instructions implemented on the POWER5+ processor and other
10972 processors that support the PowerPC V2.03 architecture.
10974 The @option{-mpowerpc64} option allows GCC to generate the additional
10975 64-bit instructions that are found in the full PowerPC64 architecture
10976 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10977 @option{-mno-powerpc64}.
10979 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10980 will use only the instructions in the common subset of both
10981 architectures plus some special AIX common-mode calls, and will not use
10982 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10983 permits GCC to use any instruction from either architecture and to
10984 allow use of the MQ register; specify this for the Motorola MPC601.
10986 @item -mnew-mnemonics
10987 @itemx -mold-mnemonics
10988 @opindex mnew-mnemonics
10989 @opindex mold-mnemonics
10990 Select which mnemonics to use in the generated assembler code.  With
10991 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10992 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10993 assembler mnemonics defined for the POWER architecture.  Instructions
10994 defined in only one architecture have only one mnemonic; GCC uses that
10995 mnemonic irrespective of which of these options is specified.
10997 GCC defaults to the mnemonics appropriate for the architecture in
10998 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10999 value of these option.  Unless you are building a cross-compiler, you
11000 should normally not specify either @option{-mnew-mnemonics} or
11001 @option{-mold-mnemonics}, but should instead accept the default.
11003 @item -mcpu=@var{cpu_type}
11004 @opindex mcpu
11005 Set architecture type, register usage, choice of mnemonics, and
11006 instruction scheduling parameters for machine type @var{cpu_type}.
11007 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11008 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11009 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11010 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11011 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11012 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11013 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11014 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11015 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11016 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11018 @option{-mcpu=common} selects a completely generic processor.  Code
11019 generated under this option will run on any POWER or PowerPC processor.
11020 GCC will use only the instructions in the common subset of both
11021 architectures, and will not use the MQ register.  GCC assumes a generic
11022 processor model for scheduling purposes.
11024 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11025 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11026 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11027 types, with an appropriate, generic processor model assumed for
11028 scheduling purposes.
11030 The other options specify a specific processor.  Code generated under
11031 those options will run best on that processor, and may not run at all on
11032 others.
11034 The @option{-mcpu} options automatically enable or disable the
11035 following options: @option{-maltivec}, @option{-mfprnd},
11036 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11037 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11038 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11039 @option{-mpowerpc-gfxopt}, @option{-mstring}.  The particular options
11040 set for any particular CPU will vary between compiler versions,
11041 depending on what setting seems to produce optimal code for that CPU;
11042 it doesn't necessarily reflect the actual hardware's capabilities.  If
11043 you wish to set an individual option to a particular value, you may
11044 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11045 -mno-altivec}.
11047 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11048 not enabled or disabled by the @option{-mcpu} option at present because
11049 AIX does not have full support for these options.  You may still
11050 enable or disable them individually if you're sure it'll work in your
11051 environment.
11053 @item -mtune=@var{cpu_type}
11054 @opindex mtune
11055 Set the instruction scheduling parameters for machine type
11056 @var{cpu_type}, but do not set the architecture type, register usage, or
11057 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11058 values for @var{cpu_type} are used for @option{-mtune} as for
11059 @option{-mcpu}.  If both are specified, the code generated will use the
11060 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11061 scheduling parameters set by @option{-mtune}.
11063 @item -mswdiv
11064 @itemx -mno-swdiv
11065 @opindex mswdiv
11066 @opindex mno-swdiv
11067 Generate code to compute division as reciprocal estimate and iterative
11068 refinement, creating opportunities for increased throughput.  This
11069 feature requires: optional PowerPC Graphics instruction set for single
11070 precision and FRE instruction for double precision, assuming divides
11071 cannot generate user-visible traps, and the domain values not include
11072 Infinities, denormals or zero denominator.
11074 @item -maltivec
11075 @itemx -mno-altivec
11076 @opindex maltivec
11077 @opindex mno-altivec
11078 Generate code that uses (does not use) AltiVec instructions, and also
11079 enable the use of built-in functions that allow more direct access to
11080 the AltiVec instruction set.  You may also need to set
11081 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11082 enhancements.
11084 @item -mvrsave
11085 @item -mno-vrsave
11086 @opindex mvrsave
11087 @opindex mno-vrsave
11088 Generate VRSAVE instructions when generating AltiVec code.
11090 @item -msecure-plt
11091 @opindex msecure-plt
11092 Generate code that allows ld and ld.so to build executables and shared
11093 libraries with non-exec .plt and .got sections.  This is a PowerPC
11094 32-bit SYSV ABI option.
11096 @item -mbss-plt
11097 @opindex mbss-plt
11098 Generate code that uses a BSS .plt section that ld.so fills in, and
11099 requires .plt and .got sections that are both writable and executable.
11100 This is a PowerPC 32-bit SYSV ABI option.
11102 @item -misel
11103 @itemx -mno-isel
11104 @opindex misel
11105 @opindex mno-isel
11106 This switch enables or disables the generation of ISEL instructions.
11108 @item -misel=@var{yes/no}
11109 This switch has been deprecated.  Use @option{-misel} and
11110 @option{-mno-isel} instead.
11112 @item -mspe
11113 @itemx -mno-isel
11114 @opindex mspe
11115 @opindex mno-spe
11116 This switch enables or disables the generation of SPE simd
11117 instructions.
11119 @item -mspe=@var{yes/no}
11120 This option has been deprecated.  Use @option{-mspe} and
11121 @option{-mno-spe} instead.
11123 @item -mfloat-gprs=@var{yes/single/double/no}
11124 @itemx -mfloat-gprs
11125 @opindex mfloat-gprs
11126 This switch enables or disables the generation of floating point
11127 operations on the general purpose registers for architectures that
11128 support it.
11130 The argument @var{yes} or @var{single} enables the use of
11131 single-precision floating point operations.
11133 The argument @var{double} enables the use of single and
11134 double-precision floating point operations.
11136 The argument @var{no} disables floating point operations on the
11137 general purpose registers.
11139 This option is currently only available on the MPC854x.
11141 @item -m32
11142 @itemx -m64
11143 @opindex m32
11144 @opindex m64
11145 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11146 targets (including GNU/Linux).  The 32-bit environment sets int, long
11147 and pointer to 32 bits and generates code that runs on any PowerPC
11148 variant.  The 64-bit environment sets int to 32 bits and long and
11149 pointer to 64 bits, and generates code for PowerPC64, as for
11150 @option{-mpowerpc64}.
11152 @item -mfull-toc
11153 @itemx -mno-fp-in-toc
11154 @itemx -mno-sum-in-toc
11155 @itemx -mminimal-toc
11156 @opindex mfull-toc
11157 @opindex mno-fp-in-toc
11158 @opindex mno-sum-in-toc
11159 @opindex mminimal-toc
11160 Modify generation of the TOC (Table Of Contents), which is created for
11161 every executable file.  The @option{-mfull-toc} option is selected by
11162 default.  In that case, GCC will allocate at least one TOC entry for
11163 each unique non-automatic variable reference in your program.  GCC
11164 will also place floating-point constants in the TOC@.  However, only
11165 16,384 entries are available in the TOC@.
11167 If you receive a linker error message that saying you have overflowed
11168 the available TOC space, you can reduce the amount of TOC space used
11169 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11170 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11171 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11172 generate code to calculate the sum of an address and a constant at
11173 run-time instead of putting that sum into the TOC@.  You may specify one
11174 or both of these options.  Each causes GCC to produce very slightly
11175 slower and larger code at the expense of conserving TOC space.
11177 If you still run out of space in the TOC even when you specify both of
11178 these options, specify @option{-mminimal-toc} instead.  This option causes
11179 GCC to make only one TOC entry for every file.  When you specify this
11180 option, GCC will produce code that is slower and larger but which
11181 uses extremely little TOC space.  You may wish to use this option
11182 only on files that contain less frequently executed code.
11184 @item -maix64
11185 @itemx -maix32
11186 @opindex maix64
11187 @opindex maix32
11188 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11189 @code{long} type, and the infrastructure needed to support them.
11190 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11191 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11192 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11194 @item -mxl-compat
11195 @itemx -mno-xl-compat
11196 @opindex mxl-compat
11197 @opindex mno-xl-compat
11198 Produce code that conforms more closely to IBM XL compiler semantics
11199 when using AIX-compatible ABI.  Pass floating-point arguments to
11200 prototyped functions beyond the register save area (RSA) on the stack
11201 in addition to argument FPRs.  Do not assume that most significant
11202 double in 128-bit long double value is properly rounded when comparing
11203 values and converting to double.  Use XL symbol names for long double
11204 support routines.
11206 The AIX calling convention was extended but not initially documented to
11207 handle an obscure K&R C case of calling a function that takes the
11208 address of its arguments with fewer arguments than declared.  IBM XL
11209 compilers access floating point arguments which do not fit in the
11210 RSA from the stack when a subroutine is compiled without
11211 optimization.  Because always storing floating-point arguments on the
11212 stack is inefficient and rarely needed, this option is not enabled by
11213 default and only is necessary when calling subroutines compiled by IBM
11214 XL compilers without optimization.
11216 @item -mpe
11217 @opindex mpe
11218 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11219 application written to use message passing with special startup code to
11220 enable the application to run.  The system must have PE installed in the
11221 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11222 must be overridden with the @option{-specs=} option to specify the
11223 appropriate directory location.  The Parallel Environment does not
11224 support threads, so the @option{-mpe} option and the @option{-pthread}
11225 option are incompatible.
11227 @item -malign-natural
11228 @itemx -malign-power
11229 @opindex malign-natural
11230 @opindex malign-power
11231 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11232 @option{-malign-natural} overrides the ABI-defined alignment of larger
11233 types, such as floating-point doubles, on their natural size-based boundary.
11234 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11235 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11237 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11238 is not supported.
11240 @item -msoft-float
11241 @itemx -mhard-float
11242 @opindex msoft-float
11243 @opindex mhard-float
11244 Generate code that does not use (uses) the floating-point register set.
11245 Software floating point emulation is provided if you use the
11246 @option{-msoft-float} option, and pass the option to GCC when linking.
11248 @item -mmultiple
11249 @itemx -mno-multiple
11250 @opindex mmultiple
11251 @opindex mno-multiple
11252 Generate code that uses (does not use) the load multiple word
11253 instructions and the store multiple word instructions.  These
11254 instructions are generated by default on POWER systems, and not
11255 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11256 endian PowerPC systems, since those instructions do not work when the
11257 processor is in little endian mode.  The exceptions are PPC740 and
11258 PPC750 which permit the instructions usage in little endian mode.
11260 @item -mstring
11261 @itemx -mno-string
11262 @opindex mstring
11263 @opindex mno-string
11264 Generate code that uses (does not use) the load string instructions
11265 and the store string word instructions to save multiple registers and
11266 do small block moves.  These instructions are generated by default on
11267 POWER systems, and not generated on PowerPC systems.  Do not use
11268 @option{-mstring} on little endian PowerPC systems, since those
11269 instructions do not work when the processor is in little endian mode.
11270 The exceptions are PPC740 and PPC750 which permit the instructions
11271 usage in little endian mode.
11273 @item -mupdate
11274 @itemx -mno-update
11275 @opindex mupdate
11276 @opindex mno-update
11277 Generate code that uses (does not use) the load or store instructions
11278 that update the base register to the address of the calculated memory
11279 location.  These instructions are generated by default.  If you use
11280 @option{-mno-update}, there is a small window between the time that the
11281 stack pointer is updated and the address of the previous frame is
11282 stored, which means code that walks the stack frame across interrupts or
11283 signals may get corrupted data.
11285 @item -mfused-madd
11286 @itemx -mno-fused-madd
11287 @opindex mfused-madd
11288 @opindex mno-fused-madd
11289 Generate code that uses (does not use) the floating point multiply and
11290 accumulate instructions.  These instructions are generated by default if
11291 hardware floating is used.
11293 @item -mno-bit-align
11294 @itemx -mbit-align
11295 @opindex mno-bit-align
11296 @opindex mbit-align
11297 On System V.4 and embedded PowerPC systems do not (do) force structures
11298 and unions that contain bit-fields to be aligned to the base type of the
11299 bit-field.
11301 For example, by default a structure containing nothing but 8
11302 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11303 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11304 the structure would be aligned to a 1 byte boundary and be one byte in
11305 size.
11307 @item -mno-strict-align
11308 @itemx -mstrict-align
11309 @opindex mno-strict-align
11310 @opindex mstrict-align
11311 On System V.4 and embedded PowerPC systems do not (do) assume that
11312 unaligned memory references will be handled by the system.
11314 @item -mrelocatable
11315 @itemx -mno-relocatable
11316 @opindex mrelocatable
11317 @opindex mno-relocatable
11318 On embedded PowerPC systems generate code that allows (does not allow)
11319 the program to be relocated to a different address at runtime.  If you
11320 use @option{-mrelocatable} on any module, all objects linked together must
11321 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11323 @item -mrelocatable-lib
11324 @itemx -mno-relocatable-lib
11325 @opindex mrelocatable-lib
11326 @opindex mno-relocatable-lib
11327 On embedded PowerPC systems generate code that allows (does not allow)
11328 the program to be relocated to a different address at runtime.  Modules
11329 compiled with @option{-mrelocatable-lib} can be linked with either modules
11330 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11331 with modules compiled with the @option{-mrelocatable} options.
11333 @item -mno-toc
11334 @itemx -mtoc
11335 @opindex mno-toc
11336 @opindex mtoc
11337 On System V.4 and embedded PowerPC systems do not (do) assume that
11338 register 2 contains a pointer to a global area pointing to the addresses
11339 used in the program.
11341 @item -mlittle
11342 @itemx -mlittle-endian
11343 @opindex mlittle
11344 @opindex mlittle-endian
11345 On System V.4 and embedded PowerPC systems compile code for the
11346 processor in little endian mode.  The @option{-mlittle-endian} option is
11347 the same as @option{-mlittle}.
11349 @item -mbig
11350 @itemx -mbig-endian
11351 @opindex mbig
11352 @opindex mbig-endian
11353 On System V.4 and embedded PowerPC systems compile code for the
11354 processor in big endian mode.  The @option{-mbig-endian} option is
11355 the same as @option{-mbig}.
11357 @item -mdynamic-no-pic
11358 @opindex mdynamic-no-pic
11359 On Darwin and Mac OS X systems, compile code so that it is not
11360 relocatable, but that its external references are relocatable.  The
11361 resulting code is suitable for applications, but not shared
11362 libraries.
11364 @item -mprioritize-restricted-insns=@var{priority}
11365 @opindex mprioritize-restricted-insns
11366 This option controls the priority that is assigned to
11367 dispatch-slot restricted instructions during the second scheduling
11368 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11369 @var{no/highest/second-highest} priority to dispatch slot restricted
11370 instructions.
11372 @item -msched-costly-dep=@var{dependence_type}
11373 @opindex msched-costly-dep
11374 This option controls which dependences are considered costly
11375 by the target during instruction scheduling.  The argument
11376 @var{dependence_type} takes one of the following values:
11377 @var{no}: no dependence is costly,
11378 @var{all}: all dependences are costly,
11379 @var{true_store_to_load}: a true dependence from store to load is costly,
11380 @var{store_to_load}: any dependence from store to load is costly,
11381 @var{number}: any dependence which latency >= @var{number} is costly.
11383 @item -minsert-sched-nops=@var{scheme}
11384 @opindex minsert-sched-nops
11385 This option controls which nop insertion scheme will be used during
11386 the second scheduling pass.  The argument @var{scheme} takes one of the
11387 following values:
11388 @var{no}: Don't insert nops.
11389 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11390 according to the scheduler's grouping.
11391 @var{regroup_exact}: Insert nops to force costly dependent insns into
11392 separate groups.  Insert exactly as many nops as needed to force an insn
11393 to a new group, according to the estimated processor grouping.
11394 @var{number}: Insert nops to force costly dependent insns into
11395 separate groups.  Insert @var{number} nops to force an insn to a new group.
11397 @item -mcall-sysv
11398 @opindex mcall-sysv
11399 On System V.4 and embedded PowerPC systems compile code using calling
11400 conventions that adheres to the March 1995 draft of the System V
11401 Application Binary Interface, PowerPC processor supplement.  This is the
11402 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11404 @item -mcall-sysv-eabi
11405 @opindex mcall-sysv-eabi
11406 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11408 @item -mcall-sysv-noeabi
11409 @opindex mcall-sysv-noeabi
11410 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11412 @item -mcall-solaris
11413 @opindex mcall-solaris
11414 On System V.4 and embedded PowerPC systems compile code for the Solaris
11415 operating system.
11417 @item -mcall-linux
11418 @opindex mcall-linux
11419 On System V.4 and embedded PowerPC systems compile code for the
11420 Linux-based GNU system.
11422 @item -mcall-gnu
11423 @opindex mcall-gnu
11424 On System V.4 and embedded PowerPC systems compile code for the
11425 Hurd-based GNU system.
11427 @item -mcall-netbsd
11428 @opindex mcall-netbsd
11429 On System V.4 and embedded PowerPC systems compile code for the
11430 NetBSD operating system.
11432 @item -maix-struct-return
11433 @opindex maix-struct-return
11434 Return all structures in memory (as specified by the AIX ABI)@.
11436 @item -msvr4-struct-return
11437 @opindex msvr4-struct-return
11438 Return structures smaller than 8 bytes in registers (as specified by the
11439 SVR4 ABI)@.
11441 @item -mabi=@var{abi-type}
11442 @opindex mabi
11443 Extend the current ABI with a particular extension, or remove such extension.
11444 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11445 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11447 @item -mabi=spe
11448 @opindex mabi=spe
11449 Extend the current ABI with SPE ABI extensions.  This does not change
11450 the default ABI, instead it adds the SPE ABI extensions to the current
11451 ABI@.
11453 @item -mabi=no-spe
11454 @opindex mabi=no-spe
11455 Disable Booke SPE ABI extensions for the current ABI@.
11457 @item -mabi=ibmlongdouble
11458 @opindex mabi=ibmlongdouble
11459 Change the current ABI to use IBM extended precision long double.
11460 This is a PowerPC 32-bit SYSV ABI option.
11462 @item -mabi=ieeelongdouble
11463 @opindex mabi=ieeelongdouble
11464 Change the current ABI to use IEEE extended precision long double.
11465 This is a PowerPC 32-bit Linux ABI option.
11467 @item -mprototype
11468 @itemx -mno-prototype
11469 @opindex mprototype
11470 @opindex mno-prototype
11471 On System V.4 and embedded PowerPC systems assume that all calls to
11472 variable argument functions are properly prototyped.  Otherwise, the
11473 compiler must insert an instruction before every non prototyped call to
11474 set or clear bit 6 of the condition code register (@var{CR}) to
11475 indicate whether floating point values were passed in the floating point
11476 registers in case the function takes a variable arguments.  With
11477 @option{-mprototype}, only calls to prototyped variable argument functions
11478 will set or clear the bit.
11480 @item -msim
11481 @opindex msim
11482 On embedded PowerPC systems, assume that the startup module is called
11483 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11484 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11485 configurations.
11487 @item -mmvme
11488 @opindex mmvme
11489 On embedded PowerPC systems, assume that the startup module is called
11490 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11491 @file{libc.a}.
11493 @item -mads
11494 @opindex mads
11495 On embedded PowerPC systems, assume that the startup module is called
11496 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11497 @file{libc.a}.
11499 @item -myellowknife
11500 @opindex myellowknife
11501 On embedded PowerPC systems, assume that the startup module is called
11502 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11503 @file{libc.a}.
11505 @item -mvxworks
11506 @opindex mvxworks
11507 On System V.4 and embedded PowerPC systems, specify that you are
11508 compiling for a VxWorks system.
11510 @item -mwindiss
11511 @opindex mwindiss
11512 Specify that you are compiling for the WindISS simulation environment.
11514 @item -memb
11515 @opindex memb
11516 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11517 header to indicate that @samp{eabi} extended relocations are used.
11519 @item -meabi
11520 @itemx -mno-eabi
11521 @opindex meabi
11522 @opindex mno-eabi
11523 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11524 Embedded Applications Binary Interface (eabi) which is a set of
11525 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11526 means that the stack is aligned to an 8 byte boundary, a function
11527 @code{__eabi} is called to from @code{main} to set up the eabi
11528 environment, and the @option{-msdata} option can use both @code{r2} and
11529 @code{r13} to point to two separate small data areas.  Selecting
11530 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11531 do not call an initialization function from @code{main}, and the
11532 @option{-msdata} option will only use @code{r13} to point to a single
11533 small data area.  The @option{-meabi} option is on by default if you
11534 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11536 @item -msdata=eabi
11537 @opindex msdata=eabi
11538 On System V.4 and embedded PowerPC systems, put small initialized
11539 @code{const} global and static data in the @samp{.sdata2} section, which
11540 is pointed to by register @code{r2}.  Put small initialized
11541 non-@code{const} global and static data in the @samp{.sdata} section,
11542 which is pointed to by register @code{r13}.  Put small uninitialized
11543 global and static data in the @samp{.sbss} section, which is adjacent to
11544 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11545 incompatible with the @option{-mrelocatable} option.  The
11546 @option{-msdata=eabi} option also sets the @option{-memb} option.
11548 @item -msdata=sysv
11549 @opindex msdata=sysv
11550 On System V.4 and embedded PowerPC systems, put small global and static
11551 data in the @samp{.sdata} section, which is pointed to by register
11552 @code{r13}.  Put small uninitialized global and static data in the
11553 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11554 The @option{-msdata=sysv} option is incompatible with the
11555 @option{-mrelocatable} option.
11557 @item -msdata=default
11558 @itemx -msdata
11559 @opindex msdata=default
11560 @opindex msdata
11561 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11562 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11563 same as @option{-msdata=sysv}.
11565 @item -msdata-data
11566 @opindex msdata-data
11567 On System V.4 and embedded PowerPC systems, put small global and static
11568 data in the @samp{.sdata} section.  Put small uninitialized global and
11569 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11570 to address small data however.  This is the default behavior unless
11571 other @option{-msdata} options are used.
11573 @item -msdata=none
11574 @itemx -mno-sdata
11575 @opindex msdata=none
11576 @opindex mno-sdata
11577 On embedded PowerPC systems, put all initialized global and static data
11578 in the @samp{.data} section, and all uninitialized data in the
11579 @samp{.bss} section.
11581 @item -G @var{num}
11582 @opindex G
11583 @cindex smaller data references (PowerPC)
11584 @cindex .sdata/.sdata2 references (PowerPC)
11585 On embedded PowerPC systems, put global and static items less than or
11586 equal to @var{num} bytes into the small data or bss sections instead of
11587 the normal data or bss section.  By default, @var{num} is 8.  The
11588 @option{-G @var{num}} switch is also passed to the linker.
11589 All modules should be compiled with the same @option{-G @var{num}} value.
11591 @item -mregnames
11592 @itemx -mno-regnames
11593 @opindex mregnames
11594 @opindex mno-regnames
11595 On System V.4 and embedded PowerPC systems do (do not) emit register
11596 names in the assembly language output using symbolic forms.
11598 @item -mlongcall
11599 @itemx -mno-longcall
11600 @opindex mlongcall
11601 @opindex mno-longcall
11602 Default to making all function calls indirectly, using a register, so
11603 that functions which reside further than 32 megabytes (33,554,432
11604 bytes) from the current location can be called.  This setting can be
11605 overridden by the @code{shortcall} function attribute, or by
11606 @code{#pragma longcall(0)}.
11608 Some linkers are capable of detecting out-of-range calls and generating
11609 glue code on the fly.  On these systems, long calls are unnecessary and
11610 generate slower code.  As of this writing, the AIX linker can do this,
11611 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11612 to the GNU linker for 32-bit PowerPC systems as well.
11614 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11615 callee, L42'', plus a ``branch island'' (glue code).  The two target
11616 addresses represent the callee and the ``branch island''.  The
11617 Darwin/PPC linker will prefer the first address and generate a ``bl
11618 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11619 otherwise, the linker will generate ``bl L42'' to call the ``branch
11620 island''.  The ``branch island'' is appended to the body of the
11621 calling function; it computes the full 32-bit address of the callee
11622 and jumps to it.
11624 On Mach-O (Darwin) systems, this option directs the compiler emit to
11625 the glue for every direct call, and the Darwin linker decides whether
11626 to use or discard it.
11628 In the future, we may cause GCC to ignore all longcall specifications
11629 when the linker is known to generate glue.
11631 @item -pthread
11632 @opindex pthread
11633 Adds support for multithreading with the @dfn{pthreads} library.
11634 This option sets flags for both the preprocessor and linker.
11636 @end table
11638 @node S/390 and zSeries Options
11639 @subsection S/390 and zSeries Options
11640 @cindex S/390 and zSeries Options
11642 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11644 @table @gcctabopt
11645 @item -mhard-float
11646 @itemx -msoft-float
11647 @opindex mhard-float
11648 @opindex msoft-float
11649 Use (do not use) the hardware floating-point instructions and registers
11650 for floating-point operations.  When @option{-msoft-float} is specified,
11651 functions in @file{libgcc.a} will be used to perform floating-point
11652 operations.  When @option{-mhard-float} is specified, the compiler
11653 generates IEEE floating-point instructions.  This is the default.
11655 @item -mlong-double-64
11656 @itemx -mlong-double-128
11657 @opindex mlong-double-64
11658 @opindex mlong-double-128
11659 These switches control the size of @code{long double} type.  A size
11660 of 64bit makes the @code{long double} type equivalent to the @code{double}
11661 type.  This is the default.
11663 @item -mbackchain
11664 @itemx -mno-backchain
11665 @opindex mbackchain
11666 @opindex mno-backchain
11667 Store (do not store) the address of the caller's frame as backchain pointer
11668 into the callee's stack frame.
11669 A backchain may be needed to allow debugging using tools that do not understand
11670 DWARF-2 call frame information.
11671 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11672 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11673 the backchain is placed into the topmost word of the 96/160 byte register
11674 save area.
11676 In general, code compiled with @option{-mbackchain} is call-compatible with
11677 code compiled with @option{-mmo-backchain}; however, use of the backchain
11678 for debugging purposes usually requires that the whole binary is built with
11679 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11680 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11681 to build a linux kernel use @option{-msoft-float}.
11683 The default is to not maintain the backchain.
11685 @item -mpacked-stack
11686 @item -mno-packed-stack
11687 @opindex mpacked-stack
11688 @opindex mno-packed-stack
11689 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11690 specified, the compiler uses the all fields of the 96/160 byte register save
11691 area only for their default purpose; unused fields still take up stack space.
11692 When @option{-mpacked-stack} is specified, register save slots are densely
11693 packed at the top of the register save area; unused space is reused for other
11694 purposes, allowing for more efficient use of the available stack space.
11695 However, when @option{-mbackchain} is also in effect, the topmost word of
11696 the save area is always used to store the backchain, and the return address
11697 register is always saved two words below the backchain.
11699 As long as the stack frame backchain is not used, code generated with
11700 @option{-mpacked-stack} is call-compatible with code generated with
11701 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11702 S/390 or zSeries generated code that uses the stack frame backchain at run
11703 time, not just for debugging purposes.  Such code is not call-compatible
11704 with code compiled with @option{-mpacked-stack}.  Also, note that the
11705 combination of @option{-mbackchain},
11706 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11707 to build a linux kernel use @option{-msoft-float}.
11709 The default is to not use the packed stack layout.
11711 @item -msmall-exec
11712 @itemx -mno-small-exec
11713 @opindex msmall-exec
11714 @opindex mno-small-exec
11715 Generate (or do not generate) code using the @code{bras} instruction
11716 to do subroutine calls.
11717 This only works reliably if the total executable size does not
11718 exceed 64k.  The default is to use the @code{basr} instruction instead,
11719 which does not have this limitation.
11721 @item -m64
11722 @itemx -m31
11723 @opindex m64
11724 @opindex m31
11725 When @option{-m31} is specified, generate code compliant to the
11726 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11727 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11728 particular to generate 64-bit instructions.  For the @samp{s390}
11729 targets, the default is @option{-m31}, while the @samp{s390x}
11730 targets default to @option{-m64}.
11732 @item -mzarch
11733 @itemx -mesa
11734 @opindex mzarch
11735 @opindex mesa
11736 When @option{-mzarch} is specified, generate code using the
11737 instructions available on z/Architecture.
11738 When @option{-mesa} is specified, generate code using the
11739 instructions available on ESA/390.  Note that @option{-mesa} is
11740 not possible with @option{-m64}.
11741 When generating code compliant to the GNU/Linux for S/390 ABI,
11742 the default is @option{-mesa}.  When generating code compliant
11743 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11745 @item -mmvcle
11746 @itemx -mno-mvcle
11747 @opindex mmvcle
11748 @opindex mno-mvcle
11749 Generate (or do not generate) code using the @code{mvcle} instruction
11750 to perform block moves.  When @option{-mno-mvcle} is specified,
11751 use a @code{mvc} loop instead.  This is the default unless optimizing for
11752 size.
11754 @item -mdebug
11755 @itemx -mno-debug
11756 @opindex mdebug
11757 @opindex mno-debug
11758 Print (or do not print) additional debug information when compiling.
11759 The default is to not print debug information.
11761 @item -march=@var{cpu-type}
11762 @opindex march
11763 Generate code that will run on @var{cpu-type}, which is the name of a system
11764 representing a certain processor type.  Possible values for
11765 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11766 When generating code using the instructions available on z/Architecture,
11767 the default is @option{-march=z900}.  Otherwise, the default is
11768 @option{-march=g5}.
11770 @item -mtune=@var{cpu-type}
11771 @opindex mtune
11772 Tune to @var{cpu-type} everything applicable about the generated code,
11773 except for the ABI and the set of available instructions.
11774 The list of @var{cpu-type} values is the same as for @option{-march}.
11775 The default is the value used for @option{-march}.
11777 @item -mtpf-trace
11778 @itemx -mno-tpf-trace
11779 @opindex mtpf-trace
11780 @opindex mno-tpf-trace
11781 Generate code that adds (does not add) in TPF OS specific branches to trace
11782 routines in the operating system.  This option is off by default, even
11783 when compiling for the TPF OS@.
11785 @item -mfused-madd
11786 @itemx -mno-fused-madd
11787 @opindex mfused-madd
11788 @opindex mno-fused-madd
11789 Generate code that uses (does not use) the floating point multiply and
11790 accumulate instructions.  These instructions are generated by default if
11791 hardware floating point is used.
11793 @item -mwarn-framesize=@var{framesize}
11794 @opindex mwarn-framesize
11795 Emit a warning if the current function exceeds the given frame size.  Because
11796 this is a compile time check it doesn't need to be a real problem when the program
11797 runs.  It is intended to identify functions which most probably cause
11798 a stack overflow.  It is useful to be used in an environment with limited stack
11799 size e.g.@: the linux kernel.
11801 @item -mwarn-dynamicstack
11802 @opindex mwarn-dynamicstack
11803 Emit a warning if the function calls alloca or uses dynamically
11804 sized arrays.  This is generally a bad idea with a limited stack size.
11806 @item -mstack-guard=@var{stack-guard}
11807 @item -mstack-size=@var{stack-size}
11808 @opindex mstack-guard
11809 @opindex mstack-size
11810 These arguments always have to be used in conjunction.  If they are present the s390
11811 back end emits additional instructions in the function prologue which trigger a trap
11812 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11813 (remember that the stack on s390 grows downward).  These options are intended to
11814 be used to help debugging stack overflow problems.  The additionally emitted code
11815 causes only little overhead and hence can also be used in production like systems
11816 without greater performance degradation.  The given values have to be exact
11817 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11818 exceeding 64k.
11819 In order to be efficient the extra code makes the assumption that the stack starts
11820 at an address aligned to the value given by @var{stack-size}.
11821 @end table
11823 @node SH Options
11824 @subsection SH Options
11826 These @samp{-m} options are defined for the SH implementations:
11828 @table @gcctabopt
11829 @item -m1
11830 @opindex m1
11831 Generate code for the SH1.
11833 @item -m2
11834 @opindex m2
11835 Generate code for the SH2.
11837 @item -m2e
11838 Generate code for the SH2e.
11840 @item -m3
11841 @opindex m3
11842 Generate code for the SH3.
11844 @item -m3e
11845 @opindex m3e
11846 Generate code for the SH3e.
11848 @item -m4-nofpu
11849 @opindex m4-nofpu
11850 Generate code for the SH4 without a floating-point unit.
11852 @item -m4-single-only
11853 @opindex m4-single-only
11854 Generate code for the SH4 with a floating-point unit that only
11855 supports single-precision arithmetic.
11857 @item -m4-single
11858 @opindex m4-single
11859 Generate code for the SH4 assuming the floating-point unit is in
11860 single-precision mode by default.
11862 @item -m4
11863 @opindex m4
11864 Generate code for the SH4.
11866 @item -m4a-nofpu
11867 @opindex m4a-nofpu
11868 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11869 floating-point unit is not used.
11871 @item -m4a-single-only
11872 @opindex m4a-single-only
11873 Generate code for the SH4a, in such a way that no double-precision
11874 floating point operations are used.
11876 @item -m4a-single
11877 @opindex m4a-single
11878 Generate code for the SH4a assuming the floating-point unit is in
11879 single-precision mode by default.
11881 @item -m4a
11882 @opindex m4a
11883 Generate code for the SH4a.
11885 @item -m4al
11886 @opindex m4al
11887 Same as @option{-m4a-nofpu}, except that it implicitly passes
11888 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11889 instructions at the moment.
11891 @item -mb
11892 @opindex mb
11893 Compile code for the processor in big endian mode.
11895 @item -ml
11896 @opindex ml
11897 Compile code for the processor in little endian mode.
11899 @item -mdalign
11900 @opindex mdalign
11901 Align doubles at 64-bit boundaries.  Note that this changes the calling
11902 conventions, and thus some functions from the standard C library will
11903 not work unless you recompile it first with @option{-mdalign}.
11905 @item -mrelax
11906 @opindex mrelax
11907 Shorten some address references at link time, when possible; uses the
11908 linker option @option{-relax}.
11910 @item -mbigtable
11911 @opindex mbigtable
11912 Use 32-bit offsets in @code{switch} tables.  The default is to use
11913 16-bit offsets.
11915 @item -mfmovd
11916 @opindex mfmovd
11917 Enable the use of the instruction @code{fmovd}.
11919 @item -mhitachi
11920 @opindex mhitachi
11921 Comply with the calling conventions defined by Renesas.
11923 @item -mrenesas
11924 @opindex mhitachi
11925 Comply with the calling conventions defined by Renesas.
11927 @item -mno-renesas
11928 @opindex mhitachi
11929 Comply with the calling conventions defined for GCC before the Renesas
11930 conventions were available.  This option is the default for all
11931 targets of the SH toolchain except for @samp{sh-symbianelf}.
11933 @item -mnomacsave
11934 @opindex mnomacsave
11935 Mark the @code{MAC} register as call-clobbered, even if
11936 @option{-mhitachi} is given.
11938 @item -mieee
11939 @opindex mieee
11940 Increase IEEE-compliance of floating-point code.
11941 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11942 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11943 comparisons of NANs / infinities incurs extra overhead in every
11944 floating point comparison, therefore the default is set to
11945 @option{-ffinite-math-only}.
11947 @item -misize
11948 @opindex misize
11949 Dump instruction size and location in the assembly code.
11951 @item -mpadstruct
11952 @opindex mpadstruct
11953 This option is deprecated.  It pads structures to multiple of 4 bytes,
11954 which is incompatible with the SH ABI@.
11956 @item -mspace
11957 @opindex mspace
11958 Optimize for space instead of speed.  Implied by @option{-Os}.
11960 @item -mprefergot
11961 @opindex mprefergot
11962 When generating position-independent code, emit function calls using
11963 the Global Offset Table instead of the Procedure Linkage Table.
11965 @item -musermode
11966 @opindex musermode
11967 Generate a library function call to invalidate instruction cache
11968 entries, after fixing up a trampoline.  This library function call
11969 doesn't assume it can write to the whole memory address space.  This
11970 is the default when the target is @code{sh-*-linux*}.
11972 @item -multcost=@var{number}
11973 @opindex multcost=@var{number}
11974 Set the cost to assume for a multiply insn.
11976 @item -mdiv=@var{strategy}
11977 @opindex mdiv=@var{strategy}
11978 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11979 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11980 inv:call2, inv:fp .
11981 "fp" performs the operation in floating point.  This has a very high latency,
11982 but needs only a few instructions, so it might be a good choice if
11983 your code has enough easily exploitable ILP to allow the compiler to
11984 schedule the floating point instructions together with other instructions.
11985 Division by zero causes a floating point exception.
11986 "inv" uses integer operations to calculate the inverse of the divisor,
11987 and then multiplies the dividend with the inverse.  This strategy allows
11988 cse and hoisting of the inverse calculation.  Division by zero calculates
11989 an unspecified result, but does not trap.
11990 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11991 have been found, or if the entire operation has been hoisted to the same
11992 place, the last stages of the inverse calculation are intertwined with the
11993 final multiply to reduce the overall latency, at the expense of using a few
11994 more instructions, and thus offering fewer scheduling opportunities with
11995 other code.
11996 "call" calls a library function that usually implements the inv:minlat
11997 strategy.
11998 This gives high code density for m5-*media-nofpu compilations.
11999 "call2" uses a different entry point of the same library function, where it
12000 assumes that a pointer to a lookup table has already been set up, which
12001 exposes the pointer load to cse / code hoisting optimizations.
12002 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12003 code generation, but if the code stays unoptimized, revert to the "call",
12004 "call2", or "fp" strategies, respectively.  Note that the
12005 potentially-trapping side effect of division by zero is carried by a
12006 separate instruction, so it is possible that all the integer instructions
12007 are hoisted out, but the marker for the side effect stays where it is.
12008 A recombination to fp operations or a call is not possible in that case.
12009 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12010 that the inverse calculation was nor separated from the multiply, they speed
12011 up division where the dividend fits into 20 bits (plus sign where applicable),
12012 by inserting a test to skip a number of operations in this case; this test
12013 slows down the case of larger dividends.  inv20u assumes the case of a such
12014 a small dividend to be unlikely, and inv20l assumes it to be likely.
12016 @item -mdivsi3_libfunc=@var{name}
12017 @opindex mdivsi3_libfunc=@var{name}
12018 Set the name of the library function used for 32 bit signed division to
12019 @var{name}.  This only affect the name used in the call and inv:call
12020 division strategies, and the compiler will still expect the same
12021 sets of input/output/clobbered registers as if this option was not present.
12023 @item -madjust-unroll
12024 @opindex madjust-unroll
12025 Throttle unrolling to avoid thrashing target registers.
12026 This option only has an effect if the gcc code base supports the
12027 TARGET_ADJUST_UNROLL_MAX target hook.
12029 @item -mindexed-addressing
12030 @opindex mindexed-addressing
12031 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12032 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12033 semantics for the indexed addressing mode.  The architecture allows the
12034 implementation of processors with 64 bit MMU, which the OS could use to
12035 get 32 bit addressing, but since no current hardware implementation supports
12036 this or any other way to make the indexed addressing mode safe to use in
12037 the 32 bit ABI, the default is -mno-indexed-addressing.
12039 @item -mgettrcost=@var{number}
12040 @opindex mgettrcost=@var{number}
12041 Set the cost assumed for the gettr instruction to @var{number}.
12042 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12044 @item -mpt-fixed
12045 @opindex mpt-fixed
12046 Assume pt* instructions won't trap.  This will generally generate better
12047 scheduled code, but is unsafe on current hardware.  The current architecture
12048 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12049 This has the unintentional effect of making it unsafe to schedule ptabs /
12050 ptrel before a branch, or hoist it out of a loop.  For example,
12051 __do_global_ctors, a part of libgcc that runs constructors at program
12052 startup, calls functions in a list which is delimited by -1.  With the
12053 -mpt-fixed option, the ptabs will be done before testing against -1.
12054 That means that all the constructors will be run a bit quicker, but when
12055 the loop comes to the end of the list, the program crashes because ptabs
12056 loads -1 into a target register.  Since this option is unsafe for any
12057 hardware implementing the current architecture specification, the default
12058 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12059 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12060 this deters register allocation using target registers for storing
12061 ordinary integers.
12063 @item -minvalid-symbols
12064 @opindex minvalid-symbols
12065 Assume symbols might be invalid.  Ordinary function symbols generated by
12066 the compiler will always be valid to load with movi/shori/ptabs or
12067 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12068 to generate symbols that will cause ptabs / ptrel to trap.
12069 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12070 It will then prevent cross-basic-block cse, hoisting and most scheduling
12071 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12072 @end table
12074 @node SPARC Options
12075 @subsection SPARC Options
12076 @cindex SPARC options
12078 These @samp{-m} options are supported on the SPARC:
12080 @table @gcctabopt
12081 @item -mno-app-regs
12082 @itemx -mapp-regs
12083 @opindex mno-app-regs
12084 @opindex mapp-regs
12085 Specify @option{-mapp-regs} to generate output using the global registers
12086 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12087 is the default.
12089 To be fully SVR4 ABI compliant at the cost of some performance loss,
12090 specify @option{-mno-app-regs}.  You should compile libraries and system
12091 software with this option.
12093 @item -mfpu
12094 @itemx -mhard-float
12095 @opindex mfpu
12096 @opindex mhard-float
12097 Generate output containing floating point instructions.  This is the
12098 default.
12100 @item -mno-fpu
12101 @itemx -msoft-float
12102 @opindex mno-fpu
12103 @opindex msoft-float
12104 Generate output containing library calls for floating point.
12105 @strong{Warning:} the requisite libraries are not available for all SPARC
12106 targets.  Normally the facilities of the machine's usual C compiler are
12107 used, but this cannot be done directly in cross-compilation.  You must make
12108 your own arrangements to provide suitable library functions for
12109 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12110 @samp{sparclite-*-*} do provide software floating point support.
12112 @option{-msoft-float} changes the calling convention in the output file;
12113 therefore, it is only useful if you compile @emph{all} of a program with
12114 this option.  In particular, you need to compile @file{libgcc.a}, the
12115 library that comes with GCC, with @option{-msoft-float} in order for
12116 this to work.
12118 @item -mhard-quad-float
12119 @opindex mhard-quad-float
12120 Generate output containing quad-word (long double) floating point
12121 instructions.
12123 @item -msoft-quad-float
12124 @opindex msoft-quad-float
12125 Generate output containing library calls for quad-word (long double)
12126 floating point instructions.  The functions called are those specified
12127 in the SPARC ABI@.  This is the default.
12129 As of this writing, there are no SPARC implementations that have hardware
12130 support for the quad-word floating point instructions.  They all invoke
12131 a trap handler for one of these instructions, and then the trap handler
12132 emulates the effect of the instruction.  Because of the trap handler overhead,
12133 this is much slower than calling the ABI library routines.  Thus the
12134 @option{-msoft-quad-float} option is the default.
12136 @item -mno-unaligned-doubles
12137 @itemx -munaligned-doubles
12138 @opindex mno-unaligned-doubles
12139 @opindex munaligned-doubles
12140 Assume that doubles have 8 byte alignment.  This is the default.
12142 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12143 alignment only if they are contained in another type, or if they have an
12144 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12145 Specifying this option avoids some rare compatibility problems with code
12146 generated by other compilers.  It is not the default because it results
12147 in a performance loss, especially for floating point code.
12149 @item -mno-faster-structs
12150 @itemx -mfaster-structs
12151 @opindex mno-faster-structs
12152 @opindex mfaster-structs
12153 With @option{-mfaster-structs}, the compiler assumes that structures
12154 should have 8 byte alignment.  This enables the use of pairs of
12155 @code{ldd} and @code{std} instructions for copies in structure
12156 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12157 However, the use of this changed alignment directly violates the SPARC
12158 ABI@.  Thus, it's intended only for use on targets where the developer
12159 acknowledges that their resulting code will not be directly in line with
12160 the rules of the ABI@.
12162 @item -mimpure-text
12163 @opindex mimpure-text
12164 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12165 the compiler to not pass @option{-z text} to the linker when linking a
12166 shared object.  Using this option, you can link position-dependent
12167 code into a shared object.
12169 @option{-mimpure-text} suppresses the ``relocations remain against
12170 allocatable but non-writable sections'' linker error message.
12171 However, the necessary relocations will trigger copy-on-write, and the
12172 shared object is not actually shared across processes.  Instead of
12173 using @option{-mimpure-text}, you should compile all source code with
12174 @option{-fpic} or @option{-fPIC}.
12176 This option is only available on SunOS and Solaris.
12178 @item -mcpu=@var{cpu_type}
12179 @opindex mcpu
12180 Set the instruction set, register set, and instruction scheduling parameters
12181 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12182 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12183 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12184 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12185 @samp{ultrasparc3}.
12187 Default instruction scheduling parameters are used for values that select
12188 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12189 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12191 Here is a list of each supported architecture and their supported
12192 implementations.
12194 @smallexample
12195     v7:             cypress
12196     v8:             supersparc, hypersparc
12197     sparclite:      f930, f934, sparclite86x
12198     sparclet:       tsc701
12199     v9:             ultrasparc, ultrasparc3
12200 @end smallexample
12202 By default (unless configured otherwise), GCC generates code for the V7
12203 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12204 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12205 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12206 SPARCStation 1, 2, IPX etc.
12208 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12209 architecture.  The only difference from V7 code is that the compiler emits
12210 the integer multiply and integer divide instructions which exist in SPARC-V8
12211 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12212 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12213 2000 series.
12215 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12216 the SPARC architecture.  This adds the integer multiply, integer divide step
12217 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12218 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12219 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12220 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12221 MB86934 chip, which is the more recent SPARClite with FPU@.
12223 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12224 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12225 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12226 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12227 optimizes it for the TEMIC SPARClet chip.
12229 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12230 architecture.  This adds 64-bit integer and floating-point move instructions,
12231 3 additional floating-point condition code registers and conditional move
12232 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12233 optimizes it for the Sun UltraSPARC I/II chips.  With
12234 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12235 Sun UltraSPARC III chip.
12237 @item -mtune=@var{cpu_type}
12238 @opindex mtune
12239 Set the instruction scheduling parameters for machine type
12240 @var{cpu_type}, but do not set the instruction set or register set that the
12241 option @option{-mcpu=@var{cpu_type}} would.
12243 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12244 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12245 that select a particular cpu implementation.  Those are @samp{cypress},
12246 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12247 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12248 @samp{ultrasparc3}.
12250 @item -mv8plus
12251 @itemx -mno-v8plus
12252 @opindex mv8plus
12253 @opindex mno-v8plus
12254 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12255 difference from the V8 ABI is that the global and out registers are
12256 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12257 mode for all SPARC-V9 processors.
12259 @item -mvis
12260 @itemx -mno-vis
12261 @opindex mvis
12262 @opindex mno-vis
12263 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12264 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12265 @end table
12267 These @samp{-m} options are supported in addition to the above
12268 on SPARC-V9 processors in 64-bit environments:
12270 @table @gcctabopt
12271 @item -mlittle-endian
12272 @opindex mlittle-endian
12273 Generate code for a processor running in little-endian mode.  It is only
12274 available for a few configurations and most notably not on Solaris and Linux.
12276 @item -m32
12277 @itemx -m64
12278 @opindex m32
12279 @opindex m64
12280 Generate code for a 32-bit or 64-bit environment.
12281 The 32-bit environment sets int, long and pointer to 32 bits.
12282 The 64-bit environment sets int to 32 bits and long and pointer
12283 to 64 bits.
12285 @item -mcmodel=medlow
12286 @opindex mcmodel=medlow
12287 Generate code for the Medium/Low code model: 64-bit addresses, programs
12288 must be linked in the low 32 bits of memory.  Programs can be statically
12289 or dynamically linked.
12291 @item -mcmodel=medmid
12292 @opindex mcmodel=medmid
12293 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12294 must be linked in the low 44 bits of memory, the text and data segments must
12295 be less than 2GB in size and the data segment must be located within 2GB of
12296 the text segment.
12298 @item -mcmodel=medany
12299 @opindex mcmodel=medany
12300 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12301 may be linked anywhere in memory, the text and data segments must be less
12302 than 2GB in size and the data segment must be located within 2GB of the
12303 text segment.
12305 @item -mcmodel=embmedany
12306 @opindex mcmodel=embmedany
12307 Generate code for the Medium/Anywhere code model for embedded systems:
12308 64-bit addresses, the text and data segments must be less than 2GB in
12309 size, both starting anywhere in memory (determined at link time).  The
12310 global register %g4 points to the base of the data segment.  Programs
12311 are statically linked and PIC is not supported.
12313 @item -mstack-bias
12314 @itemx -mno-stack-bias
12315 @opindex mstack-bias
12316 @opindex mno-stack-bias
12317 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12318 frame pointer if present, are offset by @minus{}2047 which must be added back
12319 when making stack frame references.  This is the default in 64-bit mode.
12320 Otherwise, assume no such offset is present.
12321 @end table
12323 These switches are supported in addition to the above on Solaris:
12325 @table @gcctabopt
12326 @item -threads
12327 @opindex threads
12328 Add support for multithreading using the Solaris threads library.  This
12329 option sets flags for both the preprocessor and linker.  This option does
12330 not affect the thread safety of object code produced by the compiler or
12331 that of libraries supplied with it.
12333 @item -pthreads
12334 @opindex pthreads
12335 Add support for multithreading using the POSIX threads library.  This
12336 option sets flags for both the preprocessor and linker.  This option does
12337 not affect the thread safety of object code produced  by the compiler or
12338 that of libraries supplied with it.
12340 @item -pthread
12341 @opindex pthread
12342 This is a synonym for @option{-pthreads}.
12343 @end table
12345 @node System V Options
12346 @subsection Options for System V
12348 These additional options are available on System V Release 4 for
12349 compatibility with other compilers on those systems:
12351 @table @gcctabopt
12352 @item -G
12353 @opindex G
12354 Create a shared object.
12355 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12357 @item -Qy
12358 @opindex Qy
12359 Identify the versions of each tool used by the compiler, in a
12360 @code{.ident} assembler directive in the output.
12362 @item -Qn
12363 @opindex Qn
12364 Refrain from adding @code{.ident} directives to the output file (this is
12365 the default).
12367 @item -YP,@var{dirs}
12368 @opindex YP
12369 Search the directories @var{dirs}, and no others, for libraries
12370 specified with @option{-l}.
12372 @item -Ym,@var{dir}
12373 @opindex Ym
12374 Look in the directory @var{dir} to find the M4 preprocessor.
12375 The assembler uses this option.
12376 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12377 @c the generic assembler that comes with Solaris takes just -Ym.
12378 @end table
12380 @node TMS320C3x/C4x Options
12381 @subsection TMS320C3x/C4x Options
12382 @cindex TMS320C3x/C4x Options
12384 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12386 @table @gcctabopt
12388 @item -mcpu=@var{cpu_type}
12389 @opindex mcpu
12390 Set the instruction set, register set, and instruction scheduling
12391 parameters for machine type @var{cpu_type}.  Supported values for
12392 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12393 @samp{c44}.  The default is @samp{c40} to generate code for the
12394 TMS320C40.
12396 @item -mbig-memory
12397 @itemx -mbig
12398 @itemx -msmall-memory
12399 @itemx -msmall
12400 @opindex mbig-memory
12401 @opindex mbig
12402 @opindex msmall-memory
12403 @opindex msmall
12404 Generates code for the big or small memory model.  The small memory
12405 model assumed that all data fits into one 64K word page.  At run-time
12406 the data page (DP) register must be set to point to the 64K page
12407 containing the .bss and .data program sections.  The big memory model is
12408 the default and requires reloading of the DP register for every direct
12409 memory access.
12411 @item -mbk
12412 @itemx -mno-bk
12413 @opindex mbk
12414 @opindex mno-bk
12415 Allow (disallow) allocation of general integer operands into the block
12416 count register BK@.
12418 @item -mdb
12419 @itemx -mno-db
12420 @opindex mdb
12421 @opindex mno-db
12422 Enable (disable) generation of code using decrement and branch,
12423 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12424 on the safe side, this is disabled for the C3x, since the maximum
12425 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12426 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12427 that it can utilize the decrement and branch instruction, but will give
12428 up if there is more than one memory reference in the loop.  Thus a loop
12429 where the loop counter is decremented can generate slightly more
12430 efficient code, in cases where the RPTB instruction cannot be utilized.
12432 @item -mdp-isr-reload
12433 @itemx -mparanoid
12434 @opindex mdp-isr-reload
12435 @opindex mparanoid
12436 Force the DP register to be saved on entry to an interrupt service
12437 routine (ISR), reloaded to point to the data section, and restored on
12438 exit from the ISR@.  This should not be required unless someone has
12439 violated the small memory model by modifying the DP register, say within
12440 an object library.
12442 @item -mmpyi
12443 @itemx -mno-mpyi
12444 @opindex mmpyi
12445 @opindex mno-mpyi
12446 For the C3x use the 24-bit MPYI instruction for integer multiplies
12447 instead of a library call to guarantee 32-bit results.  Note that if one
12448 of the operands is a constant, then the multiplication will be performed
12449 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12450 then squaring operations are performed inline instead of a library call.
12452 @item -mfast-fix
12453 @itemx -mno-fast-fix
12454 @opindex mfast-fix
12455 @opindex mno-fast-fix
12456 The C3x/C4x FIX instruction to convert a floating point value to an
12457 integer value chooses the nearest integer less than or equal to the
12458 floating point value rather than to the nearest integer.  Thus if the
12459 floating point number is negative, the result will be incorrectly
12460 truncated an additional code is necessary to detect and correct this
12461 case.  This option can be used to disable generation of the additional
12462 code required to correct the result.
12464 @item -mrptb
12465 @itemx -mno-rptb
12466 @opindex mrptb
12467 @opindex mno-rptb
12468 Enable (disable) generation of repeat block sequences using the RPTB
12469 instruction for zero overhead looping.  The RPTB construct is only used
12470 for innermost loops that do not call functions or jump across the loop
12471 boundaries.  There is no advantage having nested RPTB loops due to the
12472 overhead required to save and restore the RC, RS, and RE registers.
12473 This is enabled by default with @option{-O2}.
12475 @item -mrpts=@var{count}
12476 @itemx -mno-rpts
12477 @opindex mrpts
12478 @opindex mno-rpts
12479 Enable (disable) the use of the single instruction repeat instruction
12480 RPTS@.  If a repeat block contains a single instruction, and the loop
12481 count can be guaranteed to be less than the value @var{count}, GCC will
12482 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12483 then a RPTS will be emitted even if the loop count cannot be determined
12484 at compile time.  Note that the repeated instruction following RPTS does
12485 not have to be reloaded from memory each iteration, thus freeing up the
12486 CPU buses for operands.  However, since interrupts are blocked by this
12487 instruction, it is disabled by default.
12489 @item -mloop-unsigned
12490 @itemx -mno-loop-unsigned
12491 @opindex mloop-unsigned
12492 @opindex mno-loop-unsigned
12493 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12494 is @math{2^{31} + 1} since these instructions test if the iteration count is
12495 negative to terminate the loop.  If the iteration count is unsigned
12496 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12497 exceeded.  This switch allows an unsigned iteration count.
12499 @item -mti
12500 @opindex mti
12501 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12502 with.  This also enforces compatibility with the API employed by the TI
12503 C3x C compiler.  For example, long doubles are passed as structures
12504 rather than in floating point registers.
12506 @item -mregparm
12507 @itemx -mmemparm
12508 @opindex mregparm
12509 @opindex mmemparm
12510 Generate code that uses registers (stack) for passing arguments to functions.
12511 By default, arguments are passed in registers where possible rather
12512 than by pushing arguments on to the stack.
12514 @item -mparallel-insns
12515 @itemx -mno-parallel-insns
12516 @opindex mparallel-insns
12517 @opindex mno-parallel-insns
12518 Allow the generation of parallel instructions.  This is enabled by
12519 default with @option{-O2}.
12521 @item -mparallel-mpy
12522 @itemx -mno-parallel-mpy
12523 @opindex mparallel-mpy
12524 @opindex mno-parallel-mpy
12525 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12526 provided @option{-mparallel-insns} is also specified.  These instructions have
12527 tight register constraints which can pessimize the code generation
12528 of large functions.
12530 @end table
12532 @node V850 Options
12533 @subsection V850 Options
12534 @cindex V850 Options
12536 These @samp{-m} options are defined for V850 implementations:
12538 @table @gcctabopt
12539 @item -mlong-calls
12540 @itemx -mno-long-calls
12541 @opindex mlong-calls
12542 @opindex mno-long-calls
12543 Treat all calls as being far away (near).  If calls are assumed to be
12544 far away, the compiler will always load the functions address up into a
12545 register, and call indirect through the pointer.
12547 @item -mno-ep
12548 @itemx -mep
12549 @opindex mno-ep
12550 @opindex mep
12551 Do not optimize (do optimize) basic blocks that use the same index
12552 pointer 4 or more times to copy pointer into the @code{ep} register, and
12553 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12554 option is on by default if you optimize.
12556 @item -mno-prolog-function
12557 @itemx -mprolog-function
12558 @opindex mno-prolog-function
12559 @opindex mprolog-function
12560 Do not use (do use) external functions to save and restore registers
12561 at the prologue and epilogue of a function.  The external functions
12562 are slower, but use less code space if more than one function saves
12563 the same number of registers.  The @option{-mprolog-function} option
12564 is on by default if you optimize.
12566 @item -mspace
12567 @opindex mspace
12568 Try to make the code as small as possible.  At present, this just turns
12569 on the @option{-mep} and @option{-mprolog-function} options.
12571 @item -mtda=@var{n}
12572 @opindex mtda
12573 Put static or global variables whose size is @var{n} bytes or less into
12574 the tiny data area that register @code{ep} points to.  The tiny data
12575 area can hold up to 256 bytes in total (128 bytes for byte references).
12577 @item -msda=@var{n}
12578 @opindex msda
12579 Put static or global variables whose size is @var{n} bytes or less into
12580 the small data area that register @code{gp} points to.  The small data
12581 area can hold up to 64 kilobytes.
12583 @item -mzda=@var{n}
12584 @opindex mzda
12585 Put static or global variables whose size is @var{n} bytes or less into
12586 the first 32 kilobytes of memory.
12588 @item -mv850
12589 @opindex mv850
12590 Specify that the target processor is the V850.
12592 @item -mbig-switch
12593 @opindex mbig-switch
12594 Generate code suitable for big switch tables.  Use this option only if
12595 the assembler/linker complain about out of range branches within a switch
12596 table.
12598 @item -mapp-regs
12599 @opindex mapp-regs
12600 This option will cause r2 and r5 to be used in the code generated by
12601 the compiler.  This setting is the default.
12603 @item -mno-app-regs
12604 @opindex mno-app-regs
12605 This option will cause r2 and r5 to be treated as fixed registers.
12607 @item -mv850e1
12608 @opindex mv850e1
12609 Specify that the target processor is the V850E1.  The preprocessor
12610 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12611 this option is used.
12613 @item -mv850e
12614 @opindex mv850e
12615 Specify that the target processor is the V850E@.  The preprocessor
12616 constant @samp{__v850e__} will be defined if this option is used.
12618 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12619 are defined then a default target processor will be chosen and the
12620 relevant @samp{__v850*__} preprocessor constant will be defined.
12622 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12623 defined, regardless of which processor variant is the target.
12625 @item -mdisable-callt
12626 @opindex mdisable-callt
12627 This option will suppress generation of the CALLT instruction for the
12628 v850e and v850e1 flavors of the v850 architecture.  The default is
12629 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12631 @end table
12633 @node VAX Options
12634 @subsection VAX Options
12635 @cindex VAX options
12637 These @samp{-m} options are defined for the VAX:
12639 @table @gcctabopt
12640 @item -munix
12641 @opindex munix
12642 Do not output certain jump instructions (@code{aobleq} and so on)
12643 that the Unix assembler for the VAX cannot handle across long
12644 ranges.
12646 @item -mgnu
12647 @opindex mgnu
12648 Do output those jump instructions, on the assumption that you
12649 will assemble with the GNU assembler.
12651 @item -mg
12652 @opindex mg
12653 Output code for g-format floating point numbers instead of d-format.
12654 @end table
12656 @node x86-64 Options
12657 @subsection x86-64 Options
12658 @cindex x86-64 options
12660 These are listed under @xref{i386 and x86-64 Options}.
12662 @node Xstormy16 Options
12663 @subsection Xstormy16 Options
12664 @cindex Xstormy16 Options
12666 These options are defined for Xstormy16:
12668 @table @gcctabopt
12669 @item -msim
12670 @opindex msim
12671 Choose startup files and linker script suitable for the simulator.
12672 @end table
12674 @node Xtensa Options
12675 @subsection Xtensa Options
12676 @cindex Xtensa Options
12678 These options are supported for Xtensa targets:
12680 @table @gcctabopt
12681 @item -mconst16
12682 @itemx -mno-const16
12683 @opindex mconst16
12684 @opindex mno-const16
12685 Enable or disable use of @code{CONST16} instructions for loading
12686 constant values.  The @code{CONST16} instruction is currently not a
12687 standard option from Tensilica.  When enabled, @code{CONST16}
12688 instructions are always used in place of the standard @code{L32R}
12689 instructions.  The use of @code{CONST16} is enabled by default only if
12690 the @code{L32R} instruction is not available.
12692 @item -mfused-madd
12693 @itemx -mno-fused-madd
12694 @opindex mfused-madd
12695 @opindex mno-fused-madd
12696 Enable or disable use of fused multiply/add and multiply/subtract
12697 instructions in the floating-point option.  This has no effect if the
12698 floating-point option is not also enabled.  Disabling fused multiply/add
12699 and multiply/subtract instructions forces the compiler to use separate
12700 instructions for the multiply and add/subtract operations.  This may be
12701 desirable in some cases where strict IEEE 754-compliant results are
12702 required: the fused multiply add/subtract instructions do not round the
12703 intermediate result, thereby producing results with @emph{more} bits of
12704 precision than specified by the IEEE standard.  Disabling fused multiply
12705 add/subtract instructions also ensures that the program output is not
12706 sensitive to the compiler's ability to combine multiply and add/subtract
12707 operations.
12709 @item -mtext-section-literals
12710 @itemx -mno-text-section-literals
12711 @opindex mtext-section-literals
12712 @opindex mno-text-section-literals
12713 Control the treatment of literal pools.  The default is
12714 @option{-mno-text-section-literals}, which places literals in a separate
12715 section in the output file.  This allows the literal pool to be placed
12716 in a data RAM/ROM, and it also allows the linker to combine literal
12717 pools from separate object files to remove redundant literals and
12718 improve code size.  With @option{-mtext-section-literals}, the literals
12719 are interspersed in the text section in order to keep them as close as
12720 possible to their references.  This may be necessary for large assembly
12721 files.
12723 @item -mtarget-align
12724 @itemx -mno-target-align
12725 @opindex mtarget-align
12726 @opindex mno-target-align
12727 When this option is enabled, GCC instructs the assembler to
12728 automatically align instructions to reduce branch penalties at the
12729 expense of some code density.  The assembler attempts to widen density
12730 instructions to align branch targets and the instructions following call
12731 instructions.  If there are not enough preceding safe density
12732 instructions to align a target, no widening will be performed.  The
12733 default is @option{-mtarget-align}.  These options do not affect the
12734 treatment of auto-aligned instructions like @code{LOOP}, which the
12735 assembler will always align, either by widening density instructions or
12736 by inserting no-op instructions.
12738 @item -mlongcalls
12739 @itemx -mno-longcalls
12740 @opindex mlongcalls
12741 @opindex mno-longcalls
12742 When this option is enabled, GCC instructs the assembler to translate
12743 direct calls to indirect calls unless it can determine that the target
12744 of a direct call is in the range allowed by the call instruction.  This
12745 translation typically occurs for calls to functions in other source
12746 files.  Specifically, the assembler translates a direct @code{CALL}
12747 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12748 The default is @option{-mno-longcalls}.  This option should be used in
12749 programs where the call target can potentially be out of range.  This
12750 option is implemented in the assembler, not the compiler, so the
12751 assembly code generated by GCC will still show direct call
12752 instructions---look at the disassembled object code to see the actual
12753 instructions.  Note that the assembler will use an indirect call for
12754 every cross-file call, not just those that really will be out of range.
12755 @end table
12757 @node zSeries Options
12758 @subsection zSeries Options
12759 @cindex zSeries options
12761 These are listed under @xref{S/390 and zSeries Options}.
12763 @node Code Gen Options
12764 @section Options for Code Generation Conventions
12765 @cindex code generation conventions
12766 @cindex options, code generation
12767 @cindex run-time options
12769 These machine-independent options control the interface conventions
12770 used in code generation.
12772 Most of them have both positive and negative forms; the negative form
12773 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12774 one of the forms is listed---the one which is not the default.  You
12775 can figure out the other form by either removing @samp{no-} or adding
12778 @table @gcctabopt
12779 @item -fbounds-check
12780 @opindex fbounds-check
12781 For front-ends that support it, generate additional code to check that
12782 indices used to access arrays are within the declared range.  This is
12783 currently only supported by the Java and Fortran front-ends, where
12784 this option defaults to true and false respectively.
12786 @item -ftrapv
12787 @opindex ftrapv
12788 This option generates traps for signed overflow on addition, subtraction,
12789 multiplication operations.
12791 @item -fwrapv
12792 @opindex fwrapv
12793 This option instructs the compiler to assume that signed arithmetic
12794 overflow of addition, subtraction and multiplication wraps around
12795 using twos-complement representation.  This flag enables some optimizations
12796 and disables others.  This option is enabled by default for the Java
12797 front-end, as required by the Java language specification.
12799 @item -fexceptions
12800 @opindex fexceptions
12801 Enable exception handling.  Generates extra code needed to propagate
12802 exceptions.  For some targets, this implies GCC will generate frame
12803 unwind information for all functions, which can produce significant data
12804 size overhead, although it does not affect execution.  If you do not
12805 specify this option, GCC will enable it by default for languages like
12806 C++ which normally require exception handling, and disable it for
12807 languages like C that do not normally require it.  However, you may need
12808 to enable this option when compiling C code that needs to interoperate
12809 properly with exception handlers written in C++.  You may also wish to
12810 disable this option if you are compiling older C++ programs that don't
12811 use exception handling.
12813 @item -fnon-call-exceptions
12814 @opindex fnon-call-exceptions
12815 Generate code that allows trapping instructions to throw exceptions.
12816 Note that this requires platform-specific runtime support that does
12817 not exist everywhere.  Moreover, it only allows @emph{trapping}
12818 instructions to throw exceptions, i.e.@: memory references or floating
12819 point instructions.  It does not allow exceptions to be thrown from
12820 arbitrary signal handlers such as @code{SIGALRM}.
12822 @item -funwind-tables
12823 @opindex funwind-tables
12824 Similar to @option{-fexceptions}, except that it will just generate any needed
12825 static data, but will not affect the generated code in any other way.
12826 You will normally not enable this option; instead, a language processor
12827 that needs this handling would enable it on your behalf.
12829 @item -fasynchronous-unwind-tables
12830 @opindex fasynchronous-unwind-tables
12831 Generate unwind table in dwarf2 format, if supported by target machine.  The
12832 table is exact at each instruction boundary, so it can be used for stack
12833 unwinding from asynchronous events (such as debugger or garbage collector).
12835 @item -fpcc-struct-return
12836 @opindex fpcc-struct-return
12837 Return ``short'' @code{struct} and @code{union} values in memory like
12838 longer ones, rather than in registers.  This convention is less
12839 efficient, but it has the advantage of allowing intercallability between
12840 GCC-compiled files and files compiled with other compilers, particularly
12841 the Portable C Compiler (pcc).
12843 The precise convention for returning structures in memory depends
12844 on the target configuration macros.
12846 Short structures and unions are those whose size and alignment match
12847 that of some integer type.
12849 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12850 switch is not binary compatible with code compiled with the
12851 @option{-freg-struct-return} switch.
12852 Use it to conform to a non-default application binary interface.
12854 @item -freg-struct-return
12855 @opindex freg-struct-return
12856 Return @code{struct} and @code{union} values in registers when possible.
12857 This is more efficient for small structures than
12858 @option{-fpcc-struct-return}.
12860 If you specify neither @option{-fpcc-struct-return} nor
12861 @option{-freg-struct-return}, GCC defaults to whichever convention is
12862 standard for the target.  If there is no standard convention, GCC
12863 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12864 the principal compiler.  In those cases, we can choose the standard, and
12865 we chose the more efficient register return alternative.
12867 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12868 switch is not binary compatible with code compiled with the
12869 @option{-fpcc-struct-return} switch.
12870 Use it to conform to a non-default application binary interface.
12872 @item -fshort-enums
12873 @opindex fshort-enums
12874 Allocate to an @code{enum} type only as many bytes as it needs for the
12875 declared range of possible values.  Specifically, the @code{enum} type
12876 will be equivalent to the smallest integer type which has enough room.
12878 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12879 code that is not binary compatible with code generated without that switch.
12880 Use it to conform to a non-default application binary interface.
12882 @item -fshort-double
12883 @opindex fshort-double
12884 Use the same size for @code{double} as for @code{float}.
12886 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12887 code that is not binary compatible with code generated without that switch.
12888 Use it to conform to a non-default application binary interface.
12890 @item -fshort-wchar
12891 @opindex fshort-wchar
12892 Override the underlying type for @samp{wchar_t} to be @samp{short
12893 unsigned int} instead of the default for the target.  This option is
12894 useful for building programs to run under WINE@.
12896 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12897 code that is not binary compatible with code generated without that switch.
12898 Use it to conform to a non-default application binary interface.
12900 @item -fshared-data
12901 @opindex fshared-data
12902 Requests that the data and non-@code{const} variables of this
12903 compilation be shared data rather than private data.  The distinction
12904 makes sense only on certain operating systems, where shared data is
12905 shared between processes running the same program, while private data
12906 exists in one copy per process.
12908 @item -fno-common
12909 @opindex fno-common
12910 In C, allocate even uninitialized global variables in the data section of the
12911 object file, rather than generating them as common blocks.  This has the
12912 effect that if the same variable is declared (without @code{extern}) in
12913 two different compilations, you will get an error when you link them.
12914 The only reason this might be useful is if you wish to verify that the
12915 program will work on other systems which always work this way.
12917 @item -fno-ident
12918 @opindex fno-ident
12919 Ignore the @samp{#ident} directive.
12921 @item -finhibit-size-directive
12922 @opindex finhibit-size-directive
12923 Don't output a @code{.size} assembler directive, or anything else that
12924 would cause trouble if the function is split in the middle, and the
12925 two halves are placed at locations far apart in memory.  This option is
12926 used when compiling @file{crtstuff.c}; you should not need to use it
12927 for anything else.
12929 @item -fverbose-asm
12930 @opindex fverbose-asm
12931 Put extra commentary information in the generated assembly code to
12932 make it more readable.  This option is generally only of use to those
12933 who actually need to read the generated assembly code (perhaps while
12934 debugging the compiler itself).
12936 @option{-fno-verbose-asm}, the default, causes the
12937 extra information to be omitted and is useful when comparing two assembler
12938 files.
12940 @item -fpic
12941 @opindex fpic
12942 @cindex global offset table
12943 @cindex PIC
12944 Generate position-independent code (PIC) suitable for use in a shared
12945 library, if supported for the target machine.  Such code accesses all
12946 constant addresses through a global offset table (GOT)@.  The dynamic
12947 loader resolves the GOT entries when the program starts (the dynamic
12948 loader is not part of GCC; it is part of the operating system).  If
12949 the GOT size for the linked executable exceeds a machine-specific
12950 maximum size, you get an error message from the linker indicating that
12951 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12952 instead.  (These maximums are 8k on the SPARC and 32k
12953 on the m68k and RS/6000.  The 386 has no such limit.)
12955 Position-independent code requires special support, and therefore works
12956 only on certain machines.  For the 386, GCC supports PIC for System V
12957 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12958 position-independent.
12960 @item -fPIC
12961 @opindex fPIC
12962 If supported for the target machine, emit position-independent code,
12963 suitable for dynamic linking and avoiding any limit on the size of the
12964 global offset table.  This option makes a difference on the m68k,
12965 PowerPC and SPARC@.
12967 Position-independent code requires special support, and therefore works
12968 only on certain machines.
12970 @item -fpie
12971 @itemx -fPIE
12972 @opindex fpie
12973 @opindex fPIE
12974 These options are similar to @option{-fpic} and @option{-fPIC}, but
12975 generated position independent code can be only linked into executables.
12976 Usually these options are used when @option{-pie} GCC option will be
12977 used during linking.
12979 @item -fno-jump-tables
12980 @opindex fno-jump-tables
12981 Do not use jump tables for switch statements even where it would be
12982 more efficient than other code generation strategies.  This option is
12983 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12984 building code which forms part of a dynamic linker and cannot
12985 reference the address of a jump table.  On some targets, jump tables
12986 do not require a GOT and this option is not needed.
12988 @item -ffixed-@var{reg}
12989 @opindex ffixed
12990 Treat the register named @var{reg} as a fixed register; generated code
12991 should never refer to it (except perhaps as a stack pointer, frame
12992 pointer or in some other fixed role).
12994 @var{reg} must be the name of a register.  The register names accepted
12995 are machine-specific and are defined in the @code{REGISTER_NAMES}
12996 macro in the machine description macro file.
12998 This flag does not have a negative form, because it specifies a
12999 three-way choice.
13001 @item -fcall-used-@var{reg}
13002 @opindex fcall-used
13003 Treat the register named @var{reg} as an allocable register that is
13004 clobbered by function calls.  It may be allocated for temporaries or
13005 variables that do not live across a call.  Functions compiled this way
13006 will not save and restore the register @var{reg}.
13008 It is an error to used this flag with the frame pointer or stack pointer.
13009 Use of this flag for other registers that have fixed pervasive roles in
13010 the machine's execution model will produce disastrous results.
13012 This flag does not have a negative form, because it specifies a
13013 three-way choice.
13015 @item -fcall-saved-@var{reg}
13016 @opindex fcall-saved
13017 Treat the register named @var{reg} as an allocable register saved by
13018 functions.  It may be allocated even for temporaries or variables that
13019 live across a call.  Functions compiled this way will save and restore
13020 the register @var{reg} if they use it.
13022 It is an error to used this flag with the frame pointer or stack pointer.
13023 Use of this flag for other registers that have fixed pervasive roles in
13024 the machine's execution model will produce disastrous results.
13026 A different sort of disaster will result from the use of this flag for
13027 a register in which function values may be returned.
13029 This flag does not have a negative form, because it specifies a
13030 three-way choice.
13032 @item -fpack-struct[=@var{n}]
13033 @opindex fpack-struct
13034 Without a value specified, pack all structure members together without
13035 holes.  When a value is specified (which must be a small power of two), pack
13036 structure members according to this value, representing the maximum
13037 alignment (that is, objects with default alignment requirements larger than
13038 this will be output potentially unaligned at the next fitting location.
13040 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13041 code that is not binary compatible with code generated without that switch.
13042 Additionally, it makes the code suboptimal.
13043 Use it to conform to a non-default application binary interface.
13045 @item -finstrument-functions
13046 @opindex finstrument-functions
13047 Generate instrumentation calls for entry and exit to functions.  Just
13048 after function entry and just before function exit, the following
13049 profiling functions will be called with the address of the current
13050 function and its call site.  (On some platforms,
13051 @code{__builtin_return_address} does not work beyond the current
13052 function, so the call site information may not be available to the
13053 profiling functions otherwise.)
13055 @smallexample
13056 void __cyg_profile_func_enter (void *this_fn,
13057                                void *call_site);
13058 void __cyg_profile_func_exit  (void *this_fn,
13059                                void *call_site);
13060 @end smallexample
13062 The first argument is the address of the start of the current function,
13063 which may be looked up exactly in the symbol table.
13065 This instrumentation is also done for functions expanded inline in other
13066 functions.  The profiling calls will indicate where, conceptually, the
13067 inline function is entered and exited.  This means that addressable
13068 versions of such functions must be available.  If all your uses of a
13069 function are expanded inline, this may mean an additional expansion of
13070 code size.  If you use @samp{extern inline} in your C code, an
13071 addressable version of such functions must be provided.  (This is
13072 normally the case anyways, but if you get lucky and the optimizer always
13073 expands the functions inline, you might have gotten away without
13074 providing static copies.)
13076 A function may be given the attribute @code{no_instrument_function}, in
13077 which case this instrumentation will not be done.  This can be used, for
13078 example, for the profiling functions listed above, high-priority
13079 interrupt routines, and any functions from which the profiling functions
13080 cannot safely be called (perhaps signal handlers, if the profiling
13081 routines generate output or allocate memory).
13083 @item -fstack-check
13084 @opindex fstack-check
13085 Generate code to verify that you do not go beyond the boundary of the
13086 stack.  You should specify this flag if you are running in an
13087 environment with multiple threads, but only rarely need to specify it in
13088 a single-threaded environment since stack overflow is automatically
13089 detected on nearly all systems if there is only one stack.
13091 Note that this switch does not actually cause checking to be done; the
13092 operating system must do that.  The switch causes generation of code
13093 to ensure that the operating system sees the stack being extended.
13095 @item -fstack-limit-register=@var{reg}
13096 @itemx -fstack-limit-symbol=@var{sym}
13097 @itemx -fno-stack-limit
13098 @opindex fstack-limit-register
13099 @opindex fstack-limit-symbol
13100 @opindex fno-stack-limit
13101 Generate code to ensure that the stack does not grow beyond a certain value,
13102 either the value of a register or the address of a symbol.  If the stack
13103 would grow beyond the value, a signal is raised.  For most targets,
13104 the signal is raised before the stack overruns the boundary, so
13105 it is possible to catch the signal without taking special precautions.
13107 For instance, if the stack starts at absolute address @samp{0x80000000}
13108 and grows downwards, you can use the flags
13109 @option{-fstack-limit-symbol=__stack_limit} and
13110 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13111 of 128KB@.  Note that this may only work with the GNU linker.
13113 @cindex aliasing of parameters
13114 @cindex parameters, aliased
13115 @item -fargument-alias
13116 @itemx -fargument-noalias
13117 @itemx -fargument-noalias-global
13118 @opindex fargument-alias
13119 @opindex fargument-noalias
13120 @opindex fargument-noalias-global
13121 Specify the possible relationships among parameters and between
13122 parameters and global data.
13124 @option{-fargument-alias} specifies that arguments (parameters) may
13125 alias each other and may alias global storage.@*
13126 @option{-fargument-noalias} specifies that arguments do not alias
13127 each other, but may alias global storage.@*
13128 @option{-fargument-noalias-global} specifies that arguments do not
13129 alias each other and do not alias global storage.
13131 Each language will automatically use whatever option is required by
13132 the language standard.  You should not need to use these options yourself.
13134 @item -fleading-underscore
13135 @opindex fleading-underscore
13136 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13137 change the way C symbols are represented in the object file.  One use
13138 is to help link with legacy assembly code.
13140 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13141 generate code that is not binary compatible with code generated without that
13142 switch.  Use it to conform to a non-default application binary interface.
13143 Not all targets provide complete support for this switch.
13145 @item -ftls-model=@var{model}
13146 @opindex ftls-model=@var{model}
13147 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13148 The @var{model} argument should be one of @code{global-dynamic},
13149 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13151 The default without @option{-fpic} is @code{initial-exec}; with
13152 @option{-fpic} the default is @code{global-dynamic}.
13154 @item -fvisibility=@var{default|internal|hidden|protected}
13155 @opindex fvisibility
13156 Set the default ELF image symbol visibility to the specified option---all
13157 symbols will be marked with this unless overridden within the code.
13158 Using this feature can very substantially improve linking and
13159 load times of shared object libraries, produce more optimized
13160 code, provide near-perfect API export and prevent symbol clashes.
13161 It is @strong{strongly} recommended that you use this in any shared objects
13162 you distribute.
13164 Despite the nomenclature, @code{default} always means public ie;
13165 available to be linked against from outside the shared object.
13166 @code{protected} and @code{internal} are pretty useless in real-world
13167 usage so the only other commonly used option will be @code{hidden}.
13168 The default if @option{-fvisibility} isn't specified is
13169 @code{default}, i.e., make every
13170 symbol public---this causes the same behavior as previous versions of
13171 GCC@.
13173 A good explanation of the benefits offered by ensuring ELF
13174 symbols have the correct visibility is given by ``How To Write
13175 Shared Libraries'' by Ulrich Drepper (which can be found at
13176 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13177 solution made possible by this option to marking things hidden when
13178 the default is public is to make the default hidden and mark things
13179 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13180 and @code{__attribute__ ((visibility("default")))} instead of
13181 @code{__declspec(dllexport)} you get almost identical semantics with
13182 identical syntax.  This is a great boon to those working with
13183 cross-platform projects.
13185 For those adding visibility support to existing code, you may find
13186 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13187 the declarations you wish to set visibility for with (for example)
13188 @samp{#pragma GCC visibility push(hidden)} and
13189 @samp{#pragma GCC visibility pop}.
13190 Bear in mind that symbol visibility should be viewed @strong{as
13191 part of the API interface contract} and thus all new code should
13192 always specify visibility when it is not the default ie; declarations
13193 only for use within the local DSO should @strong{always} be marked explicitly
13194 as hidden as so to avoid PLT indirection overheads---making this
13195 abundantly clear also aids readability and self-documentation of the code.
13196 Note that due to ISO C++ specification requirements, operator new and
13197 operator delete must always be of default visibility.
13199 An overview of these techniques, their benefits and how to use them
13200 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13202 @end table
13204 @c man end
13206 @node Environment Variables
13207 @section Environment Variables Affecting GCC
13208 @cindex environment variables
13210 @c man begin ENVIRONMENT
13211 This section describes several environment variables that affect how GCC
13212 operates.  Some of them work by specifying directories or prefixes to use
13213 when searching for various kinds of files.  Some are used to specify other
13214 aspects of the compilation environment.
13216 Note that you can also specify places to search using options such as
13217 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13218 take precedence over places specified using environment variables, which
13219 in turn take precedence over those specified by the configuration of GCC@.
13220 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13221 GNU Compiler Collection (GCC) Internals}.
13223 @table @env
13224 @item LANG
13225 @itemx LC_CTYPE
13226 @c @itemx LC_COLLATE
13227 @itemx LC_MESSAGES
13228 @c @itemx LC_MONETARY
13229 @c @itemx LC_NUMERIC
13230 @c @itemx LC_TIME
13231 @itemx LC_ALL
13232 @findex LANG
13233 @findex LC_CTYPE
13234 @c @findex LC_COLLATE
13235 @findex LC_MESSAGES
13236 @c @findex LC_MONETARY
13237 @c @findex LC_NUMERIC
13238 @c @findex LC_TIME
13239 @findex LC_ALL
13240 @cindex locale
13241 These environment variables control the way that GCC uses
13242 localization information that allow GCC to work with different
13243 national conventions.  GCC inspects the locale categories
13244 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13245 so.  These locale categories can be set to any value supported by your
13246 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13247 Kingdom encoded in UTF-8.
13249 The @env{LC_CTYPE} environment variable specifies character
13250 classification.  GCC uses it to determine the character boundaries in
13251 a string; this is needed for some multibyte encodings that contain quote
13252 and escape characters that would otherwise be interpreted as a string
13253 end or escape.
13255 The @env{LC_MESSAGES} environment variable specifies the language to
13256 use in diagnostic messages.
13258 If the @env{LC_ALL} environment variable is set, it overrides the value
13259 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13260 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13261 environment variable.  If none of these variables are set, GCC
13262 defaults to traditional C English behavior.
13264 @item TMPDIR
13265 @findex TMPDIR
13266 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13267 files.  GCC uses temporary files to hold the output of one stage of
13268 compilation which is to be used as input to the next stage: for example,
13269 the output of the preprocessor, which is the input to the compiler
13270 proper.
13272 @item GCC_EXEC_PREFIX
13273 @findex GCC_EXEC_PREFIX
13274 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13275 names of the subprograms executed by the compiler.  No slash is added
13276 when this prefix is combined with the name of a subprogram, but you can
13277 specify a prefix that ends with a slash if you wish.
13279 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13280 an appropriate prefix to use based on the pathname it was invoked with.
13282 If GCC cannot find the subprogram using the specified prefix, it
13283 tries looking in the usual places for the subprogram.
13285 The default value of @env{GCC_EXEC_PREFIX} is
13286 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13287 of @code{prefix} when you ran the @file{configure} script.
13289 Other prefixes specified with @option{-B} take precedence over this prefix.
13291 This prefix is also used for finding files such as @file{crt0.o} that are
13292 used for linking.
13294 In addition, the prefix is used in an unusual way in finding the
13295 directories to search for header files.  For each of the standard
13296 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13297 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13298 replacing that beginning with the specified prefix to produce an
13299 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13300 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13301 These alternate directories are searched first; the standard directories
13302 come next.
13304 @item COMPILER_PATH
13305 @findex COMPILER_PATH
13306 The value of @env{COMPILER_PATH} is a colon-separated list of
13307 directories, much like @env{PATH}.  GCC tries the directories thus
13308 specified when searching for subprograms, if it can't find the
13309 subprograms using @env{GCC_EXEC_PREFIX}.
13311 @item LIBRARY_PATH
13312 @findex LIBRARY_PATH
13313 The value of @env{LIBRARY_PATH} is a colon-separated list of
13314 directories, much like @env{PATH}.  When configured as a native compiler,
13315 GCC tries the directories thus specified when searching for special
13316 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13317 using GCC also uses these directories when searching for ordinary
13318 libraries for the @option{-l} option (but directories specified with
13319 @option{-L} come first).
13321 @item LANG
13322 @findex LANG
13323 @cindex locale definition
13324 This variable is used to pass locale information to the compiler.  One way in
13325 which this information is used is to determine the character set to be used
13326 when character literals, string literals and comments are parsed in C and C++.
13327 When the compiler is configured to allow multibyte characters,
13328 the following values for @env{LANG} are recognized:
13330 @table @samp
13331 @item C-JIS
13332 Recognize JIS characters.
13333 @item C-SJIS
13334 Recognize SJIS characters.
13335 @item C-EUCJP
13336 Recognize EUCJP characters.
13337 @end table
13339 If @env{LANG} is not defined, or if it has some other value, then the
13340 compiler will use mblen and mbtowc as defined by the default locale to
13341 recognize and translate multibyte characters.
13342 @end table
13344 @noindent
13345 Some additional environments variables affect the behavior of the
13346 preprocessor.
13348 @include cppenv.texi
13350 @c man end
13352 @node Precompiled Headers
13353 @section Using Precompiled Headers
13354 @cindex precompiled headers
13355 @cindex speed of compilation
13357 Often large projects have many header files that are included in every
13358 source file.  The time the compiler takes to process these header files
13359 over and over again can account for nearly all of the time required to
13360 build the project.  To make builds faster, GCC allows users to
13361 `precompile' a header file; then, if builds can use the precompiled
13362 header file they will be much faster.
13364 To create a precompiled header file, simply compile it as you would any
13365 other file, if necessary using the @option{-x} option to make the driver
13366 treat it as a C or C++ header file.  You will probably want to use a
13367 tool like @command{make} to keep the precompiled header up-to-date when
13368 the headers it contains change.
13370 A precompiled header file will be searched for when @code{#include} is
13371 seen in the compilation.  As it searches for the included file
13372 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13373 compiler looks for a precompiled header in each directory just before it
13374 looks for the include file in that directory.  The name searched for is
13375 the name specified in the @code{#include} with @samp{.gch} appended.  If
13376 the precompiled header file can't be used, it is ignored.
13378 For instance, if you have @code{#include "all.h"}, and you have
13379 @file{all.h.gch} in the same directory as @file{all.h}, then the
13380 precompiled header file will be used if possible, and the original
13381 header will be used otherwise.
13383 Alternatively, you might decide to put the precompiled header file in a
13384 directory and use @option{-I} to ensure that directory is searched
13385 before (or instead of) the directory containing the original header.
13386 Then, if you want to check that the precompiled header file is always
13387 used, you can put a file of the same name as the original header in this
13388 directory containing an @code{#error} command.
13390 This also works with @option{-include}.  So yet another way to use
13391 precompiled headers, good for projects not designed with precompiled
13392 header files in mind, is to simply take most of the header files used by
13393 a project, include them from another header file, precompile that header
13394 file, and @option{-include} the precompiled header.  If the header files
13395 have guards against multiple inclusion, they will be skipped because
13396 they've already been included (in the precompiled header).
13398 If you need to precompile the same header file for different
13399 languages, targets, or compiler options, you can instead make a
13400 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13401 header in the directory, perhaps using @option{-o}.  It doesn't matter
13402 what you call the files in the directory, every precompiled header in
13403 the directory will be considered.  The first precompiled header
13404 encountered in the directory that is valid for this compilation will
13405 be used; they're searched in no particular order.
13407 There are many other possibilities, limited only by your imagination,
13408 good sense, and the constraints of your build system.
13410 A precompiled header file can be used only when these conditions apply:
13412 @itemize
13413 @item
13414 Only one precompiled header can be used in a particular compilation.
13416 @item
13417 A precompiled header can't be used once the first C token is seen.  You
13418 can have preprocessor directives before a precompiled header; you can
13419 even include a precompiled header from inside another header, so long as
13420 there are no C tokens before the @code{#include}.
13422 @item
13423 The precompiled header file must be produced for the same language as
13424 the current compilation.  You can't use a C precompiled header for a C++
13425 compilation.
13427 @item
13428 The precompiled header file must have been produced by the same compiler
13429 binary as the current compilation is using.
13431 @item
13432 Any macros defined before the precompiled header is included must
13433 either be defined in the same way as when the precompiled header was
13434 generated, or must not affect the precompiled header, which usually
13435 means that they don't appear in the precompiled header at all.
13437 The @option{-D} option is one way to define a macro before a
13438 precompiled header is included; using a @code{#define} can also do it.
13439 There are also some options that define macros implicitly, like
13440 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13441 defined this way.
13443 @item If debugging information is output when using the precompiled
13444 header, using @option{-g} or similar, the same kind of debugging information
13445 must have been output when building the precompiled header.  However,
13446 a precompiled header built using @option{-g} can be used in a compilation
13447 when no debugging information is being output.
13449 @item The same @option{-m} options must generally be used when building
13450 and using the precompiled header.  @xref{Submodel Options},
13451 for any cases where this rule is relaxed.
13453 @item Each of the following options must be the same when building and using
13454 the precompiled header:
13456 @gccoptlist{-fexceptions -funit-at-a-time}
13458 @item
13459 Some other command-line options starting with @option{-f},
13460 @option{-p}, or @option{-O} must be defined in the same way as when
13461 the precompiled header was generated.  At present, it's not clear
13462 which options are safe to change and which are not; the safest choice
13463 is to use exactly the same options when generating and using the
13464 precompiled header.  The following are known to be safe:
13466 @gccoptlist{-fmessage-length= -fpreprocessed
13467 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13468 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13469 -pedantic-errors}
13471 @end itemize
13473 For all of these except the last, the compiler will automatically
13474 ignore the precompiled header if the conditions aren't met.  If you
13475 find an option combination that doesn't work and doesn't cause the
13476 precompiled header to be ignored, please consider filing a bug report,
13477 see @ref{Bugs}.
13479 If you do use differing options when generating and using the
13480 precompiled header, the actual behavior will be a mixture of the
13481 behavior for the options.  For instance, if you use @option{-g} to
13482 generate the precompiled header but not when using it, you may or may
13483 not get debugging information for routines in the precompiled header.
13485 @node Running Protoize
13486 @section Running Protoize
13488 The program @code{protoize} is an optional part of GCC@.  You can use
13489 it to add prototypes to a program, thus converting the program to ISO
13490 C in one respect.  The companion program @code{unprotoize} does the
13491 reverse: it removes argument types from any prototypes that are found.
13493 When you run these programs, you must specify a set of source files as
13494 command line arguments.  The conversion programs start out by compiling
13495 these files to see what functions they define.  The information gathered
13496 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13498 After scanning comes actual conversion.  The specified files are all
13499 eligible to be converted; any files they include (whether sources or
13500 just headers) are eligible as well.
13502 But not all the eligible files are converted.  By default,
13503 @code{protoize} and @code{unprotoize} convert only source and header
13504 files in the current directory.  You can specify additional directories
13505 whose files should be converted with the @option{-d @var{directory}}
13506 option.  You can also specify particular files to exclude with the
13507 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13508 directory name matches one of the specified directory names, and its
13509 name within the directory has not been excluded.
13511 Basic conversion with @code{protoize} consists of rewriting most
13512 function definitions and function declarations to specify the types of
13513 the arguments.  The only ones not rewritten are those for varargs
13514 functions.
13516 @code{protoize} optionally inserts prototype declarations at the
13517 beginning of the source file, to make them available for any calls that
13518 precede the function's definition.  Or it can insert prototype
13519 declarations with block scope in the blocks where undeclared functions
13520 are called.
13522 Basic conversion with @code{unprotoize} consists of rewriting most
13523 function declarations to remove any argument types, and rewriting
13524 function definitions to the old-style pre-ISO form.
13526 Both conversion programs print a warning for any function declaration or
13527 definition that they can't convert.  You can suppress these warnings
13528 with @option{-q}.
13530 The output from @code{protoize} or @code{unprotoize} replaces the
13531 original source file.  The original file is renamed to a name ending
13532 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13533 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13534 for DOS) file already exists, then the source file is simply discarded.
13536 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13537 scan the program and collect information about the functions it uses.
13538 So neither of these programs will work until GCC is installed.
13540 Here is a table of the options you can use with @code{protoize} and
13541 @code{unprotoize}.  Each option works with both programs unless
13542 otherwise stated.
13544 @table @code
13545 @item -B @var{directory}
13546 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13547 usual directory (normally @file{/usr/local/lib}).  This file contains
13548 prototype information about standard system functions.  This option
13549 applies only to @code{protoize}.
13551 @item -c @var{compilation-options}
13552 Use @var{compilation-options} as the options when running @command{gcc} to
13553 produce the @samp{.X} files.  The special option @option{-aux-info} is
13554 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13556 Note that the compilation options must be given as a single argument to
13557 @code{protoize} or @code{unprotoize}.  If you want to specify several
13558 @command{gcc} options, you must quote the entire set of compilation options
13559 to make them a single word in the shell.
13561 There are certain @command{gcc} arguments that you cannot use, because they
13562 would produce the wrong kind of output.  These include @option{-g},
13563 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13564 the @var{compilation-options}, they are ignored.
13566 @item -C
13567 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13568 systems) instead of @samp{.c}.  This is convenient if you are converting
13569 a C program to C++.  This option applies only to @code{protoize}.
13571 @item -g
13572 Add explicit global declarations.  This means inserting explicit
13573 declarations at the beginning of each source file for each function
13574 that is called in the file and was not declared.  These declarations
13575 precede the first function definition that contains a call to an
13576 undeclared function.  This option applies only to @code{protoize}.
13578 @item -i @var{string}
13579 Indent old-style parameter declarations with the string @var{string}.
13580 This option applies only to @code{protoize}.
13582 @code{unprotoize} converts prototyped function definitions to old-style
13583 function definitions, where the arguments are declared between the
13584 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13585 uses five spaces as the indentation.  If you want to indent with just
13586 one space instead, use @option{-i " "}.
13588 @item -k
13589 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13590 is finished.
13592 @item -l
13593 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13594 a prototype declaration for each function in each block which calls the
13595 function without any declaration.  This option applies only to
13596 @code{protoize}.
13598 @item -n
13599 Make no real changes.  This mode just prints information about the conversions
13600 that would have been done without @option{-n}.
13602 @item -N
13603 Make no @samp{.save} files.  The original files are simply deleted.
13604 Use this option with caution.
13606 @item -p @var{program}
13607 Use the program @var{program} as the compiler.  Normally, the name
13608 @file{gcc} is used.
13610 @item -q
13611 Work quietly.  Most warnings are suppressed.
13613 @item -v
13614 Print the version number, just like @option{-v} for @command{gcc}.
13615 @end table
13617 If you need special compiler options to compile one of your program's
13618 source files, then you should generate that file's @samp{.X} file
13619 specially, by running @command{gcc} on that source file with the
13620 appropriate options and the option @option{-aux-info}.  Then run
13621 @code{protoize} on the entire set of files.  @code{protoize} will use
13622 the existing @samp{.X} file because it is newer than the source file.
13623 For example:
13625 @smallexample
13626 gcc -Dfoo=bar file1.c -aux-info file1.X
13627 protoize *.c
13628 @end smallexample
13630 @noindent
13631 You need to include the special files along with the rest in the
13632 @code{protoize} command, even though their @samp{.X} files already
13633 exist, because otherwise they won't get converted.
13635 @xref{Protoize Caveats}, for more information on how to use
13636 @code{protoize} successfully.