[multiple changes]
[official-gcc.git] / gcc / doc / invoke.texi
blobb7eab9e964f6d634f0a8725e137505fb0ce6d542
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006 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 INCLUDE
8 @include gcc-vers.texi
9 @c man end
11 @c man begin COPYRIGHT
12 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
13 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with the
18 Invariant Sections being ``GNU General Public License'' and ``Funding
19 Free Software'', the Front-Cover texts being (a) (see below), and with
20 the Back-Cover Texts being (b) (see below).  A copy of the license is
21 included in the gfdl(7) man page.
23 (a) The FSF's Front-Cover Text is:
25      A GNU Manual
27 (b) The FSF's Back-Cover Text is:
29      You have freedom to copy and modify this GNU Manual, like GNU
30      software.  Copies published by the Free Software Foundation raise
31      funds for GNU development.
32 @c man end
33 @c Set file name and title for the man page.
34 @setfilename gcc
35 @settitle GNU project C and C++ compiler
36 @c man begin SYNOPSIS
37 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45 Only the most useful options are listed here; see below for the
46 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
47 @c man end
48 @c man begin SEEALSO
49 gpl(7), gfdl(7), fsf-funding(7),
50 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52 @file{ld}, @file{binutils} and @file{gdb}.
53 @c man end
54 @c man begin BUGS
55 For instructions on reporting bugs, see
56 @w{@uref{http://gcc.gnu.org/bugs.html}}.
57 @c man end
58 @c man begin AUTHOR
59 See the Info entry for @command{gcc}, or
60 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61 for contributors to GCC@.
62 @c man end
63 @end ignore
65 @node Invoking GCC
66 @chapter GCC Command Options
67 @cindex GCC command options
68 @cindex command options
69 @cindex options, GCC command
71 @c man begin DESCRIPTION
72 When you invoke GCC, it normally does preprocessing, compilation,
73 assembly and linking.  The ``overall options'' allow you to stop this
74 process at an intermediate stage.  For example, the @option{-c} option
75 says not to run the linker.  Then the output consists of object files
76 output by the assembler.
78 Other options are passed on to one stage of processing.  Some options
79 control the preprocessor and others the compiler itself.  Yet other
80 options control the assembler and linker; most of these are not
81 documented here, since you rarely need to use any of them.
83 @cindex C compilation options
84 Most of the command line options that you can use with GCC are useful
85 for C programs; when an option is only useful with another language
86 (usually C++), the explanation says so explicitly.  If the description
87 for a particular option does not mention a source language, you can use
88 that option with all supported languages.
90 @cindex C++ compilation options
91 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92 options for compiling C++ programs.
94 @cindex grouping options
95 @cindex options, grouping
96 The @command{gcc} program accepts options and file names as operands.  Many
97 options have multi-letter names; therefore multiple single-letter options
98 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99 -r}}.
101 @cindex order of options
102 @cindex options, order
103 You can mix options and other arguments.  For the most part, the order
104 you use doesn't matter.  Order does matter when you use several options
105 of the same kind; for example, if you specify @option{-L} more than once,
106 the directories are searched in the order specified.
108 Many options have long names starting with @samp{-f} or with
109 @samp{-W}---for example, 
110 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
111 these have both positive and negative forms; the negative form of
112 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
113 only one of these two forms, whichever one is not the default.
115 @c man end
117 @xref{Option Index}, for an index to GCC's options.
119 @menu
120 * Option Summary::      Brief list of all options, without explanations.
121 * Overall Options::     Controlling the kind of output:
122                         an executable, object files, assembler files,
123                         or preprocessed source.
124 * Invoking G++::        Compiling C++ programs.
125 * C Dialect Options::   Controlling the variant of C language compiled.
126 * C++ Dialect Options:: Variations on C++.
127 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128                         and Objective-C++.
129 * Language Independent Options:: Controlling how diagnostics should be
130                         formatted.
131 * Warning Options::     How picky should the compiler be?
132 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
133 * Optimize Options::    How much optimization?
134 * Preprocessor Options:: Controlling header files and macro definitions.
135                          Also, getting dependency information for Make.
136 * Assembler Options::   Passing options to the assembler.
137 * Link Options::        Specifying libraries and so on.
138 * Directory Options::   Where to find header files and libraries.
139                         Where to find the compiler executable files.
140 * Spec Files::          How to pass switches to sub-processes.
141 * Target Options::      Running a cross-compiler, or an old version of GCC.
142 * Submodel Options::    Specifying minor hardware or convention variations,
143                         such as 68010 vs 68020.
144 * Code Gen Options::    Specifying conventions for function calls, data layout
145                         and register usage.
146 * Environment Variables:: Env vars that affect GCC.
147 * Precompiled Headers:: Compiling a header once, and using it many times.
148 * Running Protoize::    Automatically adding or removing function prototypes.
149 @end menu
151 @c man begin OPTIONS
153 @node Option Summary
154 @section Option Summary
156 Here is a summary of all the options, grouped by type.  Explanations are
157 in the following sections.
159 @table @emph
160 @item Overall Options
161 @xref{Overall Options,,Options Controlling the Kind of Output}.
162 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
163 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
165 @item C Language Options
166 @xref{C Dialect Options,,Options Controlling C Dialect}.
167 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
168 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
169 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
170 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
171 -fallow-single-precision  -fcond-mismatch @gol
172 -fsigned-bitfields  -fsigned-char @gol
173 -funsigned-bitfields  -funsigned-char}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
178 -fconserve-space  -ffriend-injection @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs @gol
181 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines  -fms-extensions @gol
185 -fno-nonansi-builtins  -fno-operator-names @gol
186 -fno-optional-diags  -fpermissive @gol
187 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
188 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
189 -fno-default-inline  -fvisibility-inlines-hidden @gol
190 -Wabi  -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo}
197 @item Objective-C and Objective-C++ Language Options
198 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199 Objective-C and Objective-C++ Dialects}.
200 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
201 -fgnu-runtime  -fnext-runtime @gol
202 -fno-nil-receivers @gol
203 -fobjc-call-cxx-cdtors @gol
204 -fobjc-direct-dispatch @gol
205 -fobjc-exceptions @gol
206 -fobjc-gc @gol
207 -freplace-objc-classes @gol
208 -fzero-link @gol
209 -gen-decls @gol
210 -Wassign-intercept @gol
211 -Wno-protocol  -Wselector @gol
212 -Wstrict-selector-match @gol
213 -Wundeclared-selector}
215 @item Language Independent Options
216 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
217 @gccoptlist{-fmessage-length=@var{n}  @gol
218 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
219 -fdiagnostics-show-option}
221 @item Warning Options
222 @xref{Warning Options,,Options to Request or Suppress Warnings}.
223 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
224 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Wno-attributes @gol
225 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
226 -Wconversion  -Wno-deprecated-declarations @gol
227 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
228 -Werror  -Werror-* -Werror-implicit-function-declaration @gol
229 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
230 -Wno-format-extra-args -Wformat-nonliteral @gol
231 -Wformat-security  -Wformat-y2k @gol
232 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
233 -Wimport  -Wno-import  -Winit-self  -Winline @gol
234 -Wno-int-to-pointer-cast @gol
235 -Wno-invalid-offsetof  -Winvalid-pch @gol
236 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
237 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
238 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
239 -Wmissing-noreturn @gol
240 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
241 -Woverlength-strings  -Wpacked  -Wpadded @gol
242 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
243 -Wredundant-decls @gol
244 -Wreturn-type  -Wsequence-point  -Wshadow @gol
245 -Wsign-compare  -Wstack-protector @gol
246 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
247 -Wstring-literal-comparison @gol
248 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
249 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
250 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
251 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
252 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
253 -Wvolatile-register-var  -Wwrite-strings}
255 @item C-only Warning Options
256 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
257 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
258 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
259 -Wdeclaration-after-statement -Wpointer-sign}
261 @item Debugging Options
262 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
263 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
264 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
265 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
266 -fdump-ipa-all -fdump-ipa-cgraph @gol
267 -fdump-tree-all @gol
268 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
269 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272 -fdump-tree-ch @gol
273 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-nrv -fdump-tree-vect @gol
282 -fdump-tree-sink @gol
283 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-salias @gol
285 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
287 -ftree-vectorizer-verbose=@var{n} @gol
288 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
289 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
290 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
291 -fmem-report -fprofile-arcs @gol
292 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
293 -ftest-coverage  -ftime-report -fvar-tracking @gol
294 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
295 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
296 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
297 -print-multi-directory  -print-multi-lib @gol
298 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
299 -save-temps  -time}
301 @item Optimization Options
302 @xref{Optimize Options,,Options that Control Optimization}.
303 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
304 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
305 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
306 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
307 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
308 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
309 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
310 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
311 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
312 -fforce-addr  -fforward-propagate  -ffunction-sections @gol
313 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
314 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
315 -finline-functions  -finline-functions-called-once @gol
316 -finline-limit=@var{n}  -fkeep-inline-functions @gol
317 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
318 -fmodulo-sched -fno-branch-count-reg @gol
319 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
320 -fno-function-cse  -fno-guess-branch-probability @gol
321 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
322 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
323 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
324 -fomit-frame-pointer  -foptimize-register-move @gol
325 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
326 -fprofile-generate -fprofile-use @gol
327 -fregmove  -frename-registers @gol
328 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
329 -frerun-cse-after-loop @gol
330 -frounding-math -frtl-abstract-sequences @gol
331 -fschedule-insns  -fschedule-insns2 @gol
332 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
333 -fsched-spec-load-dangerous  @gol
334 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
335 -fsched2-use-superblocks @gol
336 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
337 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
338 -fstack-protector  -fstack-protector-all @gol
339 -fstrict-aliasing  -ftracer  -fthread-jumps @gol
340 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
341 -fsplit-ivs-in-unroller -funswitch-loops @gol
342 -fvariable-expansion-in-unroller @gol
343 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
344 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
345 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
346 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
347 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
348 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
349 --param @var{name}=@var{value}
350 -O  -O0  -O1  -O2  -O3  -Os}
352 @item Preprocessor Options
353 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
354 @gccoptlist{-A@var{question}=@var{answer} @gol
355 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
356 -C  -dD  -dI  -dM  -dN @gol
357 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
358 -idirafter @var{dir} @gol
359 -include @var{file}  -imacros @var{file} @gol
360 -iprefix @var{file}  -iwithprefix @var{dir} @gol
361 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
362 -imultilib @var{dir} -isysroot @var{dir} @gol
363 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
364 -P  -fworking-directory  -remap @gol
365 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
366 -Xpreprocessor @var{option}}
368 @item Assembler Option
369 @xref{Assembler Options,,Passing Options to the Assembler}.
370 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
372 @item Linker Options
373 @xref{Link Options,,Options for Linking}.
374 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
375 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
376 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
377 -Wl,@var{option}  -Xlinker @var{option} @gol
378 -u @var{symbol}}
380 @item Directory Options
381 @xref{Directory Options,,Options for Directory Search}.
382 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
383 -specs=@var{file}  -I- --sysroot=@var{dir}}
385 @item Target Options
386 @c I wrote this xref this way to avoid overfull hbox. -- rms
387 @xref{Target Options}.
388 @gccoptlist{-V @var{version}  -b @var{machine}}
390 @item Machine Dependent Options
391 @xref{Submodel Options,,Hardware Models and Configurations}.
392 @c This list is ordered alphanumerically by subsection name.
393 @c Try and put the significant identifier (CPU or system) first,
394 @c so users have a clue at guessing where the ones they want will be.
396 @emph{ARC Options}
397 @gccoptlist{-EB  -EL @gol
398 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
399 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
401 @emph{ARM Options}
402 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
403 -mabi=@var{name} @gol
404 -mapcs-stack-check  -mno-apcs-stack-check @gol
405 -mapcs-float  -mno-apcs-float @gol
406 -mapcs-reentrant  -mno-apcs-reentrant @gol
407 -msched-prolog  -mno-sched-prolog @gol
408 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
409 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
410 -mthumb-interwork  -mno-thumb-interwork @gol
411 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
412 -mstructure-size-boundary=@var{n} @gol
413 -mabort-on-noreturn @gol
414 -mlong-calls  -mno-long-calls @gol
415 -msingle-pic-base  -mno-single-pic-base @gol
416 -mpic-register=@var{reg} @gol
417 -mnop-fun-dllimport @gol
418 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
419 -mpoke-function-name @gol
420 -mthumb  -marm @gol
421 -mtpcs-frame  -mtpcs-leaf-frame @gol
422 -mcaller-super-interworking  -mcallee-super-interworking @gol
423 -mtp=@var{name}}
425 @emph{AVR Options}
426 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
427 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
429 @emph{Blackfin Options}
430 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
431 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
432 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
433 -mno-id-shared-library -mshared-library-id=@var{n} @gol
434 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
435 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls}
437 @emph{CRIS Options}
438 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
439 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
440 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
441 -mstack-align  -mdata-align  -mconst-align @gol
442 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
443 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
444 -mmul-bug-workaround  -mno-mul-bug-workaround}
446 @emph{CRX Options}
447 @gccoptlist{-mmac -mpush-args}
449 @emph{Darwin Options}
450 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
451 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
452 -client_name  -compatibility_version  -current_version @gol
453 -dead_strip @gol
454 -dependency-file  -dylib_file  -dylinker_install_name @gol
455 -dynamic  -dynamiclib  -exported_symbols_list @gol
456 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
457 -force_flat_namespace  -headerpad_max_install_names @gol
458 -image_base  -init  -install_name  -keep_private_externs @gol
459 -multi_module  -multiply_defined  -multiply_defined_unused @gol
460 -noall_load   -no_dead_strip_inits_and_terms @gol
461 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
462 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
463 -private_bundle  -read_only_relocs  -sectalign @gol
464 -sectobjectsymbols  -whyload  -seg1addr @gol
465 -sectcreate  -sectobjectsymbols  -sectorder @gol
466 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
467 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
468 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
469 -single_module  -static  -sub_library  -sub_umbrella @gol
470 -twolevel_namespace  -umbrella  -undefined @gol
471 -unexported_symbols_list  -weak_reference_mismatches @gol
472 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
473 -mkernel -mone-byte-bool}
475 @emph{DEC Alpha Options}
476 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
477 -mieee  -mieee-with-inexact  -mieee-conformant @gol
478 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
479 -mtrap-precision=@var{mode}  -mbuild-constants @gol
480 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
481 -mbwx  -mmax  -mfix  -mcix @gol
482 -mfloat-vax  -mfloat-ieee @gol
483 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
484 -msmall-text  -mlarge-text @gol
485 -mmemory-latency=@var{time}}
487 @emph{DEC Alpha/VMS Options}
488 @gccoptlist{-mvms-return-codes}
490 @emph{FRV Options}
491 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
492 -mhard-float  -msoft-float @gol
493 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
494 -mdouble  -mno-double @gol
495 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
496 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
497 -mlinked-fp  -mlong-calls  -malign-labels @gol
498 -mlibrary-pic  -macc-4  -macc-8 @gol
499 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
500 -moptimize-membar -mno-optimize-membar @gol
501 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
502 -mvliw-branch  -mno-vliw-branch @gol
503 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
504 -mno-nested-cond-exec  -mtomcat-stats @gol
505 -mTLS -mtls @gol
506 -mcpu=@var{cpu}}
508 @emph{GNU/Linux Options}
509 @gccoptlist{-muclibc}
511 @emph{H8/300 Options}
512 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
514 @emph{HPPA Options}
515 @gccoptlist{-march=@var{architecture-type} @gol
516 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
517 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
518 -mfixed-range=@var{register-range} @gol
519 -mjump-in-delay -mlinker-opt -mlong-calls @gol
520 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
521 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
522 -mno-jump-in-delay  -mno-long-load-store @gol
523 -mno-portable-runtime  -mno-soft-float @gol
524 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
525 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
526 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
527 -munix=@var{unix-std}  -nolibdld  -static  -threads}
529 @emph{i386 and x86-64 Options}
530 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
531 -mfpmath=@var{unit} @gol
532 -masm=@var{dialect}  -mno-fancy-math-387 @gol
533 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
534 -mno-wide-multiply  -mrtd  -malign-double @gol
535 -mpreferred-stack-boundary=@var{num} @gol
536 -mmmx  -msse  -msse2 -msse3 -mssse3 -m3dnow @gol
537 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
538 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
539 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
540 -mstackrealign @gol
541 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
542 -mcmodel=@var{code-model} @gol
543 -m32  -m64 -mlarge-data-threshold=@var{num}}
545 @emph{IA-64 Options}
546 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
547 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
548 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
549 -minline-float-divide-max-throughput @gol
550 -minline-int-divide-min-latency @gol
551 -minline-int-divide-max-throughput  @gol
552 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
553 -mno-dwarf2-asm -mearly-stop-bits @gol
554 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
555 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
556 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
557 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
558 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
559 -mno-sched-prefer-non-data-spec-insns @gol
560 -mno-sched-prefer-non-control-spec-insns @gol
561 -mno-sched-count-spec-in-critical-path}
563 @emph{M32R/D Options}
564 @gccoptlist{-m32r2 -m32rx -m32r @gol
565 -mdebug @gol
566 -malign-loops -mno-align-loops @gol
567 -missue-rate=@var{number} @gol
568 -mbranch-cost=@var{number} @gol
569 -mmodel=@var{code-size-model-type} @gol
570 -msdata=@var{sdata-type} @gol
571 -mno-flush-func -mflush-func=@var{name} @gol
572 -mno-flush-trap -mflush-trap=@var{number} @gol
573 -G @var{num}}
575 @emph{M32C Options}
576 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
578 @emph{M680x0 Options}
579 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
580 -m68060  -mcpu32  -m5200  -mcfv4e -m68881  -mbitfield  @gol
581 -mc68000  -mc68020   @gol
582 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
583 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
584 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
586 @emph{M68hc1x Options}
587 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
588 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
589 -msoft-reg-count=@var{count}}
591 @emph{MCore Options}
592 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
593 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
594 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
595 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
596 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
598 @emph{MIPS Options}
599 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
600 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
601 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
602 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64  @gol
603 -mfp32  -mfp64  -mhard-float  -msoft-float  @gol
604 -msingle-float  -mdouble-float  -mdsp  -mpaired-single  -mips3d @gol
605 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
606 -G@var{num}  -membedded-data  -mno-embedded-data @gol
607 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
608 -msplit-addresses  -mno-split-addresses  @gol
609 -mexplicit-relocs  -mno-explicit-relocs  @gol
610 -mcheck-zero-division  -mno-check-zero-division @gol
611 -mdivide-traps  -mdivide-breaks @gol
612 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
613 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
614 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
615 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
616 -mfix-sb1  -mno-fix-sb1 @gol
617 -mflush-func=@var{func}  -mno-flush-func @gol
618 -mbranch-likely  -mno-branch-likely @gol
619 -mfp-exceptions -mno-fp-exceptions @gol
620 -mvr4130-align -mno-vr4130-align}
622 @emph{MMIX Options}
623 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
624 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
625 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
626 -mno-base-addresses  -msingle-exit  -mno-single-exit}
628 @emph{MN10300 Options}
629 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
630 -mam33  -mno-am33 @gol
631 -mam33-2  -mno-am33-2 @gol
632 -mreturn-pointer-on-d0 @gol
633 -mno-crt0  -mrelax}
635 @emph{MT Options}
636 @gccoptlist{-mno-crt0 -mbacc -msim @gol
637 -march=@var{cpu-type} }
639 @emph{PDP-11 Options}
640 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
641 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
642 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
643 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
644 -mbranch-expensive  -mbranch-cheap @gol
645 -msplit  -mno-split  -munix-asm  -mdec-asm}
647 @emph{PowerPC Options}
648 See RS/6000 and PowerPC Options.
650 @emph{RS/6000 and PowerPC Options}
651 @gccoptlist{-mcpu=@var{cpu-type} @gol
652 -mtune=@var{cpu-type} @gol
653 -mpower  -mno-power  -mpower2  -mno-power2 @gol
654 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
655 -maltivec  -mno-altivec @gol
656 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
657 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
658 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
659 -mmfpgpr -mno-mfpgpr @gol
660 -mnew-mnemonics  -mold-mnemonics @gol
661 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
662 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
663 -malign-power  -malign-natural @gol
664 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
665 -mstring  -mno-string  -mupdate  -mno-update @gol
666 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
667 -mstrict-align  -mno-strict-align  -mrelocatable @gol
668 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
669 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
670 -mdynamic-no-pic  -maltivec  -mswdiv @gol
671 -mprioritize-restricted-insns=@var{priority} @gol
672 -msched-costly-dep=@var{dependence_type} @gol
673 -minsert-sched-nops=@var{scheme} @gol
674 -mcall-sysv  -mcall-netbsd @gol
675 -maix-struct-return  -msvr4-struct-return @gol
676 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
677 -misel -mno-isel @gol
678 -misel=yes  -misel=no @gol
679 -mspe -mno-spe @gol
680 -mspe=yes  -mspe=no @gol
681 -mvrsave -mno-vrsave @gol
682 -mmulhw -mno-mulhw @gol
683 -mdlmzb -mno-dlmzb @gol
684 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
685 -mprototype  -mno-prototype @gol
686 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
687 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
689 @emph{S/390 and zSeries Options}
690 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
691 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
692 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
693 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
694 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
695 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
696 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
698 @emph{Score Options}
699 @gccoptlist{-mel -mel @gol
700 -mmac @gol
701 -mscore5u -mscore7}
703 @emph{SH Options}
704 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
705 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
706 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
707 -m5-64media  -m5-64media-nofpu @gol
708 -m5-32media  -m5-32media-nofpu @gol
709 -m5-compact  -m5-compact-nofpu @gol
710 -mb  -ml  -mdalign  -mrelax @gol
711 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
712 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
713 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
714 -mdivsi3_libfunc=@var{name}  @gol
715 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
716  -minvalid-symbols}
718 @emph{SPARC Options}
719 @gccoptlist{-mcpu=@var{cpu-type} @gol
720 -mtune=@var{cpu-type} @gol
721 -mcmodel=@var{code-model} @gol
722 -m32  -m64  -mapp-regs  -mno-app-regs @gol
723 -mfaster-structs  -mno-faster-structs @gol
724 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
725 -mhard-quad-float  -msoft-quad-float @gol
726 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
727 -mstack-bias  -mno-stack-bias @gol
728 -munaligned-doubles  -mno-unaligned-doubles @gol
729 -mv8plus  -mno-v8plus  -mvis  -mno-vis
730 -threads -pthreads -pthread}
732 @emph{SPU Options}
733 @gccoptlist{-mwarn-reloc -merror-reloc @gol
734 -msafe-dma -munsafe-dma @gol
735 -mbranch-hints @gol
736 -msmall-mem -mlarge-mem -mstdmain}
738 @emph{System V Options}
739 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
741 @emph{TMS320C3x/C4x Options}
742 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
743 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
744 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
745 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
747 @emph{V850 Options}
748 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
749 -mprolog-function  -mno-prolog-function  -mspace @gol
750 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
751 -mapp-regs  -mno-app-regs @gol
752 -mdisable-callt  -mno-disable-callt @gol
753 -mv850e1 @gol
754 -mv850e @gol
755 -mv850  -mbig-switch}
757 @emph{VAX Options}
758 @gccoptlist{-mg  -mgnu  -munix}
760 @emph{x86-64 Options}
761 See i386 and x86-64 Options.
763 @emph{Xstormy16 Options}
764 @gccoptlist{-msim}
766 @emph{Xtensa Options}
767 @gccoptlist{-mconst16 -mno-const16 @gol
768 -mfused-madd  -mno-fused-madd @gol
769 -mtext-section-literals  -mno-text-section-literals @gol
770 -mtarget-align  -mno-target-align @gol
771 -mlongcalls  -mno-longcalls}
773 @emph{zSeries Options}
774 See S/390 and zSeries Options.
776 @item Code Generation Options
777 @xref{Code Gen Options,,Options for Code Generation Conventions}.
778 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
779 -ffixed-@var{reg}  -fexceptions @gol
780 -fnon-call-exceptions  -funwind-tables @gol
781 -fasynchronous-unwind-tables @gol
782 -finhibit-size-directive  -finstrument-functions @gol
783 -fno-common  -fno-ident @gol
784 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
785 -fno-jump-tables @gol
786 -frecord-gcc-switches @gol
787 -freg-struct-return  -fshort-enums @gol
788 -fshort-double  -fshort-wchar @gol
789 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
790 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
791 -fargument-alias  -fargument-noalias @gol
792 -fargument-noalias-global  -fargument-noalias-anything
793 -fleading-underscore  -ftls-model=@var{model} @gol
794 -ftrapv  -fwrapv  -fbounds-check @gol
795 -fvisibility}
796 @end table
798 @menu
799 * Overall Options::     Controlling the kind of output:
800                         an executable, object files, assembler files,
801                         or preprocessed source.
802 * C Dialect Options::   Controlling the variant of C language compiled.
803 * C++ Dialect Options:: Variations on C++.
804 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
805                         and Objective-C++.
806 * Language Independent Options:: Controlling how diagnostics should be
807                         formatted.
808 * Warning Options::     How picky should the compiler be?
809 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
810 * Optimize Options::    How much optimization?
811 * Preprocessor Options:: Controlling header files and macro definitions.
812                          Also, getting dependency information for Make.
813 * Assembler Options::   Passing options to the assembler.
814 * Link Options::        Specifying libraries and so on.
815 * Directory Options::   Where to find header files and libraries.
816                         Where to find the compiler executable files.
817 * Spec Files::          How to pass switches to sub-processes.
818 * Target Options::      Running a cross-compiler, or an old version of GCC.
819 @end menu
821 @node Overall Options
822 @section Options Controlling the Kind of Output
824 Compilation can involve up to four stages: preprocessing, compilation
825 proper, assembly and linking, always in that order.  GCC is capable of
826 preprocessing and compiling several files either into several
827 assembler input files, or into one assembler input file; then each
828 assembler input file produces an object file, and linking combines all
829 the object files (those newly compiled, and those specified as input)
830 into an executable file.
832 @cindex file name suffix
833 For any given input file, the file name suffix determines what kind of
834 compilation is done:
836 @table @gcctabopt
837 @item @var{file}.c
838 C source code which must be preprocessed.
840 @item @var{file}.i
841 C source code which should not be preprocessed.
843 @item @var{file}.ii
844 C++ source code which should not be preprocessed.
846 @item @var{file}.m
847 Objective-C source code.  Note that you must link with the @file{libobjc}
848 library to make an Objective-C program work.
850 @item @var{file}.mi
851 Objective-C source code which should not be preprocessed.
853 @item @var{file}.mm
854 @itemx @var{file}.M
855 Objective-C++ source code.  Note that you must link with the @file{libobjc}
856 library to make an Objective-C++ program work.  Note that @samp{.M} refers
857 to a literal capital M@.
859 @item @var{file}.mii
860 Objective-C++ source code which should not be preprocessed.
862 @item @var{file}.h
863 C, C++, Objective-C or Objective-C++ header file to be turned into a
864 precompiled header.
866 @item @var{file}.cc
867 @itemx @var{file}.cp
868 @itemx @var{file}.cxx
869 @itemx @var{file}.cpp
870 @itemx @var{file}.CPP
871 @itemx @var{file}.c++
872 @itemx @var{file}.C
873 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
874 the last two letters must both be literally @samp{x}.  Likewise,
875 @samp{.C} refers to a literal capital C@.
877 @item @var{file}.mm
878 @itemx @var{file}.M
879 Objective-C++ source code which must be preprocessed.
881 @item @var{file}.mii
882 Objective-C++ source code which should not be preprocessed.
884 @item @var{file}.hh
885 @itemx @var{file}.H
886 C++ header file to be turned into a precompiled header.
888 @item @var{file}.f
889 @itemx @var{file}.for
890 @itemx @var{file}.FOR
891 Fixed form Fortran source code which should not be preprocessed.
893 @item @var{file}.F
894 @itemx @var{file}.fpp
895 @itemx @var{file}.FPP
896 Fixed form Fortran source code which must be preprocessed (with the traditional
897 preprocessor).
899 @item @var{file}.f90
900 @itemx @var{file}.f95
901 Free form Fortran source code which should not be preprocessed.
903 @item @var{file}.F90
904 @itemx @var{file}.F95
905 Free form Fortran source code which must be preprocessed (with the
906 traditional preprocessor).
908 @c FIXME: Descriptions of Java file types.
909 @c @var{file}.java
910 @c @var{file}.class
911 @c @var{file}.zip
912 @c @var{file}.jar
914 @item @var{file}.ads
915 Ada source code file which contains a library unit declaration (a
916 declaration of a package, subprogram, or generic, or a generic
917 instantiation), or a library unit renaming declaration (a package,
918 generic, or subprogram renaming declaration).  Such files are also
919 called @dfn{specs}.
921 @itemx @var{file}.adb
922 Ada source code file containing a library unit body (a subprogram or
923 package body).  Such files are also called @dfn{bodies}.
925 @c GCC also knows about some suffixes for languages not yet included:
926 @c Pascal:
927 @c @var{file}.p
928 @c @var{file}.pas
929 @c Ratfor:
930 @c @var{file}.r
932 @item @var{file}.s
933 Assembler code.
935 @item @var{file}.S
936 Assembler code which must be preprocessed.
938 @item @var{other}
939 An object file to be fed straight into linking.
940 Any file name with no recognized suffix is treated this way.
941 @end table
943 @opindex x
944 You can specify the input language explicitly with the @option{-x} option:
946 @table @gcctabopt
947 @item -x @var{language}
948 Specify explicitly the @var{language} for the following input files
949 (rather than letting the compiler choose a default based on the file
950 name suffix).  This option applies to all following input files until
951 the next @option{-x} option.  Possible values for @var{language} are:
952 @smallexample
953 c  c-header  c-cpp-output
954 c++  c++-header  c++-cpp-output
955 objective-c  objective-c-header  objective-c-cpp-output
956 objective-c++ objective-c++-header objective-c++-cpp-output
957 assembler  assembler-with-cpp
959 f95  f95-cpp-input
960 java
961 treelang
962 @end smallexample
964 @item -x none
965 Turn off any specification of a language, so that subsequent files are
966 handled according to their file name suffixes (as they are if @option{-x}
967 has not been used at all).
969 @item -pass-exit-codes
970 @opindex pass-exit-codes
971 Normally the @command{gcc} program will exit with the code of 1 if any
972 phase of the compiler returns a non-success return code.  If you specify
973 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
974 numerically highest error produced by any phase that returned an error
975 indication.  The C, C++, and Fortran frontends return 4, if an internal
976 compiler error is encountered.
977 @end table
979 If you only want some of the stages of compilation, you can use
980 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
981 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
982 @command{gcc} is to stop.  Note that some combinations (for example,
983 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
985 @table @gcctabopt
986 @item -c
987 @opindex c
988 Compile or assemble the source files, but do not link.  The linking
989 stage simply is not done.  The ultimate output is in the form of an
990 object file for each source file.
992 By default, the object file name for a source file is made by replacing
993 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
995 Unrecognized input files, not requiring compilation or assembly, are
996 ignored.
998 @item -S
999 @opindex S
1000 Stop after the stage of compilation proper; do not assemble.  The output
1001 is in the form of an assembler code file for each non-assembler input
1002 file specified.
1004 By default, the assembler file name for a source file is made by
1005 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1007 Input files that don't require compilation are ignored.
1009 @item -E
1010 @opindex E
1011 Stop after the preprocessing stage; do not run the compiler proper.  The
1012 output is in the form of preprocessed source code, which is sent to the
1013 standard output.
1015 Input files which don't require preprocessing are ignored.
1017 @cindex output file option
1018 @item -o @var{file}
1019 @opindex o
1020 Place output in file @var{file}.  This applies regardless to whatever
1021 sort of output is being produced, whether it be an executable file,
1022 an object file, an assembler file or preprocessed C code.
1024 If @option{-o} is not specified, the default is to put an executable
1025 file in @file{a.out}, the object file for
1026 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1027 assembler file in @file{@var{source}.s}, a precompiled header file in
1028 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1029 standard output.
1031 @item -v
1032 @opindex v
1033 Print (on standard error output) the commands executed to run the stages
1034 of compilation.  Also print the version number of the compiler driver
1035 program and of the preprocessor and the compiler proper.
1037 @item -###
1038 @opindex ###
1039 Like @option{-v} except the commands are not executed and all command
1040 arguments are quoted.  This is useful for shell scripts to capture the
1041 driver-generated command lines.
1043 @item -pipe
1044 @opindex pipe
1045 Use pipes rather than temporary files for communication between the
1046 various stages of compilation.  This fails to work on some systems where
1047 the assembler is unable to read from a pipe; but the GNU assembler has
1048 no trouble.
1050 @item -combine
1051 @opindex combine
1052 If you are compiling multiple source files, this option tells the driver
1053 to pass all the source files to the compiler at once (for those
1054 languages for which the compiler can handle this).  This will allow
1055 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1056 language for which this is supported is C@.  If you pass source files for
1057 multiple languages to the driver, using this option, the driver will invoke
1058 the compiler(s) that support IMA once each, passing each compiler all the
1059 source files appropriate for it.  For those languages that do not support
1060 IMA this option will be ignored, and the compiler will be invoked once for
1061 each source file in that language.  If you use this option in conjunction
1062 with @option{-save-temps}, the compiler will generate multiple
1063 pre-processed files
1064 (one for each source file), but only one (combined) @file{.o} or
1065 @file{.s} file.
1067 @item --help
1068 @opindex help
1069 Print (on the standard output) a description of the command line options
1070 understood by @command{gcc}.  If the @option{-v} option is also specified
1071 then @option{--help} will also be passed on to the various processes
1072 invoked by @command{gcc}, so that they can display the command line options
1073 they accept.  If the @option{-Wextra} option is also specified then command
1074 line options which have no documentation associated with them will also
1075 be displayed.
1077 @item --target-help
1078 @opindex target-help
1079 Print (on the standard output) a description of target specific command
1080 line options for each tool.
1082 @item --version
1083 @opindex version
1084 Display the version number and copyrights of the invoked GCC@.
1086 @include @value{srcdir}/../libiberty/at-file.texi
1087 @end table
1089 @node Invoking G++
1090 @section Compiling C++ Programs
1092 @cindex suffixes for C++ source
1093 @cindex C++ source file suffixes
1094 C++ source files conventionally use one of the suffixes @samp{.C},
1095 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1096 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1097 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1098 files with these names and compiles them as C++ programs even if you
1099 call the compiler the same way as for compiling C programs (usually
1100 with the name @command{gcc}).
1102 @findex g++
1103 @findex c++
1104 However, the use of @command{gcc} does not add the C++ library.
1105 @command{g++} is a program that calls GCC and treats @samp{.c},
1106 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1107 files unless @option{-x} is used, and automatically specifies linking
1108 against the C++ library.  This program is also useful when
1109 precompiling a C header file with a @samp{.h} extension for use in C++
1110 compilations.  On many systems, @command{g++} is also installed with
1111 the name @command{c++}.
1113 @cindex invoking @command{g++}
1114 When you compile C++ programs, you may specify many of the same
1115 command-line options that you use for compiling programs in any
1116 language; or command-line options meaningful for C and related
1117 languages; or options that are meaningful only for C++ programs.
1118 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1119 explanations of options for languages related to C@.
1120 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1121 explanations of options that are meaningful only for C++ programs.
1123 @node C Dialect Options
1124 @section Options Controlling C Dialect
1125 @cindex dialect options
1126 @cindex language dialect options
1127 @cindex options, dialect
1129 The following options control the dialect of C (or languages derived
1130 from C, such as C++, Objective-C and Objective-C++) that the compiler
1131 accepts:
1133 @table @gcctabopt
1134 @cindex ANSI support
1135 @cindex ISO support
1136 @item -ansi
1137 @opindex ansi
1138 In C mode, support all ISO C90 programs.  In C++ mode,
1139 remove GNU extensions that conflict with ISO C++.
1141 This turns off certain features of GCC that are incompatible with ISO
1142 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1143 such as the @code{asm} and @code{typeof} keywords, and
1144 predefined macros such as @code{unix} and @code{vax} that identify the
1145 type of system you are using.  It also enables the undesirable and
1146 rarely used ISO trigraph feature.  For the C compiler,
1147 it disables recognition of C++ style @samp{//} comments as well as
1148 the @code{inline} keyword.
1150 The alternate keywords @code{__asm__}, @code{__extension__},
1151 @code{__inline__} and @code{__typeof__} continue to work despite
1152 @option{-ansi}.  You would not want to use them in an ISO C program, of
1153 course, but it is useful to put them in header files that might be included
1154 in compilations done with @option{-ansi}.  Alternate predefined macros
1155 such as @code{__unix__} and @code{__vax__} are also available, with or
1156 without @option{-ansi}.
1158 The @option{-ansi} option does not cause non-ISO programs to be
1159 rejected gratuitously.  For that, @option{-pedantic} is required in
1160 addition to @option{-ansi}.  @xref{Warning Options}.
1162 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1163 option is used.  Some header files may notice this macro and refrain
1164 from declaring certain functions or defining certain macros that the
1165 ISO standard doesn't call for; this is to avoid interfering with any
1166 programs that might use these names for other things.
1168 Functions which would normally be built in but do not have semantics
1169 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1170 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1171 built-in functions provided by GCC}, for details of the functions
1172 affected.
1174 @item -std=
1175 @opindex std
1176 Determine the language standard.  This option is currently only
1177 supported when compiling C or C++.  A value for this option must be
1178 provided; possible values are
1180 @table @samp
1181 @item c89
1182 @itemx iso9899:1990
1183 ISO C90 (same as @option{-ansi}).
1185 @item iso9899:199409
1186 ISO C90 as modified in amendment 1.
1188 @item c99
1189 @itemx c9x
1190 @itemx iso9899:1999
1191 @itemx iso9899:199x
1192 ISO C99.  Note that this standard is not yet fully supported; see
1193 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1194 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1196 @item gnu89
1197 Default, ISO C90 plus GNU extensions (including some C99 features).
1199 @item gnu99
1200 @itemx gnu9x
1201 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1202 this will become the default.  The name @samp{gnu9x} is deprecated.
1204 @item c++98
1205 The 1998 ISO C++ standard plus amendments.
1207 @item gnu++98
1208 The same as @option{-std=c++98} plus GNU extensions.  This is the
1209 default for C++ code.
1211 @item c++0x
1212 The working draft of the upcoming ISO C++0x standard. This option
1213 enables experimental features that are likely to be included in
1214 C++0x. The working draft is constantly changing, and any feature that is
1215 enabled by this flag may be removed from future versions of GCC if it is
1216 not part of the C++0x standard.
1218 @item gnu++0x
1219 The same as @option{-std=c++0x} plus GNU extensions. As with
1220 @option{-std=c++0x}, this option enables experimental features that may
1221 be removed in future versions of GCC.
1222 @end table
1224 Even when this option is not specified, you can still use some of the
1225 features of newer standards in so far as they do not conflict with
1226 previous C standards.  For example, you may use @code{__restrict__} even
1227 when @option{-std=c99} is not specified.
1229 The @option{-std} options specifying some version of ISO C have the same
1230 effects as @option{-ansi}, except that features that were not in ISO C90
1231 but are in the specified version (for example, @samp{//} comments and
1232 the @code{inline} keyword in ISO C99) are not disabled.
1234 @xref{Standards,,Language Standards Supported by GCC}, for details of
1235 these standard versions.
1237 @item -aux-info @var{filename}
1238 @opindex aux-info
1239 Output to the given filename prototyped declarations for all functions
1240 declared and/or defined in a translation unit, including those in header
1241 files.  This option is silently ignored in any language other than C@.
1243 Besides declarations, the file indicates, in comments, the origin of
1244 each declaration (source file and line), whether the declaration was
1245 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1246 @samp{O} for old, respectively, in the first character after the line
1247 number and the colon), and whether it came from a declaration or a
1248 definition (@samp{C} or @samp{F}, respectively, in the following
1249 character).  In the case of function definitions, a K&R-style list of
1250 arguments followed by their declarations is also provided, inside
1251 comments, after the declaration.
1253 @item -fno-asm
1254 @opindex fno-asm
1255 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1256 keyword, so that code can use these words as identifiers.  You can use
1257 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1258 instead.  @option{-ansi} implies @option{-fno-asm}.
1260 In C++, this switch only affects the @code{typeof} keyword, since
1261 @code{asm} and @code{inline} are standard keywords.  You may want to
1262 use the @option{-fno-gnu-keywords} flag instead, which has the same
1263 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1264 switch only affects the @code{asm} and @code{typeof} keywords, since
1265 @code{inline} is a standard keyword in ISO C99.
1267 @item -fno-builtin
1268 @itemx -fno-builtin-@var{function}
1269 @opindex fno-builtin
1270 @cindex built-in functions
1271 Don't recognize built-in functions that do not begin with
1272 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1273 functions provided by GCC}, for details of the functions affected,
1274 including those which are not built-in functions when @option{-ansi} or
1275 @option{-std} options for strict ISO C conformance are used because they
1276 do not have an ISO standard meaning.
1278 GCC normally generates special code to handle certain built-in functions
1279 more efficiently; for instance, calls to @code{alloca} may become single
1280 instructions that adjust the stack directly, and calls to @code{memcpy}
1281 may become inline copy loops.  The resulting code is often both smaller
1282 and faster, but since the function calls no longer appear as such, you
1283 cannot set a breakpoint on those calls, nor can you change the behavior
1284 of the functions by linking with a different library.  In addition,
1285 when a function is recognized as a built-in function, GCC may use
1286 information about that function to warn about problems with calls to
1287 that function, or to generate more efficient code, even if the
1288 resulting code still contains calls to that function.  For example,
1289 warnings are given with @option{-Wformat} for bad calls to
1290 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1291 known not to modify global memory.
1293 With the @option{-fno-builtin-@var{function}} option
1294 only the built-in function @var{function} is
1295 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1296 function is named this is not built-in in this version of GCC, this
1297 option is ignored.  There is no corresponding
1298 @option{-fbuiltin-@var{function}} option; if you wish to enable
1299 built-in functions selectively when using @option{-fno-builtin} or
1300 @option{-ffreestanding}, you may define macros such as:
1302 @smallexample
1303 #define abs(n)          __builtin_abs ((n))
1304 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1305 @end smallexample
1307 @item -fhosted
1308 @opindex fhosted
1309 @cindex hosted environment
1311 Assert that compilation takes place in a hosted environment.  This implies
1312 @option{-fbuiltin}.  A hosted environment is one in which the
1313 entire standard library is available, and in which @code{main} has a return
1314 type of @code{int}.  Examples are nearly everything except a kernel.
1315 This is equivalent to @option{-fno-freestanding}.
1317 @item -ffreestanding
1318 @opindex ffreestanding
1319 @cindex hosted environment
1321 Assert that compilation takes place in a freestanding environment.  This
1322 implies @option{-fno-builtin}.  A freestanding environment
1323 is one in which the standard library may not exist, and program startup may
1324 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1325 This is equivalent to @option{-fno-hosted}.
1327 @xref{Standards,,Language Standards Supported by GCC}, for details of
1328 freestanding and hosted environments.
1330 @item -fopenmp
1331 @opindex fopenmp
1332 @cindex openmp parallel
1333 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1334 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1335 compiler generates parallel code according to the OpenMP Application
1336 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1338 @item -fms-extensions
1339 @opindex fms-extensions
1340 Accept some non-standard constructs used in Microsoft header files.
1342 Some cases of unnamed fields in structures and unions are only
1343 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1344 fields within structs/unions}, for details.
1346 @item -trigraphs
1347 @opindex trigraphs
1348 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1349 options for strict ISO C conformance) implies @option{-trigraphs}.
1351 @item -no-integrated-cpp
1352 @opindex no-integrated-cpp
1353 Performs a compilation in two passes: preprocessing and compiling.  This
1354 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1355 @option{-B} option.  The user supplied compilation step can then add in
1356 an additional preprocessing step after normal preprocessing but before
1357 compiling.  The default is to use the integrated cpp (internal cpp)
1359 The semantics of this option will change if "cc1", "cc1plus", and
1360 "cc1obj" are merged.
1362 @cindex traditional C language
1363 @cindex C language, traditional
1364 @item -traditional
1365 @itemx -traditional-cpp
1366 @opindex traditional-cpp
1367 @opindex traditional
1368 Formerly, these options caused GCC to attempt to emulate a pre-standard
1369 C compiler.  They are now only supported with the @option{-E} switch.
1370 The preprocessor continues to support a pre-standard mode.  See the GNU
1371 CPP manual for details.
1373 @item -fcond-mismatch
1374 @opindex fcond-mismatch
1375 Allow conditional expressions with mismatched types in the second and
1376 third arguments.  The value of such an expression is void.  This option
1377 is not supported for C++.
1379 @item -funsigned-char
1380 @opindex funsigned-char
1381 Let the type @code{char} be unsigned, like @code{unsigned char}.
1383 Each kind of machine has a default for what @code{char} should
1384 be.  It is either like @code{unsigned char} by default or like
1385 @code{signed char} by default.
1387 Ideally, a portable program should always use @code{signed char} or
1388 @code{unsigned char} when it depends on the signedness of an object.
1389 But many programs have been written to use plain @code{char} and
1390 expect it to be signed, or expect it to be unsigned, depending on the
1391 machines they were written for.  This option, and its inverse, let you
1392 make such a program work with the opposite default.
1394 The type @code{char} is always a distinct type from each of
1395 @code{signed char} or @code{unsigned char}, even though its behavior
1396 is always just like one of those two.
1398 @item -fsigned-char
1399 @opindex fsigned-char
1400 Let the type @code{char} be signed, like @code{signed char}.
1402 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1403 the negative form of @option{-funsigned-char}.  Likewise, the option
1404 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1406 @item -fsigned-bitfields
1407 @itemx -funsigned-bitfields
1408 @itemx -fno-signed-bitfields
1409 @itemx -fno-unsigned-bitfields
1410 @opindex fsigned-bitfields
1411 @opindex funsigned-bitfields
1412 @opindex fno-signed-bitfields
1413 @opindex fno-unsigned-bitfields
1414 These options control whether a bit-field is signed or unsigned, when the
1415 declaration does not use either @code{signed} or @code{unsigned}.  By
1416 default, such a bit-field is signed, because this is consistent: the
1417 basic integer types such as @code{int} are signed types.
1418 @end table
1420 @node C++ Dialect Options
1421 @section Options Controlling C++ Dialect
1423 @cindex compiler options, C++
1424 @cindex C++ options, command line
1425 @cindex options, C++
1426 This section describes the command-line options that are only meaningful
1427 for C++ programs; but you can also use most of the GNU compiler options
1428 regardless of what language your program is in.  For example, you
1429 might compile a file @code{firstClass.C} like this:
1431 @smallexample
1432 g++ -g -frepo -O -c firstClass.C
1433 @end smallexample
1435 @noindent
1436 In this example, only @option{-frepo} is an option meant
1437 only for C++ programs; you can use the other options with any
1438 language supported by GCC@.
1440 Here is a list of options that are @emph{only} for compiling C++ programs:
1442 @table @gcctabopt
1444 @item -fabi-version=@var{n}
1445 @opindex fabi-version
1446 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1447 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1448 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1449 the version that conforms most closely to the C++ ABI specification.
1450 Therefore, the ABI obtained using version 0 will change as ABI bugs
1451 are fixed.
1453 The default is version 2.
1455 @item -fno-access-control
1456 @opindex fno-access-control
1457 Turn off all access checking.  This switch is mainly useful for working
1458 around bugs in the access control code.
1460 @item -fcheck-new
1461 @opindex fcheck-new
1462 Check that the pointer returned by @code{operator new} is non-null
1463 before attempting to modify the storage allocated.  This check is
1464 normally unnecessary because the C++ standard specifies that
1465 @code{operator new} will only return @code{0} if it is declared
1466 @samp{throw()}, in which case the compiler will always check the
1467 return value even without this option.  In all other cases, when
1468 @code{operator new} has a non-empty exception specification, memory
1469 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1470 @samp{new (nothrow)}.
1472 @item -fconserve-space
1473 @opindex fconserve-space
1474 Put uninitialized or runtime-initialized global variables into the
1475 common segment, as C does.  This saves space in the executable at the
1476 cost of not diagnosing duplicate definitions.  If you compile with this
1477 flag and your program mysteriously crashes after @code{main()} has
1478 completed, you may have an object that is being destroyed twice because
1479 two definitions were merged.
1481 This option is no longer useful on most targets, now that support has
1482 been added for putting variables into BSS without making them common.
1484 @item -ffriend-injection
1485 @opindex ffriend-injection
1486 Inject friend functions into the enclosing namespace, so that they are
1487 visible outside the scope of the class in which they are declared.
1488 Friend functions were documented to work this way in the old Annotated
1489 C++ Reference Manual, and versions of G++ before 4.1 always worked
1490 that way.  However, in ISO C++ a friend function which is not declared
1491 in an enclosing scope can only be found using argument dependent
1492 lookup.  This option causes friends to be injected as they were in
1493 earlier releases.
1495 This option is for compatibility, and may be removed in a future
1496 release of G++.
1498 @item -fno-elide-constructors
1499 @opindex fno-elide-constructors
1500 The C++ standard allows an implementation to omit creating a temporary
1501 which is only used to initialize another object of the same type.
1502 Specifying this option disables that optimization, and forces G++ to
1503 call the copy constructor in all cases.
1505 @item -fno-enforce-eh-specs
1506 @opindex fno-enforce-eh-specs
1507 Don't generate code to check for violation of exception specifications
1508 at runtime.  This option violates the C++ standard, but may be useful
1509 for reducing code size in production builds, much like defining
1510 @samp{NDEBUG}.  This does not give user code permission to throw
1511 exceptions in violation of the exception specifications; the compiler
1512 will still optimize based on the specifications, so throwing an
1513 unexpected exception will result in undefined behavior.
1515 @item -ffor-scope
1516 @itemx -fno-for-scope
1517 @opindex ffor-scope
1518 @opindex fno-for-scope
1519 If @option{-ffor-scope} is specified, the scope of variables declared in
1520 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1521 as specified by the C++ standard.
1522 If @option{-fno-for-scope} is specified, the scope of variables declared in
1523 a @i{for-init-statement} extends to the end of the enclosing scope,
1524 as was the case in old versions of G++, and other (traditional)
1525 implementations of C++.
1527 The default if neither flag is given to follow the standard,
1528 but to allow and give a warning for old-style code that would
1529 otherwise be invalid, or have different behavior.
1531 @item -fno-gnu-keywords
1532 @opindex fno-gnu-keywords
1533 Do not recognize @code{typeof} as a keyword, so that code can use this
1534 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1535 @option{-ansi} implies @option{-fno-gnu-keywords}.
1537 @item -fno-implicit-templates
1538 @opindex fno-implicit-templates
1539 Never emit code for non-inline templates which are instantiated
1540 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1541 @xref{Template Instantiation}, for more information.
1543 @item -fno-implicit-inline-templates
1544 @opindex fno-implicit-inline-templates
1545 Don't emit code for implicit instantiations of inline templates, either.
1546 The default is to handle inlines differently so that compiles with and
1547 without optimization will need the same set of explicit instantiations.
1549 @item -fno-implement-inlines
1550 @opindex fno-implement-inlines
1551 To save space, do not emit out-of-line copies of inline functions
1552 controlled by @samp{#pragma implementation}.  This will cause linker
1553 errors if these functions are not inlined everywhere they are called.
1555 @item -fms-extensions
1556 @opindex fms-extensions
1557 Disable pedantic warnings about constructs used in MFC, such as implicit
1558 int and getting a pointer to member function via non-standard syntax.
1560 @item -fno-nonansi-builtins
1561 @opindex fno-nonansi-builtins
1562 Disable built-in declarations of functions that are not mandated by
1563 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1564 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1566 @item -fno-operator-names
1567 @opindex fno-operator-names
1568 Do not treat the operator name keywords @code{and}, @code{bitand},
1569 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1570 synonyms as keywords.
1572 @item -fno-optional-diags
1573 @opindex fno-optional-diags
1574 Disable diagnostics that the standard says a compiler does not need to
1575 issue.  Currently, the only such diagnostic issued by G++ is the one for
1576 a name having multiple meanings within a class.
1578 @item -fpermissive
1579 @opindex fpermissive
1580 Downgrade some diagnostics about nonconformant code from errors to
1581 warnings.  Thus, using @option{-fpermissive} will allow some
1582 nonconforming code to compile.
1584 @item -frepo
1585 @opindex frepo
1586 Enable automatic template instantiation at link time.  This option also
1587 implies @option{-fno-implicit-templates}.  @xref{Template
1588 Instantiation}, for more information.
1590 @item -fno-rtti
1591 @opindex fno-rtti
1592 Disable generation of information about every class with virtual
1593 functions for use by the C++ runtime type identification features
1594 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1595 of the language, you can save some space by using this flag.  Note that
1596 exception handling uses the same information, but it will generate it as
1597 needed. The @samp{dynamic_cast} operator can still be used for casts that
1598 do not require runtime type information, i.e. casts to @code{void *} or to
1599 unambiguous base classes.
1601 @item -fstats
1602 @opindex fstats
1603 Emit statistics about front-end processing at the end of the compilation.
1604 This information is generally only useful to the G++ development team.
1606 @item -ftemplate-depth-@var{n}
1607 @opindex ftemplate-depth
1608 Set the maximum instantiation depth for template classes to @var{n}.
1609 A limit on the template instantiation depth is needed to detect
1610 endless recursions during template class instantiation.  ANSI/ISO C++
1611 conforming programs must not rely on a maximum depth greater than 17.
1613 @item -fno-threadsafe-statics
1614 @opindex fno-threadsafe-statics
1615 Do not emit the extra code to use the routines specified in the C++
1616 ABI for thread-safe initialization of local statics.  You can use this
1617 option to reduce code size slightly in code that doesn't need to be
1618 thread-safe.
1620 @item -fuse-cxa-atexit
1621 @opindex fuse-cxa-atexit
1622 Register destructors for objects with static storage duration with the
1623 @code{__cxa_atexit} function rather than the @code{atexit} function.
1624 This option is required for fully standards-compliant handling of static
1625 destructors, but will only work if your C library supports
1626 @code{__cxa_atexit}.
1628 @item -fno-use-cxa-get-exception-ptr
1629 @opindex fno-use-cxa-get-exception-ptr
1630 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1631 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1632 if the runtime routine is not available.
1634 @item -fvisibility-inlines-hidden
1635 @opindex fvisibility-inlines-hidden
1636 This switch declares that the user does not attempt to compare
1637 pointers to inline methods where the addresses of the two functions
1638 were taken in different shared objects.
1640 The effect of this is that GCC may, effectively, mark inline methods with
1641 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1642 appear in the export table of a DSO and do not require a PLT indirection
1643 when used within the DSO@.  Enabling this option can have a dramatic effect
1644 on load and link times of a DSO as it massively reduces the size of the
1645 dynamic export table when the library makes heavy use of templates.
1647 The behaviour of this switch is not quite the same as marking the
1648 methods as hidden directly, because it does not affect static variables
1649 local to the function or cause the compiler to deduce that
1650 the function is defined in only one shared object.
1652 You may mark a method as having a visibility explicitly to negate the
1653 effect of the switch for that method.  For example, if you do want to
1654 compare pointers to a particular inline method, you might mark it as
1655 having default visibility.  Marking the enclosing class with explicit
1656 visibility will have no effect.
1658 Explicitly instantiated inline methods are unaffected by this option
1659 as their linkage might otherwise cross a shared library boundary.
1660 @xref{Template Instantiation}.
1662 @item -fno-weak
1663 @opindex fno-weak
1664 Do not use weak symbol support, even if it is provided by the linker.
1665 By default, G++ will use weak symbols if they are available.  This
1666 option exists only for testing, and should not be used by end-users;
1667 it will result in inferior code and has no benefits.  This option may
1668 be removed in a future release of G++.
1670 @item -nostdinc++
1671 @opindex nostdinc++
1672 Do not search for header files in the standard directories specific to
1673 C++, but do still search the other standard directories.  (This option
1674 is used when building the C++ library.)
1675 @end table
1677 In addition, these optimization, warning, and code generation options
1678 have meanings only for C++ programs:
1680 @table @gcctabopt
1681 @item -fno-default-inline
1682 @opindex fno-default-inline
1683 Do not assume @samp{inline} for functions defined inside a class scope.
1684 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1685 functions will have linkage like inline functions; they just won't be
1686 inlined by default.
1688 @item -Wabi @r{(C++ only)}
1689 @opindex Wabi
1690 Warn when G++ generates code that is probably not compatible with the
1691 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1692 all such cases, there are probably some cases that are not warned about,
1693 even though G++ is generating incompatible code.  There may also be
1694 cases where warnings are emitted even though the code that is generated
1695 will be compatible.
1697 You should rewrite your code to avoid these warnings if you are
1698 concerned about the fact that code generated by G++ may not be binary
1699 compatible with code generated by other compilers.
1701 The known incompatibilities at this point include:
1703 @itemize @bullet
1705 @item
1706 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1707 pack data into the same byte as a base class.  For example:
1709 @smallexample
1710 struct A @{ virtual void f(); int f1 : 1; @};
1711 struct B : public A @{ int f2 : 1; @};
1712 @end smallexample
1714 @noindent
1715 In this case, G++ will place @code{B::f2} into the same byte
1716 as@code{A::f1}; other compilers will not.  You can avoid this problem
1717 by explicitly padding @code{A} so that its size is a multiple of the
1718 byte size on your platform; that will cause G++ and other compilers to
1719 layout @code{B} identically.
1721 @item
1722 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1723 tail padding when laying out virtual bases.  For example:
1725 @smallexample
1726 struct A @{ virtual void f(); char c1; @};
1727 struct B @{ B(); char c2; @};
1728 struct C : public A, public virtual B @{@};
1729 @end smallexample
1731 @noindent
1732 In this case, G++ will not place @code{B} into the tail-padding for
1733 @code{A}; other compilers will.  You can avoid this problem by
1734 explicitly padding @code{A} so that its size is a multiple of its
1735 alignment (ignoring virtual base classes); that will cause G++ and other
1736 compilers to layout @code{C} identically.
1738 @item
1739 Incorrect handling of bit-fields with declared widths greater than that
1740 of their underlying types, when the bit-fields appear in a union.  For
1741 example:
1743 @smallexample
1744 union U @{ int i : 4096; @};
1745 @end smallexample
1747 @noindent
1748 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1749 union too small by the number of bits in an @code{int}.
1751 @item
1752 Empty classes can be placed at incorrect offsets.  For example:
1754 @smallexample
1755 struct A @{@};
1757 struct B @{
1758   A a;
1759   virtual void f ();
1762 struct C : public B, public A @{@};
1763 @end smallexample
1765 @noindent
1766 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1767 it should be placed at offset zero.  G++ mistakenly believes that the
1768 @code{A} data member of @code{B} is already at offset zero.
1770 @item
1771 Names of template functions whose types involve @code{typename} or
1772 template template parameters can be mangled incorrectly.
1774 @smallexample
1775 template <typename Q>
1776 void f(typename Q::X) @{@}
1778 template <template <typename> class Q>
1779 void f(typename Q<int>::X) @{@}
1780 @end smallexample
1782 @noindent
1783 Instantiations of these templates may be mangled incorrectly.
1785 @end itemize
1787 @item -Wctor-dtor-privacy @r{(C++ only)}
1788 @opindex Wctor-dtor-privacy
1789 Warn when a class seems unusable because all the constructors or
1790 destructors in that class are private, and it has neither friends nor
1791 public static member functions.
1793 @item -Wnon-virtual-dtor @r{(C++ only)}
1794 @opindex Wnon-virtual-dtor
1795 Warn when a class appears to be polymorphic, thereby requiring a virtual
1796 destructor, yet it declares a non-virtual one.  This warning is also
1797 enabled if -Weffc++ is specified.
1799 @item -Wreorder @r{(C++ only)}
1800 @opindex Wreorder
1801 @cindex reordering, warning
1802 @cindex warning for reordering of member initializers
1803 Warn when the order of member initializers given in the code does not
1804 match the order in which they must be executed.  For instance:
1806 @smallexample
1807 struct A @{
1808   int i;
1809   int j;
1810   A(): j (0), i (1) @{ @}
1812 @end smallexample
1814 The compiler will rearrange the member initializers for @samp{i}
1815 and @samp{j} to match the declaration order of the members, emitting
1816 a warning to that effect.  This warning is enabled by @option{-Wall}.
1817 @end table
1819 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1821 @table @gcctabopt
1822 @item -Weffc++ @r{(C++ only)}
1823 @opindex Weffc++
1824 Warn about violations of the following style guidelines from Scott Meyers'
1825 @cite{Effective C++} book:
1827 @itemize @bullet
1828 @item
1829 Item 11:  Define a copy constructor and an assignment operator for classes
1830 with dynamically allocated memory.
1832 @item
1833 Item 12:  Prefer initialization to assignment in constructors.
1835 @item
1836 Item 14:  Make destructors virtual in base classes.
1838 @item
1839 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1841 @item
1842 Item 23:  Don't try to return a reference when you must return an object.
1844 @end itemize
1846 Also warn about violations of the following style guidelines from
1847 Scott Meyers' @cite{More Effective C++} book:
1849 @itemize @bullet
1850 @item
1851 Item 6:  Distinguish between prefix and postfix forms of increment and
1852 decrement operators.
1854 @item
1855 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1857 @end itemize
1859 When selecting this option, be aware that the standard library
1860 headers do not obey all of these guidelines; use @samp{grep -v}
1861 to filter out those warnings.
1863 @item -Wno-deprecated @r{(C++ only)}
1864 @opindex Wno-deprecated
1865 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1867 @item -Wstrict-null-sentinel @r{(C++ only)}
1868 @opindex Wstrict-null-sentinel
1869 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1870 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1871 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1872 it is guaranteed to of the same size as a pointer.  But this use is
1873 not portable across different compilers.
1875 @item -Wno-non-template-friend @r{(C++ only)}
1876 @opindex Wno-non-template-friend
1877 Disable warnings when non-templatized friend functions are declared
1878 within a template.  Since the advent of explicit template specification
1879 support in G++, if the name of the friend is an unqualified-id (i.e.,
1880 @samp{friend foo(int)}), the C++ language specification demands that the
1881 friend declare or define an ordinary, nontemplate function.  (Section
1882 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1883 could be interpreted as a particular specialization of a templatized
1884 function.  Because this non-conforming behavior is no longer the default
1885 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1886 check existing code for potential trouble spots and is on by default.
1887 This new compiler behavior can be turned off with
1888 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1889 but disables the helpful warning.
1891 @item -Wold-style-cast @r{(C++ only)}
1892 @opindex Wold-style-cast
1893 Warn if an old-style (C-style) cast to a non-void type is used within
1894 a C++ program.  The new-style casts (@samp{dynamic_cast},
1895 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1896 less vulnerable to unintended effects and much easier to search for.
1898 @item -Woverloaded-virtual @r{(C++ only)}
1899 @opindex Woverloaded-virtual
1900 @cindex overloaded virtual fn, warning
1901 @cindex warning for overloaded virtual fn
1902 Warn when a function declaration hides virtual functions from a
1903 base class.  For example, in:
1905 @smallexample
1906 struct A @{
1907   virtual void f();
1910 struct B: public A @{
1911   void f(int);
1913 @end smallexample
1915 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1916 like:
1918 @smallexample
1919 B* b;
1920 b->f();
1921 @end smallexample
1923 will fail to compile.
1925 @item -Wno-pmf-conversions @r{(C++ only)}
1926 @opindex Wno-pmf-conversions
1927 Disable the diagnostic for converting a bound pointer to member function
1928 to a plain pointer.
1930 @item -Wsign-promo @r{(C++ only)}
1931 @opindex Wsign-promo
1932 Warn when overload resolution chooses a promotion from unsigned or
1933 enumerated type to a signed type, over a conversion to an unsigned type of
1934 the same size.  Previous versions of G++ would try to preserve
1935 unsignedness, but the standard mandates the current behavior.
1937 @smallexample
1938 struct A @{
1939   operator int ();
1940   A& operator = (int);
1943 main ()
1945   A a,b;
1946   a = b;
1948 @end smallexample
1950 In this example, G++ will synthesize a default @samp{A& operator =
1951 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1952 @end table
1954 @node Objective-C and Objective-C++ Dialect Options
1955 @section Options Controlling Objective-C and Objective-C++ Dialects
1957 @cindex compiler options, Objective-C and Objective-C++
1958 @cindex Objective-C and Objective-C++ options, command line
1959 @cindex options, Objective-C and Objective-C++
1960 (NOTE: This manual does not describe the Objective-C and Objective-C++
1961 languages themselves.  See @xref{Standards,,Language Standards
1962 Supported by GCC}, for references.)
1964 This section describes the command-line options that are only meaningful
1965 for Objective-C and Objective-C++ programs, but you can also use most of
1966 the language-independent GNU compiler options.
1967 For example, you might compile a file @code{some_class.m} like this:
1969 @smallexample
1970 gcc -g -fgnu-runtime -O -c some_class.m
1971 @end smallexample
1973 @noindent
1974 In this example, @option{-fgnu-runtime} is an option meant only for
1975 Objective-C and Objective-C++ programs; you can use the other options with
1976 any language supported by GCC@.
1978 Note that since Objective-C is an extension of the C language, Objective-C
1979 compilations may also use options specific to the C front-end (e.g.,
1980 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1981 C++-specific options (e.g., @option{-Wabi}).
1983 Here is a list of options that are @emph{only} for compiling Objective-C
1984 and Objective-C++ programs:
1986 @table @gcctabopt
1987 @item -fconstant-string-class=@var{class-name}
1988 @opindex fconstant-string-class
1989 Use @var{class-name} as the name of the class to instantiate for each
1990 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1991 class name is @code{NXConstantString} if the GNU runtime is being used, and
1992 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1993 @option{-fconstant-cfstrings} option, if also present, will override the
1994 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1995 to be laid out as constant CoreFoundation strings.
1997 @item -fgnu-runtime
1998 @opindex fgnu-runtime
1999 Generate object code compatible with the standard GNU Objective-C
2000 runtime.  This is the default for most types of systems.
2002 @item -fnext-runtime
2003 @opindex fnext-runtime
2004 Generate output compatible with the NeXT runtime.  This is the default
2005 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2006 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2007 used.
2009 @item -fno-nil-receivers
2010 @opindex fno-nil-receivers
2011 Assume that all Objective-C message dispatches (e.g.,
2012 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2013 is not @code{nil}.  This allows for more efficient entry points in the runtime
2014 to be used.  Currently, this option is only available in conjunction with
2015 the NeXT runtime on Mac OS X 10.3 and later.
2017 @item -fobjc-call-cxx-cdtors
2018 @opindex fobjc-call-cxx-cdtors
2019 For each Objective-C class, check if any of its instance variables is a
2020 C++ object with a non-trivial default constructor.  If so, synthesize a
2021 special @code{- (id) .cxx_construct} instance method that will run
2022 non-trivial default constructors on any such instance variables, in order,
2023 and then return @code{self}.  Similarly, check if any instance variable
2024 is a C++ object with a non-trivial destructor, and if so, synthesize a
2025 special @code{- (void) .cxx_destruct} method that will run
2026 all such default destructors, in reverse order.
2028 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2029 thusly generated will only operate on instance variables declared in the
2030 current Objective-C class, and not those inherited from superclasses.  It
2031 is the responsibility of the Objective-C runtime to invoke all such methods
2032 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2033 will be invoked by the runtime immediately after a new object
2034 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2035 be invoked immediately before the runtime deallocates an object instance.
2037 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2038 support for invoking the @code{- (id) .cxx_construct} and
2039 @code{- (void) .cxx_destruct} methods.
2041 @item -fobjc-direct-dispatch
2042 @opindex fobjc-direct-dispatch
2043 Allow fast jumps to the message dispatcher.  On Darwin this is
2044 accomplished via the comm page.
2046 @item -fobjc-exceptions
2047 @opindex fobjc-exceptions
2048 Enable syntactic support for structured exception handling in Objective-C,
2049 similar to what is offered by C++ and Java.  This option is
2050 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2051 earlier.
2053 @smallexample
2054   @@try @{
2055     @dots{}
2056        @@throw expr;
2057     @dots{}
2058   @}
2059   @@catch (AnObjCClass *exc) @{
2060     @dots{}
2061       @@throw expr;
2062     @dots{}
2063       @@throw;
2064     @dots{}
2065   @}
2066   @@catch (AnotherClass *exc) @{
2067     @dots{}
2068   @}
2069   @@catch (id allOthers) @{
2070     @dots{}
2071   @}
2072   @@finally @{
2073     @dots{}
2074       @@throw expr;
2075     @dots{}
2076   @}
2077 @end smallexample
2079 The @code{@@throw} statement may appear anywhere in an Objective-C or
2080 Objective-C++ program; when used inside of a @code{@@catch} block, the
2081 @code{@@throw} may appear without an argument (as shown above), in which case
2082 the object caught by the @code{@@catch} will be rethrown.
2084 Note that only (pointers to) Objective-C objects may be thrown and
2085 caught using this scheme.  When an object is thrown, it will be caught
2086 by the nearest @code{@@catch} clause capable of handling objects of that type,
2087 analogously to how @code{catch} blocks work in C++ and Java.  A
2088 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2089 any and all Objective-C exceptions not caught by previous @code{@@catch}
2090 clauses (if any).
2092 The @code{@@finally} clause, if present, will be executed upon exit from the
2093 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2094 regardless of whether any exceptions are thrown, caught or rethrown
2095 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2096 of the @code{finally} clause in Java.
2098 There are several caveats to using the new exception mechanism:
2100 @itemize @bullet
2101 @item
2102 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2103 idioms provided by the @code{NSException} class, the new
2104 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2105 systems, due to additional functionality needed in the (NeXT) Objective-C
2106 runtime.
2108 @item
2109 As mentioned above, the new exceptions do not support handling
2110 types other than Objective-C objects.   Furthermore, when used from
2111 Objective-C++, the Objective-C exception model does not interoperate with C++
2112 exceptions at this time.  This means you cannot @code{@@throw} an exception
2113 from Objective-C and @code{catch} it in C++, or vice versa
2114 (i.e., @code{throw @dots{} @@catch}).
2115 @end itemize
2117 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2118 blocks for thread-safe execution:
2120 @smallexample
2121   @@synchronized (ObjCClass *guard) @{
2122     @dots{}
2123   @}
2124 @end smallexample
2126 Upon entering the @code{@@synchronized} block, a thread of execution shall
2127 first check whether a lock has been placed on the corresponding @code{guard}
2128 object by another thread.  If it has, the current thread shall wait until
2129 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2130 the current thread will place its own lock on it, execute the code contained in
2131 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2132 making @code{guard} available to other threads).
2134 Unlike Java, Objective-C does not allow for entire methods to be marked
2135 @code{@@synchronized}.  Note that throwing exceptions out of
2136 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2137 to be unlocked properly.
2139 @item -fobjc-gc
2140 @opindex fobjc-gc
2141 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2143 @item -freplace-objc-classes
2144 @opindex freplace-objc-classes
2145 Emit a special marker instructing @command{ld(1)} not to statically link in
2146 the resulting object file, and allow @command{dyld(1)} to load it in at
2147 run time instead.  This is used in conjunction with the Fix-and-Continue
2148 debugging mode, where the object file in question may be recompiled and
2149 dynamically reloaded in the course of program execution, without the need
2150 to restart the program itself.  Currently, Fix-and-Continue functionality
2151 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2152 and later.
2154 @item -fzero-link
2155 @opindex fzero-link
2156 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2157 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2158 compile time) with static class references that get initialized at load time,
2159 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2160 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2161 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2162 for individual class implementations to be modified during program execution.
2164 @item -gen-decls
2165 @opindex gen-decls
2166 Dump interface declarations for all classes seen in the source file to a
2167 file named @file{@var{sourcename}.decl}.
2169 @item -Wassign-intercept
2170 @opindex Wassign-intercept
2171 Warn whenever an Objective-C assignment is being intercepted by the
2172 garbage collector.
2174 @item -Wno-protocol
2175 @opindex Wno-protocol
2176 If a class is declared to implement a protocol, a warning is issued for
2177 every method in the protocol that is not implemented by the class.  The
2178 default behavior is to issue a warning for every method not explicitly
2179 implemented in the class, even if a method implementation is inherited
2180 from the superclass.  If you use the @option{-Wno-protocol} option, then
2181 methods inherited from the superclass are considered to be implemented,
2182 and no warning is issued for them.
2184 @item -Wselector
2185 @opindex Wselector
2186 Warn if multiple methods of different types for the same selector are
2187 found during compilation.  The check is performed on the list of methods
2188 in the final stage of compilation.  Additionally, a check is performed
2189 for each selector appearing in a @code{@@selector(@dots{})}
2190 expression, and a corresponding method for that selector has been found
2191 during compilation.  Because these checks scan the method table only at
2192 the end of compilation, these warnings are not produced if the final
2193 stage of compilation is not reached, for example because an error is
2194 found during compilation, or because the @option{-fsyntax-only} option is
2195 being used.
2197 @item -Wstrict-selector-match
2198 @opindex Wstrict-selector-match
2199 Warn if multiple methods with differing argument and/or return types are
2200 found for a given selector when attempting to send a message using this
2201 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2202 is off (which is the default behavior), the compiler will omit such warnings
2203 if any differences found are confined to types which share the same size
2204 and alignment.
2206 @item -Wundeclared-selector
2207 @opindex Wundeclared-selector
2208 Warn if a @code{@@selector(@dots{})} expression referring to an
2209 undeclared selector is found.  A selector is considered undeclared if no
2210 method with that name has been declared before the
2211 @code{@@selector(@dots{})} expression, either explicitly in an
2212 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2213 an @code{@@implementation} section.  This option always performs its
2214 checks as soon as a @code{@@selector(@dots{})} expression is found,
2215 while @option{-Wselector} only performs its checks in the final stage of
2216 compilation.  This also enforces the coding style convention
2217 that methods and selectors must be declared before being used.
2219 @item -print-objc-runtime-info
2220 @opindex print-objc-runtime-info
2221 Generate C header describing the largest structure that is passed by
2222 value, if any.
2224 @end table
2226 @node Language Independent Options
2227 @section Options to Control Diagnostic Messages Formatting
2228 @cindex options to control diagnostics formatting
2229 @cindex diagnostic messages
2230 @cindex message formatting
2232 Traditionally, diagnostic messages have been formatted irrespective of
2233 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2234 below can be used to control the diagnostic messages formatting
2235 algorithm, e.g.@: how many characters per line, how often source location
2236 information should be reported.  Right now, only the C++ front end can
2237 honor these options.  However it is expected, in the near future, that
2238 the remaining front ends would be able to digest them correctly.
2240 @table @gcctabopt
2241 @item -fmessage-length=@var{n}
2242 @opindex fmessage-length
2243 Try to format error messages so that they fit on lines of about @var{n}
2244 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2245 the front ends supported by GCC@.  If @var{n} is zero, then no
2246 line-wrapping will be done; each error message will appear on a single
2247 line.
2249 @opindex fdiagnostics-show-location
2250 @item -fdiagnostics-show-location=once
2251 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2252 reporter to emit @emph{once} source location information; that is, in
2253 case the message is too long to fit on a single physical line and has to
2254 be wrapped, the source location won't be emitted (as prefix) again,
2255 over and over, in subsequent continuation lines.  This is the default
2256 behavior.
2258 @item -fdiagnostics-show-location=every-line
2259 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2260 messages reporter to emit the same source location information (as
2261 prefix) for physical lines that result from the process of breaking
2262 a message which is too long to fit on a single line.
2264 @item -fdiagnostics-show-option
2265 @opindex fdiagnostics-show-option
2266 This option instructs the diagnostic machinery to add text to each
2267 diagnostic emitted, which indicates which command line option directly
2268 controls that diagnostic, when such an option is known to the
2269 diagnostic machinery.
2271 @end table
2273 @node Warning Options
2274 @section Options to Request or Suppress Warnings
2275 @cindex options to control warnings
2276 @cindex warning messages
2277 @cindex messages, warning
2278 @cindex suppressing warnings
2280 Warnings are diagnostic messages that report constructions which
2281 are not inherently erroneous but which are risky or suggest there
2282 may have been an error.
2284 You can request many specific warnings with options beginning @samp{-W},
2285 for example @option{-Wimplicit} to request warnings on implicit
2286 declarations.  Each of these specific warning options also has a
2287 negative form beginning @samp{-Wno-} to turn off warnings;
2288 for example, @option{-Wno-implicit}.  This manual lists only one of the
2289 two forms, whichever is not the default.
2291 The following options control the amount and kinds of warnings produced
2292 by GCC; for further, language-specific options also refer to
2293 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2294 Options}.
2296 @table @gcctabopt
2297 @cindex syntax checking
2298 @item -fsyntax-only
2299 @opindex fsyntax-only
2300 Check the code for syntax errors, but don't do anything beyond that.
2302 @item -pedantic
2303 @opindex pedantic
2304 Issue all the warnings demanded by strict ISO C and ISO C++;
2305 reject all programs that use forbidden extensions, and some other
2306 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2307 version of the ISO C standard specified by any @option{-std} option used.
2309 Valid ISO C and ISO C++ programs should compile properly with or without
2310 this option (though a rare few will require @option{-ansi} or a
2311 @option{-std} option specifying the required version of ISO C)@.  However,
2312 without this option, certain GNU extensions and traditional C and C++
2313 features are supported as well.  With this option, they are rejected.
2315 @option{-pedantic} does not cause warning messages for use of the
2316 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2317 warnings are also disabled in the expression that follows
2318 @code{__extension__}.  However, only system header files should use
2319 these escape routes; application programs should avoid them.
2320 @xref{Alternate Keywords}.
2322 Some users try to use @option{-pedantic} to check programs for strict ISO
2323 C conformance.  They soon find that it does not do quite what they want:
2324 it finds some non-ISO practices, but not all---only those for which
2325 ISO C @emph{requires} a diagnostic, and some others for which
2326 diagnostics have been added.
2328 A feature to report any failure to conform to ISO C might be useful in
2329 some instances, but would require considerable additional work and would
2330 be quite different from @option{-pedantic}.  We don't have plans to
2331 support such a feature in the near future.
2333 Where the standard specified with @option{-std} represents a GNU
2334 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2335 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2336 extended dialect is based.  Warnings from @option{-pedantic} are given
2337 where they are required by the base standard.  (It would not make sense
2338 for such warnings to be given only for features not in the specified GNU
2339 C dialect, since by definition the GNU dialects of C include all
2340 features the compiler supports with the given option, and there would be
2341 nothing to warn about.)
2343 @item -pedantic-errors
2344 @opindex pedantic-errors
2345 Like @option{-pedantic}, except that errors are produced rather than
2346 warnings.
2348 @item -w
2349 @opindex w
2350 Inhibit all warning messages.
2352 @item -Wno-import
2353 @opindex Wno-import
2354 Inhibit warning messages about the use of @samp{#import}.
2356 @item -Wchar-subscripts
2357 @opindex Wchar-subscripts
2358 Warn if an array subscript has type @code{char}.  This is a common cause
2359 of error, as programmers often forget that this type is signed on some
2360 machines.
2361 This warning is enabled by @option{-Wall}.
2363 @item -Wcomment
2364 @opindex Wcomment
2365 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2366 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2367 This warning is enabled by @option{-Wall}.
2369 @item -Wfatal-errors
2370 @opindex Wfatal-errors
2371 This option causes the compiler to abort compilation on the first error
2372 occurred rather than trying to keep going and printing further error
2373 messages.
2375 @item -Wformat
2376 @opindex Wformat
2377 @opindex ffreestanding
2378 @opindex fno-builtin
2379 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2380 the arguments supplied have types appropriate to the format string
2381 specified, and that the conversions specified in the format string make
2382 sense.  This includes standard functions, and others specified by format
2383 attributes (@pxref{Function Attributes}), in the @code{printf},
2384 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2385 not in the C standard) families (or other target-specific families).
2386 Which functions are checked without format attributes having been
2387 specified depends on the standard version selected, and such checks of
2388 functions without the attribute specified are disabled by
2389 @option{-ffreestanding} or @option{-fno-builtin}.
2391 The formats are checked against the format features supported by GNU
2392 libc version 2.2.  These include all ISO C90 and C99 features, as well
2393 as features from the Single Unix Specification and some BSD and GNU
2394 extensions.  Other library implementations may not support all these
2395 features; GCC does not support warning about features that go beyond a
2396 particular library's limitations.  However, if @option{-pedantic} is used
2397 with @option{-Wformat}, warnings will be given about format features not
2398 in the selected standard version (but not for @code{strfmon} formats,
2399 since those are not in any version of the C standard).  @xref{C Dialect
2400 Options,,Options Controlling C Dialect}.
2402 Since @option{-Wformat} also checks for null format arguments for
2403 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2405 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2406 aspects of format checking, the options @option{-Wformat-y2k},
2407 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2408 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2409 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2411 @item -Wformat-y2k
2412 @opindex Wformat-y2k
2413 If @option{-Wformat} is specified, also warn about @code{strftime}
2414 formats which may yield only a two-digit year.
2416 @item -Wno-format-extra-args
2417 @opindex Wno-format-extra-args
2418 If @option{-Wformat} is specified, do not warn about excess arguments to a
2419 @code{printf} or @code{scanf} format function.  The C standard specifies
2420 that such arguments are ignored.
2422 Where the unused arguments lie between used arguments that are
2423 specified with @samp{$} operand number specifications, normally
2424 warnings are still given, since the implementation could not know what
2425 type to pass to @code{va_arg} to skip the unused arguments.  However,
2426 in the case of @code{scanf} formats, this option will suppress the
2427 warning if the unused arguments are all pointers, since the Single
2428 Unix Specification says that such unused arguments are allowed.
2430 @item -Wno-format-zero-length
2431 @opindex Wno-format-zero-length
2432 If @option{-Wformat} is specified, do not warn about zero-length formats.
2433 The C standard specifies that zero-length formats are allowed.
2435 @item -Wformat-nonliteral
2436 @opindex Wformat-nonliteral
2437 If @option{-Wformat} is specified, also warn if the format string is not a
2438 string literal and so cannot be checked, unless the format function
2439 takes its format arguments as a @code{va_list}.
2441 @item -Wformat-security
2442 @opindex Wformat-security
2443 If @option{-Wformat} is specified, also warn about uses of format
2444 functions that represent possible security problems.  At present, this
2445 warns about calls to @code{printf} and @code{scanf} functions where the
2446 format string is not a string literal and there are no format arguments,
2447 as in @code{printf (foo);}.  This may be a security hole if the format
2448 string came from untrusted input and contains @samp{%n}.  (This is
2449 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2450 in future warnings may be added to @option{-Wformat-security} that are not
2451 included in @option{-Wformat-nonliteral}.)
2453 @item -Wformat=2
2454 @opindex Wformat=2
2455 Enable @option{-Wformat} plus format checks not included in
2456 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2457 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2459 @item -Wnonnull
2460 @opindex Wnonnull
2461 Warn about passing a null pointer for arguments marked as
2462 requiring a non-null value by the @code{nonnull} function attribute.
2464 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2465 can be disabled with the @option{-Wno-nonnull} option.
2467 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2468 @opindex Winit-self
2469 Warn about uninitialized variables which are initialized with themselves.
2470 Note this option can only be used with the @option{-Wuninitialized} option,
2471 which in turn only works with @option{-O1} and above.
2473 For example, GCC will warn about @code{i} being uninitialized in the
2474 following snippet only when @option{-Winit-self} has been specified:
2475 @smallexample
2476 @group
2477 int f()
2479   int i = i;
2480   return i;
2482 @end group
2483 @end smallexample
2485 @item -Wimplicit-int
2486 @opindex Wimplicit-int
2487 Warn when a declaration does not specify a type.
2488 This warning is enabled by @option{-Wall}.
2490 @item -Wimplicit-function-declaration
2491 @itemx -Werror-implicit-function-declaration
2492 @opindex Wimplicit-function-declaration
2493 @opindex Werror-implicit-function-declaration
2494 Give a warning (or error) whenever a function is used before being
2495 declared.  The form @option{-Wno-error-implicit-function-declaration}
2496 is not supported.
2497 This warning is enabled by @option{-Wall} (as a warning, not an error).
2499 @item -Wimplicit
2500 @opindex Wimplicit
2501 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2502 This warning is enabled by @option{-Wall}.
2504 @item -Wmain
2505 @opindex Wmain
2506 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2507 function with external linkage, returning int, taking either zero
2508 arguments, two, or three arguments of appropriate types.
2509 This warning is enabled by @option{-Wall}.
2511 @item -Wmissing-braces
2512 @opindex Wmissing-braces
2513 Warn if an aggregate or union initializer is not fully bracketed.  In
2514 the following example, the initializer for @samp{a} is not fully
2515 bracketed, but that for @samp{b} is fully bracketed.
2517 @smallexample
2518 int a[2][2] = @{ 0, 1, 2, 3 @};
2519 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2520 @end smallexample
2522 This warning is enabled by @option{-Wall}.
2524 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2525 @opindex Wmissing-include-dirs
2526 Warn if a user-supplied include directory does not exist.
2528 @item -Wparentheses
2529 @opindex Wparentheses
2530 Warn if parentheses are omitted in certain contexts, such
2531 as when there is an assignment in a context where a truth value
2532 is expected, or when operators are nested whose precedence people
2533 often get confused about.  Only the warning for an assignment used as
2534 a truth value is supported when compiling C++; the other warnings are
2535 only supported when compiling C@.
2537 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2538 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2539 interpretation from that of ordinary mathematical notation.
2541 Also warn about constructions where there may be confusion to which
2542 @code{if} statement an @code{else} branch belongs.  Here is an example of
2543 such a case:
2545 @smallexample
2546 @group
2548   if (a)
2549     if (b)
2550       foo ();
2551   else
2552     bar ();
2554 @end group
2555 @end smallexample
2557 In C, every @code{else} branch belongs to the innermost possible @code{if}
2558 statement, which in this example is @code{if (b)}.  This is often not
2559 what the programmer expected, as illustrated in the above example by
2560 indentation the programmer chose.  When there is the potential for this
2561 confusion, GCC will issue a warning when this flag is specified.
2562 To eliminate the warning, add explicit braces around the innermost
2563 @code{if} statement so there is no way the @code{else} could belong to
2564 the enclosing @code{if}.  The resulting code would look like this:
2566 @smallexample
2567 @group
2569   if (a)
2570     @{
2571       if (b)
2572         foo ();
2573       else
2574         bar ();
2575     @}
2577 @end group
2578 @end smallexample
2580 This warning is enabled by @option{-Wall}.
2582 @item -Wsequence-point
2583 @opindex Wsequence-point
2584 Warn about code that may have undefined semantics because of violations
2585 of sequence point rules in the C and C++ standards.
2587 The C and C++ standards defines the order in which expressions in a C/C++
2588 program are evaluated in terms of @dfn{sequence points}, which represent
2589 a partial ordering between the execution of parts of the program: those
2590 executed before the sequence point, and those executed after it.  These
2591 occur after the evaluation of a full expression (one which is not part
2592 of a larger expression), after the evaluation of the first operand of a
2593 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2594 function is called (but after the evaluation of its arguments and the
2595 expression denoting the called function), and in certain other places.
2596 Other than as expressed by the sequence point rules, the order of
2597 evaluation of subexpressions of an expression is not specified.  All
2598 these rules describe only a partial order rather than a total order,
2599 since, for example, if two functions are called within one expression
2600 with no sequence point between them, the order in which the functions
2601 are called is not specified.  However, the standards committee have
2602 ruled that function calls do not overlap.
2604 It is not specified when between sequence points modifications to the
2605 values of objects take effect.  Programs whose behavior depends on this
2606 have undefined behavior; the C and C++ standards specify that ``Between
2607 the previous and next sequence point an object shall have its stored
2608 value modified at most once by the evaluation of an expression.  
2609 Furthermore, the prior value shall be read only to determine the value
2610 to be stored.''.  If a program breaks these rules, the results on any
2611 particular implementation are entirely unpredictable.
2613 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2614 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2615 diagnosed by this option, and it may give an occasional false positive
2616 result, but in general it has been found fairly effective at detecting
2617 this sort of problem in programs.
2619 The standard is worded confusingly, therefore there is some debate
2620 over the precise meaning of the sequence point rules in subtle cases.
2621 Links to discussions of the problem, including proposed formal
2622 definitions, may be found on the GCC readings page, at
2623 @w{@uref{http://gcc.gnu.org/readings.html}}.
2625 This warning is enabled by @option{-Wall} for C and C++.
2627 @item -Wreturn-type
2628 @opindex Wreturn-type
2629 Warn whenever a function is defined with a return-type that defaults to
2630 @code{int}.  Also warn about any @code{return} statement with no
2631 return-value in a function whose return-type is not @code{void}.
2633 For C, also warn if the return type of a function has a type qualifier
2634 such as @code{const}.  Such a type qualifier has no effect, since the
2635 value returned by a function is not an lvalue.  ISO C prohibits
2636 qualified @code{void} return types on function definitions, so such
2637 return types always receive a warning even without this option.
2639 For C++, a function without return type always produces a diagnostic
2640 message, even when @option{-Wno-return-type} is specified.  The only
2641 exceptions are @samp{main} and functions defined in system headers.
2643 This warning is enabled by @option{-Wall}.
2645 @item -Wswitch
2646 @opindex Wswitch
2647 Warn whenever a @code{switch} statement has an index of enumerated type
2648 and lacks a @code{case} for one or more of the named codes of that
2649 enumeration.  (The presence of a @code{default} label prevents this
2650 warning.)  @code{case} labels outside the enumeration range also
2651 provoke warnings when this option is used.
2652 This warning is enabled by @option{-Wall}.
2654 @item -Wswitch-default
2655 @opindex Wswitch-switch
2656 Warn whenever a @code{switch} statement does not have a @code{default}
2657 case.
2659 @item -Wswitch-enum
2660 @opindex Wswitch-enum
2661 Warn whenever a @code{switch} statement has an index of enumerated type
2662 and lacks a @code{case} for one or more of the named codes of that
2663 enumeration.  @code{case} labels outside the enumeration range also
2664 provoke warnings when this option is used.
2666 @item -Wtrigraphs
2667 @opindex Wtrigraphs
2668 Warn if any trigraphs are encountered that might change the meaning of
2669 the program (trigraphs within comments are not warned about).
2670 This warning is enabled by @option{-Wall}.
2672 @item -Wunused-function
2673 @opindex Wunused-function
2674 Warn whenever a static function is declared but not defined or a
2675 non-inline static function is unused.
2676 This warning is enabled by @option{-Wall}.
2678 @item -Wunused-label
2679 @opindex Wunused-label
2680 Warn whenever a label is declared but not used.
2681 This warning is enabled by @option{-Wall}.
2683 To suppress this warning use the @samp{unused} attribute
2684 (@pxref{Variable Attributes}).
2686 @item -Wunused-parameter
2687 @opindex Wunused-parameter
2688 Warn whenever a function parameter is unused aside from its declaration.
2690 To suppress this warning use the @samp{unused} attribute
2691 (@pxref{Variable Attributes}).
2693 @item -Wunused-variable
2694 @opindex Wunused-variable
2695 Warn whenever a local variable or non-constant static variable is unused
2696 aside from its declaration.
2697 This warning is enabled by @option{-Wall}.
2699 To suppress this warning use the @samp{unused} attribute
2700 (@pxref{Variable Attributes}).
2702 @item -Wunused-value
2703 @opindex Wunused-value
2704 Warn whenever a statement computes a result that is explicitly not used.
2705 This warning is enabled by @option{-Wall}.
2707 To suppress this warning cast the expression to @samp{void}.
2709 @item -Wunused
2710 @opindex Wunused
2711 All the above @option{-Wunused} options combined.
2713 In order to get a warning about an unused function parameter, you must
2714 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2715 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2717 @item -Wuninitialized
2718 @opindex Wuninitialized
2719 Warn if an automatic variable is used without first being initialized or
2720 if a variable may be clobbered by a @code{setjmp} call.
2722 These warnings are possible only in optimizing compilation,
2723 because they require data flow information that is computed only
2724 when optimizing.  If you do not specify @option{-O}, you will not get 
2725 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2726 requiring @option{-O}.
2728 If you want to warn about code which uses the uninitialized value of the
2729 variable in its own initializer, use the @option{-Winit-self} option.
2731 These warnings occur for individual uninitialized or clobbered
2732 elements of structure, union or array variables as well as for
2733 variables which are uninitialized or clobbered as a whole.  They do
2734 not occur for variables or elements declared @code{volatile}.  Because
2735 these warnings depend on optimization, the exact variables or elements
2736 for which there are warnings will depend on the precise optimization
2737 options and version of GCC used.
2739 Note that there may be no warning about a variable that is used only
2740 to compute a value that itself is never used, because such
2741 computations may be deleted by data flow analysis before the warnings
2742 are printed.
2744 These warnings are made optional because GCC is not smart
2745 enough to see all the reasons why the code might be correct
2746 despite appearing to have an error.  Here is one example of how
2747 this can happen:
2749 @smallexample
2750 @group
2752   int x;
2753   switch (y)
2754     @{
2755     case 1: x = 1;
2756       break;
2757     case 2: x = 4;
2758       break;
2759     case 3: x = 5;
2760     @}
2761   foo (x);
2763 @end group
2764 @end smallexample
2766 @noindent
2767 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2768 always initialized, but GCC doesn't know this.  Here is
2769 another common case:
2771 @smallexample
2773   int save_y;
2774   if (change_y) save_y = y, y = new_y;
2775   @dots{}
2776   if (change_y) y = save_y;
2778 @end smallexample
2780 @noindent
2781 This has no bug because @code{save_y} is used only if it is set.
2783 @cindex @code{longjmp} warnings
2784 This option also warns when a non-volatile automatic variable might be
2785 changed by a call to @code{longjmp}.  These warnings as well are possible
2786 only in optimizing compilation.
2788 The compiler sees only the calls to @code{setjmp}.  It cannot know
2789 where @code{longjmp} will be called; in fact, a signal handler could
2790 call it at any point in the code.  As a result, you may get a warning
2791 even when there is in fact no problem because @code{longjmp} cannot
2792 in fact be called at the place which would cause a problem.
2794 Some spurious warnings can be avoided if you declare all the functions
2795 you use that never return as @code{noreturn}.  @xref{Function
2796 Attributes}.
2798 This warning is enabled by @option{-Wall}.
2800 @item -Wunknown-pragmas
2801 @opindex Wunknown-pragmas
2802 @cindex warning for unknown pragmas
2803 @cindex unknown pragmas, warning
2804 @cindex pragmas, warning of unknown
2805 Warn when a #pragma directive is encountered which is not understood by
2806 GCC@.  If this command line option is used, warnings will even be issued
2807 for unknown pragmas in system header files.  This is not the case if
2808 the warnings were only enabled by the @option{-Wall} command line option.
2810 @item -Wno-pragmas
2811 @opindex Wno-pragmas
2812 @opindex Wpragmas
2813 Do not warn about misuses of pragmas, such as incorrect parameters,
2814 invalid syntax, or conflicts between pragmas.  See also
2815 @samp{-Wunknown-pragmas}.
2817 @item -Wstrict-aliasing
2818 @opindex Wstrict-aliasing
2819 This option is only active when @option{-fstrict-aliasing} is active.
2820 It warns about code which might break the strict aliasing rules that the
2821 compiler is using for optimization.  The warning does not catch all
2822 cases, but does attempt to catch the more common pitfalls.  It is
2823 included in @option{-Wall}.
2825 @item -Wstrict-aliasing=2
2826 @opindex Wstrict-aliasing=2
2827 This option is only active when @option{-fstrict-aliasing} is active.
2828 It warns about code which might break the strict aliasing rules that the
2829 compiler is using for optimization.  This warning catches more cases than
2830 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2831 cases that are safe.
2833 @item -Wall
2834 @opindex Wall
2835 All of the above @samp{-W} options combined.  This enables all the
2836 warnings about constructions that some users consider questionable, and
2837 that are easy to avoid (or modify to prevent the warning), even in
2838 conjunction with macros.  This also enables some language-specific
2839 warnings described in @ref{C++ Dialect Options} and
2840 @ref{Objective-C and Objective-C++ Dialect Options}.
2841 @end table
2843 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2844 Some of them warn about constructions that users generally do not
2845 consider questionable, but which occasionally you might wish to check
2846 for; others warn about constructions that are necessary or hard to avoid
2847 in some cases, and there is no simple way to modify the code to suppress
2848 the warning.
2850 @table @gcctabopt
2851 @item -Wextra
2852 @opindex W
2853 @opindex Wextra
2854 (This option used to be called @option{-W}.  The older name is still
2855 supported, but the newer name is more descriptive.)  Print extra warning
2856 messages for these events:
2858 @itemize @bullet
2859 @item
2860 A function can return either with or without a value.  (Falling
2861 off the end of the function body is considered returning without
2862 a value.)  For example, this function would evoke such a
2863 warning:
2865 @smallexample
2866 @group
2867 foo (a)
2869   if (a > 0)
2870     return a;
2872 @end group
2873 @end smallexample
2875 @item
2876 An expression-statement or the left-hand side of a comma expression
2877 contains no side effects.
2878 To suppress the warning, cast the unused expression to void.
2879 For example, an expression such as @samp{x[i,j]} will cause a warning,
2880 but @samp{x[(void)i,j]} will not.
2882 @item
2883 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2885 @item
2886 Storage-class specifiers like @code{static} are not the first things in
2887 a declaration.  According to the C Standard, this usage is obsolescent.
2889 @item
2890 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2891 arguments.
2893 @item
2894 A comparison between signed and unsigned values could produce an
2895 incorrect result when the signed value is converted to unsigned.
2896 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2898 @item
2899 An aggregate has an initializer which does not initialize all members.
2900 This warning can be independently controlled by
2901 @option{-Wmissing-field-initializers}.
2903 @item
2904 An initialized field without side effects is overridden when using
2905 designated initializers (@pxref{Designated Inits, , Designated
2906 Initializers}).  This warning can be independently controlled by
2907 @option{-Woverride-init}.
2909 @item
2910 A function parameter is declared without a type specifier in K&R-style
2911 functions:
2913 @smallexample
2914 void foo(bar) @{ @}
2915 @end smallexample
2917 @item
2918 An empty body occurs in an @samp{if} or @samp{else} statement.
2920 @item
2921 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2922 @samp{>}, or @samp{>=}.
2924 @item
2925 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2927 @item
2928 Any of several floating-point events that often indicate errors, such as
2929 overflow, underflow, loss of precision, etc.
2931 @item @r{(C++ only)}
2932 An enumerator and a non-enumerator both appear in a conditional expression.
2934 @item @r{(C++ only)}
2935 A non-static reference or non-static @samp{const} member appears in a
2936 class without constructors.
2938 @item @r{(C++ only)}
2939 Ambiguous virtual bases.
2941 @item @r{(C++ only)}
2942 Subscripting an array which has been declared @samp{register}.
2944 @item @r{(C++ only)}
2945 Taking the address of a variable which has been declared @samp{register}.
2947 @item @r{(C++ only)}
2948 A base class is not initialized in a derived class' copy constructor.
2949 @end itemize
2951 @item -Wno-div-by-zero
2952 @opindex Wno-div-by-zero
2953 @opindex Wdiv-by-zero
2954 Do not warn about compile-time integer division by zero.  Floating point
2955 division by zero is not warned about, as it can be a legitimate way of
2956 obtaining infinities and NaNs.
2958 @item -Wsystem-headers
2959 @opindex Wsystem-headers
2960 @cindex warnings from system headers
2961 @cindex system headers, warnings from
2962 Print warning messages for constructs found in system header files.
2963 Warnings from system headers are normally suppressed, on the assumption
2964 that they usually do not indicate real problems and would only make the
2965 compiler output harder to read.  Using this command line option tells
2966 GCC to emit warnings from system headers as if they occurred in user
2967 code.  However, note that using @option{-Wall} in conjunction with this
2968 option will @emph{not} warn about unknown pragmas in system
2969 headers---for that, @option{-Wunknown-pragmas} must also be used.
2971 @item -Wfloat-equal
2972 @opindex Wfloat-equal
2973 Warn if floating point values are used in equality comparisons.
2975 The idea behind this is that sometimes it is convenient (for the
2976 programmer) to consider floating-point values as approximations to
2977 infinitely precise real numbers.  If you are doing this, then you need
2978 to compute (by analyzing the code, or in some other way) the maximum or
2979 likely maximum error that the computation introduces, and allow for it
2980 when performing comparisons (and when producing output, but that's a
2981 different problem).  In particular, instead of testing for equality, you
2982 would check to see whether the two values have ranges that overlap; and
2983 this is done with the relational operators, so equality comparisons are
2984 probably mistaken.
2986 @item -Wtraditional @r{(C only)}
2987 @opindex Wtraditional
2988 Warn about certain constructs that behave differently in traditional and
2989 ISO C@.  Also warn about ISO C constructs that have no traditional C
2990 equivalent, and/or problematic constructs which should be avoided.
2992 @itemize @bullet
2993 @item
2994 Macro parameters that appear within string literals in the macro body.
2995 In traditional C macro replacement takes place within string literals,
2996 but does not in ISO C@.
2998 @item
2999 In traditional C, some preprocessor directives did not exist.
3000 Traditional preprocessors would only consider a line to be a directive
3001 if the @samp{#} appeared in column 1 on the line.  Therefore
3002 @option{-Wtraditional} warns about directives that traditional C
3003 understands but would ignore because the @samp{#} does not appear as the
3004 first character on the line.  It also suggests you hide directives like
3005 @samp{#pragma} not understood by traditional C by indenting them.  Some
3006 traditional implementations would not recognize @samp{#elif}, so it
3007 suggests avoiding it altogether.
3009 @item
3010 A function-like macro that appears without arguments.
3012 @item
3013 The unary plus operator.
3015 @item
3016 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3017 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3018 constants.)  Note, these suffixes appear in macros defined in the system
3019 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3020 Use of these macros in user code might normally lead to spurious
3021 warnings, however GCC's integrated preprocessor has enough context to
3022 avoid warning in these cases.
3024 @item
3025 A function declared external in one block and then used after the end of
3026 the block.
3028 @item
3029 A @code{switch} statement has an operand of type @code{long}.
3031 @item
3032 A non-@code{static} function declaration follows a @code{static} one.
3033 This construct is not accepted by some traditional C compilers.
3035 @item
3036 The ISO type of an integer constant has a different width or
3037 signedness from its traditional type.  This warning is only issued if
3038 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3039 typically represent bit patterns, are not warned about.
3041 @item
3042 Usage of ISO string concatenation is detected.
3044 @item
3045 Initialization of automatic aggregates.
3047 @item
3048 Identifier conflicts with labels.  Traditional C lacks a separate
3049 namespace for labels.
3051 @item
3052 Initialization of unions.  If the initializer is zero, the warning is
3053 omitted.  This is done under the assumption that the zero initializer in
3054 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3055 initializer warnings and relies on default initialization to zero in the
3056 traditional C case.
3058 @item
3059 Conversions by prototypes between fixed/floating point values and vice
3060 versa.  The absence of these prototypes when compiling with traditional
3061 C would cause serious problems.  This is a subset of the possible
3062 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3064 @item
3065 Use of ISO C style function definitions.  This warning intentionally is
3066 @emph{not} issued for prototype declarations or variadic functions
3067 because these ISO C features will appear in your code when using
3068 libiberty's traditional C compatibility macros, @code{PARAMS} and
3069 @code{VPARAMS}.  This warning is also bypassed for nested functions
3070 because that feature is already a GCC extension and thus not relevant to
3071 traditional C compatibility.
3072 @end itemize
3074 @item -Wtraditional-conversion @r{(C only)}
3075 @opindex Wtraditional-conversion
3076 Warn if a prototype causes a type conversion that is different from what
3077 would happen to the same argument in the absence of a prototype.  This
3078 includes conversions of fixed point to floating and vice versa, and
3079 conversions changing the width or signedness of a fixed point argument
3080 except when the same as the default promotion.
3082 @item -Wdeclaration-after-statement @r{(C only)}
3083 @opindex Wdeclaration-after-statement
3084 Warn when a declaration is found after a statement in a block.  This
3085 construct, known from C++, was introduced with ISO C99 and is by default
3086 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3087 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3089 @item -Wundef
3090 @opindex Wundef
3091 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3093 @item -Wno-endif-labels
3094 @opindex Wno-endif-labels
3095 @opindex Wendif-labels
3096 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3098 @item -Wshadow
3099 @opindex Wshadow
3100 Warn whenever a local variable shadows another local variable, parameter or
3101 global variable or whenever a built-in function is shadowed.
3103 @item -Wlarger-than-@var{len}
3104 @opindex Wlarger-than
3105 Warn whenever an object of larger than @var{len} bytes is defined.
3107 @item -Wunsafe-loop-optimizations
3108 @opindex Wunsafe-loop-optimizations
3109 Warn if the loop cannot be optimized because the compiler could not
3110 assume anything on the bounds of the loop indices.  With
3111 @option{-funsafe-loop-optimizations} warn if the compiler made
3112 such assumptions.
3114 @item -Wpointer-arith
3115 @opindex Wpointer-arith
3116 Warn about anything that depends on the ``size of'' a function type or
3117 of @code{void}.  GNU C assigns these types a size of 1, for
3118 convenience in calculations with @code{void *} pointers and pointers
3119 to functions.
3121 @item -Wbad-function-cast @r{(C only)}
3122 @opindex Wbad-function-cast
3123 Warn whenever a function call is cast to a non-matching type.
3124 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3126 @item -Wc++-compat
3127 Warn about ISO C constructs that are outside of the common subset of
3128 ISO C and ISO C++, e.g.@: request for implicit conversion from
3129 @code{void *} to a pointer to non-@code{void} type.
3131 @item -Wcast-qual
3132 @opindex Wcast-qual
3133 Warn whenever a pointer is cast so as to remove a type qualifier from
3134 the target type.  For example, warn if a @code{const char *} is cast
3135 to an ordinary @code{char *}.
3137 @item -Wcast-align
3138 @opindex Wcast-align
3139 Warn whenever a pointer is cast such that the required alignment of the
3140 target is increased.  For example, warn if a @code{char *} is cast to
3141 an @code{int *} on machines where integers can only be accessed at
3142 two- or four-byte boundaries.
3144 @item -Wwrite-strings
3145 @opindex Wwrite-strings
3146 When compiling C, give string constants the type @code{const
3147 char[@var{length}]} so that
3148 copying the address of one into a non-@code{const} @code{char *}
3149 pointer will get a warning; when compiling C++, warn about the
3150 deprecated conversion from string literals to @code{char *}.  This
3151 warning, by default, is enabled for C++ programs.
3152 These warnings will help you find at
3153 compile time code that can try to write into a string constant, but
3154 only if you have been very careful about using @code{const} in
3155 declarations and prototypes.  Otherwise, it will just be a nuisance;
3156 this is why we did not make @option{-Wall} request these warnings.
3158 @item -Wconversion
3159 @opindex Wconversion
3160 Warn for implicit conversions that may alter a value. This includes
3161 conversions between real and integer, like @code{abs (x)} when
3162 @code{x} is @code{double}; conversions between signed and unsigned,
3163 like @code{unsigned ui = -1}; and conversions to smaller types, like
3164 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3165 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3166 changed by the conversion like in @code{abs (2.0)}.
3168 @item -Wsign-compare
3169 @opindex Wsign-compare
3170 @cindex warning for comparison of signed and unsigned values
3171 @cindex comparison of signed and unsigned values, warning
3172 @cindex signed and unsigned values, comparison warning
3173 Warn when a comparison between signed and unsigned values could produce
3174 an incorrect result when the signed value is converted to unsigned.
3175 This warning is also enabled by @option{-Wextra}; to get the other warnings
3176 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3178 @item -Waggregate-return
3179 @opindex Waggregate-return
3180 Warn if any functions that return structures or unions are defined or
3181 called.  (In languages where you can return an array, this also elicits
3182 a warning.)
3184 @item -Walways-true
3185 @opindex Walways-true
3186 Warn about comparisons which are always true such as testing if
3187 unsigned values are greater than or equal to zero.  This warning is
3188 enabled by @option{-Wall}.
3190 @item -Wno-attributes
3191 @opindex Wno-attributes
3192 @opindex Wattributes
3193 Do not warn if an unexpected @code{__attribute__} is used, such as
3194 unrecognized attributes, function attributes applied to variables,
3195 etc.  This will not stop errors for incorrect use of supported
3196 attributes.
3198 @item -Wstrict-prototypes @r{(C only)}
3199 @opindex Wstrict-prototypes
3200 Warn if a function is declared or defined without specifying the
3201 argument types.  (An old-style function definition is permitted without
3202 a warning if preceded by a declaration which specifies the argument
3203 types.)
3205 @item -Wold-style-definition @r{(C only)}
3206 @opindex Wold-style-definition
3207 Warn if an old-style function definition is used.  A warning is given
3208 even if there is a previous prototype.
3210 @item -Wmissing-prototypes @r{(C only)}
3211 @opindex Wmissing-prototypes
3212 Warn if a global function is defined without a previous prototype
3213 declaration.  This warning is issued even if the definition itself
3214 provides a prototype.  The aim is to detect global functions that fail
3215 to be declared in header files.
3217 @item -Wmissing-declarations @r{(C only)}
3218 @opindex Wmissing-declarations
3219 Warn if a global function is defined without a previous declaration.
3220 Do so even if the definition itself provides a prototype.
3221 Use this option to detect global functions that are not declared in
3222 header files.
3224 @item -Wmissing-field-initializers
3225 @opindex Wmissing-field-initializers
3226 @opindex W
3227 @opindex Wextra
3228 Warn if a structure's initializer has some fields missing.  For
3229 example, the following code would cause such a warning, because
3230 @code{x.h} is implicitly zero:
3232 @smallexample
3233 struct s @{ int f, g, h; @};
3234 struct s x = @{ 3, 4 @};
3235 @end smallexample
3237 This option does not warn about designated initializers, so the following
3238 modification would not trigger a warning:
3240 @smallexample
3241 struct s @{ int f, g, h; @};
3242 struct s x = @{ .f = 3, .g = 4 @};
3243 @end smallexample
3245 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3246 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3248 @item -Wmissing-noreturn
3249 @opindex Wmissing-noreturn
3250 Warn about functions which might be candidates for attribute @code{noreturn}.
3251 Note these are only possible candidates, not absolute ones.  Care should
3252 be taken to manually verify functions actually do not ever return before
3253 adding the @code{noreturn} attribute, otherwise subtle code generation
3254 bugs could be introduced.  You will not get a warning for @code{main} in
3255 hosted C environments.
3257 @item -Wmissing-format-attribute
3258 @opindex Wmissing-format-attribute
3259 @opindex Wformat
3260 Warn about function pointers which might be candidates for @code{format}
3261 attributes.  Note these are only possible candidates, not absolute ones.
3262 GCC will guess that function pointers with @code{format} attributes that
3263 are used in assignment, initialization, parameter passing or return
3264 statements should have a corresponding @code{format} attribute in the
3265 resulting type.  I.e.@: the left-hand side of the assignment or
3266 initialization, the type of the parameter variable, or the return type
3267 of the containing function respectively should also have a @code{format}
3268 attribute to avoid the warning.
3270 GCC will also warn about function definitions which might be
3271 candidates for @code{format} attributes.  Again, these are only
3272 possible candidates.  GCC will guess that @code{format} attributes
3273 might be appropriate for any function that calls a function like
3274 @code{vprintf} or @code{vscanf}, but this might not always be the
3275 case, and some functions for which @code{format} attributes are
3276 appropriate may not be detected.
3278 @item -Wno-multichar
3279 @opindex Wno-multichar
3280 @opindex Wmultichar
3281 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3282 Usually they indicate a typo in the user's code, as they have
3283 implementation-defined values, and should not be used in portable code.
3285 @item -Wnormalized=<none|id|nfc|nfkc>
3286 @opindex Wnormalized
3287 @cindex NFC
3288 @cindex NFKC
3289 @cindex character set, input normalization
3290 In ISO C and ISO C++, two identifiers are different if they are
3291 different sequences of characters.  However, sometimes when characters
3292 outside the basic ASCII character set are used, you can have two
3293 different character sequences that look the same.  To avoid confusion,
3294 the ISO 10646 standard sets out some @dfn{normalization rules} which
3295 when applied ensure that two sequences that look the same are turned into
3296 the same sequence.  GCC can warn you if you are using identifiers which
3297 have not been normalized; this option controls that warning.
3299 There are four levels of warning that GCC supports.  The default is
3300 @option{-Wnormalized=nfc}, which warns about any identifier which is
3301 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3302 recommended form for most uses.
3304 Unfortunately, there are some characters which ISO C and ISO C++ allow
3305 in identifiers that when turned into NFC aren't allowable as
3306 identifiers.  That is, there's no way to use these symbols in portable
3307 ISO C or C++ and have all your identifiers in NFC.
3308 @option{-Wnormalized=id} suppresses the warning for these characters.
3309 It is hoped that future versions of the standards involved will correct
3310 this, which is why this option is not the default.
3312 You can switch the warning off for all characters by writing
3313 @option{-Wnormalized=none}.  You would only want to do this if you
3314 were using some other normalization scheme (like ``D''), because
3315 otherwise you can easily create bugs that are literally impossible to see.
3317 Some characters in ISO 10646 have distinct meanings but look identical
3318 in some fonts or display methodologies, especially once formatting has
3319 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3320 LETTER N'', will display just like a regular @code{n} which has been
3321 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3322 normalization scheme to convert all these into a standard form as
3323 well, and GCC will warn if your code is not in NFKC if you use
3324 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3325 about every identifier that contains the letter O because it might be
3326 confused with the digit 0, and so is not the default, but may be
3327 useful as a local coding convention if the programming environment is
3328 unable to be fixed to display these characters distinctly.
3330 @item -Wno-deprecated-declarations
3331 @opindex Wno-deprecated-declarations
3332 Do not warn about uses of functions (@pxref{Function Attributes}),
3333 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3334 Attributes}) marked as deprecated by using the @code{deprecated}
3335 attribute.
3337 @item -Wno-overflow
3338 @opindex Wno-overflow
3339 Do not warn about compile-time overflow in constant expressions.
3341 @item -Woverride-init
3342 @opindex Woverride-init
3343 @opindex W
3344 @opindex Wextra
3345 Warn if an initialized field without side effects is overridden when
3346 using designated initializers (@pxref{Designated Inits, , Designated
3347 Initializers}).
3349 This warning is included in @option{-Wextra}.  To get other
3350 @option{-Wextra} warnings without this one, use @samp{-Wextra
3351 -Wno-override-init}.
3353 @item -Wpacked
3354 @opindex Wpacked
3355 Warn if a structure is given the packed attribute, but the packed
3356 attribute has no effect on the layout or size of the structure.
3357 Such structures may be mis-aligned for little benefit.  For
3358 instance, in this code, the variable @code{f.x} in @code{struct bar}
3359 will be misaligned even though @code{struct bar} does not itself
3360 have the packed attribute:
3362 @smallexample
3363 @group
3364 struct foo @{
3365   int x;
3366   char a, b, c, d;
3367 @} __attribute__((packed));
3368 struct bar @{
3369   char z;
3370   struct foo f;
3372 @end group
3373 @end smallexample
3375 @item -Wpadded
3376 @opindex Wpadded
3377 Warn if padding is included in a structure, either to align an element
3378 of the structure or to align the whole structure.  Sometimes when this
3379 happens it is possible to rearrange the fields of the structure to
3380 reduce the padding and so make the structure smaller.
3382 @item -Wredundant-decls
3383 @opindex Wredundant-decls
3384 Warn if anything is declared more than once in the same scope, even in
3385 cases where multiple declaration is valid and changes nothing.
3387 @item -Wnested-externs @r{(C only)}
3388 @opindex Wnested-externs
3389 Warn if an @code{extern} declaration is encountered within a function.
3391 @item -Wunreachable-code
3392 @opindex Wunreachable-code
3393 Warn if the compiler detects that code will never be executed.
3395 This option is intended to warn when the compiler detects that at
3396 least a whole line of source code will never be executed, because
3397 some condition is never satisfied or because it is after a
3398 procedure that never returns.
3400 It is possible for this option to produce a warning even though there
3401 are circumstances under which part of the affected line can be executed,
3402 so care should be taken when removing apparently-unreachable code.
3404 For instance, when a function is inlined, a warning may mean that the
3405 line is unreachable in only one inlined copy of the function.
3407 This option is not made part of @option{-Wall} because in a debugging
3408 version of a program there is often substantial code which checks
3409 correct functioning of the program and is, hopefully, unreachable
3410 because the program does work.  Another common use of unreachable
3411 code is to provide behavior which is selectable at compile-time.
3413 @item -Winline
3414 @opindex Winline
3415 Warn if a function can not be inlined and it was declared as inline.
3416 Even with this option, the compiler will not warn about failures to
3417 inline functions declared in system headers.
3419 The compiler uses a variety of heuristics to determine whether or not
3420 to inline a function.  For example, the compiler takes into account
3421 the size of the function being inlined and the amount of inlining
3422 that has already been done in the current function.  Therefore,
3423 seemingly insignificant changes in the source program can cause the
3424 warnings produced by @option{-Winline} to appear or disappear.
3426 @item -Wno-invalid-offsetof @r{(C++ only)}
3427 @opindex Wno-invalid-offsetof
3428 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3429 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3430 to a non-POD type is undefined.  In existing C++ implementations,
3431 however, @samp{offsetof} typically gives meaningful results even when
3432 applied to certain kinds of non-POD types. (Such as a simple
3433 @samp{struct} that fails to be a POD type only by virtue of having a
3434 constructor.)  This flag is for users who are aware that they are
3435 writing nonportable code and who have deliberately chosen to ignore the
3436 warning about it.
3438 The restrictions on @samp{offsetof} may be relaxed in a future version
3439 of the C++ standard.
3441 @item -Wno-int-to-pointer-cast @r{(C only)}
3442 @opindex Wno-int-to-pointer-cast
3443 Suppress warnings from casts to pointer type of an integer of a
3444 different size.
3446 @item -Wno-pointer-to-int-cast @r{(C only)}
3447 @opindex Wno-pointer-to-int-cast
3448 Suppress warnings from casts from a pointer to an integer type of a
3449 different size.
3451 @item -Winvalid-pch
3452 @opindex Winvalid-pch
3453 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3454 the search path but can't be used.
3456 @item -Wlong-long
3457 @opindex Wlong-long
3458 @opindex Wno-long-long
3459 Warn if @samp{long long} type is used.  This is default.  To inhibit
3460 the warning messages, use @option{-Wno-long-long}.  Flags
3461 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3462 only when @option{-pedantic} flag is used.
3464 @item -Wvariadic-macros
3465 @opindex Wvariadic-macros
3466 @opindex Wno-variadic-macros
3467 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3468 alternate syntax when in pedantic ISO C99 mode.  This is default.
3469 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3471 @item -Wvolatile-register-var
3472 @opindex Wvolatile-register-var
3473 @opindex Wno-volatile-register-var
3474 Warn if a register variable is declared volatile.  The volatile
3475 modifier does not inhibit all optimizations that may eliminate reads
3476 and/or writes to register variables.
3478 @item -Wdisabled-optimization
3479 @opindex Wdisabled-optimization
3480 Warn if a requested optimization pass is disabled.  This warning does
3481 not generally indicate that there is anything wrong with your code; it
3482 merely indicates that GCC's optimizers were unable to handle the code
3483 effectively.  Often, the problem is that your code is too big or too
3484 complex; GCC will refuse to optimize programs when the optimization
3485 itself is likely to take inordinate amounts of time.
3487 @item -Wpointer-sign
3488 @opindex Wpointer-sign
3489 @opindex Wno-pointer-sign
3490 Warn for pointer argument passing or assignment with different signedness.
3491 This option is only supported for C and Objective-C@.  It is implied by
3492 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3493 @option{-Wno-pointer-sign}.
3495 @item -Werror
3496 @opindex Werror
3497 Make all warnings into errors.
3499 @item -Werror=
3500 @opindex Werror=
3501 Make the specified warning into an errors.  The specifier for a
3502 warning is appended, for example @option{-Werror=switch} turns the
3503 warnings controlled by @option{-Wswitch} into errors.  This switch
3504 takes a negative form, to be used to negate @option{-Werror} for
3505 specific warnings, for example @option{-Wno-error=switch} makes
3506 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3507 is in effect.  You can use the @option{-fdiagnostics-show-option}
3508 option to have each controllable warning amended with the option which
3509 controls it, to determine what to use with this option.
3511 Note that specifying @option{-Werror=}@var{foo} automatically implies
3512 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3513 imply anything.
3515 @item -Wstack-protector
3516 @opindex Wstack-protector
3517 This option is only active when @option{-fstack-protector} is active.  It
3518 warns about functions that will not be protected against stack smashing.
3520 @item -Wstring-literal-comparison
3521 @opindex Wstring-literal-comparison
3522 Warn about suspicious comparisons to string literal constants.  In C,
3523 direct comparisons against the memory address of a string literal, such
3524 as @code{if (x == "abc")}, typically indicate a programmer error, and
3525 even when intentional, result in unspecified behavior and are not portable.
3526 Usually these warnings alert that the programmer intended to use
3527 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3529 @item -Woverlength-strings
3530 @opindex Woverlength-strings
3531 Warn about string constants which are longer than the ``minimum
3532 maximum'' length specified in the C standard.  Modern compilers
3533 generally allow string constants which are much longer than the
3534 standard's minimum limit, but very portable programs should avoid
3535 using longer strings.
3537 The limit applies @emph{after} string constant concatenation, and does
3538 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3539 C99, it was raised to 4095.  C++98 does not specify a normative
3540 minimum maximum, so we do not diagnose overlength strings in C++@.
3542 This option is implied by @option{-pedantic}, and can be disabled with
3543 @option{-Wno-overlength-strings}.
3544 @end table
3546 @node Debugging Options
3547 @section Options for Debugging Your Program or GCC
3548 @cindex options, debugging
3549 @cindex debugging information options
3551 GCC has various special options that are used for debugging
3552 either your program or GCC:
3554 @table @gcctabopt
3555 @item -g
3556 @opindex g
3557 Produce debugging information in the operating system's native format
3558 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3559 information.
3561 On most systems that use stabs format, @option{-g} enables use of extra
3562 debugging information that only GDB can use; this extra information
3563 makes debugging work better in GDB but will probably make other debuggers
3564 crash or
3565 refuse to read the program.  If you want to control for certain whether
3566 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3567 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3569 GCC allows you to use @option{-g} with
3570 @option{-O}.  The shortcuts taken by optimized code may occasionally
3571 produce surprising results: some variables you declared may not exist
3572 at all; flow of control may briefly move where you did not expect it;
3573 some statements may not be executed because they compute constant
3574 results or their values were already at hand; some statements may
3575 execute in different places because they were moved out of loops.
3577 Nevertheless it proves possible to debug optimized output.  This makes
3578 it reasonable to use the optimizer for programs that might have bugs.
3580 The following options are useful when GCC is generated with the
3581 capability for more than one debugging format.
3583 @item -ggdb
3584 @opindex ggdb
3585 Produce debugging information for use by GDB@.  This means to use the
3586 most expressive format available (DWARF 2, stabs, or the native format
3587 if neither of those are supported), including GDB extensions if at all
3588 possible.
3590 @item -gstabs
3591 @opindex gstabs
3592 Produce debugging information in stabs format (if that is supported),
3593 without GDB extensions.  This is the format used by DBX on most BSD
3594 systems.  On MIPS, Alpha and System V Release 4 systems this option
3595 produces stabs debugging output which is not understood by DBX or SDB@.
3596 On System V Release 4 systems this option requires the GNU assembler.
3598 @item -feliminate-unused-debug-symbols
3599 @opindex feliminate-unused-debug-symbols
3600 Produce debugging information in stabs format (if that is supported),
3601 for only symbols that are actually used.
3603 @item -femit-class-debug-always
3604 Instead of emitting debugging information for a C++ class in only one
3605 object file, emit it in all object files using the class.  This option
3606 should be used only with debuggers that are unable to handle the way GCC
3607 normally emits debugging information for classes because using this
3608 option will increase the size of debugging information by as much as a
3609 factor of two.
3611 @item -gstabs+
3612 @opindex gstabs+
3613 Produce debugging information in stabs format (if that is supported),
3614 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3615 use of these extensions is likely to make other debuggers crash or
3616 refuse to read the program.
3618 @item -gcoff
3619 @opindex gcoff
3620 Produce debugging information in COFF format (if that is supported).
3621 This is the format used by SDB on most System V systems prior to
3622 System V Release 4.
3624 @item -gxcoff
3625 @opindex gxcoff
3626 Produce debugging information in XCOFF format (if that is supported).
3627 This is the format used by the DBX debugger on IBM RS/6000 systems.
3629 @item -gxcoff+
3630 @opindex gxcoff+
3631 Produce debugging information in XCOFF format (if that is supported),
3632 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3633 use of these extensions is likely to make other debuggers crash or
3634 refuse to read the program, and may cause assemblers other than the GNU
3635 assembler (GAS) to fail with an error.
3637 @item -gdwarf-2
3638 @opindex gdwarf-2
3639 Produce debugging information in DWARF version 2 format (if that is
3640 supported).  This is the format used by DBX on IRIX 6.  With this
3641 option, GCC uses features of DWARF version 3 when they are useful;
3642 version 3 is upward compatible with version 2, but may still cause
3643 problems for older debuggers.
3645 @item -gvms
3646 @opindex gvms
3647 Produce debugging information in VMS debug format (if that is
3648 supported).  This is the format used by DEBUG on VMS systems.
3650 @item -g@var{level}
3651 @itemx -ggdb@var{level}
3652 @itemx -gstabs@var{level}
3653 @itemx -gcoff@var{level}
3654 @itemx -gxcoff@var{level}
3655 @itemx -gvms@var{level}
3656 Request debugging information and also use @var{level} to specify how
3657 much information.  The default level is 2.
3659 Level 1 produces minimal information, enough for making backtraces in
3660 parts of the program that you don't plan to debug.  This includes
3661 descriptions of functions and external variables, but no information
3662 about local variables and no line numbers.
3664 Level 3 includes extra information, such as all the macro definitions
3665 present in the program.  Some debuggers support macro expansion when
3666 you use @option{-g3}.
3668 @option{-gdwarf-2} does not accept a concatenated debug level, because
3669 GCC used to support an option @option{-gdwarf} that meant to generate
3670 debug information in version 1 of the DWARF format (which is very
3671 different from version 2), and it would have been too confusing.  That
3672 debug format is long obsolete, but the option cannot be changed now.
3673 Instead use an additional @option{-g@var{level}} option to change the
3674 debug level for DWARF2.
3676 @item -feliminate-dwarf2-dups
3677 @opindex feliminate-dwarf2-dups
3678 Compress DWARF2 debugging information by eliminating duplicated
3679 information about each symbol.  This option only makes sense when
3680 generating DWARF2 debugging information with @option{-gdwarf-2}.
3682 @cindex @command{prof}
3683 @item -p
3684 @opindex p
3685 Generate extra code to write profile information suitable for the
3686 analysis program @command{prof}.  You must use this option when compiling
3687 the source files you want data about, and you must also use it when
3688 linking.
3690 @cindex @command{gprof}
3691 @item -pg
3692 @opindex pg
3693 Generate extra code to write profile information suitable for the
3694 analysis program @command{gprof}.  You must use this option when compiling
3695 the source files you want data about, and you must also use it when
3696 linking.
3698 @item -Q
3699 @opindex Q
3700 Makes the compiler print out each function name as it is compiled, and
3701 print some statistics about each pass when it finishes.
3703 @item -ftime-report
3704 @opindex ftime-report
3705 Makes the compiler print some statistics about the time consumed by each
3706 pass when it finishes.
3708 @item -fmem-report
3709 @opindex fmem-report
3710 Makes the compiler print some statistics about permanent memory
3711 allocation when it finishes.
3713 @item -fprofile-arcs
3714 @opindex fprofile-arcs
3715 Add code so that program flow @dfn{arcs} are instrumented.  During
3716 execution the program records how many times each branch and call is
3717 executed and how many times it is taken or returns.  When the compiled
3718 program exits it saves this data to a file called
3719 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3720 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3721 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3722 @var{auxname} is generated from the name of the output file, if
3723 explicitly specified and it is not the final executable, otherwise it is
3724 the basename of the source file.  In both cases any suffix is removed
3725 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3726 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3727 @xref{Cross-profiling}.
3729 @cindex @command{gcov}
3730 @item --coverage
3731 @opindex coverage
3733 This option is used to compile and link code instrumented for coverage
3734 analysis.  The option is a synonym for @option{-fprofile-arcs}
3735 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3736 linking).  See the documentation for those options for more details.
3738 @itemize
3740 @item
3741 Compile the source files with @option{-fprofile-arcs} plus optimization
3742 and code generation options.  For test coverage analysis, use the
3743 additional @option{-ftest-coverage} option.  You do not need to profile
3744 every source file in a program.
3746 @item
3747 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3748 (the latter implies the former).
3750 @item
3751 Run the program on a representative workload to generate the arc profile
3752 information.  This may be repeated any number of times.  You can run
3753 concurrent instances of your program, and provided that the file system
3754 supports locking, the data files will be correctly updated.  Also
3755 @code{fork} calls are detected and correctly handled (double counting
3756 will not happen).
3758 @item
3759 For profile-directed optimizations, compile the source files again with
3760 the same optimization and code generation options plus
3761 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3762 Control Optimization}).
3764 @item
3765 For test coverage analysis, use @command{gcov} to produce human readable
3766 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3767 @command{gcov} documentation for further information.
3769 @end itemize
3771 With @option{-fprofile-arcs}, for each function of your program GCC
3772 creates a program flow graph, then finds a spanning tree for the graph.
3773 Only arcs that are not on the spanning tree have to be instrumented: the
3774 compiler adds code to count the number of times that these arcs are
3775 executed.  When an arc is the only exit or only entrance to a block, the
3776 instrumentation code can be added to the block; otherwise, a new basic
3777 block must be created to hold the instrumentation code.
3779 @need 2000
3780 @item -ftest-coverage
3781 @opindex ftest-coverage
3782 Produce a notes file that the @command{gcov} code-coverage utility
3783 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3784 show program coverage.  Each source file's note file is called
3785 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3786 above for a description of @var{auxname} and instructions on how to
3787 generate test coverage data.  Coverage data will match the source files
3788 more closely, if you do not optimize.
3790 @item -d@var{letters}
3791 @item -fdump-rtl-@var{pass}
3792 @opindex d
3793 Says to make debugging dumps during compilation at times specified by
3794 @var{letters}.    This is used for debugging the RTL-based passes of the
3795 compiler.  The file names for most of the dumps are made by appending a
3796 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3797 from the name of the output file, if explicitly specified and it is not
3798 an executable, otherwise it is the basename of the source file.
3800 Most debug dumps can be enabled either passing a letter to the @option{-d}
3801 option, or with a long @option{-fdump-rtl} switch; here are the possible
3802 letters for use in @var{letters} and @var{pass}, and their meanings:
3804 @table @gcctabopt
3805 @item -dA
3806 @opindex dA
3807 Annotate the assembler output with miscellaneous debugging information.
3809 @item -dB
3810 @itemx -fdump-rtl-bbro
3811 @opindex dB
3812 @opindex fdump-rtl-bbro
3813 Dump after block reordering, to @file{@var{file}.148r.bbro}.
3815 @item -dc
3816 @itemx -fdump-rtl-combine
3817 @opindex dc
3818 @opindex fdump-rtl-combine
3819 Dump after instruction combination, to the file @file{@var{file}.129r.combine}.
3821 @item -dC
3822 @itemx -fdump-rtl-ce1
3823 @itemx -fdump-rtl-ce2
3824 @opindex dC
3825 @opindex fdump-rtl-ce1
3826 @opindex fdump-rtl-ce2
3827 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3828 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
3829 and @option{-fdump-rtl-ce2} enable dumping after the second if
3830 conversion, to the file @file{@var{file}.130r.ce2}.
3832 @item -dd
3833 @itemx -fdump-rtl-btl
3834 @itemx -fdump-rtl-dbr
3835 @opindex dd
3836 @opindex fdump-rtl-btl
3837 @opindex fdump-rtl-dbr
3838 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3839 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3840 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3841 scheduling, to @file{@var{file}.36.dbr}.
3843 @item -dD
3844 @opindex dD
3845 Dump all macro definitions, at the end of preprocessing, in addition to
3846 normal output.
3848 @item -dE
3849 @itemx -fdump-rtl-ce3
3850 @opindex dE
3851 @opindex fdump-rtl-ce3
3852 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3854 @item -df
3855 @itemx -fdump-rtl-cfg
3856 @itemx -fdump-rtl-life
3857 @opindex df
3858 @opindex fdump-rtl-cfg
3859 @opindex fdump-rtl-life
3860 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3861 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
3862 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3863 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3865 @item -dg
3866 @itemx -fdump-rtl-greg
3867 @opindex dg
3868 @opindex fdump-rtl-greg
3869 Dump after global register allocation, to @file{@var{file}.139r.greg}.
3871 @item -dG
3872 @itemx -fdump-rtl-gcse
3873 @itemx -fdump-rtl-bypass
3874 @opindex dG
3875 @opindex fdump-rtl-gcse
3876 @opindex fdump-rtl-bypass
3877 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3878 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3879 enable dumping after jump bypassing and control flow optimizations, to
3880 @file{@var{file}.115r.bypass}.
3882 @item -dh
3883 @itemx -fdump-rtl-eh
3884 @opindex dh
3885 @opindex fdump-rtl-eh
3886 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3888 @item -di
3889 @itemx -fdump-rtl-sibling
3890 @opindex di
3891 @opindex fdump-rtl-sibling
3892 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3894 @item -dj
3895 @itemx -fdump-rtl-jump
3896 @opindex dj
3897 @opindex fdump-rtl-jump
3898 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3900 @item -dk
3901 @itemx -fdump-rtl-stack
3902 @opindex dk
3903 @opindex fdump-rtl-stack
3904 Dump after conversion from registers to stack, to @file{@var{file}.152r.stack}.
3906 @item -dl
3907 @itemx -fdump-rtl-lreg
3908 @opindex dl
3909 @opindex fdump-rtl-lreg
3910 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3912 @item -dL
3913 @itemx -fdump-rtl-loop2
3914 @opindex dL
3915 @opindex fdump-rtl-loop2
3916 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
3917 loop optimization pass, to @file{@var{file}.119r.loop2},
3918 @file{@var{file}.120r.loop2_init},
3919 @file{@var{file}.121r.loop2_invariant}, and
3920 @file{@var{file}.125r.loop2_done}.
3922 @item -dm
3923 @itemx -fdump-rtl-sms
3924 @opindex dm
3925 @opindex fdump-rtl-sms
3926 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
3928 @item -dM
3929 @itemx -fdump-rtl-mach
3930 @opindex dM
3931 @opindex fdump-rtl-mach
3932 Dump after performing the machine dependent reorganization pass, to
3933 @file{@var{file}.155r.mach}.
3935 @item -dn
3936 @itemx -fdump-rtl-rnreg
3937 @opindex dn
3938 @opindex fdump-rtl-rnreg
3939 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
3941 @item -dN
3942 @itemx -fdump-rtl-regmove
3943 @opindex dN
3944 @opindex fdump-rtl-regmove
3945 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
3947 @item -do
3948 @itemx -fdump-rtl-postreload
3949 @opindex do
3950 @opindex fdump-rtl-postreload
3951 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3953 @item -dr
3954 @itemx -fdump-rtl-expand
3955 @opindex dr
3956 @opindex fdump-rtl-expand
3957 Dump after RTL generation, to @file{@var{file}.104r.expand}.
3959 @item -dR
3960 @itemx -fdump-rtl-sched2
3961 @opindex dR
3962 @opindex fdump-rtl-sched2
3963 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
3965 @item -ds
3966 @itemx -fdump-rtl-cse
3967 @opindex ds
3968 @opindex fdump-rtl-cse
3969 Dump after CSE (including the jump optimization that sometimes follows
3970 CSE), to @file{@var{file}.113r.cse}.
3972 @item -dS
3973 @itemx -fdump-rtl-sched1
3974 @opindex dS
3975 @opindex fdump-rtl-sched1
3976 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
3978 @item -dt
3979 @itemx -fdump-rtl-cse2
3980 @opindex dt
3981 @opindex fdump-rtl-cse2
3982 Dump after the second CSE pass (including the jump optimization that
3983 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
3985 @item -dT
3986 @itemx -fdump-rtl-tracer
3987 @opindex dT
3988 @opindex fdump-rtl-tracer
3989 Dump after running tracer, to @file{@var{file}.118r.tracer}.
3991 @item -dV
3992 @itemx -fdump-rtl-vpt
3993 @itemx -fdump-rtl-vartrack
3994 @opindex dV
3995 @opindex fdump-rtl-vpt
3996 @opindex fdump-rtl-vartrack
3997 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3998 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3999 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4000 to @file{@var{file}.154r.vartrack}.
4002 @item -dw
4003 @itemx -fdump-rtl-flow2
4004 @opindex dw
4005 @opindex fdump-rtl-flow2
4006 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4008 @item -dz
4009 @itemx -fdump-rtl-peephole2
4010 @opindex dz
4011 @opindex fdump-rtl-peephole2
4012 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4014 @item -dZ
4015 @itemx -fdump-rtl-web
4016 @opindex dZ
4017 @opindex fdump-rtl-web
4018 Dump after live range splitting, to @file{@var{file}.126r.web}.
4020 @item -da
4021 @itemx -fdump-rtl-all
4022 @opindex da
4023 @opindex fdump-rtl-all
4024 Produce all the dumps listed above.
4026 @item -dH
4027 @opindex dH
4028 Produce a core dump whenever an error occurs.
4030 @item -dm
4031 @opindex dm
4032 Print statistics on memory usage, at the end of the run, to
4033 standard error.
4035 @item -dp
4036 @opindex dp
4037 Annotate the assembler output with a comment indicating which
4038 pattern and alternative was used.  The length of each instruction is
4039 also printed.
4041 @item -dP
4042 @opindex dP
4043 Dump the RTL in the assembler output as a comment before each instruction.
4044 Also turns on @option{-dp} annotation.
4046 @item -dv
4047 @opindex dv
4048 For each of the other indicated dump files (either with @option{-d} or
4049 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4050 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4052 @item -dx
4053 @opindex dx
4054 Just generate RTL for a function instead of compiling it.  Usually used
4055 with @samp{r} (@option{-fdump-rtl-expand}).
4057 @item -dy
4058 @opindex dy
4059 Dump debugging information during parsing, to standard error.
4060 @end table
4062 @item -fdump-noaddr
4063 @opindex fdump-noaddr
4064 When doing debugging dumps (see @option{-d} option above), suppress
4065 address output.  This makes it more feasible to use diff on debugging
4066 dumps for compiler invocations with different compiler binaries and/or
4067 different text / bss / data / heap / stack / dso start locations.
4069 @item -fdump-unnumbered
4070 @opindex fdump-unnumbered
4071 When doing debugging dumps (see @option{-d} option above), suppress instruction
4072 numbers, line number note and address output.  This makes it more feasible to
4073 use diff on debugging dumps for compiler invocations with different
4074 options, in particular with and without @option{-g}.
4076 @item -fdump-translation-unit @r{(C++ only)}
4077 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4078 @opindex fdump-translation-unit
4079 Dump a representation of the tree structure for the entire translation
4080 unit to a file.  The file name is made by appending @file{.tu} to the
4081 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4082 controls the details of the dump as described for the
4083 @option{-fdump-tree} options.
4085 @item -fdump-class-hierarchy @r{(C++ only)}
4086 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4087 @opindex fdump-class-hierarchy
4088 Dump a representation of each class's hierarchy and virtual function
4089 table layout to a file.  The file name is made by appending @file{.class}
4090 to the source file name.  If the @samp{-@var{options}} form is used,
4091 @var{options} controls the details of the dump as described for the
4092 @option{-fdump-tree} options.
4094 @item -fdump-ipa-@var{switch}
4095 @opindex fdump-ipa
4096 Control the dumping at various stages of inter-procedural analysis
4097 language tree to a file.  The file name is generated by appending a switch
4098 specific suffix to the source file name.  The following dumps are possible:
4100 @table @samp
4101 @item all
4102 Enables all inter-procedural analysis dumps; currently the only produced
4103 dump is the @samp{cgraph} dump.
4105 @item cgraph
4106 Dumps information about call-graph optimization, unused function removal,
4107 and inlining decisions.
4108 @end table
4110 @item -fdump-tree-@var{switch}
4111 @itemx -fdump-tree-@var{switch}-@var{options}
4112 @opindex fdump-tree
4113 Control the dumping at various stages of processing the intermediate
4114 language tree to a file.  The file name is generated by appending a switch
4115 specific suffix to the source file name.  If the @samp{-@var{options}}
4116 form is used, @var{options} is a list of @samp{-} separated options that
4117 control the details of the dump.  Not all options are applicable to all
4118 dumps, those which are not meaningful will be ignored.  The following
4119 options are available
4121 @table @samp
4122 @item address
4123 Print the address of each node.  Usually this is not meaningful as it
4124 changes according to the environment and source file.  Its primary use
4125 is for tying up a dump file with a debug environment.
4126 @item slim
4127 Inhibit dumping of members of a scope or body of a function merely
4128 because that scope has been reached.  Only dump such items when they
4129 are directly reachable by some other path.  When dumping pretty-printed
4130 trees, this option inhibits dumping the bodies of control structures.
4131 @item raw
4132 Print a raw representation of the tree.  By default, trees are
4133 pretty-printed into a C-like representation.
4134 @item details
4135 Enable more detailed dumps (not honored by every dump option).
4136 @item stats
4137 Enable dumping various statistics about the pass (not honored by every dump
4138 option).
4139 @item blocks
4140 Enable showing basic block boundaries (disabled in raw dumps).
4141 @item vops
4142 Enable showing virtual operands for every statement.
4143 @item lineno
4144 Enable showing line numbers for statements.
4145 @item uid
4146 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4147 @item all
4148 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4149 @end table
4151 The following tree dumps are possible:
4152 @table @samp
4154 @item original
4155 Dump before any tree based optimization, to @file{@var{file}.original}.
4157 @item optimized
4158 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4160 @item inlined
4161 Dump after function inlining, to @file{@var{file}.inlined}.
4163 @item gimple
4164 @opindex fdump-tree-gimple
4165 Dump each function before and after the gimplification pass to a file.  The
4166 file name is made by appending @file{.gimple} to the source file name.
4168 @item cfg
4169 @opindex fdump-tree-cfg
4170 Dump the control flow graph of each function to a file.  The file name is
4171 made by appending @file{.cfg} to the source file name.
4173 @item vcg
4174 @opindex fdump-tree-vcg
4175 Dump the control flow graph of each function to a file in VCG format.  The
4176 file name is made by appending @file{.vcg} to the source file name.  Note
4177 that if the file contains more than one function, the generated file cannot
4178 be used directly by VCG@.  You will need to cut and paste each function's
4179 graph into its own separate file first.
4181 @item ch
4182 @opindex fdump-tree-ch
4183 Dump each function after copying loop headers.  The file name is made by
4184 appending @file{.ch} to the source file name.
4186 @item ssa
4187 @opindex fdump-tree-ssa
4188 Dump SSA related information to a file.  The file name is made by appending
4189 @file{.ssa} to the source file name.
4191 @item salias
4192 @opindex fdump-tree-salias
4193 Dump structure aliasing variable information to a file.  This file name
4194 is made by appending @file{.salias} to the source file name.
4196 @item alias
4197 @opindex fdump-tree-alias
4198 Dump aliasing information for each function.  The file name is made by
4199 appending @file{.alias} to the source file name.
4201 @item ccp
4202 @opindex fdump-tree-ccp
4203 Dump each function after CCP@.  The file name is made by appending
4204 @file{.ccp} to the source file name.
4206 @item storeccp
4207 @opindex fdump-tree-storeccp
4208 Dump each function after STORE-CCP.  The file name is made by appending
4209 @file{.storeccp} to the source file name.
4211 @item pre
4212 @opindex fdump-tree-pre
4213 Dump trees after partial redundancy elimination.  The file name is made
4214 by appending @file{.pre} to the source file name.
4216 @item fre
4217 @opindex fdump-tree-fre
4218 Dump trees after full redundancy elimination.  The file name is made
4219 by appending @file{.fre} to the source file name.
4221 @item copyprop
4222 @opindex fdump-tree-copyprop
4223 Dump trees after copy propagation.  The file name is made
4224 by appending @file{.copyprop} to the source file name.
4226 @item store_copyprop
4227 @opindex fdump-tree-store_copyprop
4228 Dump trees after store copy-propagation.  The file name is made
4229 by appending @file{.store_copyprop} to the source file name.
4231 @item dce
4232 @opindex fdump-tree-dce
4233 Dump each function after dead code elimination.  The file name is made by
4234 appending @file{.dce} to the source file name.
4236 @item mudflap
4237 @opindex fdump-tree-mudflap
4238 Dump each function after adding mudflap instrumentation.  The file name is
4239 made by appending @file{.mudflap} to the source file name.
4241 @item sra
4242 @opindex fdump-tree-sra
4243 Dump each function after performing scalar replacement of aggregates.  The
4244 file name is made by appending @file{.sra} to the source file name.
4246 @item sink
4247 @opindex fdump-tree-sink
4248 Dump each function after performing code sinking.  The file name is made
4249 by appending @file{.sink} to the source file name. 
4251 @item dom
4252 @opindex fdump-tree-dom
4253 Dump each function after applying dominator tree optimizations.  The file
4254 name is made by appending @file{.dom} to the source file name.
4256 @item dse
4257 @opindex fdump-tree-dse
4258 Dump each function after applying dead store elimination.  The file
4259 name is made by appending @file{.dse} to the source file name.
4261 @item phiopt
4262 @opindex fdump-tree-phiopt
4263 Dump each function after optimizing PHI nodes into straightline code.  The file
4264 name is made by appending @file{.phiopt} to the source file name.
4266 @item forwprop
4267 @opindex fdump-tree-forwprop
4268 Dump each function after forward propagating single use variables.  The file
4269 name is made by appending @file{.forwprop} to the source file name.
4271 @item copyrename
4272 @opindex fdump-tree-copyrename
4273 Dump each function after applying the copy rename optimization.  The file
4274 name is made by appending @file{.copyrename} to the source file name.
4276 @item nrv
4277 @opindex fdump-tree-nrv
4278 Dump each function after applying the named return value optimization on
4279 generic trees.  The file name is made by appending @file{.nrv} to the source
4280 file name.
4282 @item vect
4283 @opindex fdump-tree-vect
4284 Dump each function after applying vectorization of loops.  The file name is
4285 made by appending @file{.vect} to the source file name.
4287 @item vrp
4288 @opindex fdump-tree-vrp
4289 Dump each function after Value Range Propagation (VRP).  The file name
4290 is made by appending @file{.vrp} to the source file name.
4292 @item all
4293 @opindex fdump-tree-all
4294 Enable all the available tree dumps with the flags provided in this option.
4295 @end table
4297 @item -ftree-vectorizer-verbose=@var{n}
4298 @opindex ftree-vectorizer-verbose
4299 This option controls the amount of debugging output the vectorizer prints.
4300 This information is written to standard error, unless 
4301 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified, 
4302 in which case it is output to the usual dump listing file, @file{.vect}.
4303 For @var{n}=0 no diagnostic information is reported.
4304 If @var{n}=1 the vectorizer reports each loop that got vectorized, 
4305 and the total number of loops that got vectorized.
4306 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed 
4307 the first analysis phase (vect_analyze_loop_form) - i.e. countable, 
4308 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity 
4309 level that @option{-fdump-tree-vect-stats} uses.
4310 Higher verbosity levels mean either more information dumped for each 
4311 reported loop, or same amount of information reported for more loops:
4312 If @var{n}=3, alignment related information is added to the reports.
4313 If @var{n}=4, data-references related information (e.g. memory dependences, 
4314 memory access-patterns) is added to the reports.
4315 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops 
4316 that did not pass the first analysis phase (i.e. may not be countable, or 
4317 may have complicated control-flow).
4318 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4319 For @var{n}=7, all the information the vectorizer generates during its 
4320 analysis and transformation is reported.  This is the same verbosity level
4321 that @option{-fdump-tree-vect-details} uses.
4323 @item -frandom-seed=@var{string}
4324 @opindex frandom-string
4325 This option provides a seed that GCC uses when it would otherwise use
4326 random numbers.  It is used to generate certain symbol names
4327 that have to be different in every compiled file.  It is also used to
4328 place unique stamps in coverage data files and the object files that
4329 produce them.  You can use the @option{-frandom-seed} option to produce
4330 reproducibly identical object files.
4332 The @var{string} should be different for every file you compile.
4334 @item -fsched-verbose=@var{n}
4335 @opindex fsched-verbose
4336 On targets that use instruction scheduling, this option controls the
4337 amount of debugging output the scheduler prints.  This information is
4338 written to standard error, unless @option{-dS} or @option{-dR} is
4339 specified, in which case it is output to the usual dump
4340 listing file, @file{.sched} or @file{.sched2} respectively.  However
4341 for @var{n} greater than nine, the output is always printed to standard
4342 error.
4344 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4345 same information as @option{-dRS}.  For @var{n} greater than one, it
4346 also output basic block probabilities, detailed ready list information
4347 and unit/insn info.  For @var{n} greater than two, it includes RTL
4348 at abort point, control-flow and regions info.  And for @var{n} over
4349 four, @option{-fsched-verbose} also includes dependence info.
4351 @item -save-temps
4352 @opindex save-temps
4353 Store the usual ``temporary'' intermediate files permanently; place them
4354 in the current directory and name them based on the source file.  Thus,
4355 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4356 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4357 preprocessed @file{foo.i} output file even though the compiler now
4358 normally uses an integrated preprocessor.
4360 When used in combination with the @option{-x} command line option,
4361 @option{-save-temps} is sensible enough to avoid over writing an
4362 input source file with the same extension as an intermediate file.
4363 The corresponding intermediate file may be obtained by renaming the
4364 source file before using @option{-save-temps}.
4366 @item -time
4367 @opindex time
4368 Report the CPU time taken by each subprocess in the compilation
4369 sequence.  For C source files, this is the compiler proper and assembler
4370 (plus the linker if linking is done).  The output looks like this:
4372 @smallexample
4373 # cc1 0.12 0.01
4374 # as 0.00 0.01
4375 @end smallexample
4377 The first number on each line is the ``user time'', that is time spent
4378 executing the program itself.  The second number is ``system time'',
4379 time spent executing operating system routines on behalf of the program.
4380 Both numbers are in seconds.
4382 @item -fvar-tracking
4383 @opindex fvar-tracking
4384 Run variable tracking pass.  It computes where variables are stored at each
4385 position in code.  Better debugging information is then generated
4386 (if the debugging information format supports this information).
4388 It is enabled by default when compiling with optimization (@option{-Os},
4389 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4390 the debug info format supports it.
4392 @item -print-file-name=@var{library}
4393 @opindex print-file-name
4394 Print the full absolute name of the library file @var{library} that
4395 would be used when linking---and don't do anything else.  With this
4396 option, GCC does not compile or link anything; it just prints the
4397 file name.
4399 @item -print-multi-directory
4400 @opindex print-multi-directory
4401 Print the directory name corresponding to the multilib selected by any
4402 other switches present in the command line.  This directory is supposed
4403 to exist in @env{GCC_EXEC_PREFIX}.
4405 @item -print-multi-lib
4406 @opindex print-multi-lib
4407 Print the mapping from multilib directory names to compiler switches
4408 that enable them.  The directory name is separated from the switches by
4409 @samp{;}, and each switch starts with an @samp{@@} instead of the
4410 @samp{-}, without spaces between multiple switches.  This is supposed to
4411 ease shell-processing.
4413 @item -print-prog-name=@var{program}
4414 @opindex print-prog-name
4415 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4417 @item -print-libgcc-file-name
4418 @opindex print-libgcc-file-name
4419 Same as @option{-print-file-name=libgcc.a}.
4421 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4422 but you do want to link with @file{libgcc.a}.  You can do
4424 @smallexample
4425 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4426 @end smallexample
4428 @item -print-search-dirs
4429 @opindex print-search-dirs
4430 Print the name of the configured installation directory and a list of
4431 program and library directories @command{gcc} will search---and don't do anything else.
4433 This is useful when @command{gcc} prints the error message
4434 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4435 To resolve this you either need to put @file{cpp0} and the other compiler
4436 components where @command{gcc} expects to find them, or you can set the environment
4437 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4438 Don't forget the trailing @samp{/}.
4439 @xref{Environment Variables}.
4441 @item -dumpmachine
4442 @opindex dumpmachine
4443 Print the compiler's target machine (for example,
4444 @samp{i686-pc-linux-gnu})---and don't do anything else.
4446 @item -dumpversion
4447 @opindex dumpversion
4448 Print the compiler version (for example, @samp{3.0})---and don't do
4449 anything else.
4451 @item -dumpspecs
4452 @opindex dumpspecs
4453 Print the compiler's built-in specs---and don't do anything else.  (This
4454 is used when GCC itself is being built.)  @xref{Spec Files}.
4456 @item -feliminate-unused-debug-types
4457 @opindex feliminate-unused-debug-types
4458 Normally, when producing DWARF2 output, GCC will emit debugging
4459 information for all types declared in a compilation
4460 unit, regardless of whether or not they are actually used
4461 in that compilation unit.  Sometimes this is useful, such as
4462 if, in the debugger, you want to cast a value to a type that is
4463 not actually used in your program (but is declared).  More often,
4464 however, this results in a significant amount of wasted space.
4465 With this option, GCC will avoid producing debug symbol output
4466 for types that are nowhere used in the source file being compiled.
4467 @end table
4469 @node Optimize Options
4470 @section Options That Control Optimization
4471 @cindex optimize options
4472 @cindex options, optimization
4474 These options control various sorts of optimizations.
4476 Without any optimization option, the compiler's goal is to reduce the
4477 cost of compilation and to make debugging produce the expected
4478 results.  Statements are independent: if you stop the program with a
4479 breakpoint between statements, you can then assign a new value to any
4480 variable or change the program counter to any other statement in the
4481 function and get exactly the results you would expect from the source
4482 code.
4484 Turning on optimization flags makes the compiler attempt to improve
4485 the performance and/or code size at the expense of compilation time
4486 and possibly the ability to debug the program.
4488 The compiler performs optimization based on the knowledge it has of
4489 the program.  Optimization levels @option{-O} and above, in
4490 particular, enable @emph{unit-at-a-time} mode, which allows the
4491 compiler to consider information gained from later functions in
4492 the file when compiling a function.  Compiling multiple files at
4493 once to a single output file in @emph{unit-at-a-time} mode allows
4494 the compiler to use information gained from all of the files when
4495 compiling each of them.
4497 Not all optimizations are controlled directly by a flag.  Only
4498 optimizations that have a flag are listed.
4500 @table @gcctabopt
4501 @item -O
4502 @itemx -O1
4503 @opindex O
4504 @opindex O1
4505 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4506 more memory for a large function.
4508 With @option{-O}, the compiler tries to reduce code size and execution
4509 time, without performing any optimizations that take a great deal of
4510 compilation time.
4512 @option{-O} turns on the following optimization flags:
4513 @gccoptlist{-fdefer-pop @gol
4514 -fdelayed-branch @gol
4515 -fguess-branch-probability @gol
4516 -fcprop-registers @gol
4517 -fif-conversion @gol
4518 -fif-conversion2 @gol
4519 -ftree-ccp @gol
4520 -ftree-dce @gol
4521 -ftree-dominator-opts @gol
4522 -ftree-dse @gol
4523 -ftree-ter @gol
4524 -ftree-lrs @gol
4525 -ftree-sra @gol
4526 -ftree-copyrename @gol
4527 -ftree-fre @gol
4528 -ftree-ch @gol
4529 -funit-at-a-time @gol
4530 -fmerge-constants}
4532 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4533 where doing so does not interfere with debugging.
4535 @item -O2
4536 @opindex O2
4537 Optimize even more.  GCC performs nearly all supported optimizations
4538 that do not involve a space-speed tradeoff.  The compiler does not
4539 perform loop unrolling or function inlining when you specify @option{-O2}.
4540 As compared to @option{-O}, this option increases both compilation time
4541 and the performance of the generated code.
4543 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4544 also turns on the following optimization flags:
4545 @gccoptlist{-fthread-jumps @gol
4546 -fcrossjumping @gol
4547 -foptimize-sibling-calls @gol
4548 -fcse-follow-jumps  -fcse-skip-blocks @gol
4549 -fgcse  -fgcse-lm  @gol
4550 -fexpensive-optimizations @gol
4551 -frerun-cse-after-loop  @gol
4552 -fcaller-saves @gol
4553 -fpeephole2 @gol
4554 -fschedule-insns  -fschedule-insns2 @gol
4555 -fsched-interblock  -fsched-spec @gol
4556 -fregmove @gol
4557 -fstrict-aliasing @gol
4558 -fdelete-null-pointer-checks @gol
4559 -freorder-blocks  -freorder-functions @gol
4560 -falign-functions  -falign-jumps @gol
4561 -falign-loops  -falign-labels @gol
4562 -ftree-vrp @gol
4563 -ftree-pre}
4565 Please note the warning under @option{-fgcse} about
4566 invoking @option{-O2} on programs that use computed gotos.
4568 @item -O3
4569 @opindex O3
4570 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4571 @option{-O2} and also turns on the @option{-finline-functions},
4572 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4574 @item -O0
4575 @opindex O0
4576 Do not optimize.  This is the default.
4578 @item -Os
4579 @opindex Os
4580 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4581 do not typically increase code size.  It also performs further
4582 optimizations designed to reduce code size.
4584 @option{-Os} disables the following optimization flags:
4585 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4586 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4587 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4589 If you use multiple @option{-O} options, with or without level numbers,
4590 the last such option is the one that is effective.
4591 @end table
4593 Options of the form @option{-f@var{flag}} specify machine-independent
4594 flags.  Most flags have both positive and negative forms; the negative
4595 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4596 below, only one of the forms is listed---the one you typically will
4597 use.  You can figure out the other form by either removing @samp{no-}
4598 or adding it.
4600 The following options control specific optimizations.  They are either
4601 activated by @option{-O} options or are related to ones that are.  You
4602 can use the following flags in the rare cases when ``fine-tuning'' of
4603 optimizations to be performed is desired.
4605 @table @gcctabopt
4606 @item -fno-default-inline
4607 @opindex fno-default-inline
4608 Do not make member functions inline by default merely because they are
4609 defined inside the class scope (C++ only).  Otherwise, when you specify
4610 @w{@option{-O}}, member functions defined inside class scope are compiled
4611 inline by default; i.e., you don't need to add @samp{inline} in front of
4612 the member function name.
4614 @item -fno-defer-pop
4615 @opindex fno-defer-pop
4616 Always pop the arguments to each function call as soon as that function
4617 returns.  For machines which must pop arguments after a function call,
4618 the compiler normally lets arguments accumulate on the stack for several
4619 function calls and pops them all at once.
4621 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4623 @item -fforce-mem
4624 @opindex fforce-mem
4625 Force memory operands to be copied into registers before doing
4626 arithmetic on them.  This produces better code by making all memory
4627 references potential common subexpressions.  When they are not common
4628 subexpressions, instruction combination should eliminate the separate
4629 register-load. This option is now a nop and will be removed in 4.2.
4631 @item -fforce-addr
4632 @opindex fforce-addr
4633 Force memory address constants to be copied into registers before
4634 doing arithmetic on them.
4636 @item -fforward-propagate
4637 @opindex fforward-propagate
4638 Perform a forward propagation pass on RTL.  The pass tries to combine two
4639 instructions and checks if the result can be simplified.  If loop unrolling
4640 is active, two passes are performed and the second is scheduled after
4641 loop unrolling.
4643 This option is enabled by default at optimization levels @option{-O2},
4644 @option{-O3}, @option{-Os}.
4646 @item -fomit-frame-pointer
4647 @opindex fomit-frame-pointer
4648 Don't keep the frame pointer in a register for functions that
4649 don't need one.  This avoids the instructions to save, set up and
4650 restore frame pointers; it also makes an extra register available
4651 in many functions.  @strong{It also makes debugging impossible on
4652 some machines.}
4654 On some machines, such as the VAX, this flag has no effect, because
4655 the standard calling sequence automatically handles the frame pointer
4656 and nothing is saved by pretending it doesn't exist.  The
4657 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4658 whether a target machine supports this flag.  @xref{Registers,,Register
4659 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4661 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4663 @item -foptimize-sibling-calls
4664 @opindex foptimize-sibling-calls
4665 Optimize sibling and tail recursive calls.
4667 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4669 @item -fno-inline
4670 @opindex fno-inline
4671 Don't pay attention to the @code{inline} keyword.  Normally this option
4672 is used to keep the compiler from expanding any functions inline.
4673 Note that if you are not optimizing, no functions can be expanded inline.
4675 @item -finline-functions
4676 @opindex finline-functions
4677 Integrate all simple functions into their callers.  The compiler
4678 heuristically decides which functions are simple enough to be worth
4679 integrating in this way.
4681 If all calls to a given function are integrated, and the function is
4682 declared @code{static}, then the function is normally not output as
4683 assembler code in its own right.
4685 Enabled at level @option{-O3}.
4687 @item -finline-functions-called-once
4688 @opindex finline-functions-called-once
4689 Consider all @code{static} functions called once for inlining into their
4690 caller even if they are not marked @code{inline}.  If a call to a given
4691 function is integrated, then the function is not output as assembler code
4692 in its own right.
4694 Enabled if @option{-funit-at-a-time} is enabled.
4696 @item -fearly-inlining
4697 @opindex fearly-inlining
4698 Inline functions marked by @code{always_inline} and functions whose body seems
4699 smaller than the function call overhead early before doing
4700 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4701 makes profiling significantly cheaper and usually inlining faster on programs
4702 having large chains of nested wrapper functions.
4704 Enabled by default.
4706 @item -finline-limit=@var{n}
4707 @opindex finline-limit
4708 By default, GCC limits the size of functions that can be inlined.  This flag
4709 allows the control of this limit for functions that are explicitly marked as
4710 inline (i.e., marked with the inline keyword or defined within the class
4711 definition in c++).  @var{n} is the size of functions that can be inlined in
4712 number of pseudo instructions (not counting parameter handling).  The default
4713 value of @var{n} is 600.
4714 Increasing this value can result in more inlined code at
4715 the cost of compilation time and memory consumption.  Decreasing usually makes
4716 the compilation faster and less code will be inlined (which presumably
4717 means slower programs).  This option is particularly useful for programs that
4718 use inlining heavily such as those based on recursive templates with C++.
4720 Inlining is actually controlled by a number of parameters, which may be
4721 specified individually by using @option{--param @var{name}=@var{value}}.
4722 The @option{-finline-limit=@var{n}} option sets some of these parameters
4723 as follows:
4725 @table @gcctabopt
4726 @item max-inline-insns-single
4727  is set to @var{n}/2.
4728 @item max-inline-insns-auto
4729  is set to @var{n}/2.
4730 @item min-inline-insns
4731  is set to 130 or @var{n}/4, whichever is smaller.
4732 @item max-inline-insns-rtl
4733  is set to @var{n}.
4734 @end table
4736 See below for a documentation of the individual
4737 parameters controlling inlining.
4739 @emph{Note:} pseudo instruction represents, in this particular context, an
4740 abstract measurement of function's size.  In no way does it represent a count
4741 of assembly instructions and as such its exact meaning might change from one
4742 release to an another.
4744 @item -fkeep-inline-functions
4745 @opindex fkeep-inline-functions
4746 In C, emit @code{static} functions that are declared @code{inline}
4747 into the object file, even if the function has been inlined into all
4748 of its callers.  This switch does not affect functions using the
4749 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
4750 inline functions into the object file.
4752 @item -fkeep-static-consts
4753 @opindex fkeep-static-consts
4754 Emit variables declared @code{static const} when optimization isn't turned
4755 on, even if the variables aren't referenced.
4757 GCC enables this option by default.  If you want to force the compiler to
4758 check if the variable was referenced, regardless of whether or not
4759 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4761 @item -fmerge-constants
4762 Attempt to merge identical constants (string constants and floating point
4763 constants) across compilation units.
4765 This option is the default for optimized compilation if the assembler and
4766 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4767 behavior.
4769 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4771 @item -fmerge-all-constants
4772 Attempt to merge identical constants and identical variables.
4774 This option implies @option{-fmerge-constants}.  In addition to
4775 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4776 arrays or initialized constant variables with integral or floating point
4777 types.  Languages like C or C++ require each non-automatic variable to
4778 have distinct location, so using this option will result in non-conforming
4779 behavior.
4781 @item -fmodulo-sched
4782 @opindex fmodulo-sched
4783 Perform swing modulo scheduling immediately before the first scheduling
4784 pass.  This pass looks at innermost loops and reorders their
4785 instructions by overlapping different iterations.
4787 @item -fno-branch-count-reg
4788 @opindex fno-branch-count-reg
4789 Do not use ``decrement and branch'' instructions on a count register,
4790 but instead generate a sequence of instructions that decrement a
4791 register, compare it against zero, then branch based upon the result.
4792 This option is only meaningful on architectures that support such
4793 instructions, which include x86, PowerPC, IA-64 and S/390.
4795 The default is @option{-fbranch-count-reg}.
4797 @item -fno-function-cse
4798 @opindex fno-function-cse
4799 Do not put function addresses in registers; make each instruction that
4800 calls a constant function contain the function's address explicitly.
4802 This option results in less efficient code, but some strange hacks
4803 that alter the assembler output may be confused by the optimizations
4804 performed when this option is not used.
4806 The default is @option{-ffunction-cse}
4808 @item -fno-zero-initialized-in-bss
4809 @opindex fno-zero-initialized-in-bss
4810 If the target supports a BSS section, GCC by default puts variables that
4811 are initialized to zero into BSS@.  This can save space in the resulting
4812 code.
4814 This option turns off this behavior because some programs explicitly
4815 rely on variables going to the data section.  E.g., so that the
4816 resulting executable can find the beginning of that section and/or make
4817 assumptions based on that.
4819 The default is @option{-fzero-initialized-in-bss}.
4821 @item -fbounds-check
4822 @opindex fbounds-check
4823 For front-ends that support it, generate additional code to check that
4824 indices used to access arrays are within the declared range.  This is
4825 currently only supported by the Java and Fortran front-ends, where
4826 this option defaults to true and false respectively.
4828 @item -fmudflap -fmudflapth -fmudflapir
4829 @opindex fmudflap
4830 @opindex fmudflapth
4831 @opindex fmudflapir
4832 @cindex bounds checking
4833 @cindex mudflap
4834 For front-ends that support it (C and C++), instrument all risky
4835 pointer/array dereferencing operations, some standard library
4836 string/heap functions, and some other associated constructs with
4837 range/validity tests.  Modules so instrumented should be immune to
4838 buffer overflows, invalid heap use, and some other classes of C/C++
4839 programming errors.  The instrumentation relies on a separate runtime
4840 library (@file{libmudflap}), which will be linked into a program if
4841 @option{-fmudflap} is given at link time.  Run-time behavior of the
4842 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4843 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4844 for its options.
4846 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4847 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4848 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4849 instrumentation should ignore pointer reads.  This produces less
4850 instrumentation (and therefore faster execution) and still provides
4851 some protection against outright memory corrupting writes, but allows
4852 erroneously read data to propagate within a program.
4854 @item -fthread-jumps
4855 @opindex fthread-jumps
4856 Perform optimizations where we check to see if a jump branches to a
4857 location where another comparison subsumed by the first is found.  If
4858 so, the first branch is redirected to either the destination of the
4859 second branch or a point immediately following it, depending on whether
4860 the condition is known to be true or false.
4862 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4864 @item -fcse-follow-jumps
4865 @opindex fcse-follow-jumps
4866 In common subexpression elimination, scan through jump instructions
4867 when the target of the jump is not reached by any other path.  For
4868 example, when CSE encounters an @code{if} statement with an
4869 @code{else} clause, CSE will follow the jump when the condition
4870 tested is false.
4872 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4874 @item -fcse-skip-blocks
4875 @opindex fcse-skip-blocks
4876 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4877 follow jumps which conditionally skip over blocks.  When CSE
4878 encounters a simple @code{if} statement with no else clause,
4879 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4880 body of the @code{if}.
4882 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4884 @item -frerun-cse-after-loop
4885 @opindex frerun-cse-after-loop
4886 Re-run common subexpression elimination after loop optimizations has been
4887 performed.
4889 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4891 @item -fgcse
4892 @opindex fgcse
4893 Perform a global common subexpression elimination pass.
4894 This pass also performs global constant and copy propagation.
4896 @emph{Note:} When compiling a program using computed gotos, a GCC
4897 extension, you may get better runtime performance if you disable
4898 the global common subexpression elimination pass by adding
4899 @option{-fno-gcse} to the command line.
4901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4903 @item -fgcse-lm
4904 @opindex fgcse-lm
4905 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4906 attempt to move loads which are only killed by stores into themselves.  This
4907 allows a loop containing a load/store sequence to be changed to a load outside
4908 the loop, and a copy/store within the loop.
4910 Enabled by default when gcse is enabled.
4912 @item -fgcse-sm
4913 @opindex fgcse-sm
4914 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4915 global common subexpression elimination.  This pass will attempt to move
4916 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4917 loops containing a load/store sequence can be changed to a load before
4918 the loop and a store after the loop.
4920 Not enabled at any optimization level.
4922 @item -fgcse-las
4923 @opindex fgcse-las
4924 When @option{-fgcse-las} is enabled, the global common subexpression
4925 elimination pass eliminates redundant loads that come after stores to the
4926 same memory location (both partial and full redundancies).
4928 Not enabled at any optimization level.
4930 @item -fgcse-after-reload
4931 @opindex fgcse-after-reload
4932 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4933 pass is performed after reload.  The purpose of this pass is to cleanup
4934 redundant spilling.
4936 @item -funsafe-loop-optimizations
4937 @opindex funsafe-loop-optimizations
4938 If given, the loop optimizer will assume that loop indices do not
4939 overflow, and that the loops with nontrivial exit condition are not
4940 infinite.  This enables a wider range of loop optimizations even if
4941 the loop optimizer itself cannot prove that these assumptions are valid.
4942 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4943 if it finds this kind of loop.
4945 @item -fcrossjumping
4946 @opindex crossjumping
4947 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4948 resulting code may or may not perform better than without cross-jumping.
4950 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4952 @item -fif-conversion
4953 @opindex if-conversion
4954 Attempt to transform conditional jumps into branch-less equivalents.  This
4955 include use of conditional moves, min, max, set flags and abs instructions, and
4956 some tricks doable by standard arithmetics.  The use of conditional execution
4957 on chips where it is available is controlled by @code{if-conversion2}.
4959 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4961 @item -fif-conversion2
4962 @opindex if-conversion2
4963 Use conditional execution (where available) to transform conditional jumps into
4964 branch-less equivalents.
4966 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4968 @item -fdelete-null-pointer-checks
4969 @opindex fdelete-null-pointer-checks
4970 Use global dataflow analysis to identify and eliminate useless checks
4971 for null pointers.  The compiler assumes that dereferencing a null
4972 pointer would have halted the program.  If a pointer is checked after
4973 it has already been dereferenced, it cannot be null.
4975 In some environments, this assumption is not true, and programs can
4976 safely dereference null pointers.  Use
4977 @option{-fno-delete-null-pointer-checks} to disable this optimization
4978 for programs which depend on that behavior.
4980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4982 @item -fexpensive-optimizations
4983 @opindex fexpensive-optimizations
4984 Perform a number of minor optimizations that are relatively expensive.
4986 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4988 @item -foptimize-register-move
4989 @itemx -fregmove
4990 @opindex foptimize-register-move
4991 @opindex fregmove
4992 Attempt to reassign register numbers in move instructions and as
4993 operands of other simple instructions in order to maximize the amount of
4994 register tying.  This is especially helpful on machines with two-operand
4995 instructions.
4997 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4998 optimization.
5000 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5002 @item -fdelayed-branch
5003 @opindex fdelayed-branch
5004 If supported for the target machine, attempt to reorder instructions
5005 to exploit instruction slots available after delayed branch
5006 instructions.
5008 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5010 @item -fschedule-insns
5011 @opindex fschedule-insns
5012 If supported for the target machine, attempt to reorder instructions to
5013 eliminate execution stalls due to required data being unavailable.  This
5014 helps machines that have slow floating point or memory load instructions
5015 by allowing other instructions to be issued until the result of the load
5016 or floating point instruction is required.
5018 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5020 @item -fschedule-insns2
5021 @opindex fschedule-insns2
5022 Similar to @option{-fschedule-insns}, but requests an additional pass of
5023 instruction scheduling after register allocation has been done.  This is
5024 especially useful on machines with a relatively small number of
5025 registers and where memory load instructions take more than one cycle.
5027 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5029 @item -fno-sched-interblock
5030 @opindex fno-sched-interblock
5031 Don't schedule instructions across basic blocks.  This is normally
5032 enabled by default when scheduling before register allocation, i.e.@:
5033 with @option{-fschedule-insns} or at @option{-O2} or higher.
5035 @item -fno-sched-spec
5036 @opindex fno-sched-spec
5037 Don't allow speculative motion of non-load instructions.  This is normally
5038 enabled by default when scheduling before register allocation, i.e.@:
5039 with @option{-fschedule-insns} or at @option{-O2} or higher.
5041 @item -fsched-spec-load
5042 @opindex fsched-spec-load
5043 Allow speculative motion of some load instructions.  This only makes
5044 sense when scheduling before register allocation, i.e.@: with
5045 @option{-fschedule-insns} or at @option{-O2} or higher.
5047 @item -fsched-spec-load-dangerous
5048 @opindex fsched-spec-load-dangerous
5049 Allow speculative motion of more load instructions.  This only makes
5050 sense when scheduling before register allocation, i.e.@: with
5051 @option{-fschedule-insns} or at @option{-O2} or higher.
5053 @item -fsched-stalled-insns=@var{n}
5054 @opindex fsched-stalled-insns
5055 Define how many insns (if any) can be moved prematurely from the queue
5056 of stalled insns into the ready list, during the second scheduling pass.
5058 @item -fsched-stalled-insns-dep=@var{n}
5059 @opindex fsched-stalled-insns-dep
5060 Define how many insn groups (cycles) will be examined for a dependency
5061 on a stalled insn that is candidate for premature removal from the queue
5062 of stalled insns.  Has an effect only during the second scheduling pass,
5063 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5065 @item -fsched2-use-superblocks
5066 @opindex fsched2-use-superblocks
5067 When scheduling after register allocation, do use superblock scheduling
5068 algorithm.  Superblock scheduling allows motion across basic block boundaries
5069 resulting on faster schedules.  This option is experimental, as not all machine
5070 descriptions used by GCC model the CPU closely enough to avoid unreliable
5071 results from the algorithm.
5073 This only makes sense when scheduling after register allocation, i.e.@: with
5074 @option{-fschedule-insns2} or at @option{-O2} or higher.
5076 @item -fsched2-use-traces
5077 @opindex fsched2-use-traces
5078 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5079 allocation and additionally perform code duplication in order to increase the
5080 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5081 trace formation.
5083 This mode should produce faster but significantly longer programs.  Also
5084 without @option{-fbranch-probabilities} the traces constructed may not
5085 match the reality and hurt the performance.  This only makes
5086 sense when scheduling after register allocation, i.e.@: with
5087 @option{-fschedule-insns2} or at @option{-O2} or higher.
5089 @item -fsee
5090 @opindex fsee
5091 Eliminates redundant extension instructions and move the non redundant
5092 ones to optimal placement using LCM.
5094 @item -freschedule-modulo-scheduled-loops
5095 @opindex fscheduling-in-modulo-scheduled-loops
5096 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5097 we may want to prevent the later scheduling passes from changing its schedule, we use this
5098 option to control that.
5100 @item -fcaller-saves
5101 @opindex fcaller-saves
5102 Enable values to be allocated in registers that will be clobbered by
5103 function calls, by emitting extra instructions to save and restore the
5104 registers around such calls.  Such allocation is done only when it
5105 seems to result in better code than would otherwise be produced.
5107 This option is always enabled by default on certain machines, usually
5108 those which have no call-preserved registers to use instead.
5110 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5112 @item -ftree-pre
5113 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5114 enabled by default at @option{-O2} and @option{-O3}.
5116 @item -ftree-fre
5117 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5118 between FRE and PRE is that FRE only considers expressions
5119 that are computed on all paths leading to the redundant computation.
5120 This analysis faster than PRE, though it exposes fewer redundancies.
5121 This flag is enabled by default at @option{-O} and higher.
5123 @item -ftree-copy-prop
5124 Perform copy propagation on trees.  This pass eliminates unnecessary
5125 copy operations.  This flag is enabled by default at @option{-O} and
5126 higher.
5128 @item -ftree-store-copy-prop
5129 Perform copy propagation of memory loads and stores.  This pass
5130 eliminates unnecessary copy operations in memory references
5131 (structures, global variables, arrays, etc).  This flag is enabled by
5132 default at @option{-O2} and higher.
5134 @item -ftree-salias
5135 Perform structural alias analysis on trees.  This flag
5136 is enabled by default at @option{-O} and higher.
5138 @item -fipa-pta
5139 Perform interprocedural pointer analysis.
5141 @item -ftree-sink
5142 Perform forward store motion  on trees.  This flag is
5143 enabled by default at @option{-O} and higher.
5145 @item -ftree-ccp
5146 Perform sparse conditional constant propagation (CCP) on trees.  This
5147 pass only operates on local scalar variables and is enabled by default
5148 at @option{-O} and higher.
5150 @item -ftree-store-ccp
5151 Perform sparse conditional constant propagation (CCP) on trees.  This
5152 pass operates on both local scalar variables and memory stores and
5153 loads (global variables, structures, arrays, etc).  This flag is
5154 enabled by default at @option{-O2} and higher.
5156 @item -ftree-dce
5157 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5158 default at @option{-O} and higher.
5160 @item -ftree-dominator-opts
5161 Perform a variety of simple scalar cleanups (constant/copy
5162 propagation, redundancy elimination, range propagation and expression
5163 simplification) based on a dominator tree traversal.  This also
5164 performs jump threading (to reduce jumps to jumps). This flag is
5165 enabled by default at @option{-O} and higher.
5167 @item -ftree-ch
5168 Perform loop header copying on trees.  This is beneficial since it increases
5169 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5170 is enabled by default at @option{-O} and higher.  It is not enabled
5171 for @option{-Os}, since it usually increases code size.
5173 @item -ftree-loop-optimize
5174 Perform loop optimizations on trees.  This flag is enabled by default
5175 at @option{-O} and higher.
5177 @item -ftree-loop-linear
5178 Perform linear loop transformations on tree.  This flag can improve cache
5179 performance and allow further loop optimizations to take place.
5181 @item -ftree-loop-im
5182 Perform loop invariant motion on trees.  This pass moves only invariants that
5183 would be hard to handle at RTL level (function calls, operations that expand to
5184 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5185 operands of conditions that are invariant out of the loop, so that we can use
5186 just trivial invariantness analysis in loop unswitching.  The pass also includes
5187 store motion.
5189 @item -ftree-loop-ivcanon
5190 Create a canonical counter for number of iterations in the loop for that
5191 determining number of iterations requires complicated analysis.  Later
5192 optimizations then may determine the number easily.  Useful especially
5193 in connection with unrolling.
5195 @item -fivopts
5196 Perform induction variable optimizations (strength reduction, induction
5197 variable merging and induction variable elimination) on trees.
5199 @item -ftree-sra
5200 Perform scalar replacement of aggregates.  This pass replaces structure
5201 references with scalars to prevent committing structures to memory too
5202 early.  This flag is enabled by default at @option{-O} and higher.
5204 @item -ftree-copyrename
5205 Perform copy renaming on trees.  This pass attempts to rename compiler
5206 temporaries to other variables at copy locations, usually resulting in
5207 variable names which more closely resemble the original variables.  This flag
5208 is enabled by default at @option{-O} and higher.
5210 @item -ftree-ter
5211 Perform temporary expression replacement during the SSA->normal phase.  Single
5212 use/single def temporaries are replaced at their use location with their
5213 defining expression.  This results in non-GIMPLE code, but gives the expanders
5214 much more complex trees to work on resulting in better RTL generation.  This is
5215 enabled by default at @option{-O} and higher.
5217 @item -ftree-lrs
5218 Perform live range splitting during the SSA->normal phase.  Distinct live
5219 ranges of a variable are split into unique variables, allowing for better
5220 optimization later.  This is enabled by default at @option{-O} and higher.
5222 @item -ftree-vectorize
5223 Perform loop vectorization on trees.
5225 @item -ftree-vect-loop-version
5226 @opindex ftree-vect-loop-version
5227 Perform loop versioning when doing loop vectorization on trees.  When a loop
5228 appears to be vectorizable except that data alignment or data dependence cannot
5229 be determined at compile time then vectorized and non-vectorized versions of
5230 the loop are generated along with runtime checks for alignment or dependence
5231 to control which version is executed.  This option is enabled by default
5232 except at level @option{-Os} where it is disabled.
5234 @item -ftree-vrp
5235 Perform Value Range Propagation on trees.  This is similar to the
5236 constant propagation pass, but instead of values, ranges of values are
5237 propagated.  This allows the optimizers to remove unnecessary range
5238 checks like array bound checks and null pointer checks.  This is
5239 enabled by default at @option{-O2} and higher.  Null pointer check
5240 elimination is only done if @option{-fdelete-null-pointer-checks} is
5241 enabled.
5243 @item -ftracer
5244 @opindex ftracer
5245 Perform tail duplication to enlarge superblock size.  This transformation
5246 simplifies the control flow of the function allowing other optimizations to do
5247 better job.
5249 @item -funroll-loops
5250 @opindex funroll-loops
5251 Unroll loops whose number of iterations can be determined at compile
5252 time or upon entry to the loop.  @option{-funroll-loops} implies
5253 @option{-frerun-cse-after-loop}.  This option makes code larger,
5254 and may or may not make it run faster.
5256 @item -funroll-all-loops
5257 @opindex funroll-all-loops
5258 Unroll all loops, even if their number of iterations is uncertain when
5259 the loop is entered.  This usually makes programs run more slowly.
5260 @option{-funroll-all-loops} implies the same options as
5261 @option{-funroll-loops},
5263 @item -fsplit-ivs-in-unroller
5264 @opindex -fsplit-ivs-in-unroller
5265 Enables expressing of values of induction variables in later iterations
5266 of the unrolled loop using the value in the first iteration.  This breaks
5267 long dependency chains, thus improving efficiency of the scheduling passes.
5269 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5270 same effect.  However in cases the loop body is more complicated than
5271 a single basic block, this is not reliable.  It also does not work at all
5272 on some of the architectures due to restrictions in the CSE pass.
5274 This optimization is enabled by default.
5276 @item -fvariable-expansion-in-unroller
5277 @opindex -fvariable-expansion-in-unroller
5278 With this option, the compiler will create multiple copies of some
5279 local variables when unrolling a loop which can result in superior code.
5281 @item -fprefetch-loop-arrays
5282 @opindex fprefetch-loop-arrays
5283 If supported by the target machine, generate instructions to prefetch
5284 memory to improve the performance of loops that access large arrays.
5286 This option may generate better or worse code; results are highly
5287 dependent on the structure of loops within the source code.
5289 Disabled at level @option{-Os}.
5291 @item -fno-peephole
5292 @itemx -fno-peephole2
5293 @opindex fno-peephole
5294 @opindex fno-peephole2
5295 Disable any machine-specific peephole optimizations.  The difference
5296 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5297 are implemented in the compiler; some targets use one, some use the
5298 other, a few use both.
5300 @option{-fpeephole} is enabled by default.
5301 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5303 @item -fno-guess-branch-probability
5304 @opindex fno-guess-branch-probability
5305 Do not guess branch probabilities using heuristics.
5307 GCC will use heuristics to guess branch probabilities if they are
5308 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5309 heuristics are based on the control flow graph.  If some branch probabilities
5310 are specified by @samp{__builtin_expect}, then the heuristics will be
5311 used to guess branch probabilities for the rest of the control flow graph,
5312 taking the @samp{__builtin_expect} info into account.  The interactions
5313 between the heuristics and @samp{__builtin_expect} can be complex, and in
5314 some cases, it may be useful to disable the heuristics so that the effects
5315 of @samp{__builtin_expect} are easier to understand.
5317 The default is @option{-fguess-branch-probability} at levels
5318 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5320 @item -freorder-blocks
5321 @opindex freorder-blocks
5322 Reorder basic blocks in the compiled function in order to reduce number of
5323 taken branches and improve code locality.
5325 Enabled at levels @option{-O2}, @option{-O3}.
5327 @item -freorder-blocks-and-partition
5328 @opindex freorder-blocks-and-partition
5329 In addition to reordering basic blocks in the compiled function, in order
5330 to reduce number of taken branches, partitions hot and cold basic blocks
5331 into separate sections of the assembly and .o files, to improve
5332 paging and cache locality performance.
5334 This optimization is automatically turned off in the presence of
5335 exception handling, for linkonce sections, for functions with a user-defined
5336 section attribute and on any architecture that does not support named
5337 sections.
5339 @item -freorder-functions
5340 @opindex freorder-functions
5341 Reorder functions in the object file in order to
5342 improve code locality.  This is implemented by using special
5343 subsections @code{.text.hot} for most frequently executed functions and
5344 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5345 the linker so object file format must support named sections and linker must
5346 place them in a reasonable way.
5348 Also profile feedback must be available in to make this option effective.  See
5349 @option{-fprofile-arcs} for details.
5351 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5353 @item -fstrict-aliasing
5354 @opindex fstrict-aliasing
5355 Allows the compiler to assume the strictest aliasing rules applicable to
5356 the language being compiled.  For C (and C++), this activates
5357 optimizations based on the type of expressions.  In particular, an
5358 object of one type is assumed never to reside at the same address as an
5359 object of a different type, unless the types are almost the same.  For
5360 example, an @code{unsigned int} can alias an @code{int}, but not a
5361 @code{void*} or a @code{double}.  A character type may alias any other
5362 type.
5364 Pay special attention to code like this:
5365 @smallexample
5366 union a_union @{
5367   int i;
5368   double d;
5371 int f() @{
5372   a_union t;
5373   t.d = 3.0;
5374   return t.i;
5376 @end smallexample
5377 The practice of reading from a different union member than the one most
5378 recently written to (called ``type-punning'') is common.  Even with
5379 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5380 is accessed through the union type.  So, the code above will work as
5381 expected.  However, this code might not:
5382 @smallexample
5383 int f() @{
5384   a_union t;
5385   int* ip;
5386   t.d = 3.0;
5387   ip = &t.i;
5388   return *ip;
5390 @end smallexample
5392 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5394 @item -falign-functions
5395 @itemx -falign-functions=@var{n}
5396 @opindex falign-functions
5397 Align the start of functions to the next power-of-two greater than
5398 @var{n}, skipping up to @var{n} bytes.  For instance,
5399 @option{-falign-functions=32} aligns functions to the next 32-byte
5400 boundary, but @option{-falign-functions=24} would align to the next
5401 32-byte boundary only if this can be done by skipping 23 bytes or less.
5403 @option{-fno-align-functions} and @option{-falign-functions=1} are
5404 equivalent and mean that functions will not be aligned.
5406 Some assemblers only support this flag when @var{n} is a power of two;
5407 in that case, it is rounded up.
5409 If @var{n} is not specified or is zero, use a machine-dependent default.
5411 Enabled at levels @option{-O2}, @option{-O3}.
5413 @item -falign-labels
5414 @itemx -falign-labels=@var{n}
5415 @opindex falign-labels
5416 Align all branch targets to a power-of-two boundary, skipping up to
5417 @var{n} bytes like @option{-falign-functions}.  This option can easily
5418 make code slower, because it must insert dummy operations for when the
5419 branch target is reached in the usual flow of the code.
5421 @option{-fno-align-labels} and @option{-falign-labels=1} are
5422 equivalent and mean that labels will not be aligned.
5424 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5425 are greater than this value, then their values are used instead.
5427 If @var{n} is not specified or is zero, use a machine-dependent default
5428 which is very likely to be @samp{1}, meaning no alignment.
5430 Enabled at levels @option{-O2}, @option{-O3}.
5432 @item -falign-loops
5433 @itemx -falign-loops=@var{n}
5434 @opindex falign-loops
5435 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5436 like @option{-falign-functions}.  The hope is that the loop will be
5437 executed many times, which will make up for any execution of the dummy
5438 operations.
5440 @option{-fno-align-loops} and @option{-falign-loops=1} are
5441 equivalent and mean that loops will not be aligned.
5443 If @var{n} is not specified or is zero, use a machine-dependent default.
5445 Enabled at levels @option{-O2}, @option{-O3}.
5447 @item -falign-jumps
5448 @itemx -falign-jumps=@var{n}
5449 @opindex falign-jumps
5450 Align branch targets to a power-of-two boundary, for branch targets
5451 where the targets can only be reached by jumping, skipping up to @var{n}
5452 bytes like @option{-falign-functions}.  In this case, no dummy operations
5453 need be executed.
5455 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5456 equivalent and mean that loops will not be aligned.
5458 If @var{n} is not specified or is zero, use a machine-dependent default.
5460 Enabled at levels @option{-O2}, @option{-O3}.
5462 @item -funit-at-a-time
5463 @opindex funit-at-a-time
5464 Parse the whole compilation unit before starting to produce code.
5465 This allows some extra optimizations to take place but consumes
5466 more memory (in general).  There are some compatibility issues
5467 with @emph{unit-at-a-time} mode:
5468 @itemize @bullet
5469 @item
5470 enabling @emph{unit-at-a-time} mode may change the order
5471 in which functions, variables, and top-level @code{asm} statements
5472 are emitted, and will likely break code relying on some particular
5473 ordering.  The majority of such top-level @code{asm} statements,
5474 though, can be replaced by @code{section} attributes.  The
5475 @option{fno-toplevel-reorder} option may be used to keep the ordering
5476 used in the input file, at the cost of some optimizations.
5478 @item
5479 @emph{unit-at-a-time} mode removes unreferenced static variables
5480 and functions.  This may result in undefined references
5481 when an @code{asm} statement refers directly to variables or functions
5482 that are otherwise unused.  In that case either the variable/function
5483 shall be listed as an operand of the @code{asm} statement operand or,
5484 in the case of top-level @code{asm} statements the attribute @code{used}
5485 shall be used on the declaration.
5487 @item
5488 Static functions now can use non-standard passing conventions that
5489 may break @code{asm} statements calling functions directly.  Again,
5490 attribute @code{used} will prevent this behavior.
5491 @end itemize
5493 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5494 but this scheme may not be supported by future releases of GCC@.
5496 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5498 @item -fno-toplevel-reorder
5499 Do not reorder top-level functions, variables, and @code{asm}
5500 statements.  Output them in the same order that they appear in the
5501 input file.  When this option is used, unreferenced static variables
5502 will not be removed.  This option is intended to support existing code
5503 which relies on a particular ordering.  For new code, it is better to
5504 use attributes.
5506 @item -fweb
5507 @opindex fweb
5508 Constructs webs as commonly used for register allocation purposes and assign
5509 each web individual pseudo register.  This allows the register allocation pass
5510 to operate on pseudos directly, but also strengthens several other optimization
5511 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5512 however, make debugging impossible, since variables will no longer stay in a
5513 ``home register''.
5515 Enabled by default with @option{-funroll-loops}.
5517 @item -fwhole-program
5518 @opindex fwhole-program
5519 Assume that the current compilation unit represents whole program being
5520 compiled.  All public functions and variables with the exception of @code{main}
5521 and those merged by attribute @code{externally_visible} become static functions
5522 and in a affect gets more aggressively optimized by interprocedural optimizers.
5523 While this option is equivalent to proper use of @code{static} keyword for
5524 programs consisting of single file, in combination with option
5525 @option{--combine} this flag can be used to compile most of smaller scale C
5526 programs since the functions and variables become local for the whole combined
5527 compilation unit, not for the single source file itself.
5530 @item -fno-cprop-registers
5531 @opindex fno-cprop-registers
5532 After register allocation and post-register allocation instruction splitting,
5533 we perform a copy-propagation pass to try to reduce scheduling dependencies
5534 and occasionally eliminate the copy.
5536 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5538 @item -fprofile-generate
5539 @opindex fprofile-generate
5541 Enable options usually used for instrumenting application to produce
5542 profile useful for later recompilation with profile feedback based
5543 optimization.  You must use @option{-fprofile-generate} both when
5544 compiling and when linking your program.
5546 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5548 @item -fprofile-use
5549 @opindex fprofile-use
5550 Enable profile feedback directed optimizations, and optimizations
5551 generally profitable only with profile feedback available.
5553 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5554 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5556 @end table
5558 The following options control compiler behavior regarding floating
5559 point arithmetic.  These options trade off between speed and
5560 correctness.  All must be specifically enabled.
5562 @table @gcctabopt
5563 @item -ffloat-store
5564 @opindex ffloat-store
5565 Do not store floating point variables in registers, and inhibit other
5566 options that might change whether a floating point value is taken from a
5567 register or memory.
5569 @cindex floating point precision
5570 This option prevents undesirable excess precision on machines such as
5571 the 68000 where the floating registers (of the 68881) keep more
5572 precision than a @code{double} is supposed to have.  Similarly for the
5573 x86 architecture.  For most programs, the excess precision does only
5574 good, but a few programs rely on the precise definition of IEEE floating
5575 point.  Use @option{-ffloat-store} for such programs, after modifying
5576 them to store all pertinent intermediate computations into variables.
5578 @item -ffast-math
5579 @opindex ffast-math
5580 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5581 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5582 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5583 and @option{fcx-limited-range}.
5585 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5587 This option should never be turned on by any @option{-O} option since
5588 it can result in incorrect output for programs which depend on
5589 an exact implementation of IEEE or ISO rules/specifications for
5590 math functions.
5592 @item -fno-math-errno
5593 @opindex fno-math-errno
5594 Do not set ERRNO after calling math functions that are executed
5595 with a single instruction, e.g., sqrt.  A program that relies on
5596 IEEE exceptions for math error handling may want to use this flag
5597 for speed while maintaining IEEE arithmetic compatibility.
5599 This option should never be turned on by any @option{-O} option since
5600 it can result in incorrect output for programs which depend on
5601 an exact implementation of IEEE or ISO rules/specifications for
5602 math functions.
5604 The default is @option{-fmath-errno}.
5606 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5607 no reason for the compiler to consider the possibility that it might,
5608 and @option{-fno-math-errno} is the default.
5610 @item -funsafe-math-optimizations
5611 @opindex funsafe-math-optimizations
5612 Allow optimizations for floating-point arithmetic that (a) assume
5613 that arguments and results are valid and (b) may violate IEEE or
5614 ANSI standards.  When used at link-time, it may include libraries
5615 or startup files that change the default FPU control word or other
5616 similar optimizations.
5618 This option should never be turned on by any @option{-O} option since
5619 it can result in incorrect output for programs which depend on
5620 an exact implementation of IEEE or ISO rules/specifications for
5621 math functions.
5623 The default is @option{-fno-unsafe-math-optimizations}.
5625 @item -ffinite-math-only
5626 @opindex ffinite-math-only
5627 Allow optimizations for floating-point arithmetic that assume
5628 that arguments and results are not NaNs or +-Infs.
5630 This option should never be turned on by any @option{-O} option since
5631 it can result in incorrect output for programs which depend on
5632 an exact implementation of IEEE or ISO rules/specifications.
5634 The default is @option{-fno-finite-math-only}.
5636 @item -fno-trapping-math
5637 @opindex fno-trapping-math
5638 Compile code assuming that floating-point operations cannot generate
5639 user-visible traps.  These traps include division by zero, overflow,
5640 underflow, inexact result and invalid operation.  This option implies
5641 @option{-fno-signaling-nans}.  Setting this option may allow faster
5642 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5644 This option should never be turned on by any @option{-O} option since
5645 it can result in incorrect output for programs which depend on
5646 an exact implementation of IEEE or ISO rules/specifications for
5647 math functions.
5649 The default is @option{-ftrapping-math}.
5651 @item -frounding-math
5652 @opindex frounding-math
5653 Disable transformations and optimizations that assume default floating
5654 point rounding behavior.  This is round-to-zero for all floating point
5655 to integer conversions, and round-to-nearest for all other arithmetic
5656 truncations.  This option should be specified for programs that change
5657 the FP rounding mode dynamically, or that may be executed with a
5658 non-default rounding mode.  This option disables constant folding of
5659 floating point expressions at compile-time (which may be affected by
5660 rounding mode) and arithmetic transformations that are unsafe in the
5661 presence of sign-dependent rounding modes.
5663 The default is @option{-fno-rounding-math}.
5665 This option is experimental and does not currently guarantee to
5666 disable all GCC optimizations that are affected by rounding mode.
5667 Future versions of GCC may provide finer control of this setting
5668 using C99's @code{FENV_ACCESS} pragma.  This command line option
5669 will be used to specify the default state for @code{FENV_ACCESS}.
5671 @item -frtl-abstract-sequences
5672 @opindex frtl-abstract-sequences
5673 It is a size optimization method. This option is to find identical
5674 sequences of code, which can be turned into pseudo-procedures  and
5675 then  replace  all  occurrences with  calls to  the  newly created
5676 subroutine. It is kind of an opposite of @option{-finline-functions}.
5677 This optimization runs at RTL level.
5679 @item -fsignaling-nans
5680 @opindex fsignaling-nans
5681 Compile code assuming that IEEE signaling NaNs may generate user-visible
5682 traps during floating-point operations.  Setting this option disables
5683 optimizations that may change the number of exceptions visible with
5684 signaling NaNs.  This option implies @option{-ftrapping-math}.
5686 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5687 be defined.
5689 The default is @option{-fno-signaling-nans}.
5691 This option is experimental and does not currently guarantee to
5692 disable all GCC optimizations that affect signaling NaN behavior.
5694 @item -fsingle-precision-constant
5695 @opindex fsingle-precision-constant
5696 Treat floating point constant as single precision constant instead of
5697 implicitly converting it to double precision constant.
5699 @item -fcx-limited-range
5700 @itemx -fno-cx-limited-range
5701 @opindex fcx-limited-range
5702 @opindex fno-cx-limited-range
5703 When enabled, this option states that a range reduction step is not
5704 needed when performing complex division.  The default is
5705 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5707 This option controls the default setting of the ISO C99 
5708 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5709 all languages.
5711 @end table
5713 The following options control optimizations that may improve
5714 performance, but are not enabled by any @option{-O} options.  This
5715 section includes experimental options that may produce broken code.
5717 @table @gcctabopt
5718 @item -fbranch-probabilities
5719 @opindex fbranch-probabilities
5720 After running a program compiled with @option{-fprofile-arcs}
5721 (@pxref{Debugging Options,, Options for Debugging Your Program or
5722 @command{gcc}}), you can compile it a second time using
5723 @option{-fbranch-probabilities}, to improve optimizations based on
5724 the number of times each branch was taken.  When the program
5725 compiled with @option{-fprofile-arcs} exits it saves arc execution
5726 counts to a file called @file{@var{sourcename}.gcda} for each source
5727 file  The information in this data file is very dependent on the
5728 structure of the generated code, so you must use the same source code
5729 and the same optimization options for both compilations.
5731 With @option{-fbranch-probabilities}, GCC puts a
5732 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5733 These can be used to improve optimization.  Currently, they are only
5734 used in one place: in @file{reorg.c}, instead of guessing which path a
5735 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5736 exactly determine which path is taken more often.
5738 @item -fprofile-values
5739 @opindex fprofile-values
5740 If combined with @option{-fprofile-arcs}, it adds code so that some
5741 data about values of expressions in the program is gathered.
5743 With @option{-fbranch-probabilities}, it reads back the data gathered
5744 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5745 notes to instructions for their later usage in optimizations.
5747 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5749 @item -fvpt
5750 @opindex fvpt
5751 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5752 a code to gather information about values of expressions.
5754 With @option{-fbranch-probabilities}, it reads back the data gathered
5755 and actually performs the optimizations based on them.
5756 Currently the optimizations include specialization of division operation
5757 using the knowledge about the value of the denominator.
5759 @item -frename-registers
5760 @opindex frename-registers
5761 Attempt to avoid false dependencies in scheduled code by making use
5762 of registers left over after register allocation.  This optimization
5763 will most benefit processors with lots of registers.  Depending on the
5764 debug information format adopted by the target, however, it can
5765 make debugging impossible, since variables will no longer stay in
5766 a ``home register''.
5768 Enabled by default with @option{-funroll-loops}.
5770 @item -ftracer
5771 @opindex ftracer
5772 Perform tail duplication to enlarge superblock size.  This transformation
5773 simplifies the control flow of the function allowing other optimizations to do
5774 better job.
5776 Enabled with @option{-fprofile-use}.
5778 @item -funroll-loops
5779 @opindex funroll-loops
5780 Unroll loops whose number of iterations can be determined at compile time or
5781 upon entry to the loop.  @option{-funroll-loops} implies
5782 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5783 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5784 small constant number of iterations).  This option makes code larger, and may
5785 or may not make it run faster.
5787 Enabled with @option{-fprofile-use}.
5789 @item -funroll-all-loops
5790 @opindex funroll-all-loops
5791 Unroll all loops, even if their number of iterations is uncertain when
5792 the loop is entered.  This usually makes programs run more slowly.
5793 @option{-funroll-all-loops} implies the same options as
5794 @option{-funroll-loops}.
5796 @item -fpeel-loops
5797 @opindex fpeel-loops
5798 Peels the loops for that there is enough information that they do not
5799 roll much (from profile feedback).  It also turns on complete loop peeling
5800 (i.e.@: complete removal of loops with small constant number of iterations).
5802 Enabled with @option{-fprofile-use}.
5804 @item -fmove-loop-invariants
5805 @opindex fmove-loop-invariants
5806 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5807 at level @option{-O1}
5809 @item -funswitch-loops
5810 @opindex funswitch-loops
5811 Move branches with loop invariant conditions out of the loop, with duplicates
5812 of the loop on both branches (modified according to result of the condition).
5814 @item -ffunction-sections
5815 @itemx -fdata-sections
5816 @opindex ffunction-sections
5817 @opindex fdata-sections
5818 Place each function or data item into its own section in the output
5819 file if the target supports arbitrary sections.  The name of the
5820 function or the name of the data item determines the section's name
5821 in the output file.
5823 Use these options on systems where the linker can perform optimizations
5824 to improve locality of reference in the instruction space.  Most systems
5825 using the ELF object format and SPARC processors running Solaris 2 have
5826 linkers with such optimizations.  AIX may have these optimizations in
5827 the future.
5829 Only use these options when there are significant benefits from doing
5830 so.  When you specify these options, the assembler and linker will
5831 create larger object and executable files and will also be slower.
5832 You will not be able to use @code{gprof} on all systems if you
5833 specify this option and you may have problems with debugging if
5834 you specify both this option and @option{-g}.
5836 @item -fbranch-target-load-optimize
5837 @opindex fbranch-target-load-optimize
5838 Perform branch target register load optimization before prologue / epilogue
5839 threading.
5840 The use of target registers can typically be exposed only during reload,
5841 thus hoisting loads out of loops and doing inter-block scheduling needs
5842 a separate optimization pass.
5844 @item -fbranch-target-load-optimize2
5845 @opindex fbranch-target-load-optimize2
5846 Perform branch target register load optimization after prologue / epilogue
5847 threading.
5849 @item -fbtr-bb-exclusive
5850 @opindex fbtr-bb-exclusive
5851 When performing branch target register load optimization, don't reuse
5852 branch target registers in within any basic block.
5854 @item -fstack-protector
5855 Emit extra code to check for buffer overflows, such as stack smashing
5856 attacks.  This is done by adding a guard variable to functions with
5857 vulnerable objects.  This includes functions that call alloca, and
5858 functions with buffers larger than 8 bytes.  The guards are initialized
5859 when a function is entered and then checked when the function exits.
5860 If a guard check fails, an error message is printed and the program exits.
5862 @item -fstack-protector-all
5863 Like @option{-fstack-protector} except that all functions are protected.
5865 @item -fsection-anchors
5866 @opindex fsection-anchors
5867 Try to reduce the number of symbolic address calculations by using
5868 shared ``anchor'' symbols to address nearby objects.  This transformation
5869 can help to reduce the number of GOT entries and GOT accesses on some
5870 targets.
5872 For example, the implementation of the following function @code{foo}:
5874 @smallexample
5875 static int a, b, c;
5876 int foo (void) @{ return a + b + c; @}
5877 @end smallexample
5879 would usually calculate the addresses of all three variables, but if you
5880 compile it with @option{-fsection-anchors}, it will access the variables
5881 from a common anchor point instead.  The effect is similar to the
5882 following pseudocode (which isn't valid C):
5884 @smallexample
5885 int foo (void)
5887   register int *xr = &x;
5888   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
5890 @end smallexample
5892 Not all targets support this option.
5894 @item --param @var{name}=@var{value}
5895 @opindex param
5896 In some places, GCC uses various constants to control the amount of
5897 optimization that is done.  For example, GCC will not inline functions
5898 that contain more that a certain number of instructions.  You can
5899 control some of these constants on the command-line using the
5900 @option{--param} option.
5902 The names of specific parameters, and the meaning of the values, are
5903 tied to the internals of the compiler, and are subject to change
5904 without notice in future releases.
5906 In each case, the @var{value} is an integer.  The allowable choices for
5907 @var{name} are given in the following table:
5909 @table @gcctabopt
5910 @item salias-max-implicit-fields
5911 The maximum number of fields in a variable without direct
5912 structure accesses for which structure aliasing will consider trying 
5913 to track each field.  The default is 5
5915 @item salias-max-array-elements
5916 The maximum number of elements an array can have and its elements
5917 still be tracked individually by structure aliasing. The default is 4
5919 @item sra-max-structure-size
5920 The maximum structure size, in bytes, at which the scalar replacement
5921 of aggregates (SRA) optimization will perform block copies.  The
5922 default value, 0, implies that GCC will select the most appropriate
5923 size itself.
5925 @item sra-field-structure-ratio
5926 The threshold ratio (as a percentage) between instantiated fields and
5927 the complete structure size.  We say that if the ratio of the number
5928 of bytes in instantiated fields to the number of bytes in the complete
5929 structure exceeds this parameter, then block copies are not used.  The
5930 default is 75.
5932 @item max-crossjump-edges
5933 The maximum number of incoming edges to consider for crossjumping.
5934 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5935 the number of edges incoming to each block.  Increasing values mean
5936 more aggressive optimization, making the compile time increase with
5937 probably small improvement in executable size.
5939 @item min-crossjump-insns
5940 The minimum number of instructions which must be matched at the end
5941 of two blocks before crossjumping will be performed on them.  This
5942 value is ignored in the case where all instructions in the block being
5943 crossjumped from are matched.  The default value is 5.
5945 @item max-grow-copy-bb-insns
5946 The maximum code size expansion factor when copying basic blocks
5947 instead of jumping.  The expansion is relative to a jump instruction.
5948 The default value is 8.
5950 @item max-goto-duplication-insns
5951 The maximum number of instructions to duplicate to a block that jumps
5952 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5953 passes, GCC factors computed gotos early in the compilation process,
5954 and unfactors them as late as possible.  Only computed jumps at the
5955 end of a basic blocks with no more than max-goto-duplication-insns are
5956 unfactored.  The default value is 8.
5958 @item max-delay-slot-insn-search
5959 The maximum number of instructions to consider when looking for an
5960 instruction to fill a delay slot.  If more than this arbitrary number of
5961 instructions is searched, the time savings from filling the delay slot
5962 will be minimal so stop searching.  Increasing values mean more
5963 aggressive optimization, making the compile time increase with probably
5964 small improvement in executable run time.
5966 @item max-delay-slot-live-search
5967 When trying to fill delay slots, the maximum number of instructions to
5968 consider when searching for a block with valid live register
5969 information.  Increasing this arbitrarily chosen value means more
5970 aggressive optimization, increasing the compile time.  This parameter
5971 should be removed when the delay slot code is rewritten to maintain the
5972 control-flow graph.
5974 @item max-gcse-memory
5975 The approximate maximum amount of memory that will be allocated in
5976 order to perform the global common subexpression elimination
5977 optimization.  If more memory than specified is required, the
5978 optimization will not be done.
5980 @item max-gcse-passes
5981 The maximum number of passes of GCSE to run.  The default is 1.
5983 @item max-pending-list-length
5984 The maximum number of pending dependencies scheduling will allow
5985 before flushing the current state and starting over.  Large functions
5986 with few branches or calls can create excessively large lists which
5987 needlessly consume memory and resources.
5989 @item max-inline-insns-single
5990 Several parameters control the tree inliner used in gcc.
5991 This number sets the maximum number of instructions (counted in GCC's
5992 internal representation) in a single function that the tree inliner
5993 will consider for inlining.  This only affects functions declared
5994 inline and methods implemented in a class declaration (C++).
5995 The default value is 450.
5997 @item max-inline-insns-auto
5998 When you use @option{-finline-functions} (included in @option{-O3}),
5999 a lot of functions that would otherwise not be considered for inlining
6000 by the compiler will be investigated.  To those functions, a different
6001 (more restrictive) limit compared to functions declared inline can
6002 be applied.
6003 The default value is 90.
6005 @item large-function-insns
6006 The limit specifying really large functions.  For functions larger than this
6007 limit after inlining inlining is constrained by
6008 @option{--param large-function-growth}.  This parameter is useful primarily
6009 to avoid extreme compilation time caused by non-linear algorithms used by the
6010 backend.
6011 This parameter is ignored when @option{-funit-at-a-time} is not used.
6012 The default value is 2700.
6014 @item large-function-growth
6015 Specifies maximal growth of large function caused by inlining in percents.
6016 This parameter is ignored when @option{-funit-at-a-time} is not used.
6017 The default value is 100 which limits large function growth to 2.0 times
6018 the original size.
6020 @item large-unit-insns
6021 The limit specifying large translation unit.  Growth caused by inlining of
6022 units larger than this limit is limited by @option{--param inline-unit-growth}.
6023 For small units this might be too tight (consider unit consisting of function A
6024 that is inline and B that just calls A three time.  If B is small relative to
6025 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6026 large units consisting of small inlininable functions however the overall unit
6027 growth limit is needed to avoid exponential explosion of code size.  Thus for
6028 smaller units, the size is increased to @option{--param large-unit-insns}
6029 before applying @option{--param inline-unit-growth}.  The default is 10000
6031 @item inline-unit-growth
6032 Specifies maximal overall growth of the compilation unit caused by inlining.
6033 This parameter is ignored when @option{-funit-at-a-time} is not used.
6034 The default value is 50 which limits unit growth to 1.5 times the original
6035 size.
6037 @item large-stack-frame
6038 The limit specifying large stack frames.  While inlining the algorithm is trying
6039 to not grow past this limit too much.  Default value is 256 bytes.
6041 @item large-stack-frame-growth
6042 Specifies maximal growth of large stack frames caused by inlining in percents.
6043 The default value is 1000 which limits large stack frame growth to 11 times
6044 the original size.
6046 @item max-inline-insns-recursive
6047 @itemx max-inline-insns-recursive-auto
6048 Specifies maximum number of instructions out-of-line copy of self recursive inline
6049 function can grow into by performing recursive inlining.
6051 For functions declared inline @option{--param max-inline-insns-recursive} is
6052 taken into account.  For function not declared inline, recursive inlining
6053 happens only when @option{-finline-functions} (included in @option{-O3}) is
6054 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6055 default value is 450.
6057 @item max-inline-recursive-depth
6058 @itemx max-inline-recursive-depth-auto
6059 Specifies maximum recursion depth used by the recursive inlining.
6061 For functions declared inline @option{--param max-inline-recursive-depth} is
6062 taken into account.  For function not declared inline, recursive inlining
6063 happens only when @option{-finline-functions} (included in @option{-O3}) is
6064 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6065 default value is 450.
6067 @item min-inline-recursive-probability
6068 Recursive inlining is profitable only for function having deep recursion
6069 in average and can hurt for function having little recursion depth by
6070 increasing the prologue size or complexity of function body to other
6071 optimizers.
6073 When profile feedback is available (see @option{-fprofile-generate}) the actual
6074 recursion depth can be guessed from probability that function will recurse via
6075 given call expression.  This parameter limits inlining only to call expression
6076 whose probability exceeds given threshold (in percents).  The default value is
6079 @item inline-call-cost
6080 Specify cost of call instruction relative to simple arithmetics operations
6081 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6082 functions and at the same time increases size of leaf function that is believed to
6083 reduce function size by being inlined.  In effect it increases amount of
6084 inlining for code having large abstraction penalty (many functions that just
6085 pass the arguments to other functions) and decrease inlining for code with low
6086 abstraction penalty.  The default value is 16.
6088 @item max-unrolled-insns
6089 The maximum number of instructions that a loop should have if that loop
6090 is unrolled, and if the loop is unrolled, it determines how many times
6091 the loop code is unrolled.
6093 @item max-average-unrolled-insns
6094 The maximum number of instructions biased by probabilities of their execution
6095 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6096 it determines how many times the loop code is unrolled.
6098 @item max-unroll-times
6099 The maximum number of unrollings of a single loop.
6101 @item max-peeled-insns
6102 The maximum number of instructions that a loop should have if that loop
6103 is peeled, and if the loop is peeled, it determines how many times
6104 the loop code is peeled.
6106 @item max-peel-times
6107 The maximum number of peelings of a single loop.
6109 @item max-completely-peeled-insns
6110 The maximum number of insns of a completely peeled loop.
6112 @item max-completely-peel-times
6113 The maximum number of iterations of a loop to be suitable for complete peeling.
6115 @item max-unswitch-insns
6116 The maximum number of insns of an unswitched loop.
6118 @item max-unswitch-level
6119 The maximum number of branches unswitched in a single loop.
6121 @item lim-expensive
6122 The minimum cost of an expensive expression in the loop invariant motion.
6124 @item iv-consider-all-candidates-bound
6125 Bound on number of candidates for induction variables below that
6126 all candidates are considered for each use in induction variable
6127 optimizations.  Only the most relevant candidates are considered
6128 if there are more candidates, to avoid quadratic time complexity.
6130 @item iv-max-considered-uses
6131 The induction variable optimizations give up on loops that contain more
6132 induction variable uses.
6134 @item iv-always-prune-cand-set-bound
6135 If number of candidates in the set is smaller than this value,
6136 we always try to remove unnecessary ivs from the set during its
6137 optimization when a new iv is added to the set.
6139 @item scev-max-expr-size
6140 Bound on size of expressions used in the scalar evolutions analyzer.
6141 Large expressions slow the analyzer.
6143 @item vect-max-version-checks
6144 The maximum number of runtime checks that can be performed when doing
6145 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6146 for more information.
6148 @item max-iterations-to-track
6150 The maximum number of iterations of a loop the brute force algorithm
6151 for analysis of # of iterations of the loop tries to evaluate.
6153 @item hot-bb-count-fraction
6154 Select fraction of the maximal count of repetitions of basic block in program
6155 given basic block needs to have to be considered hot.
6157 @item hot-bb-frequency-fraction
6158 Select fraction of the maximal frequency of executions of basic block in
6159 function given basic block needs to have to be considered hot
6161 @item max-predicted-iterations
6162 The maximum number of loop iterations we predict statically.  This is useful
6163 in cases where function contain single loop with known bound and other loop
6164 with unknown.  We predict the known number of iterations correctly, while
6165 the unknown number of iterations average to roughly 10.  This means that the
6166 loop without bounds would appear artificially cold relative to the other one.
6168 @item tracer-dynamic-coverage
6169 @itemx tracer-dynamic-coverage-feedback
6171 This value is used to limit superblock formation once the given percentage of
6172 executed instructions is covered.  This limits unnecessary code size
6173 expansion.
6175 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6176 feedback is available.  The real profiles (as opposed to statically estimated
6177 ones) are much less balanced allowing the threshold to be larger value.
6179 @item tracer-max-code-growth
6180 Stop tail duplication once code growth has reached given percentage.  This is
6181 rather hokey argument, as most of the duplicates will be eliminated later in
6182 cross jumping, so it may be set to much higher values than is the desired code
6183 growth.
6185 @item tracer-min-branch-ratio
6187 Stop reverse growth when the reverse probability of best edge is less than this
6188 threshold (in percent).
6190 @item tracer-min-branch-ratio
6191 @itemx tracer-min-branch-ratio-feedback
6193 Stop forward growth if the best edge do have probability lower than this
6194 threshold.
6196 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6197 compilation for profile feedback and one for compilation without.  The value
6198 for compilation with profile feedback needs to be more conservative (higher) in
6199 order to make tracer effective.
6201 @item max-cse-path-length
6203 Maximum number of basic blocks on path that cse considers.  The default is 10.
6205 @item max-cse-insns
6206 The maximum instructions CSE process before flushing. The default is 1000.
6208 @item max-aliased-vops
6210 Maximum number of virtual operands per statement allowed to represent
6211 aliases before triggering the alias grouping heuristic.  Alias
6212 grouping reduces compile times and memory consumption needed for
6213 aliasing at the expense of precision loss in alias information.
6215 @item ggc-min-expand
6217 GCC uses a garbage collector to manage its own memory allocation.  This
6218 parameter specifies the minimum percentage by which the garbage
6219 collector's heap should be allowed to expand between collections.
6220 Tuning this may improve compilation speed; it has no effect on code
6221 generation.
6223 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6224 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6225 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6226 GCC is not able to calculate RAM on a particular platform, the lower
6227 bound of 30% is used.  Setting this parameter and
6228 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6229 every opportunity.  This is extremely slow, but can be useful for
6230 debugging.
6232 @item ggc-min-heapsize
6234 Minimum size of the garbage collector's heap before it begins bothering
6235 to collect garbage.  The first collection occurs after the heap expands
6236 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6237 tuning this may improve compilation speed, and has no effect on code
6238 generation.
6240 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6241 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6242 with a lower bound of 4096 (four megabytes) and an upper bound of
6243 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6244 particular platform, the lower bound is used.  Setting this parameter
6245 very large effectively disables garbage collection.  Setting this
6246 parameter and @option{ggc-min-expand} to zero causes a full collection
6247 to occur at every opportunity.
6249 @item max-reload-search-insns
6250 The maximum number of instruction reload should look backward for equivalent
6251 register.  Increasing values mean more aggressive optimization, making the
6252 compile time increase with probably slightly better performance.  The default
6253 value is 100.
6255 @item max-cselib-memory-locations
6256 The maximum number of memory locations cselib should take into account.
6257 Increasing values mean more aggressive optimization, making the compile time
6258 increase with probably slightly better performance.  The default value is 500.
6260 @item max-flow-memory-locations
6261 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6262 The default value is 100.
6264 @item reorder-blocks-duplicate
6265 @itemx reorder-blocks-duplicate-feedback
6267 Used by basic block reordering pass to decide whether to use unconditional
6268 branch or duplicate the code on its destination.  Code is duplicated when its
6269 estimated size is smaller than this value multiplied by the estimated size of
6270 unconditional jump in the hot spots of the program.
6272 The @option{reorder-block-duplicate-feedback} is used only when profile
6273 feedback is available and may be set to higher values than
6274 @option{reorder-block-duplicate} since information about the hot spots is more
6275 accurate.
6277 @item max-sched-ready-insns
6278 The maximum number of instructions ready to be issued the scheduler should
6279 consider at any given time during the first scheduling pass.  Increasing
6280 values mean more thorough searches, making the compilation time increase
6281 with probably little benefit.  The default value is 100.
6283 @item max-sched-region-blocks
6284 The maximum number of blocks in a region to be considered for
6285 interblock scheduling.  The default value is 10.
6287 @item max-sched-region-insns
6288 The maximum number of insns in a region to be considered for
6289 interblock scheduling.  The default value is 100.
6291 @item min-spec-prob
6292 The minimum probability (in percents) of reaching a source block
6293 for interblock speculative scheduling.  The default value is 40.
6295 @item max-sched-extend-regions-iters
6296 The maximum number of iterations through CFG to extend regions.
6297 0 - disable region extension,
6298 N - do at most N iterations.
6299 The default value is 0.
6301 @item max-sched-insn-conflict-delay
6302 The maximum conflict delay for an insn to be considered for speculative motion.
6303 The default value is 3.
6305 @item sched-spec-prob-cutoff
6306 The minimal probability of speculation success (in percents), so that
6307 speculative insn will be scheduled.
6308 The default value is 40.
6310 @item max-last-value-rtl
6312 The maximum size measured as number of RTLs that can be recorded in an expression
6313 in combiner for a pseudo register as last known value of that register.  The default
6314 is 10000.
6316 @item integer-share-limit
6317 Small integer constants can use a shared data structure, reducing the
6318 compiler's memory usage and increasing its speed.  This sets the maximum
6319 value of a shared integer constant's.  The default value is 256.
6321 @item min-virtual-mappings
6322 Specifies the minimum number of virtual mappings in the incremental
6323 SSA updater that should be registered to trigger the virtual mappings
6324 heuristic defined by virtual-mappings-ratio.  The default value is
6325 100.
6327 @item virtual-mappings-ratio
6328 If the number of virtual mappings is virtual-mappings-ratio bigger
6329 than the number of virtual symbols to be updated, then the incremental
6330 SSA updater switches to a full update for those symbols.  The default
6331 ratio is 3.
6333 @item ssp-buffer-size
6334 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6335 protection when @option{-fstack-protection} is used.
6337 @item max-jump-thread-duplication-stmts
6338 Maximum number of statements allowed in a block that needs to be
6339 duplicated when threading jumps.
6341 @item max-fields-for-field-sensitive
6342 Maximum number of fields in a structure we will treat in
6343 a field sensitive manner during pointer analysis.
6345 @item prefetch-latency
6346 Estimate on average number of instructions that are executed before
6347 prefetch finishes.  The distance we prefetch ahead is proportional
6348 to this constant.  Increasing this number may also lead to less
6349 streams being prefetched (see @option{simultaneous-prefetches}).
6351 @item simultaneous-prefetches
6352 Maximum number of prefetches that can run at the same time.
6354 @item l1-cache-line-size
6355 The size of cache line in L1 cache, in bytes.
6357 @item l1-cache-size
6358 The number of cache lines in L1 cache.
6360 @end table
6361 @end table
6363 @node Preprocessor Options
6364 @section Options Controlling the Preprocessor
6365 @cindex preprocessor options
6366 @cindex options, preprocessor
6368 These options control the C preprocessor, which is run on each C source
6369 file before actual compilation.
6371 If you use the @option{-E} option, nothing is done except preprocessing.
6372 Some of these options make sense only together with @option{-E} because
6373 they cause the preprocessor output to be unsuitable for actual
6374 compilation.
6376 @table @gcctabopt
6377 @opindex Wp
6378 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6379 and pass @var{option} directly through to the preprocessor.  If
6380 @var{option} contains commas, it is split into multiple options at the
6381 commas.  However, many options are modified, translated or interpreted
6382 by the compiler driver before being passed to the preprocessor, and
6383 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6384 interface is undocumented and subject to change, so whenever possible
6385 you should avoid using @option{-Wp} and let the driver handle the
6386 options instead.
6388 @item -Xpreprocessor @var{option}
6389 @opindex preprocessor
6390 Pass @var{option} as an option to the preprocessor.  You can use this to
6391 supply system-specific preprocessor options which GCC does not know how to
6392 recognize.
6394 If you want to pass an option that takes an argument, you must use
6395 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6396 @end table
6398 @include cppopts.texi
6400 @node Assembler Options
6401 @section Passing Options to the Assembler
6403 @c prevent bad page break with this line
6404 You can pass options to the assembler.
6406 @table @gcctabopt
6407 @item -Wa,@var{option}
6408 @opindex Wa
6409 Pass @var{option} as an option to the assembler.  If @var{option}
6410 contains commas, it is split into multiple options at the commas.
6412 @item -Xassembler @var{option}
6413 @opindex Xassembler
6414 Pass @var{option} as an option to the assembler.  You can use this to
6415 supply system-specific assembler options which GCC does not know how to
6416 recognize.
6418 If you want to pass an option that takes an argument, you must use
6419 @option{-Xassembler} twice, once for the option and once for the argument.
6421 @end table
6423 @node Link Options
6424 @section Options for Linking
6425 @cindex link options
6426 @cindex options, linking
6428 These options come into play when the compiler links object files into
6429 an executable output file.  They are meaningless if the compiler is
6430 not doing a link step.
6432 @table @gcctabopt
6433 @cindex file names
6434 @item @var{object-file-name}
6435 A file name that does not end in a special recognized suffix is
6436 considered to name an object file or library.  (Object files are
6437 distinguished from libraries by the linker according to the file
6438 contents.)  If linking is done, these object files are used as input
6439 to the linker.
6441 @item -c
6442 @itemx -S
6443 @itemx -E
6444 @opindex c
6445 @opindex S
6446 @opindex E
6447 If any of these options is used, then the linker is not run, and
6448 object file names should not be used as arguments.  @xref{Overall
6449 Options}.
6451 @cindex Libraries
6452 @item -l@var{library}
6453 @itemx -l @var{library}
6454 @opindex l
6455 Search the library named @var{library} when linking.  (The second
6456 alternative with the library as a separate argument is only for
6457 POSIX compliance and is not recommended.)
6459 It makes a difference where in the command you write this option; the
6460 linker searches and processes libraries and object files in the order they
6461 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6462 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6463 to functions in @samp{z}, those functions may not be loaded.
6465 The linker searches a standard list of directories for the library,
6466 which is actually a file named @file{lib@var{library}.a}.  The linker
6467 then uses this file as if it had been specified precisely by name.
6469 The directories searched include several standard system directories
6470 plus any that you specify with @option{-L}.
6472 Normally the files found this way are library files---archive files
6473 whose members are object files.  The linker handles an archive file by
6474 scanning through it for members which define symbols that have so far
6475 been referenced but not defined.  But if the file that is found is an
6476 ordinary object file, it is linked in the usual fashion.  The only
6477 difference between using an @option{-l} option and specifying a file name
6478 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6479 and searches several directories.
6481 @item -lobjc
6482 @opindex lobjc
6483 You need this special case of the @option{-l} option in order to
6484 link an Objective-C or Objective-C++ program.
6486 @item -nostartfiles
6487 @opindex nostartfiles
6488 Do not use the standard system startup files when linking.
6489 The standard system libraries are used normally, unless @option{-nostdlib}
6490 or @option{-nodefaultlibs} is used.
6492 @item -nodefaultlibs
6493 @opindex nodefaultlibs
6494 Do not use the standard system libraries when linking.
6495 Only the libraries you specify will be passed to the linker.
6496 The standard startup files are used normally, unless @option{-nostartfiles}
6497 is used.  The compiler may generate calls to @code{memcmp},
6498 @code{memset}, @code{memcpy} and @code{memmove}.
6499 These entries are usually resolved by entries in
6500 libc.  These entry points should be supplied through some other
6501 mechanism when this option is specified.
6503 @item -nostdlib
6504 @opindex nostdlib
6505 Do not use the standard system startup files or libraries when linking.
6506 No startup files and only the libraries you specify will be passed to
6507 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6508 @code{memcpy} and @code{memmove}.
6509 These entries are usually resolved by entries in
6510 libc.  These entry points should be supplied through some other
6511 mechanism when this option is specified.
6513 @cindex @option{-lgcc}, use with @option{-nostdlib}
6514 @cindex @option{-nostdlib} and unresolved references
6515 @cindex unresolved references and @option{-nostdlib}
6516 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6517 @cindex @option{-nodefaultlibs} and unresolved references
6518 @cindex unresolved references and @option{-nodefaultlibs}
6519 One of the standard libraries bypassed by @option{-nostdlib} and
6520 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6521 that GCC uses to overcome shortcomings of particular machines, or special
6522 needs for some languages.
6523 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6524 Collection (GCC) Internals},
6525 for more discussion of @file{libgcc.a}.)
6526 In most cases, you need @file{libgcc.a} even when you want to avoid
6527 other standard libraries.  In other words, when you specify @option{-nostdlib}
6528 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6529 This ensures that you have no unresolved references to internal GCC
6530 library subroutines.  (For example, @samp{__main}, used to ensure C++
6531 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6532 GNU Compiler Collection (GCC) Internals}.)
6534 @item -pie
6535 @opindex pie
6536 Produce a position independent executable on targets which support it.
6537 For predictable results, you must also specify the same set of options
6538 that were used to generate code (@option{-fpie}, @option{-fPIE},
6539 or model suboptions) when you specify this option.
6541 @item -rdynamic
6542 @opindex rdynamic
6543 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6544 that support it. This instructs the linker to add all symbols, not
6545 only used ones, to the dynamic symbol table. This option is needed
6546 for some uses of @code{dlopen} or to allow obtaining backtraces
6547 from within a program.
6549 @item -s
6550 @opindex s
6551 Remove all symbol table and relocation information from the executable.
6553 @item -static
6554 @opindex static
6555 On systems that support dynamic linking, this prevents linking with the shared
6556 libraries.  On other systems, this option has no effect.
6558 @item -shared
6559 @opindex shared
6560 Produce a shared object which can then be linked with other objects to
6561 form an executable.  Not all systems support this option.  For predictable
6562 results, you must also specify the same set of options that were used to
6563 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6564 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6565 needs to build supplementary stub code for constructors to work.  On
6566 multi-libbed systems, @samp{gcc -shared} must select the correct support
6567 libraries to link against.  Failing to supply the correct flags may lead
6568 to subtle defects.  Supplying them in cases where they are not necessary
6569 is innocuous.}
6571 @item -shared-libgcc
6572 @itemx -static-libgcc
6573 @opindex shared-libgcc
6574 @opindex static-libgcc
6575 On systems that provide @file{libgcc} as a shared library, these options
6576 force the use of either the shared or static version respectively.
6577 If no shared version of @file{libgcc} was built when the compiler was
6578 configured, these options have no effect.
6580 There are several situations in which an application should use the
6581 shared @file{libgcc} instead of the static version.  The most common
6582 of these is when the application wishes to throw and catch exceptions
6583 across different shared libraries.  In that case, each of the libraries
6584 as well as the application itself should use the shared @file{libgcc}.
6586 Therefore, the G++ and GCJ drivers automatically add
6587 @option{-shared-libgcc} whenever you build a shared library or a main
6588 executable, because C++ and Java programs typically use exceptions, so
6589 this is the right thing to do.
6591 If, instead, you use the GCC driver to create shared libraries, you may
6592 find that they will not always be linked with the shared @file{libgcc}.
6593 If GCC finds, at its configuration time, that you have a non-GNU linker
6594 or a GNU linker that does not support option @option{--eh-frame-hdr},
6595 it will link the shared version of @file{libgcc} into shared libraries
6596 by default.  Otherwise, it will take advantage of the linker and optimize
6597 away the linking with the shared version of @file{libgcc}, linking with
6598 the static version of libgcc by default.  This allows exceptions to
6599 propagate through such shared libraries, without incurring relocation
6600 costs at library load time.
6602 However, if a library or main executable is supposed to throw or catch
6603 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6604 for the languages used in the program, or using the option
6605 @option{-shared-libgcc}, such that it is linked with the shared
6606 @file{libgcc}.
6608 @item -symbolic
6609 @opindex symbolic
6610 Bind references to global symbols when building a shared object.  Warn
6611 about any unresolved references (unless overridden by the link editor
6612 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6613 this option.
6615 @item -Xlinker @var{option}
6616 @opindex Xlinker
6617 Pass @var{option} as an option to the linker.  You can use this to
6618 supply system-specific linker options which GCC does not know how to
6619 recognize.
6621 If you want to pass an option that takes an argument, you must use
6622 @option{-Xlinker} twice, once for the option and once for the argument.
6623 For example, to pass @option{-assert definitions}, you must write
6624 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6625 @option{-Xlinker "-assert definitions"}, because this passes the entire
6626 string as a single argument, which is not what the linker expects.
6628 @item -Wl,@var{option}
6629 @opindex Wl
6630 Pass @var{option} as an option to the linker.  If @var{option} contains
6631 commas, it is split into multiple options at the commas.
6633 @item -u @var{symbol}
6634 @opindex u
6635 Pretend the symbol @var{symbol} is undefined, to force linking of
6636 library modules to define it.  You can use @option{-u} multiple times with
6637 different symbols to force loading of additional library modules.
6638 @end table
6640 @node Directory Options
6641 @section Options for Directory Search
6642 @cindex directory options
6643 @cindex options, directory search
6644 @cindex search path
6646 These options specify directories to search for header files, for
6647 libraries and for parts of the compiler:
6649 @table @gcctabopt
6650 @item -I@var{dir}
6651 @opindex I
6652 Add the directory @var{dir} to the head of the list of directories to be
6653 searched for header files.  This can be used to override a system header
6654 file, substituting your own version, since these directories are
6655 searched before the system header file directories.  However, you should
6656 not use this option to add directories that contain vendor-supplied
6657 system header files (use @option{-isystem} for that).  If you use more than
6658 one @option{-I} option, the directories are scanned in left-to-right
6659 order; the standard system directories come after.
6661 If a standard system include directory, or a directory specified with
6662 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6663 option will be ignored.  The directory will still be searched but as a
6664 system directory at its normal position in the system include chain.
6665 This is to ensure that GCC's procedure to fix buggy system headers and
6666 the ordering for the include_next directive are not inadvertently changed.
6667 If you really need to change the search order for system directories,
6668 use the @option{-nostdinc} and/or @option{-isystem} options.
6670 @item -iquote@var{dir}
6671 @opindex iquote
6672 Add the directory @var{dir} to the head of the list of directories to
6673 be searched for header files only for the case of @samp{#include
6674 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6675 otherwise just like @option{-I}.
6677 @item -L@var{dir}
6678 @opindex L
6679 Add directory @var{dir} to the list of directories to be searched
6680 for @option{-l}.
6682 @item -B@var{prefix}
6683 @opindex B
6684 This option specifies where to find the executables, libraries,
6685 include files, and data files of the compiler itself.
6687 The compiler driver program runs one or more of the subprograms
6688 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6689 @var{prefix} as a prefix for each program it tries to run, both with and
6690 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6692 For each subprogram to be run, the compiler driver first tries the
6693 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6694 was not specified, the driver tries two standard prefixes, which are
6695 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6696 those results in a file name that is found, the unmodified program
6697 name is searched for using the directories specified in your
6698 @env{PATH} environment variable.
6700 The compiler will check to see if the path provided by the @option{-B}
6701 refers to a directory, and if necessary it will add a directory
6702 separator character at the end of the path.
6704 @option{-B} prefixes that effectively specify directory names also apply
6705 to libraries in the linker, because the compiler translates these
6706 options into @option{-L} options for the linker.  They also apply to
6707 includes files in the preprocessor, because the compiler translates these
6708 options into @option{-isystem} options for the preprocessor.  In this case,
6709 the compiler appends @samp{include} to the prefix.
6711 The run-time support file @file{libgcc.a} can also be searched for using
6712 the @option{-B} prefix, if needed.  If it is not found there, the two
6713 standard prefixes above are tried, and that is all.  The file is left
6714 out of the link if it is not found by those means.
6716 Another way to specify a prefix much like the @option{-B} prefix is to use
6717 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6718 Variables}.
6720 As a special kludge, if the path provided by @option{-B} is
6721 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6722 9, then it will be replaced by @file{[dir/]include}.  This is to help
6723 with boot-strapping the compiler.
6725 @item -specs=@var{file}
6726 @opindex specs
6727 Process @var{file} after the compiler reads in the standard @file{specs}
6728 file, in order to override the defaults that the @file{gcc} driver
6729 program uses when determining what switches to pass to @file{cc1},
6730 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6731 @option{-specs=@var{file}} can be specified on the command line, and they
6732 are processed in order, from left to right.
6734 @item --sysroot=@var{dir}
6735 @opindex sysroot
6736 Use @var{dir} as the logical root directory for headers and libraries.
6737 For example, if the compiler would normally search for headers in
6738 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6739 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6741 If you use both this option and the @option{-isysroot} option, then
6742 the @option{--sysroot} option will apply to libraries, but the
6743 @option{-isysroot} option will apply to header files.
6745 The GNU linker (beginning with version 2.16) has the necessary support
6746 for this option.  If your linker does not support this option, the
6747 header file aspect of @option{--sysroot} will still work, but the
6748 library aspect will not.
6750 @item -I-
6751 @opindex I-
6752 This option has been deprecated.  Please use @option{-iquote} instead for
6753 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6754 Any directories you specify with @option{-I} options before the @option{-I-}
6755 option are searched only for the case of @samp{#include "@var{file}"};
6756 they are not searched for @samp{#include <@var{file}>}.
6758 If additional directories are specified with @option{-I} options after
6759 the @option{-I-}, these directories are searched for all @samp{#include}
6760 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6761 this way.)
6763 In addition, the @option{-I-} option inhibits the use of the current
6764 directory (where the current input file came from) as the first search
6765 directory for @samp{#include "@var{file}"}.  There is no way to
6766 override this effect of @option{-I-}.  With @option{-I.} you can specify
6767 searching the directory which was current when the compiler was
6768 invoked.  That is not exactly the same as what the preprocessor does
6769 by default, but it is often satisfactory.
6771 @option{-I-} does not inhibit the use of the standard system directories
6772 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6773 independent.
6774 @end table
6776 @c man end
6778 @node Spec Files
6779 @section Specifying subprocesses and the switches to pass to them
6780 @cindex Spec Files
6782 @command{gcc} is a driver program.  It performs its job by invoking a
6783 sequence of other programs to do the work of compiling, assembling and
6784 linking.  GCC interprets its command-line parameters and uses these to
6785 deduce which programs it should invoke, and which command-line options
6786 it ought to place on their command lines.  This behavior is controlled
6787 by @dfn{spec strings}.  In most cases there is one spec string for each
6788 program that GCC can invoke, but a few programs have multiple spec
6789 strings to control their behavior.  The spec strings built into GCC can
6790 be overridden by using the @option{-specs=} command-line switch to specify
6791 a spec file.
6793 @dfn{Spec files} are plaintext files that are used to construct spec
6794 strings.  They consist of a sequence of directives separated by blank
6795 lines.  The type of directive is determined by the first non-whitespace
6796 character on the line and it can be one of the following:
6798 @table @code
6799 @item %@var{command}
6800 Issues a @var{command} to the spec file processor.  The commands that can
6801 appear here are:
6803 @table @code
6804 @item %include <@var{file}>
6805 @cindex %include
6806 Search for @var{file} and insert its text at the current point in the
6807 specs file.
6809 @item %include_noerr <@var{file}>
6810 @cindex %include_noerr
6811 Just like @samp{%include}, but do not generate an error message if the include
6812 file cannot be found.
6814 @item %rename @var{old_name} @var{new_name}
6815 @cindex %rename
6816 Rename the spec string @var{old_name} to @var{new_name}.
6818 @end table
6820 @item *[@var{spec_name}]:
6821 This tells the compiler to create, override or delete the named spec
6822 string.  All lines after this directive up to the next directive or
6823 blank line are considered to be the text for the spec string.  If this
6824 results in an empty string then the spec will be deleted.  (Or, if the
6825 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6826 does not currently exist a new spec will be created.  If the spec does
6827 exist then its contents will be overridden by the text of this
6828 directive, unless the first character of that text is the @samp{+}
6829 character, in which case the text will be appended to the spec.
6831 @item [@var{suffix}]:
6832 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6833 and up to the next directive or blank line are considered to make up the
6834 spec string for the indicated suffix.  When the compiler encounters an
6835 input file with the named suffix, it will processes the spec string in
6836 order to work out how to compile that file.  For example:
6838 @smallexample
6839 .ZZ:
6840 z-compile -input %i
6841 @end smallexample
6843 This says that any input file whose name ends in @samp{.ZZ} should be
6844 passed to the program @samp{z-compile}, which should be invoked with the
6845 command-line switch @option{-input} and with the result of performing the
6846 @samp{%i} substitution.  (See below.)
6848 As an alternative to providing a spec string, the text that follows a
6849 suffix directive can be one of the following:
6851 @table @code
6852 @item @@@var{language}
6853 This says that the suffix is an alias for a known @var{language}.  This is
6854 similar to using the @option{-x} command-line switch to GCC to specify a
6855 language explicitly.  For example:
6857 @smallexample
6858 .ZZ:
6859 @@c++
6860 @end smallexample
6862 Says that .ZZ files are, in fact, C++ source files.
6864 @item #@var{name}
6865 This causes an error messages saying:
6867 @smallexample
6868 @var{name} compiler not installed on this system.
6869 @end smallexample
6870 @end table
6872 GCC already has an extensive list of suffixes built into it.
6873 This directive will add an entry to the end of the list of suffixes, but
6874 since the list is searched from the end backwards, it is effectively
6875 possible to override earlier entries using this technique.
6877 @end table
6879 GCC has the following spec strings built into it.  Spec files can
6880 override these strings or create their own.  Note that individual
6881 targets can also add their own spec strings to this list.
6883 @smallexample
6884 asm          Options to pass to the assembler
6885 asm_final    Options to pass to the assembler post-processor
6886 cpp          Options to pass to the C preprocessor
6887 cc1          Options to pass to the C compiler
6888 cc1plus      Options to pass to the C++ compiler
6889 endfile      Object files to include at the end of the link
6890 link         Options to pass to the linker
6891 lib          Libraries to include on the command line to the linker
6892 libgcc       Decides which GCC support library to pass to the linker
6893 linker       Sets the name of the linker
6894 predefines   Defines to be passed to the C preprocessor
6895 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6896              by default
6897 startfile    Object files to include at the start of the link
6898 @end smallexample
6900 Here is a small example of a spec file:
6902 @smallexample
6903 %rename lib                 old_lib
6905 *lib:
6906 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6907 @end smallexample
6909 This example renames the spec called @samp{lib} to @samp{old_lib} and
6910 then overrides the previous definition of @samp{lib} with a new one.
6911 The new definition adds in some extra command-line options before
6912 including the text of the old definition.
6914 @dfn{Spec strings} are a list of command-line options to be passed to their
6915 corresponding program.  In addition, the spec strings can contain
6916 @samp{%}-prefixed sequences to substitute variable text or to
6917 conditionally insert text into the command line.  Using these constructs
6918 it is possible to generate quite complex command lines.
6920 Here is a table of all defined @samp{%}-sequences for spec
6921 strings.  Note that spaces are not generated automatically around the
6922 results of expanding these sequences.  Therefore you can concatenate them
6923 together or combine them with constant text in a single argument.
6925 @table @code
6926 @item %%
6927 Substitute one @samp{%} into the program name or argument.
6929 @item %i
6930 Substitute the name of the input file being processed.
6932 @item %b
6933 Substitute the basename of the input file being processed.
6934 This is the substring up to (and not including) the last period
6935 and not including the directory.
6937 @item %B
6938 This is the same as @samp{%b}, but include the file suffix (text after
6939 the last period).
6941 @item %d
6942 Marks the argument containing or following the @samp{%d} as a
6943 temporary file name, so that that file will be deleted if GCC exits
6944 successfully.  Unlike @samp{%g}, this contributes no text to the
6945 argument.
6947 @item %g@var{suffix}
6948 Substitute a file name that has suffix @var{suffix} and is chosen
6949 once per compilation, and mark the argument in the same way as
6950 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6951 name is now chosen in a way that is hard to predict even when previously
6952 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6953 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6954 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6955 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6956 was simply substituted with a file name chosen once per compilation,
6957 without regard to any appended suffix (which was therefore treated
6958 just like ordinary text), making such attacks more likely to succeed.
6960 @item %u@var{suffix}
6961 Like @samp{%g}, but generates a new temporary file name even if
6962 @samp{%u@var{suffix}} was already seen.
6964 @item %U@var{suffix}
6965 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6966 new one if there is no such last file name.  In the absence of any
6967 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6968 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6969 would involve the generation of two distinct file names, one
6970 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6971 simply substituted with a file name chosen for the previous @samp{%u},
6972 without regard to any appended suffix.
6974 @item %j@var{suffix}
6975 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6976 writable, and if save-temps is off; otherwise, substitute the name
6977 of a temporary file, just like @samp{%u}.  This temporary file is not
6978 meant for communication between processes, but rather as a junk
6979 disposal mechanism.
6981 @item %|@var{suffix}
6982 @itemx %m@var{suffix}
6983 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6984 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6985 all.  These are the two most common ways to instruct a program that it
6986 should read from standard input or write to standard output.  If you
6987 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6988 construct: see for example @file{f/lang-specs.h}.
6990 @item %.@var{SUFFIX}
6991 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6992 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6993 terminated by the next space or %.
6995 @item %w
6996 Marks the argument containing or following the @samp{%w} as the
6997 designated output file of this compilation.  This puts the argument
6998 into the sequence of arguments that @samp{%o} will substitute later.
7000 @item %o
7001 Substitutes the names of all the output files, with spaces
7002 automatically placed around them.  You should write spaces
7003 around the @samp{%o} as well or the results are undefined.
7004 @samp{%o} is for use in the specs for running the linker.
7005 Input files whose names have no recognized suffix are not compiled
7006 at all, but they are included among the output files, so they will
7007 be linked.
7009 @item %O
7010 Substitutes the suffix for object files.  Note that this is
7011 handled specially when it immediately follows @samp{%g, %u, or %U},
7012 because of the need for those to form complete file names.  The
7013 handling is such that @samp{%O} is treated exactly as if it had already
7014 been substituted, except that @samp{%g, %u, and %U} do not currently
7015 support additional @var{suffix} characters following @samp{%O} as they would
7016 following, for example, @samp{.o}.
7018 @item %p
7019 Substitutes the standard macro predefinitions for the
7020 current target machine.  Use this when running @code{cpp}.
7022 @item %P
7023 Like @samp{%p}, but puts @samp{__} before and after the name of each
7024 predefined macro, except for macros that start with @samp{__} or with
7025 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7028 @item %I
7029 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7030 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7031 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7032 and @option{-imultilib} as necessary.
7034 @item %s
7035 Current argument is the name of a library or startup file of some sort.
7036 Search for that file in a standard list of directories and substitute
7037 the full name found.
7039 @item %e@var{str}
7040 Print @var{str} as an error message.  @var{str} is terminated by a newline.
7041 Use this when inconsistent options are detected.
7043 @item %(@var{name})
7044 Substitute the contents of spec string @var{name} at this point.
7046 @item %[@var{name}]
7047 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7049 @item %x@{@var{option}@}
7050 Accumulate an option for @samp{%X}.
7052 @item %X
7053 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7054 spec string.
7056 @item %Y
7057 Output the accumulated assembler options specified by @option{-Wa}.
7059 @item %Z
7060 Output the accumulated preprocessor options specified by @option{-Wp}.
7062 @item %a
7063 Process the @code{asm} spec.  This is used to compute the
7064 switches to be passed to the assembler.
7066 @item %A
7067 Process the @code{asm_final} spec.  This is a spec string for
7068 passing switches to an assembler post-processor, if such a program is
7069 needed.
7071 @item %l
7072 Process the @code{link} spec.  This is the spec for computing the
7073 command line passed to the linker.  Typically it will make use of the
7074 @samp{%L %G %S %D and %E} sequences.
7076 @item %D
7077 Dump out a @option{-L} option for each directory that GCC believes might
7078 contain startup files.  If the target supports multilibs then the
7079 current multilib directory will be prepended to each of these paths.
7081 @item %L
7082 Process the @code{lib} spec.  This is a spec string for deciding which
7083 libraries should be included on the command line to the linker.
7085 @item %G
7086 Process the @code{libgcc} spec.  This is a spec string for deciding
7087 which GCC support library should be included on the command line to the linker.
7089 @item %S
7090 Process the @code{startfile} spec.  This is a spec for deciding which
7091 object files should be the first ones passed to the linker.  Typically
7092 this might be a file named @file{crt0.o}.
7094 @item %E
7095 Process the @code{endfile} spec.  This is a spec string that specifies
7096 the last object files that will be passed to the linker.
7098 @item %C
7099 Process the @code{cpp} spec.  This is used to construct the arguments
7100 to be passed to the C preprocessor.
7102 @item %1
7103 Process the @code{cc1} spec.  This is used to construct the options to be
7104 passed to the actual C compiler (@samp{cc1}).
7106 @item %2
7107 Process the @code{cc1plus} spec.  This is used to construct the options to be
7108 passed to the actual C++ compiler (@samp{cc1plus}).
7110 @item %*
7111 Substitute the variable part of a matched option.  See below.
7112 Note that each comma in the substituted string is replaced by
7113 a single space.
7115 @item %<@code{S}
7116 Remove all occurrences of @code{-S} from the command line.  Note---this
7117 command is position dependent.  @samp{%} commands in the spec string
7118 before this one will see @code{-S}, @samp{%} commands in the spec string
7119 after this one will not.
7121 @item %:@var{function}(@var{args})
7122 Call the named function @var{function}, passing it @var{args}.
7123 @var{args} is first processed as a nested spec string, then split
7124 into an argument vector in the usual fashion.  The function returns
7125 a string which is processed as if it had appeared literally as part
7126 of the current spec.
7128 The following built-in spec functions are provided:
7130 @table @code
7131 @item @code{if-exists}
7132 The @code{if-exists} spec function takes one argument, an absolute
7133 pathname to a file.  If the file exists, @code{if-exists} returns the
7134 pathname.  Here is a small example of its usage:
7136 @smallexample
7137 *startfile:
7138 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7139 @end smallexample
7141 @item @code{if-exists-else}
7142 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7143 spec function, except that it takes two arguments.  The first argument is
7144 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7145 returns the pathname.  If it does not exist, it returns the second argument.
7146 This way, @code{if-exists-else} can be used to select one file or another,
7147 based on the existence of the first.  Here is a small example of its usage:
7149 @smallexample
7150 *startfile:
7151 crt0%O%s %:if-exists(crti%O%s) \
7152 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7153 @end smallexample
7155 @item @code{replace-outfile}
7156 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7157 first argument in the outfiles array and replaces it with the second argument.  Here
7158 is a small example of its usage:
7160 @smallexample
7161 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7162 @end smallexample
7164 @end table
7166 @item %@{@code{S}@}
7167 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7168 If that switch was not specified, this substitutes nothing.  Note that
7169 the leading dash is omitted when specifying this option, and it is
7170 automatically inserted if the substitution is performed.  Thus the spec
7171 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7172 and would output the command line option @option{-foo}.
7174 @item %W@{@code{S}@}
7175 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7176 deleted on failure.
7178 @item %@{@code{S}*@}
7179 Substitutes all the switches specified to GCC whose names start
7180 with @code{-S}, but which also take an argument.  This is used for
7181 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7182 GCC considers @option{-o foo} as being
7183 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7184 text, including the space.  Thus two arguments would be generated.
7186 @item %@{@code{S}*&@code{T}*@}
7187 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7188 (the order of @code{S} and @code{T} in the spec is not significant).
7189 There can be any number of ampersand-separated variables; for each the
7190 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7192 @item %@{@code{S}:@code{X}@}
7193 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7195 @item %@{!@code{S}:@code{X}@}
7196 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7198 @item %@{@code{S}*:@code{X}@}
7199 Substitutes @code{X} if one or more switches whose names start with
7200 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7201 once, no matter how many such switches appeared.  However, if @code{%*}
7202 appears somewhere in @code{X}, then @code{X} will be substituted once
7203 for each matching switch, with the @code{%*} replaced by the part of
7204 that switch that matched the @code{*}.
7206 @item %@{.@code{S}:@code{X}@}
7207 Substitutes @code{X}, if processing a file with suffix @code{S}.
7209 @item %@{!.@code{S}:@code{X}@}
7210 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7212 @item %@{@code{S}|@code{P}:@code{X}@}
7213 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7214 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7215 although they have a stronger binding than the @samp{|}.  If @code{%*}
7216 appears in @code{X}, all of the alternatives must be starred, and only
7217 the first matching alternative is substituted.
7219 For example, a spec string like this:
7221 @smallexample
7222 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7223 @end smallexample
7225 will output the following command-line options from the following input
7226 command-line options:
7228 @smallexample
7229 fred.c        -foo -baz
7230 jim.d         -bar -boggle
7231 -d fred.c     -foo -baz -boggle
7232 -d jim.d      -bar -baz -boggle
7233 @end smallexample
7235 @item %@{S:X; T:Y; :D@}
7237 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7238 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7239 be as many clauses as you need.  This may be combined with @code{.},
7240 @code{!}, @code{|}, and @code{*} as needed.
7243 @end table
7245 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7246 construct may contain other nested @samp{%} constructs or spaces, or
7247 even newlines.  They are processed as usual, as described above.
7248 Trailing white space in @code{X} is ignored.  White space may also
7249 appear anywhere on the left side of the colon in these constructs,
7250 except between @code{.} or @code{*} and the corresponding word.
7252 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7253 handled specifically in these constructs.  If another value of
7254 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7255 @option{-W} switch is found later in the command line, the earlier
7256 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7257 just one letter, which passes all matching options.
7259 The character @samp{|} at the beginning of the predicate text is used to
7260 indicate that a command should be piped to the following command, but
7261 only if @option{-pipe} is specified.
7263 It is built into GCC which switches take arguments and which do not.
7264 (You might think it would be useful to generalize this to allow each
7265 compiler's spec to say which switches take arguments.  But this cannot
7266 be done in a consistent fashion.  GCC cannot even decide which input
7267 files have been specified without knowing which switches take arguments,
7268 and it must know which input files to compile in order to tell which
7269 compilers to run).
7271 GCC also knows implicitly that arguments starting in @option{-l} are to be
7272 treated as compiler output files, and passed to the linker in their
7273 proper position among the other output files.
7275 @c man begin OPTIONS
7277 @node Target Options
7278 @section Specifying Target Machine and Compiler Version
7279 @cindex target options
7280 @cindex cross compiling
7281 @cindex specifying machine version
7282 @cindex specifying compiler version and target machine
7283 @cindex compiler version, specifying
7284 @cindex target machine, specifying
7286 The usual way to run GCC is to run the executable called @file{gcc}, or
7287 @file{<machine>-gcc} when cross-compiling, or
7288 @file{<machine>-gcc-<version>} to run a version other than the one that
7289 was installed last.  Sometimes this is inconvenient, so GCC provides
7290 options that will switch to another cross-compiler or version.
7292 @table @gcctabopt
7293 @item -b @var{machine}
7294 @opindex b
7295 The argument @var{machine} specifies the target machine for compilation.
7297 The value to use for @var{machine} is the same as was specified as the
7298 machine type when configuring GCC as a cross-compiler.  For
7299 example, if a cross-compiler was configured with @samp{configure
7300 arm-elf}, meaning to compile for an arm processor with elf binaries,
7301 then you would specify @option{-b arm-elf} to run that cross compiler.
7302 Because there are other options beginning with @option{-b}, the
7303 configuration must contain a hyphen. 
7305 @item -V @var{version}
7306 @opindex V
7307 The argument @var{version} specifies which version of GCC to run.
7308 This is useful when multiple versions are installed.  For example,
7309 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7310 @end table
7312 The @option{-V} and @option{-b} options work by running the
7313 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7314 use them if you can just run that directly.
7316 @node Submodel Options
7317 @section Hardware Models and Configurations
7318 @cindex submodel options
7319 @cindex specifying hardware config
7320 @cindex hardware models and configurations, specifying
7321 @cindex machine dependent options
7323 Earlier we discussed the standard option @option{-b} which chooses among
7324 different installed compilers for completely different target
7325 machines, such as VAX vs.@: 68000 vs.@: 80386.
7327 In addition, each of these target machine types can have its own
7328 special options, starting with @samp{-m}, to choose among various
7329 hardware models or configurations---for example, 68010 vs 68020,
7330 floating coprocessor or none.  A single installed version of the
7331 compiler can compile for any model or configuration, according to the
7332 options specified.
7334 Some configurations of the compiler also support additional special
7335 options, usually for compatibility with other compilers on the same
7336 platform.
7338 @c This list is ordered alphanumerically by subsection name.
7339 @c It should be the same order and spelling as these options are listed
7340 @c in Machine Dependent Options
7342 @menu
7343 * ARC Options::
7344 * ARM Options::
7345 * AVR Options::
7346 * Blackfin Options::
7347 * CRIS Options::
7348 * CRX Options::
7349 * Darwin Options::
7350 * DEC Alpha Options::
7351 * DEC Alpha/VMS Options::
7352 * FRV Options::
7353 * GNU/Linux Options::
7354 * H8/300 Options::
7355 * HPPA Options::
7356 * i386 and x86-64 Options::
7357 * IA-64 Options::
7358 * M32C Options::
7359 * M32R/D Options::
7360 * M680x0 Options::
7361 * M68hc1x Options::
7362 * MCore Options::
7363 * MIPS Options::
7364 * MMIX Options::
7365 * MN10300 Options::
7366 * MT Options::
7367 * PDP-11 Options::
7368 * PowerPC Options::
7369 * RS/6000 and PowerPC Options::
7370 * S/390 and zSeries Options::
7371 * Score Options::
7372 * SH Options::
7373 * SPARC Options::
7374 * SPU Options::
7375 * System V Options::
7376 * TMS320C3x/C4x Options::
7377 * V850 Options::
7378 * VAX Options::
7379 * x86-64 Options::
7380 * Xstormy16 Options::
7381 * Xtensa Options::
7382 * zSeries Options::
7383 @end menu
7385 @node ARC Options
7386 @subsection ARC Options
7387 @cindex ARC Options
7389 These options are defined for ARC implementations:
7391 @table @gcctabopt
7392 @item -EL
7393 @opindex EL
7394 Compile code for little endian mode.  This is the default.
7396 @item -EB
7397 @opindex EB
7398 Compile code for big endian mode.
7400 @item -mmangle-cpu
7401 @opindex mmangle-cpu
7402 Prepend the name of the cpu to all public symbol names.
7403 In multiple-processor systems, there are many ARC variants with different
7404 instruction and register set characteristics.  This flag prevents code
7405 compiled for one cpu to be linked with code compiled for another.
7406 No facility exists for handling variants that are ``almost identical''.
7407 This is an all or nothing option.
7409 @item -mcpu=@var{cpu}
7410 @opindex mcpu
7411 Compile code for ARC variant @var{cpu}.
7412 Which variants are supported depend on the configuration.
7413 All variants support @option{-mcpu=base}, this is the default.
7415 @item -mtext=@var{text-section}
7416 @itemx -mdata=@var{data-section}
7417 @itemx -mrodata=@var{readonly-data-section}
7418 @opindex mtext
7419 @opindex mdata
7420 @opindex mrodata
7421 Put functions, data, and readonly data in @var{text-section},
7422 @var{data-section}, and @var{readonly-data-section} respectively
7423 by default.  This can be overridden with the @code{section} attribute.
7424 @xref{Variable Attributes}.
7426 @end table
7428 @node ARM Options
7429 @subsection ARM Options
7430 @cindex ARM options
7432 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7433 architectures:
7435 @table @gcctabopt
7436 @item -mabi=@var{name}
7437 @opindex mabi
7438 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7439 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7441 @item -mapcs-frame
7442 @opindex mapcs-frame
7443 Generate a stack frame that is compliant with the ARM Procedure Call
7444 Standard for all functions, even if this is not strictly necessary for
7445 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7446 with this option will cause the stack frames not to be generated for
7447 leaf functions.  The default is @option{-mno-apcs-frame}.
7449 @item -mapcs
7450 @opindex mapcs
7451 This is a synonym for @option{-mapcs-frame}.
7453 @ignore
7454 @c not currently implemented
7455 @item -mapcs-stack-check
7456 @opindex mapcs-stack-check
7457 Generate code to check the amount of stack space available upon entry to
7458 every function (that actually uses some stack space).  If there is
7459 insufficient space available then either the function
7460 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7461 called, depending upon the amount of stack space required.  The run time
7462 system is required to provide these functions.  The default is
7463 @option{-mno-apcs-stack-check}, since this produces smaller code.
7465 @c not currently implemented
7466 @item -mapcs-float
7467 @opindex mapcs-float
7468 Pass floating point arguments using the float point registers.  This is
7469 one of the variants of the APCS@.  This option is recommended if the
7470 target hardware has a floating point unit or if a lot of floating point
7471 arithmetic is going to be performed by the code.  The default is
7472 @option{-mno-apcs-float}, since integer only code is slightly increased in
7473 size if @option{-mapcs-float} is used.
7475 @c not currently implemented
7476 @item -mapcs-reentrant
7477 @opindex mapcs-reentrant
7478 Generate reentrant, position independent code.  The default is
7479 @option{-mno-apcs-reentrant}.
7480 @end ignore
7482 @item -mthumb-interwork
7483 @opindex mthumb-interwork
7484 Generate code which supports calling between the ARM and Thumb
7485 instruction sets.  Without this option the two instruction sets cannot
7486 be reliably used inside one program.  The default is
7487 @option{-mno-thumb-interwork}, since slightly larger code is generated
7488 when @option{-mthumb-interwork} is specified.
7490 @item -mno-sched-prolog
7491 @opindex mno-sched-prolog
7492 Prevent the reordering of instructions in the function prolog, or the
7493 merging of those instruction with the instructions in the function's
7494 body.  This means that all functions will start with a recognizable set
7495 of instructions (or in fact one of a choice from a small set of
7496 different function prologues), and this information can be used to
7497 locate the start if functions inside an executable piece of code.  The
7498 default is @option{-msched-prolog}.
7500 @item -mhard-float
7501 @opindex mhard-float
7502 Generate output containing floating point instructions.  This is the
7503 default.
7505 @item -msoft-float
7506 @opindex msoft-float
7507 Generate output containing library calls for floating point.
7508 @strong{Warning:} the requisite libraries are not available for all ARM
7509 targets.  Normally the facilities of the machine's usual C compiler are
7510 used, but this cannot be done directly in cross-compilation.  You must make
7511 your own arrangements to provide suitable library functions for
7512 cross-compilation.
7514 @option{-msoft-float} changes the calling convention in the output file;
7515 therefore, it is only useful if you compile @emph{all} of a program with
7516 this option.  In particular, you need to compile @file{libgcc.a}, the
7517 library that comes with GCC, with @option{-msoft-float} in order for
7518 this to work.
7520 @item -mfloat-abi=@var{name}
7521 @opindex mfloat-abi
7522 Specifies which ABI to use for floating point values.  Permissible values
7523 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7525 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7526 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7527 of floating point instructions, but still uses the soft-float calling
7528 conventions.
7530 @item -mlittle-endian
7531 @opindex mlittle-endian
7532 Generate code for a processor running in little-endian mode.  This is
7533 the default for all standard configurations.
7535 @item -mbig-endian
7536 @opindex mbig-endian
7537 Generate code for a processor running in big-endian mode; the default is
7538 to compile code for a little-endian processor.
7540 @item -mwords-little-endian
7541 @opindex mwords-little-endian
7542 This option only applies when generating code for big-endian processors.
7543 Generate code for a little-endian word order but a big-endian byte
7544 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7545 option should only be used if you require compatibility with code for
7546 big-endian ARM processors generated by versions of the compiler prior to
7547 2.8.
7549 @item -mcpu=@var{name}
7550 @opindex mcpu
7551 This specifies the name of the target ARM processor.  GCC uses this name
7552 to determine what kind of instructions it can emit when generating
7553 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7554 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7555 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7556 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7557 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7558 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7559 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7560 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7561 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7562 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7563 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7564 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7565 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7566 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7567 @samp{ep9312}.
7569 @itemx -mtune=@var{name}
7570 @opindex mtune
7571 This option is very similar to the @option{-mcpu=} option, except that
7572 instead of specifying the actual target processor type, and hence
7573 restricting which instructions can be used, it specifies that GCC should
7574 tune the performance of the code as if the target were of the type
7575 specified in this option, but still choosing the instructions that it
7576 will generate based on the cpu specified by a @option{-mcpu=} option.
7577 For some ARM implementations better performance can be obtained by using
7578 this option.
7580 @item -march=@var{name}
7581 @opindex march
7582 This specifies the name of the target ARM architecture.  GCC uses this
7583 name to determine what kind of instructions it can emit when generating
7584 assembly code.  This option can be used in conjunction with or instead
7585 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7586 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7587 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7588 @samp{iwmmxt}, @samp{ep9312}.
7590 @item -mfpu=@var{name}
7591 @itemx -mfpe=@var{number}
7592 @itemx -mfp=@var{number}
7593 @opindex mfpu
7594 @opindex mfpe
7595 @opindex mfp
7596 This specifies what floating point hardware (or hardware emulation) is
7597 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7598 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7599 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7600 with older versions of GCC@.
7602 If @option{-msoft-float} is specified this specifies the format of
7603 floating point values.
7605 @item -mstructure-size-boundary=@var{n}
7606 @opindex mstructure-size-boundary
7607 The size of all structures and unions will be rounded up to a multiple
7608 of the number of bits set by this option.  Permissible values are 8, 32
7609 and 64.  The default value varies for different toolchains.  For the COFF
7610 targeted toolchain the default value is 8.  A value of 64 is only allowed
7611 if the underlying ABI supports it.
7613 Specifying the larger number can produce faster, more efficient code, but
7614 can also increase the size of the program.  Different values are potentially
7615 incompatible.  Code compiled with one value cannot necessarily expect to
7616 work with code or libraries compiled with another value, if they exchange
7617 information using structures or unions.
7619 @item -mabort-on-noreturn
7620 @opindex mabort-on-noreturn
7621 Generate a call to the function @code{abort} at the end of a
7622 @code{noreturn} function.  It will be executed if the function tries to
7623 return.
7625 @item -mlong-calls
7626 @itemx -mno-long-calls
7627 @opindex mlong-calls
7628 @opindex mno-long-calls
7629 Tells the compiler to perform function calls by first loading the
7630 address of the function into a register and then performing a subroutine
7631 call on this register.  This switch is needed if the target function
7632 will lie outside of the 64 megabyte addressing range of the offset based
7633 version of subroutine call instruction.
7635 Even if this switch is enabled, not all function calls will be turned
7636 into long calls.  The heuristic is that static functions, functions
7637 which have the @samp{short-call} attribute, functions that are inside
7638 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7639 definitions have already been compiled within the current compilation
7640 unit, will not be turned into long calls.  The exception to this rule is
7641 that weak function definitions, functions with the @samp{long-call}
7642 attribute or the @samp{section} attribute, and functions that are within
7643 the scope of a @samp{#pragma long_calls} directive, will always be
7644 turned into long calls.
7646 This feature is not enabled by default.  Specifying
7647 @option{-mno-long-calls} will restore the default behavior, as will
7648 placing the function calls within the scope of a @samp{#pragma
7649 long_calls_off} directive.  Note these switches have no effect on how
7650 the compiler generates code to handle function calls via function
7651 pointers.
7653 @item -mnop-fun-dllimport
7654 @opindex mnop-fun-dllimport
7655 Disable support for the @code{dllimport} attribute.
7657 @item -msingle-pic-base
7658 @opindex msingle-pic-base
7659 Treat the register used for PIC addressing as read-only, rather than
7660 loading it in the prologue for each function.  The run-time system is
7661 responsible for initializing this register with an appropriate value
7662 before execution begins.
7664 @item -mpic-register=@var{reg}
7665 @opindex mpic-register
7666 Specify the register to be used for PIC addressing.  The default is R10
7667 unless stack-checking is enabled, when R9 is used.
7669 @item -mcirrus-fix-invalid-insns
7670 @opindex mcirrus-fix-invalid-insns
7671 @opindex mno-cirrus-fix-invalid-insns
7672 Insert NOPs into the instruction stream to in order to work around
7673 problems with invalid Maverick instruction combinations.  This option
7674 is only valid if the @option{-mcpu=ep9312} option has been used to
7675 enable generation of instructions for the Cirrus Maverick floating
7676 point co-processor.  This option is not enabled by default, since the
7677 problem is only present in older Maverick implementations.  The default
7678 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7679 switch.
7681 @item -mpoke-function-name
7682 @opindex mpoke-function-name
7683 Write the name of each function into the text section, directly
7684 preceding the function prologue.  The generated code is similar to this:
7686 @smallexample
7687      t0
7688          .ascii "arm_poke_function_name", 0
7689          .align
7690      t1
7691          .word 0xff000000 + (t1 - t0)
7692      arm_poke_function_name
7693          mov     ip, sp
7694          stmfd   sp!, @{fp, ip, lr, pc@}
7695          sub     fp, ip, #4
7696 @end smallexample
7698 When performing a stack backtrace, code can inspect the value of
7699 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7700 location @code{pc - 12} and the top 8 bits are set, then we know that
7701 there is a function name embedded immediately preceding this location
7702 and has length @code{((pc[-3]) & 0xff000000)}.
7704 @item -mthumb
7705 @opindex mthumb
7706 Generate code for the 16-bit Thumb instruction set.  The default is to
7707 use the 32-bit ARM instruction set.
7709 @item -mtpcs-frame
7710 @opindex mtpcs-frame
7711 Generate a stack frame that is compliant with the Thumb Procedure Call
7712 Standard for all non-leaf functions.  (A leaf function is one that does
7713 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7715 @item -mtpcs-leaf-frame
7716 @opindex mtpcs-leaf-frame
7717 Generate a stack frame that is compliant with the Thumb Procedure Call
7718 Standard for all leaf functions.  (A leaf function is one that does
7719 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7721 @item -mcallee-super-interworking
7722 @opindex mcallee-super-interworking
7723 Gives all externally visible functions in the file being compiled an ARM
7724 instruction set header which switches to Thumb mode before executing the
7725 rest of the function.  This allows these functions to be called from
7726 non-interworking code.
7728 @item -mcaller-super-interworking
7729 @opindex mcaller-super-interworking
7730 Allows calls via function pointers (including virtual functions) to
7731 execute correctly regardless of whether the target code has been
7732 compiled for interworking or not.  There is a small overhead in the cost
7733 of executing a function pointer if this option is enabled.
7735 @item -mtp=@var{name}
7736 @opindex mtp
7737 Specify the access model for the thread local storage pointer.  The valid
7738 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7739 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7740 (supported in the arm6k architecture), and @option{auto}, which uses the
7741 best available method for the selected processor.  The default setting is
7742 @option{auto}.
7744 @end table
7746 @node AVR Options
7747 @subsection AVR Options
7748 @cindex AVR Options
7750 These options are defined for AVR implementations:
7752 @table @gcctabopt
7753 @item -mmcu=@var{mcu}
7754 @opindex mmcu
7755 Specify ATMEL AVR instruction set or MCU type.
7757 Instruction set avr1 is for the minimal AVR core, not supported by the C
7758 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7759 attiny11, attiny12, attiny15, attiny28).
7761 Instruction set avr2 (default) is for the classic AVR core with up to
7762 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7763 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7764 at90c8534, at90s8535).
7766 Instruction set avr3 is for the classic AVR core with up to 128K program
7767 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7769 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7770 memory space (MCU types: atmega8, atmega83, atmega85).
7772 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7773 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7774 atmega64, atmega128, at43usb355, at94k).
7776 @item -msize
7777 @opindex msize
7778 Output instruction sizes to the asm file.
7780 @item -minit-stack=@var{N}
7781 @opindex minit-stack
7782 Specify the initial stack address, which may be a symbol or numeric value,
7783 @samp{__stack} is the default.
7785 @item -mno-interrupts
7786 @opindex mno-interrupts
7787 Generated code is not compatible with hardware interrupts.
7788 Code size will be smaller.
7790 @item -mcall-prologues
7791 @opindex mcall-prologues
7792 Functions prologues/epilogues expanded as call to appropriate
7793 subroutines.  Code size will be smaller.
7795 @item -mno-tablejump
7796 @opindex mno-tablejump
7797 Do not generate tablejump insns which sometimes increase code size.
7799 @item -mtiny-stack
7800 @opindex mtiny-stack
7801 Change only the low 8 bits of the stack pointer.
7803 @item -mint8
7804 @opindex mint8
7805 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7806 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7807 and long long will be 4 bytes.  Please note that this option does not
7808 comply to the C standards, but it will provide you with smaller code
7809 size.
7810 @end table
7812 @node Blackfin Options
7813 @subsection Blackfin Options
7814 @cindex Blackfin Options
7816 @table @gcctabopt
7817 @item -momit-leaf-frame-pointer
7818 @opindex momit-leaf-frame-pointer
7819 Don't keep the frame pointer in a register for leaf functions.  This
7820 avoids the instructions to save, set up and restore frame pointers and
7821 makes an extra register available in leaf functions.  The option
7822 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7823 which might make debugging harder.
7825 @item -mspecld-anomaly
7826 @opindex mspecld-anomaly
7827 When enabled, the compiler will ensure that the generated code does not
7828 contain speculative loads after jump instructions.  This option is enabled
7829 by default.
7831 @item -mno-specld-anomaly
7832 @opindex mno-specld-anomaly
7833 Don't generate extra code to prevent speculative loads from occurring.
7835 @item -mcsync-anomaly
7836 @opindex mcsync-anomaly
7837 When enabled, the compiler will ensure that the generated code does not
7838 contain CSYNC or SSYNC instructions too soon after conditional branches.
7839 This option is enabled by default.
7841 @item -mno-csync-anomaly
7842 @opindex mno-csync-anomaly
7843 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7844 occurring too soon after a conditional branch.
7846 @item -mlow-64k
7847 @opindex mlow-64k
7848 When enabled, the compiler is free to take advantage of the knowledge that
7849 the entire program fits into the low 64k of memory.
7851 @item -mno-low-64k
7852 @opindex mno-low-64k
7853 Assume that the program is arbitrarily large.  This is the default.
7855 @item -mstack-check-l1
7856 @opindex mstack-check-l1
7857 Do stack checking using information placed into L1 scratchpad memory by the
7858 uClinux kernel.
7860 @item -mid-shared-library
7861 @opindex mid-shared-library
7862 Generate code that supports shared libraries via the library ID method.
7863 This allows for execute in place and shared libraries in an environment
7864 without virtual memory management.  This option implies @option{-fPIC}.
7866 @item -mno-id-shared-library
7867 @opindex mno-id-shared-library
7868 Generate code that doesn't assume ID based shared libraries are being used.
7869 This is the default.
7871 @item -mleaf-id-shared-library
7872 @opindex mleaf-id-shared-library
7873 Generate code that supports shared libraries via the library ID method,
7874 but assumes that this library or executable won't link against any other
7875 ID shared libraries.  That allows the compiler to use faster code for jumps
7876 and calls.
7878 @item -mno-leaf-id-shared-library
7879 @opindex mno-leaf-id-shared-library
7880 Do not assume that the code being compiled won't link against any ID shared
7881 libraries.  Slower code will be generated for jump and call insns.
7883 @item -mshared-library-id=n
7884 @opindex mshared-library-id
7885 Specified the identification number of the ID based shared library being
7886 compiled.  Specifying a value of 0 will generate more compact code, specifying
7887 other values will force the allocation of that number to the current
7888 library but is no more space or time efficient than omitting this option.
7890 @item -msep-data
7891 @opindex msep-data
7892 Generate code that allows the data segment to be located in a different
7893 area of memory from the text segment.  This allows for execute in place in
7894 an environment without virtual memory management by eliminating relocations
7895 against the text section.
7897 @item -mno-sep-data
7898 @opindex mno-sep-data
7899 Generate code that assumes that the data segment follows the text segment.
7900 This is the default.
7902 @item -mlong-calls
7903 @itemx -mno-long-calls
7904 @opindex mlong-calls
7905 @opindex mno-long-calls
7906 Tells the compiler to perform function calls by first loading the
7907 address of the function into a register and then performing a subroutine
7908 call on this register.  This switch is needed if the target function
7909 will lie outside of the 24 bit addressing range of the offset based
7910 version of subroutine call instruction.
7912 This feature is not enabled by default.  Specifying
7913 @option{-mno-long-calls} will restore the default behavior.  Note these
7914 switches have no effect on how the compiler generates code to handle
7915 function calls via function pointers.
7916 @end table
7918 @node CRIS Options
7919 @subsection CRIS Options
7920 @cindex CRIS Options
7922 These options are defined specifically for the CRIS ports.
7924 @table @gcctabopt
7925 @item -march=@var{architecture-type}
7926 @itemx -mcpu=@var{architecture-type}
7927 @opindex march
7928 @opindex mcpu
7929 Generate code for the specified architecture.  The choices for
7930 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7931 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7932 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7933 @samp{v10}.
7935 @item -mtune=@var{architecture-type}
7936 @opindex mtune
7937 Tune to @var{architecture-type} everything applicable about the generated
7938 code, except for the ABI and the set of available instructions.  The
7939 choices for @var{architecture-type} are the same as for
7940 @option{-march=@var{architecture-type}}.
7942 @item -mmax-stack-frame=@var{n}
7943 @opindex mmax-stack-frame
7944 Warn when the stack frame of a function exceeds @var{n} bytes.
7946 @item -melinux-stacksize=@var{n}
7947 @opindex melinux-stacksize
7948 Only available with the @samp{cris-axis-aout} target.  Arranges for
7949 indications in the program to the kernel loader that the stack of the
7950 program should be set to @var{n} bytes.
7952 @item -metrax4
7953 @itemx -metrax100
7954 @opindex metrax4
7955 @opindex metrax100
7956 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7957 @option{-march=v3} and @option{-march=v8} respectively.
7959 @item -mmul-bug-workaround
7960 @itemx -mno-mul-bug-workaround
7961 @opindex mmul-bug-workaround
7962 @opindex mno-mul-bug-workaround
7963 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7964 models where it applies.  This option is active by default.
7966 @item -mpdebug
7967 @opindex mpdebug
7968 Enable CRIS-specific verbose debug-related information in the assembly
7969 code.  This option also has the effect to turn off the @samp{#NO_APP}
7970 formatted-code indicator to the assembler at the beginning of the
7971 assembly file.
7973 @item -mcc-init
7974 @opindex mcc-init
7975 Do not use condition-code results from previous instruction; always emit
7976 compare and test instructions before use of condition codes.
7978 @item -mno-side-effects
7979 @opindex mno-side-effects
7980 Do not emit instructions with side-effects in addressing modes other than
7981 post-increment.
7983 @item -mstack-align
7984 @itemx -mno-stack-align
7985 @itemx -mdata-align
7986 @itemx -mno-data-align
7987 @itemx -mconst-align
7988 @itemx -mno-const-align
7989 @opindex mstack-align
7990 @opindex mno-stack-align
7991 @opindex mdata-align
7992 @opindex mno-data-align
7993 @opindex mconst-align
7994 @opindex mno-const-align
7995 These options (no-options) arranges (eliminate arrangements) for the
7996 stack-frame, individual data and constants to be aligned for the maximum
7997 single data access size for the chosen CPU model.  The default is to
7998 arrange for 32-bit alignment.  ABI details such as structure layout are
7999 not affected by these options.
8001 @item -m32-bit
8002 @itemx -m16-bit
8003 @itemx -m8-bit
8004 @opindex m32-bit
8005 @opindex m16-bit
8006 @opindex m8-bit
8007 Similar to the stack- data- and const-align options above, these options
8008 arrange for stack-frame, writable data and constants to all be 32-bit,
8009 16-bit or 8-bit aligned.  The default is 32-bit alignment.
8011 @item -mno-prologue-epilogue
8012 @itemx -mprologue-epilogue
8013 @opindex mno-prologue-epilogue
8014 @opindex mprologue-epilogue
8015 With @option{-mno-prologue-epilogue}, the normal function prologue and
8016 epilogue that sets up the stack-frame are omitted and no return
8017 instructions or return sequences are generated in the code.  Use this
8018 option only together with visual inspection of the compiled code: no
8019 warnings or errors are generated when call-saved registers must be saved,
8020 or storage for local variable needs to be allocated.
8022 @item -mno-gotplt
8023 @itemx -mgotplt
8024 @opindex mno-gotplt
8025 @opindex mgotplt
8026 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8027 instruction sequences that load addresses for functions from the PLT part
8028 of the GOT rather than (traditional on other architectures) calls to the
8029 PLT@.  The default is @option{-mgotplt}.
8031 @item -maout
8032 @opindex maout
8033 Legacy no-op option only recognized with the cris-axis-aout target.
8035 @item -melf
8036 @opindex melf
8037 Legacy no-op option only recognized with the cris-axis-elf and
8038 cris-axis-linux-gnu targets.
8040 @item -melinux
8041 @opindex melinux
8042 Only recognized with the cris-axis-aout target, where it selects a
8043 GNU/linux-like multilib, include files and instruction set for
8044 @option{-march=v8}.
8046 @item -mlinux
8047 @opindex mlinux
8048 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8050 @item -sim
8051 @opindex sim
8052 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8053 to link with input-output functions from a simulator library.  Code,
8054 initialized data and zero-initialized data are allocated consecutively.
8056 @item -sim2
8057 @opindex sim2
8058 Like @option{-sim}, but pass linker options to locate initialized data at
8059 0x40000000 and zero-initialized data at 0x80000000.
8060 @end table
8062 @node CRX Options
8063 @subsection CRX Options
8064 @cindex CRX Options
8066 These options are defined specifically for the CRX ports.
8068 @table @gcctabopt
8070 @item -mmac
8071 @opindex mmac
8072 Enable the use of multiply-accumulate instructions. Disabled by default.
8074 @item -mpush-args
8075 @opindex mpush-args
8076 Push instructions will be used to pass outgoing arguments when functions
8077 are called. Enabled by default.
8078 @end table
8080 @node Darwin Options
8081 @subsection Darwin Options
8082 @cindex Darwin options
8084 These options are defined for all architectures running the Darwin operating
8085 system.
8087 FSF GCC on Darwin does not create ``fat'' object files; it will create
8088 an object file for the single architecture that it was built to
8089 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8090 @option{-arch} options are used; it does so by running the compiler or
8091 linker multiple times and joining the results together with
8092 @file{lipo}.
8094 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8095 @samp{i686}) is determined by the flags that specify the ISA
8096 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8097 @option{-force_cpusubtype_ALL} option can be used to override this.
8099 The Darwin tools vary in their behavior when presented with an ISA
8100 mismatch.  The assembler, @file{as}, will only permit instructions to
8101 be used that are valid for the subtype of the file it is generating,
8102 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8103 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8104 and print an error if asked to create a shared library with a less
8105 restrictive subtype than its input files (for instance, trying to put
8106 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8107 for executables, @file{ld}, will quietly give the executable the most
8108 restrictive subtype of any of its input files.
8110 @table @gcctabopt
8111 @item -F@var{dir}
8112 @opindex F
8113 Add the framework directory @var{dir} to the head of the list of
8114 directories to be searched for header files.  These directories are
8115 interleaved with those specified by @option{-I} options and are
8116 scanned in a left-to-right order.
8118 A framework directory is a directory with frameworks in it.  A
8119 framework is a directory with a @samp{"Headers"} and/or
8120 @samp{"PrivateHeaders"} directory contained directly in it that ends
8121 in @samp{".framework"}.  The name of a framework is the name of this
8122 directory excluding the @samp{".framework"}.  Headers associated with
8123 the framework are found in one of those two directories, with
8124 @samp{"Headers"} being searched first.  A subframework is a framework
8125 directory that is in a framework's @samp{"Frameworks"} directory.
8126 Includes of subframework headers can only appear in a header of a
8127 framework that contains the subframework, or in a sibling subframework
8128 header.  Two subframeworks are siblings if they occur in the same
8129 framework.  A subframework should not have the same name as a
8130 framework, a warning will be issued if this is violated.  Currently a
8131 subframework cannot have subframeworks, in the future, the mechanism
8132 may be extended to support this.  The standard frameworks can be found
8133 in @samp{"/System/Library/Frameworks"} and
8134 @samp{"/Library/Frameworks"}.  An example include looks like
8135 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8136 the name of the framework and header.h is found in the
8137 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8139 @item -gused
8140 @opindex -gused
8141 Emit debugging information for symbols that are used.  For STABS
8142 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8143 This is by default ON@.
8145 @item -gfull
8146 @opindex -gfull
8147 Emit debugging information for all symbols and types.
8149 @item -mmacosx-version-min=@var{version}
8150 The earliest version of MacOS X that this executable will run on
8151 is @var{version}.  Typical values of @var{version} include @code{10.1},
8152 @code{10.2}, and @code{10.3.9}.
8154 The default for this option is to make choices that seem to be most
8155 useful.  
8157 @item -mkernel
8158 @opindex mkernel
8159 Enable kernel development mode.  The @option{-mkernel} option sets
8160 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8161 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8162 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8163 applicable.  This mode also sets @option{-mno-altivec},
8164 @option{-msoft-float}, @option{-fno-builtin} and
8165 @option{-mlong-branch} for PowerPC targets.
8167 @item -mone-byte-bool
8168 @opindex -mone-byte-bool
8169 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8170 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8171 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8172 option has no effect on x86.
8174 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8175 to generate code that is not binary compatible with code generated
8176 without that switch.  Using this switch may require recompiling all
8177 other modules in a program, including system libraries.  Use this
8178 switch to conform to a non-default data model.
8180 @item -mfix-and-continue
8181 @itemx -ffix-and-continue
8182 @itemx -findirect-data
8183 @opindex mfix-and-continue
8184 @opindex ffix-and-continue
8185 @opindex findirect-data
8186 Generate code suitable for fast turn around development.  Needed to
8187 enable gdb to dynamically load @code{.o} files into already running
8188 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8189 are provided for backwards compatibility.
8191 @item -all_load
8192 @opindex all_load
8193 Loads all members of static archive libraries.
8194 See man ld(1) for more information.
8196 @item -arch_errors_fatal
8197 @opindex arch_errors_fatal
8198 Cause the errors having to do with files that have the wrong architecture
8199 to be fatal.
8201 @item -bind_at_load
8202 @opindex bind_at_load
8203 Causes the output file to be marked such that the dynamic linker will
8204 bind all undefined references when the file is loaded or launched.
8206 @item -bundle
8207 @opindex bundle
8208 Produce a Mach-o bundle format file.
8209 See man ld(1) for more information.
8211 @item -bundle_loader @var{executable}
8212 @opindex bundle_loader
8213 This option specifies the @var{executable} that will be loading the build
8214 output file being linked.  See man ld(1) for more information.
8216 @item -dynamiclib
8217 @opindex -dynamiclib
8218 When passed this option, GCC will produce a dynamic library instead of
8219 an executable when linking, using the Darwin @file{libtool} command.
8221 @item -force_cpusubtype_ALL
8222 @opindex -force_cpusubtype_ALL
8223 This causes GCC's output file to have the @var{ALL} subtype, instead of
8224 one controlled by the @option{-mcpu} or @option{-march} option.
8226 @item -allowable_client  @var{client_name}
8227 @itemx -client_name
8228 @itemx -compatibility_version
8229 @itemx -current_version
8230 @itemx -dead_strip
8231 @itemx -dependency-file
8232 @itemx -dylib_file
8233 @itemx -dylinker_install_name
8234 @itemx -dynamic
8235 @itemx -exported_symbols_list
8236 @itemx -filelist
8237 @itemx -flat_namespace
8238 @itemx -force_flat_namespace
8239 @itemx -headerpad_max_install_names
8240 @itemx -image_base
8241 @itemx -init
8242 @itemx -install_name
8243 @itemx -keep_private_externs
8244 @itemx -multi_module
8245 @itemx -multiply_defined
8246 @itemx -multiply_defined_unused
8247 @itemx -noall_load
8248 @itemx -no_dead_strip_inits_and_terms
8249 @itemx -nofixprebinding
8250 @itemx -nomultidefs
8251 @itemx -noprebind
8252 @itemx -noseglinkedit
8253 @itemx -pagezero_size
8254 @itemx -prebind
8255 @itemx -prebind_all_twolevel_modules
8256 @itemx -private_bundle
8257 @itemx -read_only_relocs
8258 @itemx -sectalign
8259 @itemx -sectobjectsymbols
8260 @itemx -whyload
8261 @itemx -seg1addr
8262 @itemx -sectcreate
8263 @itemx -sectobjectsymbols
8264 @itemx -sectorder
8265 @itemx -segaddr
8266 @itemx -segs_read_only_addr
8267 @itemx -segs_read_write_addr
8268 @itemx -seg_addr_table
8269 @itemx -seg_addr_table_filename
8270 @itemx -seglinkedit
8271 @itemx -segprot
8272 @itemx -segs_read_only_addr
8273 @itemx -segs_read_write_addr
8274 @itemx -single_module
8275 @itemx -static
8276 @itemx -sub_library
8277 @itemx -sub_umbrella
8278 @itemx -twolevel_namespace
8279 @itemx -umbrella
8280 @itemx -undefined
8281 @itemx -unexported_symbols_list
8282 @itemx -weak_reference_mismatches
8283 @itemx -whatsloaded
8285 @opindex allowable_client
8286 @opindex client_name
8287 @opindex compatibility_version
8288 @opindex current_version
8289 @opindex dead_strip
8290 @opindex dependency-file
8291 @opindex dylib_file
8292 @opindex dylinker_install_name
8293 @opindex dynamic
8294 @opindex exported_symbols_list
8295 @opindex filelist
8296 @opindex flat_namespace
8297 @opindex force_flat_namespace
8298 @opindex headerpad_max_install_names
8299 @opindex image_base
8300 @opindex init
8301 @opindex install_name
8302 @opindex keep_private_externs
8303 @opindex multi_module
8304 @opindex multiply_defined
8305 @opindex multiply_defined_unused
8306 @opindex noall_load
8307 @opindex no_dead_strip_inits_and_terms
8308 @opindex nofixprebinding
8309 @opindex nomultidefs
8310 @opindex noprebind
8311 @opindex noseglinkedit
8312 @opindex pagezero_size
8313 @opindex prebind
8314 @opindex prebind_all_twolevel_modules
8315 @opindex private_bundle
8316 @opindex read_only_relocs
8317 @opindex sectalign
8318 @opindex sectobjectsymbols
8319 @opindex whyload
8320 @opindex seg1addr
8321 @opindex sectcreate
8322 @opindex sectobjectsymbols
8323 @opindex sectorder
8324 @opindex segaddr
8325 @opindex segs_read_only_addr
8326 @opindex segs_read_write_addr
8327 @opindex seg_addr_table
8328 @opindex seg_addr_table_filename
8329 @opindex seglinkedit
8330 @opindex segprot
8331 @opindex segs_read_only_addr
8332 @opindex segs_read_write_addr
8333 @opindex single_module
8334 @opindex static
8335 @opindex sub_library
8336 @opindex sub_umbrella
8337 @opindex twolevel_namespace
8338 @opindex umbrella
8339 @opindex undefined
8340 @opindex unexported_symbols_list
8341 @opindex weak_reference_mismatches
8342 @opindex whatsloaded
8344 These options are passed to the Darwin linker.  The Darwin linker man page
8345 describes them in detail.
8346 @end table
8348 @node DEC Alpha Options
8349 @subsection DEC Alpha Options
8351 These @samp{-m} options are defined for the DEC Alpha implementations:
8353 @table @gcctabopt
8354 @item -mno-soft-float
8355 @itemx -msoft-float
8356 @opindex mno-soft-float
8357 @opindex msoft-float
8358 Use (do not use) the hardware floating-point instructions for
8359 floating-point operations.  When @option{-msoft-float} is specified,
8360 functions in @file{libgcc.a} will be used to perform floating-point
8361 operations.  Unless they are replaced by routines that emulate the
8362 floating-point operations, or compiled in such a way as to call such
8363 emulations routines, these routines will issue floating-point
8364 operations.   If you are compiling for an Alpha without floating-point
8365 operations, you must ensure that the library is built so as not to call
8366 them.
8368 Note that Alpha implementations without floating-point operations are
8369 required to have floating-point registers.
8371 @item -mfp-reg
8372 @itemx -mno-fp-regs
8373 @opindex mfp-reg
8374 @opindex mno-fp-regs
8375 Generate code that uses (does not use) the floating-point register set.
8376 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8377 register set is not used, floating point operands are passed in integer
8378 registers as if they were integers and floating-point results are passed
8379 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8380 so any function with a floating-point argument or return value called by code
8381 compiled with @option{-mno-fp-regs} must also be compiled with that
8382 option.
8384 A typical use of this option is building a kernel that does not use,
8385 and hence need not save and restore, any floating-point registers.
8387 @item -mieee
8388 @opindex mieee
8389 The Alpha architecture implements floating-point hardware optimized for
8390 maximum performance.  It is mostly compliant with the IEEE floating
8391 point standard.  However, for full compliance, software assistance is
8392 required.  This option generates code fully IEEE compliant code
8393 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8394 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8395 defined during compilation.  The resulting code is less efficient but is
8396 able to correctly support denormalized numbers and exceptional IEEE
8397 values such as not-a-number and plus/minus infinity.  Other Alpha
8398 compilers call this option @option{-ieee_with_no_inexact}.
8400 @item -mieee-with-inexact
8401 @opindex mieee-with-inexact
8402 This is like @option{-mieee} except the generated code also maintains
8403 the IEEE @var{inexact-flag}.  Turning on this option causes the
8404 generated code to implement fully-compliant IEEE math.  In addition to
8405 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8406 macro.  On some Alpha implementations the resulting code may execute
8407 significantly slower than the code generated by default.  Since there is
8408 very little code that depends on the @var{inexact-flag}, you should
8409 normally not specify this option.  Other Alpha compilers call this
8410 option @option{-ieee_with_inexact}.
8412 @item -mfp-trap-mode=@var{trap-mode}
8413 @opindex mfp-trap-mode
8414 This option controls what floating-point related traps are enabled.
8415 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8416 The trap mode can be set to one of four values:
8418 @table @samp
8419 @item n
8420 This is the default (normal) setting.  The only traps that are enabled
8421 are the ones that cannot be disabled in software (e.g., division by zero
8422 trap).
8424 @item u
8425 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8426 as well.
8428 @item su
8429 Like @samp{u}, but the instructions are marked to be safe for software
8430 completion (see Alpha architecture manual for details).
8432 @item sui
8433 Like @samp{su}, but inexact traps are enabled as well.
8434 @end table
8436 @item -mfp-rounding-mode=@var{rounding-mode}
8437 @opindex mfp-rounding-mode
8438 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8439 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8442 @table @samp
8443 @item n
8444 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8445 the nearest machine number or towards the even machine number in case
8446 of a tie.
8448 @item m
8449 Round towards minus infinity.
8451 @item c
8452 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8454 @item d
8455 Dynamic rounding mode.  A field in the floating point control register
8456 (@var{fpcr}, see Alpha architecture reference manual) controls the
8457 rounding mode in effect.  The C library initializes this register for
8458 rounding towards plus infinity.  Thus, unless your program modifies the
8459 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8460 @end table
8462 @item -mtrap-precision=@var{trap-precision}
8463 @opindex mtrap-precision
8464 In the Alpha architecture, floating point traps are imprecise.  This
8465 means without software assistance it is impossible to recover from a
8466 floating trap and program execution normally needs to be terminated.
8467 GCC can generate code that can assist operating system trap handlers
8468 in determining the exact location that caused a floating point trap.
8469 Depending on the requirements of an application, different levels of
8470 precisions can be selected:
8472 @table @samp
8473 @item p
8474 Program precision.  This option is the default and means a trap handler
8475 can only identify which program caused a floating point exception.
8477 @item f
8478 Function precision.  The trap handler can determine the function that
8479 caused a floating point exception.
8481 @item i
8482 Instruction precision.  The trap handler can determine the exact
8483 instruction that caused a floating point exception.
8484 @end table
8486 Other Alpha compilers provide the equivalent options called
8487 @option{-scope_safe} and @option{-resumption_safe}.
8489 @item -mieee-conformant
8490 @opindex mieee-conformant
8491 This option marks the generated code as IEEE conformant.  You must not
8492 use this option unless you also specify @option{-mtrap-precision=i} and either
8493 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8494 is to emit the line @samp{.eflag 48} in the function prologue of the
8495 generated assembly file.  Under DEC Unix, this has the effect that
8496 IEEE-conformant math library routines will be linked in.
8498 @item -mbuild-constants
8499 @opindex mbuild-constants
8500 Normally GCC examines a 32- or 64-bit integer constant to
8501 see if it can construct it from smaller constants in two or three
8502 instructions.  If it cannot, it will output the constant as a literal and
8503 generate code to load it from the data segment at runtime.
8505 Use this option to require GCC to construct @emph{all} integer constants
8506 using code, even if it takes more instructions (the maximum is six).
8508 You would typically use this option to build a shared library dynamic
8509 loader.  Itself a shared library, it must relocate itself in memory
8510 before it can find the variables and constants in its own data segment.
8512 @item -malpha-as
8513 @itemx -mgas
8514 @opindex malpha-as
8515 @opindex mgas
8516 Select whether to generate code to be assembled by the vendor-supplied
8517 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8519 @item -mbwx
8520 @itemx -mno-bwx
8521 @itemx -mcix
8522 @itemx -mno-cix
8523 @itemx -mfix
8524 @itemx -mno-fix
8525 @itemx -mmax
8526 @itemx -mno-max
8527 @opindex mbwx
8528 @opindex mno-bwx
8529 @opindex mcix
8530 @opindex mno-cix
8531 @opindex mfix
8532 @opindex mno-fix
8533 @opindex mmax
8534 @opindex mno-max
8535 Indicate whether GCC should generate code to use the optional BWX,
8536 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8537 sets supported by the CPU type specified via @option{-mcpu=} option or that
8538 of the CPU on which GCC was built if none was specified.
8540 @item -mfloat-vax
8541 @itemx -mfloat-ieee
8542 @opindex mfloat-vax
8543 @opindex mfloat-ieee
8544 Generate code that uses (does not use) VAX F and G floating point
8545 arithmetic instead of IEEE single and double precision.
8547 @item -mexplicit-relocs
8548 @itemx -mno-explicit-relocs
8549 @opindex mexplicit-relocs
8550 @opindex mno-explicit-relocs
8551 Older Alpha assemblers provided no way to generate symbol relocations
8552 except via assembler macros.  Use of these macros does not allow
8553 optimal instruction scheduling.  GNU binutils as of version 2.12
8554 supports a new syntax that allows the compiler to explicitly mark
8555 which relocations should apply to which instructions.  This option
8556 is mostly useful for debugging, as GCC detects the capabilities of
8557 the assembler when it is built and sets the default accordingly.
8559 @item -msmall-data
8560 @itemx -mlarge-data
8561 @opindex msmall-data
8562 @opindex mlarge-data
8563 When @option{-mexplicit-relocs} is in effect, static data is
8564 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8565 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8566 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8567 16-bit relocations off of the @code{$gp} register.  This limits the
8568 size of the small data area to 64KB, but allows the variables to be
8569 directly accessed via a single instruction.
8571 The default is @option{-mlarge-data}.  With this option the data area
8572 is limited to just below 2GB@.  Programs that require more than 2GB of
8573 data must use @code{malloc} or @code{mmap} to allocate the data in the
8574 heap instead of in the program's data segment.
8576 When generating code for shared libraries, @option{-fpic} implies
8577 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8579 @item -msmall-text
8580 @itemx -mlarge-text
8581 @opindex msmall-text
8582 @opindex mlarge-text
8583 When @option{-msmall-text} is used, the compiler assumes that the
8584 code of the entire program (or shared library) fits in 4MB, and is
8585 thus reachable with a branch instruction.  When @option{-msmall-data}
8586 is used, the compiler can assume that all local symbols share the
8587 same @code{$gp} value, and thus reduce the number of instructions
8588 required for a function call from 4 to 1.
8590 The default is @option{-mlarge-text}.
8592 @item -mcpu=@var{cpu_type}
8593 @opindex mcpu
8594 Set the instruction set and instruction scheduling parameters for
8595 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8596 style name or the corresponding chip number.  GCC supports scheduling
8597 parameters for the EV4, EV5 and EV6 family of processors and will
8598 choose the default values for the instruction set from the processor
8599 you specify.  If you do not specify a processor type, GCC will default
8600 to the processor on which the compiler was built.
8602 Supported values for @var{cpu_type} are
8604 @table @samp
8605 @item ev4
8606 @itemx ev45
8607 @itemx 21064
8608 Schedules as an EV4 and has no instruction set extensions.
8610 @item ev5
8611 @itemx 21164
8612 Schedules as an EV5 and has no instruction set extensions.
8614 @item ev56
8615 @itemx 21164a
8616 Schedules as an EV5 and supports the BWX extension.
8618 @item pca56
8619 @itemx 21164pc
8620 @itemx 21164PC
8621 Schedules as an EV5 and supports the BWX and MAX extensions.
8623 @item ev6
8624 @itemx 21264
8625 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8627 @item ev67
8628 @itemx 21264a
8629 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8630 @end table
8632 @item -mtune=@var{cpu_type}
8633 @opindex mtune
8634 Set only the instruction scheduling parameters for machine type
8635 @var{cpu_type}.  The instruction set is not changed.
8637 @item -mmemory-latency=@var{time}
8638 @opindex mmemory-latency
8639 Sets the latency the scheduler should assume for typical memory
8640 references as seen by the application.  This number is highly
8641 dependent on the memory access patterns used by the application
8642 and the size of the external cache on the machine.
8644 Valid options for @var{time} are
8646 @table @samp
8647 @item @var{number}
8648 A decimal number representing clock cycles.
8650 @item L1
8651 @itemx L2
8652 @itemx L3
8653 @itemx main
8654 The compiler contains estimates of the number of clock cycles for
8655 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8656 (also called Dcache, Scache, and Bcache), as well as to main memory.
8657 Note that L3 is only valid for EV5.
8659 @end table
8660 @end table
8662 @node DEC Alpha/VMS Options
8663 @subsection DEC Alpha/VMS Options
8665 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8667 @table @gcctabopt
8668 @item -mvms-return-codes
8669 @opindex mvms-return-codes
8670 Return VMS condition codes from main.  The default is to return POSIX
8671 style condition (e.g.@ error) codes.
8672 @end table
8674 @node FRV Options
8675 @subsection FRV Options
8676 @cindex FRV Options
8678 @table @gcctabopt
8679 @item -mgpr-32
8680 @opindex mgpr-32
8682 Only use the first 32 general purpose registers.
8684 @item -mgpr-64
8685 @opindex mgpr-64
8687 Use all 64 general purpose registers.
8689 @item -mfpr-32
8690 @opindex mfpr-32
8692 Use only the first 32 floating point registers.
8694 @item -mfpr-64
8695 @opindex mfpr-64
8697 Use all 64 floating point registers
8699 @item -mhard-float
8700 @opindex mhard-float
8702 Use hardware instructions for floating point operations.
8704 @item -msoft-float
8705 @opindex msoft-float
8707 Use library routines for floating point operations.
8709 @item -malloc-cc
8710 @opindex malloc-cc
8712 Dynamically allocate condition code registers.
8714 @item -mfixed-cc
8715 @opindex mfixed-cc
8717 Do not try to dynamically allocate condition code registers, only
8718 use @code{icc0} and @code{fcc0}.
8720 @item -mdword
8721 @opindex mdword
8723 Change ABI to use double word insns.
8725 @item -mno-dword
8726 @opindex mno-dword
8728 Do not use double word instructions.
8730 @item -mdouble
8731 @opindex mdouble
8733 Use floating point double instructions.
8735 @item -mno-double
8736 @opindex mno-double
8738 Do not use floating point double instructions.
8740 @item -mmedia
8741 @opindex mmedia
8743 Use media instructions.
8745 @item -mno-media
8746 @opindex mno-media
8748 Do not use media instructions.
8750 @item -mmuladd
8751 @opindex mmuladd
8753 Use multiply and add/subtract instructions.
8755 @item -mno-muladd
8756 @opindex mno-muladd
8758 Do not use multiply and add/subtract instructions.
8760 @item -mfdpic
8761 @opindex mfdpic
8763 Select the FDPIC ABI, that uses function descriptors to represent
8764 pointers to functions.  Without any PIC/PIE-related options, it
8765 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8766 assumes GOT entries and small data are within a 12-bit range from the
8767 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8768 are computed with 32 bits.
8770 @item -minline-plt
8771 @opindex minline-plt
8773 Enable inlining of PLT entries in function calls to functions that are
8774 not known to bind locally.  It has no effect without @option{-mfdpic}.
8775 It's enabled by default if optimizing for speed and compiling for
8776 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8777 optimization option such as @option{-O3} or above is present in the
8778 command line.
8780 @item -mTLS
8781 @opindex TLS
8783 Assume a large TLS segment when generating thread-local code.
8785 @item -mtls
8786 @opindex tls
8788 Do not assume a large TLS segment when generating thread-local code.
8790 @item -mgprel-ro
8791 @opindex mgprel-ro
8793 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8794 that is known to be in read-only sections.  It's enabled by default,
8795 except for @option{-fpic} or @option{-fpie}: even though it may help
8796 make the global offset table smaller, it trades 1 instruction for 4.
8797 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8798 one of which may be shared by multiple symbols, and it avoids the need
8799 for a GOT entry for the referenced symbol, so it's more likely to be a
8800 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8802 @item -multilib-library-pic
8803 @opindex multilib-library-pic
8805 Link with the (library, not FD) pic libraries.  It's implied by
8806 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8807 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8808 it explicitly.
8810 @item -mlinked-fp
8811 @opindex mlinked-fp
8813 Follow the EABI requirement of always creating a frame pointer whenever
8814 a stack frame is allocated.  This option is enabled by default and can
8815 be disabled with @option{-mno-linked-fp}.
8817 @item -mlong-calls
8818 @opindex mlong-calls
8820 Use indirect addressing to call functions outside the current
8821 compilation unit.  This allows the functions to be placed anywhere
8822 within the 32-bit address space.
8824 @item -malign-labels
8825 @opindex malign-labels
8827 Try to align labels to an 8-byte boundary by inserting nops into the
8828 previous packet.  This option only has an effect when VLIW packing
8829 is enabled.  It doesn't create new packets; it merely adds nops to
8830 existing ones.
8832 @item -mlibrary-pic
8833 @opindex mlibrary-pic
8835 Generate position-independent EABI code.
8837 @item -macc-4
8838 @opindex macc-4
8840 Use only the first four media accumulator registers.
8842 @item -macc-8
8843 @opindex macc-8
8845 Use all eight media accumulator registers.
8847 @item -mpack
8848 @opindex mpack
8850 Pack VLIW instructions.
8852 @item -mno-pack
8853 @opindex mno-pack
8855 Do not pack VLIW instructions.
8857 @item -mno-eflags
8858 @opindex mno-eflags
8860 Do not mark ABI switches in e_flags.
8862 @item -mcond-move
8863 @opindex mcond-move
8865 Enable the use of conditional-move instructions (default).
8867 This switch is mainly for debugging the compiler and will likely be removed
8868 in a future version.
8870 @item -mno-cond-move
8871 @opindex mno-cond-move
8873 Disable the use of conditional-move instructions.
8875 This switch is mainly for debugging the compiler and will likely be removed
8876 in a future version.
8878 @item -mscc
8879 @opindex mscc
8881 Enable the use of conditional set instructions (default).
8883 This switch is mainly for debugging the compiler and will likely be removed
8884 in a future version.
8886 @item -mno-scc
8887 @opindex mno-scc
8889 Disable the use of conditional set instructions.
8891 This switch is mainly for debugging the compiler and will likely be removed
8892 in a future version.
8894 @item -mcond-exec
8895 @opindex mcond-exec
8897 Enable the use of conditional execution (default).
8899 This switch is mainly for debugging the compiler and will likely be removed
8900 in a future version.
8902 @item -mno-cond-exec
8903 @opindex mno-cond-exec
8905 Disable the use of conditional execution.
8907 This switch is mainly for debugging the compiler and will likely be removed
8908 in a future version.
8910 @item -mvliw-branch
8911 @opindex mvliw-branch
8913 Run a pass to pack branches into VLIW instructions (default).
8915 This switch is mainly for debugging the compiler and will likely be removed
8916 in a future version.
8918 @item -mno-vliw-branch
8919 @opindex mno-vliw-branch
8921 Do not run a pass to pack branches into VLIW instructions.
8923 This switch is mainly for debugging the compiler and will likely be removed
8924 in a future version.
8926 @item -mmulti-cond-exec
8927 @opindex mmulti-cond-exec
8929 Enable optimization of @code{&&} and @code{||} in conditional execution
8930 (default).
8932 This switch is mainly for debugging the compiler and will likely be removed
8933 in a future version.
8935 @item -mno-multi-cond-exec
8936 @opindex mno-multi-cond-exec
8938 Disable optimization of @code{&&} and @code{||} in conditional execution.
8940 This switch is mainly for debugging the compiler and will likely be removed
8941 in a future version.
8943 @item -mnested-cond-exec
8944 @opindex mnested-cond-exec
8946 Enable nested conditional execution optimizations (default).
8948 This switch is mainly for debugging the compiler and will likely be removed
8949 in a future version.
8951 @item -mno-nested-cond-exec
8952 @opindex mno-nested-cond-exec
8954 Disable nested conditional execution optimizations.
8956 This switch is mainly for debugging the compiler and will likely be removed
8957 in a future version.
8959 @item -moptimize-membar
8960 @opindex moptimize-membar
8962 This switch removes redundant @code{membar} instructions from the
8963 compiler generated code.  It is enabled by default.
8965 @item -mno-optimize-membar
8966 @opindex mno-optimize-membar
8968 This switch disables the automatic removal of redundant @code{membar}
8969 instructions from the generated code.
8971 @item -mtomcat-stats
8972 @opindex mtomcat-stats
8974 Cause gas to print out tomcat statistics.
8976 @item -mcpu=@var{cpu}
8977 @opindex mcpu
8979 Select the processor type for which to generate code.  Possible values are
8980 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8981 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8983 @end table
8985 @node GNU/Linux Options
8986 @subsection GNU/Linux Options
8988 These @samp{-m} options are defined for GNU/Linux targets:
8990 @table @gcctabopt
8991 @item -mglibc
8992 @opindex mglibc
8993 Use the GNU C library instead of uClibc.  This is the default except
8994 on @samp{*-*-linux-*uclibc*} targets.
8996 @item -muclibc
8997 @opindex muclibc
8998 Use uClibc instead of the GNU C library.  This is the default on
8999 @samp{*-*-linux-*uclibc*} targets.
9000 @end table
9002 @node H8/300 Options
9003 @subsection H8/300 Options
9005 These @samp{-m} options are defined for the H8/300 implementations:
9007 @table @gcctabopt
9008 @item -mrelax
9009 @opindex mrelax
9010 Shorten some address references at link time, when possible; uses the
9011 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9012 ld, Using ld}, for a fuller description.
9014 @item -mh
9015 @opindex mh
9016 Generate code for the H8/300H@.
9018 @item -ms
9019 @opindex ms
9020 Generate code for the H8S@.
9022 @item -mn
9023 @opindex mn
9024 Generate code for the H8S and H8/300H in the normal mode.  This switch
9025 must be used either with @option{-mh} or @option{-ms}.
9027 @item -ms2600
9028 @opindex ms2600
9029 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9031 @item -mint32
9032 @opindex mint32
9033 Make @code{int} data 32 bits by default.
9035 @item -malign-300
9036 @opindex malign-300
9037 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9038 The default for the H8/300H and H8S is to align longs and floats on 4
9039 byte boundaries.
9040 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9041 This option has no effect on the H8/300.
9042 @end table
9044 @node HPPA Options
9045 @subsection HPPA Options
9046 @cindex HPPA Options
9048 These @samp{-m} options are defined for the HPPA family of computers:
9050 @table @gcctabopt
9051 @item -march=@var{architecture-type}
9052 @opindex march
9053 Generate code for the specified architecture.  The choices for
9054 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9055 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9056 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9057 architecture option for your machine.  Code compiled for lower numbered
9058 architectures will run on higher numbered architectures, but not the
9059 other way around.
9061 @item -mpa-risc-1-0
9062 @itemx -mpa-risc-1-1
9063 @itemx -mpa-risc-2-0
9064 @opindex mpa-risc-1-0
9065 @opindex mpa-risc-1-1
9066 @opindex mpa-risc-2-0
9067 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9069 @item -mbig-switch
9070 @opindex mbig-switch
9071 Generate code suitable for big switch tables.  Use this option only if
9072 the assembler/linker complain about out of range branches within a switch
9073 table.
9075 @item -mjump-in-delay
9076 @opindex mjump-in-delay
9077 Fill delay slots of function calls with unconditional jump instructions
9078 by modifying the return pointer for the function call to be the target
9079 of the conditional jump.
9081 @item -mdisable-fpregs
9082 @opindex mdisable-fpregs
9083 Prevent floating point registers from being used in any manner.  This is
9084 necessary for compiling kernels which perform lazy context switching of
9085 floating point registers.  If you use this option and attempt to perform
9086 floating point operations, the compiler will abort.
9088 @item -mdisable-indexing
9089 @opindex mdisable-indexing
9090 Prevent the compiler from using indexing address modes.  This avoids some
9091 rather obscure problems when compiling MIG generated code under MACH@.
9093 @item -mno-space-regs
9094 @opindex mno-space-regs
9095 Generate code that assumes the target has no space registers.  This allows
9096 GCC to generate faster indirect calls and use unscaled index address modes.
9098 Such code is suitable for level 0 PA systems and kernels.
9100 @item -mfast-indirect-calls
9101 @opindex mfast-indirect-calls
9102 Generate code that assumes calls never cross space boundaries.  This
9103 allows GCC to emit code which performs faster indirect calls.
9105 This option will not work in the presence of shared libraries or nested
9106 functions.
9108 @item -mfixed-range=@var{register-range}
9109 @opindex mfixed-range
9110 Generate code treating the given register range as fixed registers.
9111 A fixed register is one that the register allocator can not use.  This is
9112 useful when compiling kernel code.  A register range is specified as
9113 two registers separated by a dash.  Multiple register ranges can be
9114 specified separated by a comma.
9116 @item -mlong-load-store
9117 @opindex mlong-load-store
9118 Generate 3-instruction load and store sequences as sometimes required by
9119 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9120 the HP compilers.
9122 @item -mportable-runtime
9123 @opindex mportable-runtime
9124 Use the portable calling conventions proposed by HP for ELF systems.
9126 @item -mgas
9127 @opindex mgas
9128 Enable the use of assembler directives only GAS understands.
9130 @item -mschedule=@var{cpu-type}
9131 @opindex mschedule
9132 Schedule code according to the constraints for the machine type
9133 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9134 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9135 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9136 proper scheduling option for your machine.  The default scheduling is
9137 @samp{8000}.
9139 @item -mlinker-opt
9140 @opindex mlinker-opt
9141 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9142 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9143 linkers in which they give bogus error messages when linking some programs.
9145 @item -msoft-float
9146 @opindex msoft-float
9147 Generate output containing library calls for floating point.
9148 @strong{Warning:} the requisite libraries are not available for all HPPA
9149 targets.  Normally the facilities of the machine's usual C compiler are
9150 used, but this cannot be done directly in cross-compilation.  You must make
9151 your own arrangements to provide suitable library functions for
9152 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9153 does provide software floating point support.
9155 @option{-msoft-float} changes the calling convention in the output file;
9156 therefore, it is only useful if you compile @emph{all} of a program with
9157 this option.  In particular, you need to compile @file{libgcc.a}, the
9158 library that comes with GCC, with @option{-msoft-float} in order for
9159 this to work.
9161 @item -msio
9162 @opindex msio
9163 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9164 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9165 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9166 options are available under HP-UX and HI-UX@.
9168 @item -mgnu-ld
9169 @opindex gnu-ld
9170 Use GNU ld specific options.  This passes @option{-shared} to ld when
9171 building a shared library.  It is the default when GCC is configured,
9172 explicitly or implicitly, with the GNU linker.  This option does not
9173 have any affect on which ld is called, it only changes what parameters
9174 are passed to that ld.  The ld that is called is determined by the
9175 @option{--with-ld} configure option, GCC's program search path, and
9176 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9177 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9178 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9180 @item -mhp-ld
9181 @opindex hp-ld
9182 Use HP ld specific options.  This passes @option{-b} to ld when building
9183 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9184 links.  It is the default when GCC is configured, explicitly or
9185 implicitly, with the HP linker.  This option does not have any affect on
9186 which ld is called, it only changes what parameters are passed to that
9187 ld.  The ld that is called is determined by the @option{--with-ld}
9188 configure option, GCC's program search path, and finally by the user's
9189 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9190 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9191 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9193 @item -mlong-calls
9194 @opindex mno-long-calls
9195 Generate code that uses long call sequences.  This ensures that a call
9196 is always able to reach linker generated stubs.  The default is to generate
9197 long calls only when the distance from the call site to the beginning
9198 of the function or translation unit, as the case may be, exceeds a
9199 predefined limit set by the branch type being used.  The limits for
9200 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9201 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9202 240,000 bytes.
9204 Distances are measured from the beginning of functions when using the
9205 @option{-ffunction-sections} option, or when using the @option{-mgas}
9206 and @option{-mno-portable-runtime} options together under HP-UX with
9207 the SOM linker.
9209 It is normally not desirable to use this option as it will degrade
9210 performance.  However, it may be useful in large applications,
9211 particularly when partial linking is used to build the application.
9213 The types of long calls used depends on the capabilities of the
9214 assembler and linker, and the type of code being generated.  The
9215 impact on systems that support long absolute calls, and long pic
9216 symbol-difference or pc-relative calls should be relatively small.
9217 However, an indirect call is used on 32-bit ELF systems in pic code
9218 and it is quite long.
9220 @item -munix=@var{unix-std}
9221 @opindex march
9222 Generate compiler predefines and select a startfile for the specified
9223 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9224 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9225 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9226 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9227 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9228 and later.
9230 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9231 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9232 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9233 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9234 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9235 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9237 It is @emph{important} to note that this option changes the interfaces
9238 for various library routines.  It also affects the operational behavior
9239 of the C library.  Thus, @emph{extreme} care is needed in using this
9240 option.
9242 Library code that is intended to operate with more than one UNIX
9243 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9244 as appropriate.  Most GNU software doesn't provide this capability.
9246 @item -nolibdld
9247 @opindex nolibdld
9248 Suppress the generation of link options to search libdld.sl when the
9249 @option{-static} option is specified on HP-UX 10 and later.
9251 @item -static
9252 @opindex static
9253 The HP-UX implementation of setlocale in libc has a dependency on
9254 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9255 when the @option{-static} option is specified, special link options
9256 are needed to resolve this dependency.
9258 On HP-UX 10 and later, the GCC driver adds the necessary options to
9259 link with libdld.sl when the @option{-static} option is specified.
9260 This causes the resulting binary to be dynamic.  On the 64-bit port,
9261 the linkers generate dynamic binaries by default in any case.  The
9262 @option{-nolibdld} option can be used to prevent the GCC driver from
9263 adding these link options.
9265 @item -threads
9266 @opindex threads
9267 Add support for multithreading with the @dfn{dce thread} library
9268 under HP-UX@.  This option sets flags for both the preprocessor and
9269 linker.
9270 @end table
9272 @node i386 and x86-64 Options
9273 @subsection Intel 386 and AMD x86-64 Options
9274 @cindex i386 Options
9275 @cindex x86-64 Options
9276 @cindex Intel 386 Options
9277 @cindex AMD x86-64 Options
9279 These @samp{-m} options are defined for the i386 and x86-64 family of
9280 computers:
9282 @table @gcctabopt
9283 @item -mtune=@var{cpu-type}
9284 @opindex mtune
9285 Tune to @var{cpu-type} everything applicable about the generated code, except
9286 for the ABI and the set of available instructions.  The choices for
9287 @var{cpu-type} are:
9288 @table @emph
9289 @item generic
9290 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9291 If you know the CPU on which your code will run, then you should use
9292 the corresponding @option{-mtune} option instead of
9293 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9294 of your application will have, then you should use this option.
9296 As new processors are deployed in the marketplace, the behavior of this
9297 option will change.  Therefore, if you upgrade to a newer version of
9298 GCC, the code generated option will change to reflect the processors
9299 that were most common when that version of GCC was released.
9301 There is no @option{-march=generic} option because @option{-march}
9302 indicates the instruction set the compiler can use, and there is no
9303 generic instruction set applicable to all processors.  In contrast,
9304 @option{-mtune} indicates the processor (or, in this case, collection of
9305 processors) for which the code is optimized.
9306 @item native
9307 This selects the CPU to tune for at compilation time by determining
9308 the processor type of the compiling machine.  Using @option{-mtune=native}
9309 will produce code optimized for the local machine under the constraints
9310 of the selected instruction set.  Using @option{-march=native} will
9311 enable all instruction subsets supported by the local machine (hence
9312 the result might not run on different machines).
9313 @item i386
9314 Original Intel's i386 CPU@.
9315 @item i486
9316 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9317 @item i586, pentium
9318 Intel Pentium CPU with no MMX support.
9319 @item pentium-mmx
9320 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9321 @item pentiumpro
9322 Intel PentiumPro CPU@.
9323 @item i686
9324 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9325 instruction set will be used, so the code will run on all i686 family chips.
9326 @item pentium2
9327 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9328 @item pentium3, pentium3m
9329 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9330 support.
9331 @item pentium-m
9332 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9333 support.  Used by Centrino notebooks.
9334 @item pentium4, pentium4m
9335 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9336 @item prescott
9337 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9338 set support.
9339 @item nocona
9340 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9341 SSE2 and SSE3 instruction set support.
9342 @item core2
9343 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
9344 instruction set support.
9345 @item k6
9346 AMD K6 CPU with MMX instruction set support.
9347 @item k6-2, k6-3
9348 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9349 @item athlon, athlon-tbird
9350 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9351 support.
9352 @item athlon-4, athlon-xp, athlon-mp
9353 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9354 instruction set support.
9355 @item k8, opteron, athlon64, athlon-fx
9356 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9357 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9358 @item winchip-c6
9359 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9360 set support.
9361 @item winchip2
9362 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9363 instruction set support.
9364 @item c3
9365 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9366 implemented for this chip.)
9367 @item c3-2
9368 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9369 implemented for this chip.)
9370 @item geode
9371 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
9372 @end table
9374 While picking a specific @var{cpu-type} will schedule things appropriately
9375 for that particular chip, the compiler will not generate any code that
9376 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9377 being used.
9379 @item -march=@var{cpu-type}
9380 @opindex march
9381 Generate instructions for the machine type @var{cpu-type}.  The choices
9382 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9383 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9385 @item -mcpu=@var{cpu-type}
9386 @opindex mcpu
9387 A deprecated synonym for @option{-mtune}.
9389 @item -m386
9390 @itemx -m486
9391 @itemx -mpentium
9392 @itemx -mpentiumpro
9393 @opindex m386
9394 @opindex m486
9395 @opindex mpentium
9396 @opindex mpentiumpro
9397 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9398 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9399 These synonyms are deprecated.
9401 @item -mfpmath=@var{unit}
9402 @opindex march
9403 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9404 for @var{unit} are:
9406 @table @samp
9407 @item 387
9408 Use the standard 387 floating point coprocessor present majority of chips and
9409 emulated otherwise.  Code compiled with this option will run almost everywhere.
9410 The temporary results are computed in 80bit precision instead of precision
9411 specified by the type resulting in slightly different results compared to most
9412 of other chips.  See @option{-ffloat-store} for more detailed description.
9414 This is the default choice for i386 compiler.
9416 @item sse
9417 Use scalar floating point instructions present in the SSE instruction set.
9418 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9419 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9420 instruction set supports only single precision arithmetics, thus the double and
9421 extended precision arithmetics is still done using 387.  Later version, present
9422 only in Pentium4 and the future AMD x86-64 chips supports double precision
9423 arithmetics too.
9425 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9426 or @option{-msse2} switches to enable SSE extensions and make this option
9427 effective.  For the x86-64 compiler, these extensions are enabled by default.
9429 The resulting code should be considerably faster in the majority of cases and avoid
9430 the numerical instability problems of 387 code, but may break some existing
9431 code that expects temporaries to be 80bit.
9433 This is the default choice for the x86-64 compiler.
9435 @item sse,387
9436 Attempt to utilize both instruction sets at once.  This effectively double the
9437 amount of available registers and on chips with separate execution units for
9438 387 and SSE the execution resources too.  Use this option with care, as it is
9439 still experimental, because the GCC register allocator does not model separate
9440 functional units well resulting in instable performance.
9441 @end table
9443 @item -masm=@var{dialect}
9444 @opindex masm=@var{dialect}
9445 Output asm instructions using selected @var{dialect}.  Supported
9446 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9447 not support @samp{intel}.
9449 @item -mieee-fp
9450 @itemx -mno-ieee-fp
9451 @opindex mieee-fp
9452 @opindex mno-ieee-fp
9453 Control whether or not the compiler uses IEEE floating point
9454 comparisons.  These handle correctly the case where the result of a
9455 comparison is unordered.
9457 @item -msoft-float
9458 @opindex msoft-float
9459 Generate output containing library calls for floating point.
9460 @strong{Warning:} the requisite libraries are not part of GCC@.
9461 Normally the facilities of the machine's usual C compiler are used, but
9462 this can't be done directly in cross-compilation.  You must make your
9463 own arrangements to provide suitable library functions for
9464 cross-compilation.
9466 On machines where a function returns floating point results in the 80387
9467 register stack, some floating point opcodes may be emitted even if
9468 @option{-msoft-float} is used.
9470 @item -mno-fp-ret-in-387
9471 @opindex mno-fp-ret-in-387
9472 Do not use the FPU registers for return values of functions.
9474 The usual calling convention has functions return values of types
9475 @code{float} and @code{double} in an FPU register, even if there
9476 is no FPU@.  The idea is that the operating system should emulate
9477 an FPU@.
9479 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9480 in ordinary CPU registers instead.
9482 @item -mno-fancy-math-387
9483 @opindex mno-fancy-math-387
9484 Some 387 emulators do not support the @code{sin}, @code{cos} and
9485 @code{sqrt} instructions for the 387.  Specify this option to avoid
9486 generating those instructions.  This option is the default on FreeBSD,
9487 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9488 indicates that the target cpu will always have an FPU and so the
9489 instruction will not need emulation.  As of revision 2.6.1, these
9490 instructions are not generated unless you also use the
9491 @option{-funsafe-math-optimizations} switch.
9493 @item -malign-double
9494 @itemx -mno-align-double
9495 @opindex malign-double
9496 @opindex mno-align-double
9497 Control whether GCC aligns @code{double}, @code{long double}, and
9498 @code{long long} variables on a two word boundary or a one word
9499 boundary.  Aligning @code{double} variables on a two word boundary will
9500 produce code that runs somewhat faster on a @samp{Pentium} at the
9501 expense of more memory.
9503 On x86-64, @option{-malign-double} is enabled by default.
9505 @strong{Warning:} if you use the @option{-malign-double} switch,
9506 structures containing the above types will be aligned differently than
9507 the published application binary interface specifications for the 386
9508 and will not be binary compatible with structures in code compiled
9509 without that switch.
9511 @item -m96bit-long-double
9512 @itemx -m128bit-long-double
9513 @opindex m96bit-long-double
9514 @opindex m128bit-long-double
9515 These switches control the size of @code{long double} type.  The i386
9516 application binary interface specifies the size to be 96 bits,
9517 so @option{-m96bit-long-double} is the default in 32 bit mode.
9519 Modern architectures (Pentium and newer) would prefer @code{long double}
9520 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9521 conforming to the ABI, this would not be possible.  So specifying a
9522 @option{-m128bit-long-double} will align @code{long double}
9523 to a 16 byte boundary by padding the @code{long double} with an additional
9524 32 bit zero.
9526 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9527 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9529 Notice that neither of these options enable any extra precision over the x87
9530 standard of 80 bits for a @code{long double}.
9532 @strong{Warning:} if you override the default value for your target ABI, the
9533 structures and arrays containing @code{long double} variables will change
9534 their size as well as function calling convention for function taking
9535 @code{long double} will be modified.  Hence they will not be binary
9536 compatible with arrays or structures in code compiled without that switch.
9538 @item -mmlarge-data-threshold=@var{number}
9539 @opindex mlarge-data-threshold=@var{number}
9540 When @option{-mcmodel=medium} is specified, the data greater than
9541 @var{threshold} are placed in large data section.  This value must be the
9542 same across all object linked into the binary and defaults to 65535.
9544 @item -msvr3-shlib
9545 @itemx -mno-svr3-shlib
9546 @opindex msvr3-shlib
9547 @opindex mno-svr3-shlib
9548 Control whether GCC places uninitialized local variables into the
9549 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9550 into @code{bss}.  These options are meaningful only on System V Release 3.
9552 @item -mrtd
9553 @opindex mrtd
9554 Use a different function-calling convention, in which functions that
9555 take a fixed number of arguments return with the @code{ret} @var{num}
9556 instruction, which pops their arguments while returning.  This saves one
9557 instruction in the caller since there is no need to pop the arguments
9558 there.
9560 You can specify that an individual function is called with this calling
9561 sequence with the function attribute @samp{stdcall}.  You can also
9562 override the @option{-mrtd} option by using the function attribute
9563 @samp{cdecl}.  @xref{Function Attributes}.
9565 @strong{Warning:} this calling convention is incompatible with the one
9566 normally used on Unix, so you cannot use it if you need to call
9567 libraries compiled with the Unix compiler.
9569 Also, you must provide function prototypes for all functions that
9570 take variable numbers of arguments (including @code{printf});
9571 otherwise incorrect code will be generated for calls to those
9572 functions.
9574 In addition, seriously incorrect code will result if you call a
9575 function with too many arguments.  (Normally, extra arguments are
9576 harmlessly ignored.)
9578 @item -mregparm=@var{num}
9579 @opindex mregparm
9580 Control how many registers are used to pass integer arguments.  By
9581 default, no registers are used to pass arguments, and at most 3
9582 registers can be used.  You can control this behavior for a specific
9583 function by using the function attribute @samp{regparm}.
9584 @xref{Function Attributes}.
9586 @strong{Warning:} if you use this switch, and
9587 @var{num} is nonzero, then you must build all modules with the same
9588 value, including any libraries.  This includes the system libraries and
9589 startup modules.
9591 @item -msseregparm
9592 @opindex msseregparm
9593 Use SSE register passing conventions for float and double arguments
9594 and return values.  You can control this behavior for a specific
9595 function by using the function attribute @samp{sseregparm}.
9596 @xref{Function Attributes}.
9598 @strong{Warning:} if you use this switch then you must build all
9599 modules with the same value, including any libraries.  This includes
9600 the system libraries and startup modules.
9602 @item -mstackrealign
9603 @opindex mstackrealign
9604 Realign the stack at entry.  On the Intel x86, the
9605 @option{-mstackrealign} option will generate an alternate prologue and
9606 epilogue that realigns the runtime stack.  This supports mixing legacy
9607 codes that keep a 4-byte aligned stack with modern codes that keep a
9608 16-byte stack for SSE compatibility.  The alternate prologue and
9609 epilogue are slower and bigger than the regular ones, and the
9610 alternate prologue requires an extra scratch register; this lowers the
9611 number of registers available if used in conjunction with the
9612 @code{regparm} attribute.  The @option{-mstackrealign} option is
9613 incompatible with the nested function prologue; this is considered a
9614 hard error.  See also the attribute @code{force_align_arg_pointer},
9615 applicable to individual functions.
9617 @item -mpreferred-stack-boundary=@var{num}
9618 @opindex mpreferred-stack-boundary
9619 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9620 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9621 the default is 4 (16 bytes or 128 bits).
9623 On Pentium and PentiumPro, @code{double} and @code{long double} values
9624 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9625 suffer significant run time performance penalties.  On Pentium III, the
9626 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9627 properly if it is not 16 byte aligned.
9629 To ensure proper alignment of this values on the stack, the stack boundary
9630 must be as aligned as that required by any value stored on the stack.
9631 Further, every function must be generated such that it keeps the stack
9632 aligned.  Thus calling a function compiled with a higher preferred
9633 stack boundary from a function compiled with a lower preferred stack
9634 boundary will most likely misalign the stack.  It is recommended that
9635 libraries that use callbacks always use the default setting.
9637 This extra alignment does consume extra stack space, and generally
9638 increases code size.  Code that is sensitive to stack space usage, such
9639 as embedded systems and operating system kernels, may want to reduce the
9640 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9642 @item -mmmx
9643 @itemx -mno-mmx
9644 @item -msse
9645 @itemx -mno-sse
9646 @item -msse2
9647 @itemx -mno-sse2
9648 @item -msse3
9649 @itemx -mno-sse3
9650 @item -mssse3
9651 @itemx -mno-ssse3
9652 @item -m3dnow
9653 @itemx -mno-3dnow
9654 @opindex mmmx
9655 @opindex mno-mmx
9656 @opindex msse
9657 @opindex mno-sse
9658 @opindex m3dnow
9659 @opindex mno-3dnow
9660 These switches enable or disable the use of instructions in the MMX,
9661 SSE, SSE2, SSE3, SSSE3 or 3DNow! extended instruction sets.
9662 These extensions are also available as built-in functions: see
9663 @ref{X86 Built-in Functions}, for details of the functions enabled and
9664 disabled by these switches.
9666 To have SSE/SSE2 instructions generated automatically from floating-point
9667 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9669 These options will enable GCC to use these extended instructions in
9670 generated code, even without @option{-mfpmath=sse}.  Applications which
9671 perform runtime CPU detection must compile separate files for each
9672 supported architecture, using the appropriate flags.  In particular,
9673 the file containing the CPU detection code should be compiled without
9674 these options.
9676 @item -mpush-args
9677 @itemx -mno-push-args
9678 @opindex mpush-args
9679 @opindex mno-push-args
9680 Use PUSH operations to store outgoing parameters.  This method is shorter
9681 and usually equally fast as method using SUB/MOV operations and is enabled
9682 by default.  In some cases disabling it may improve performance because of
9683 improved scheduling and reduced dependencies.
9685 @item -maccumulate-outgoing-args
9686 @opindex maccumulate-outgoing-args
9687 If enabled, the maximum amount of space required for outgoing arguments will be
9688 computed in the function prologue.  This is faster on most modern CPUs
9689 because of reduced dependencies, improved scheduling and reduced stack usage
9690 when preferred stack boundary is not equal to 2.  The drawback is a notable
9691 increase in code size.  This switch implies @option{-mno-push-args}.
9693 @item -mthreads
9694 @opindex mthreads
9695 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9696 on thread-safe exception handling must compile and link all code with the
9697 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9698 @option{-D_MT}; when linking, it links in a special thread helper library
9699 @option{-lmingwthrd} which cleans up per thread exception handling data.
9701 @item -mno-align-stringops
9702 @opindex mno-align-stringops
9703 Do not align destination of inlined string operations.  This switch reduces
9704 code size and improves performance in case the destination is already aligned,
9705 but GCC doesn't know about it.
9707 @item -minline-all-stringops
9708 @opindex minline-all-stringops
9709 By default GCC inlines string operations only when destination is known to be
9710 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9711 size, but may improve performance of code that depends on fast memcpy, strlen
9712 and memset for short lengths.
9714 @item -minline-stringops-dynamically
9715 @opindex minline-stringops-dynamically
9716 For string operation of unknown size, inline runtime checks so for small
9717 blocks inline code is used, while for large blocks library call is used.
9719 @item -mstringop-strategy=@var{alg}
9720 @opindex mstringop-strategy=@var{alg}
9721 Overwrite internal decision heuristic about particular algorithm to inline
9722 string operation with.  The allowed values are @code{rep_byte},
9723 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
9724 of specified size, @code{loop}, @code{unrolled_loop} for expanding inline loop,
9725 @code{libcall} for always expanding library call.
9727 @item -momit-leaf-frame-pointer
9728 @opindex momit-leaf-frame-pointer
9729 Don't keep the frame pointer in a register for leaf functions.  This
9730 avoids the instructions to save, set up and restore frame pointers and
9731 makes an extra register available in leaf functions.  The option
9732 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9733 which might make debugging harder.
9735 @item -mtls-direct-seg-refs
9736 @itemx -mno-tls-direct-seg-refs
9737 @opindex mtls-direct-seg-refs
9738 Controls whether TLS variables may be accessed with offsets from the
9739 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9740 or whether the thread base pointer must be added.  Whether or not this
9741 is legal depends on the operating system, and whether it maps the
9742 segment to cover the entire TLS area.
9744 For systems that use GNU libc, the default is on.
9745 @end table
9747 These @samp{-m} switches are supported in addition to the above
9748 on AMD x86-64 processors in 64-bit environments.
9750 @table @gcctabopt
9751 @item -m32
9752 @itemx -m64
9753 @opindex m32
9754 @opindex m64
9755 Generate code for a 32-bit or 64-bit environment.
9756 The 32-bit environment sets int, long and pointer to 32 bits and
9757 generates code that runs on any i386 system.
9758 The 64-bit environment sets int to 32 bits and long and pointer
9759 to 64 bits and generates code for AMD's x86-64 architecture.
9761 @item -mno-red-zone
9762 @opindex no-red-zone
9763 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9764 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9765 stack pointer that will not be modified by signal or interrupt handlers
9766 and therefore can be used for temporary data without adjusting the stack
9767 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9769 @item -mcmodel=small
9770 @opindex mcmodel=small
9771 Generate code for the small code model: the program and its symbols must
9772 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9773 Programs can be statically or dynamically linked.  This is the default
9774 code model.
9776 @item -mcmodel=kernel
9777 @opindex mcmodel=kernel
9778 Generate code for the kernel code model.  The kernel runs in the
9779 negative 2 GB of the address space.
9780 This model has to be used for Linux kernel code.
9782 @item -mcmodel=medium
9783 @opindex mcmodel=medium
9784 Generate code for the medium model: The program is linked in the lower 2
9785 GB of the address space but symbols can be located anywhere in the
9786 address space.  Programs can be statically or dynamically linked, but
9787 building of shared libraries are not supported with the medium model.
9789 @item -mcmodel=large
9790 @opindex mcmodel=large
9791 Generate code for the large model: This model makes no assumptions
9792 about addresses and sizes of sections.  Currently GCC does not implement
9793 this model.
9794 @end table
9796 @node IA-64 Options
9797 @subsection IA-64 Options
9798 @cindex IA-64 Options
9800 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9802 @table @gcctabopt
9803 @item -mbig-endian
9804 @opindex mbig-endian
9805 Generate code for a big endian target.  This is the default for HP-UX@.
9807 @item -mlittle-endian
9808 @opindex mlittle-endian
9809 Generate code for a little endian target.  This is the default for AIX5
9810 and GNU/Linux.
9812 @item -mgnu-as
9813 @itemx -mno-gnu-as
9814 @opindex mgnu-as
9815 @opindex mno-gnu-as
9816 Generate (or don't) code for the GNU assembler.  This is the default.
9817 @c Also, this is the default if the configure option @option{--with-gnu-as}
9818 @c is used.
9820 @item -mgnu-ld
9821 @itemx -mno-gnu-ld
9822 @opindex mgnu-ld
9823 @opindex mno-gnu-ld
9824 Generate (or don't) code for the GNU linker.  This is the default.
9825 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9826 @c is used.
9828 @item -mno-pic
9829 @opindex mno-pic
9830 Generate code that does not use a global pointer register.  The result
9831 is not position independent code, and violates the IA-64 ABI@.
9833 @item -mvolatile-asm-stop
9834 @itemx -mno-volatile-asm-stop
9835 @opindex mvolatile-asm-stop
9836 @opindex mno-volatile-asm-stop
9837 Generate (or don't) a stop bit immediately before and after volatile asm
9838 statements.
9840 @item -mregister-names
9841 @itemx -mno-register-names
9842 @opindex mregister-names
9843 @opindex mno-register-names
9844 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9845 the stacked registers.  This may make assembler output more readable.
9847 @item -mno-sdata
9848 @itemx -msdata
9849 @opindex mno-sdata
9850 @opindex msdata
9851 Disable (or enable) optimizations that use the small data section.  This may
9852 be useful for working around optimizer bugs.
9854 @item -mconstant-gp
9855 @opindex mconstant-gp
9856 Generate code that uses a single constant global pointer value.  This is
9857 useful when compiling kernel code.
9859 @item -mauto-pic
9860 @opindex mauto-pic
9861 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9862 This is useful when compiling firmware code.
9864 @item -minline-float-divide-min-latency
9865 @opindex minline-float-divide-min-latency
9866 Generate code for inline divides of floating point values
9867 using the minimum latency algorithm.
9869 @item -minline-float-divide-max-throughput
9870 @opindex minline-float-divide-max-throughput
9871 Generate code for inline divides of floating point values
9872 using the maximum throughput algorithm.
9874 @item -minline-int-divide-min-latency
9875 @opindex minline-int-divide-min-latency
9876 Generate code for inline divides of integer values
9877 using the minimum latency algorithm.
9879 @item -minline-int-divide-max-throughput
9880 @opindex minline-int-divide-max-throughput
9881 Generate code for inline divides of integer values
9882 using the maximum throughput algorithm.
9884 @item -minline-sqrt-min-latency
9885 @opindex minline-sqrt-min-latency
9886 Generate code for inline square roots
9887 using the minimum latency algorithm.
9889 @item -minline-sqrt-max-throughput
9890 @opindex minline-sqrt-max-throughput
9891 Generate code for inline square roots
9892 using the maximum throughput algorithm.
9894 @item -mno-dwarf2-asm
9895 @itemx -mdwarf2-asm
9896 @opindex mno-dwarf2-asm
9897 @opindex mdwarf2-asm
9898 Don't (or do) generate assembler code for the DWARF2 line number debugging
9899 info.  This may be useful when not using the GNU assembler.
9901 @item -mearly-stop-bits
9902 @itemx -mno-early-stop-bits
9903 @opindex mearly-stop-bits
9904 @opindex mno-early-stop-bits
9905 Allow stop bits to be placed earlier than immediately preceding the
9906 instruction that triggered the stop bit.  This can improve instruction
9907 scheduling, but does not always do so.
9909 @item -mfixed-range=@var{register-range}
9910 @opindex mfixed-range
9911 Generate code treating the given register range as fixed registers.
9912 A fixed register is one that the register allocator can not use.  This is
9913 useful when compiling kernel code.  A register range is specified as
9914 two registers separated by a dash.  Multiple register ranges can be
9915 specified separated by a comma.
9917 @item -mtls-size=@var{tls-size}
9918 @opindex mtls-size
9919 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9922 @item -mtune=@var{cpu-type}
9923 @opindex mtune
9924 Tune the instruction scheduling for a particular CPU, Valid values are
9925 itanium, itanium1, merced, itanium2, and mckinley.
9927 @item -mt
9928 @itemx -pthread
9929 @opindex mt
9930 @opindex pthread
9931 Add support for multithreading using the POSIX threads library.  This
9932 option sets flags for both the preprocessor and linker.  It does
9933 not affect the thread safety of object code produced by the compiler or
9934 that of libraries supplied with it.  These are HP-UX specific flags.
9936 @item -milp32
9937 @itemx -mlp64
9938 @opindex milp32
9939 @opindex mlp64
9940 Generate code for a 32-bit or 64-bit environment.
9941 The 32-bit environment sets int, long and pointer to 32 bits.
9942 The 64-bit environment sets int to 32 bits and long and pointer
9943 to 64 bits.  These are HP-UX specific flags.
9945 @item -mno-sched-br-data-spec
9946 @itemx -msched-br-data-spec
9947 @opindex -mno-sched-br-data-spec
9948 @opindex -msched-br-data-spec
9949 (Dis/En)able data speculative scheduling before reload.
9950 This will result in generation of the ld.a instructions and
9951 the corresponding check instructions (ld.c / chk.a).
9952 The default is 'disable'.
9954 @item -msched-ar-data-spec
9955 @itemx -mno-sched-ar-data-spec
9956 @opindex -msched-ar-data-spec
9957 @opindex -mno-sched-ar-data-spec
9958 (En/Dis)able data speculative scheduling after reload.
9959 This will result in generation of the ld.a instructions and
9960 the corresponding check instructions (ld.c / chk.a).
9961 The default is 'enable'.
9963 @item -mno-sched-control-spec
9964 @itemx -msched-control-spec
9965 @opindex -mno-sched-control-spec
9966 @opindex -msched-control-spec
9967 (Dis/En)able control speculative scheduling.  This feature is
9968 available only during region scheduling (i.e. before reload).
9969 This will result in generation of the ld.s instructions and
9970 the corresponding check instructions chk.s .
9971 The default is 'disable'.
9973 @item -msched-br-in-data-spec
9974 @itemx -mno-sched-br-in-data-spec
9975 @opindex -msched-br-in-data-spec
9976 @opindex -mno-sched-br-in-data-spec
9977 (En/Dis)able speculative scheduling of the instructions that
9978 are dependent on the data speculative loads before reload.
9979 This is effective only with @option{-msched-br-data-spec} enabled.
9980 The default is 'enable'.
9982 @item -msched-ar-in-data-spec
9983 @itemx -mno-sched-ar-in-data-spec
9984 @opindex -msched-ar-in-data-spec
9985 @opindex -mno-sched-ar-in-data-spec
9986 (En/Dis)able speculative scheduling of the instructions that
9987 are dependent on the data speculative loads after reload.
9988 This is effective only with @option{-msched-ar-data-spec} enabled.
9989 The default is 'enable'.
9991 @item -msched-in-control-spec
9992 @itemx -mno-sched-in-control-spec
9993 @opindex -msched-in-control-spec
9994 @opindex -mno-sched-in-control-spec
9995 (En/Dis)able speculative scheduling of the instructions that
9996 are dependent on the control speculative loads.
9997 This is effective only with @option{-msched-control-spec} enabled.
9998 The default is 'enable'.
10000 @item -msched-ldc
10001 @itemx -mno-sched-ldc
10002 @opindex -msched-ldc
10003 @opindex -mno-sched-ldc
10004 (En/Dis)able use of simple data speculation checks ld.c .
10005 If disabled, only chk.a instructions will be emitted to check
10006 data speculative loads.
10007 The default is 'enable'.
10009 @item -mno-sched-control-ldc
10010 @itemx -msched-control-ldc
10011 @opindex -mno-sched-control-ldc
10012 @opindex -msched-control-ldc 
10013 (Dis/En)able use of ld.c instructions to check control speculative loads.
10014 If enabled, in case of control speculative load with no speculatively
10015 scheduled dependent instructions this load will be emitted as ld.sa and
10016 ld.c will be used to check it.
10017 The default is 'disable'.
10019 @item -mno-sched-spec-verbose
10020 @itemx -msched-spec-verbose
10021 @opindex -mno-sched-spec-verbose
10022 @opindex -msched-spec-verbose
10023 (Dis/En)able printing of the information about speculative motions.
10025 @item -mno-sched-prefer-non-data-spec-insns
10026 @itemx -msched-prefer-non-data-spec-insns
10027 @opindex -mno-sched-prefer-non-data-spec-insns
10028 @opindex -msched-prefer-non-data-spec-insns
10029 If enabled, data speculative instructions will be chosen for schedule
10030 only if there are no other choices at the moment.  This will make
10031 the use of the data speculation much more conservative.
10032 The default is 'disable'.
10034 @item -mno-sched-prefer-non-control-spec-insns
10035 @itemx -msched-prefer-non-control-spec-insns
10036 @opindex -mno-sched-prefer-non-control-spec-insns
10037 @opindex -msched-prefer-non-control-spec-insns
10038 If enabled, control speculative instructions will be chosen for schedule
10039 only if there are no other choices at the moment.  This will make
10040 the use of the control speculation much more conservative.
10041 The default is 'disable'.
10043 @item -mno-sched-count-spec-in-critical-path
10044 @itemx -msched-count-spec-in-critical-path
10045 @opindex -mno-sched-count-spec-in-critical-path
10046 @opindex -msched-count-spec-in-critical-path
10047 If enabled, speculative dependencies will be considered during
10048 computation of the instructions priorities.  This will make the use of the
10049 speculation a bit more conservative.
10050 The default is 'disable'.
10052 @end table
10054 @node M32C Options
10055 @subsection M32C Options
10056 @cindex M32C options
10058 @table @gcctabopt
10059 @item -mcpu=@var{name}
10060 @opindex mcpu=
10061 Select the CPU for which code is generated.  @var{name} may be one of
10062 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10063 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10064 the M32C/80 series.
10066 @item -msim
10067 @opindex msim
10068 Specifies that the program will be run on the simulator.  This causes
10069 an alternate runtime library to be linked in which supports, for
10070 example, file I/O.  You must not use this option when generating
10071 programs that will run on real hardware; you must provide your own
10072 runtime library for whatever I/O functions are needed.
10074 @item -memregs=@var{number}
10075 @opindex memregs=
10076 Specifies the number of memory-based pseudo-registers GCC will use
10077 during code generation.  These pseudo-registers will be used like real
10078 registers, so there is a tradeoff between GCC's ability to fit the
10079 code into available registers, and the performance penalty of using
10080 memory instead of registers.  Note that all modules in a program must
10081 be compiled with the same value for this option.  Because of that, you
10082 must not use this option with the default runtime libraries gcc
10083 builds.
10085 @end table
10087 @node M32R/D Options
10088 @subsection M32R/D Options
10089 @cindex M32R/D options
10091 These @option{-m} options are defined for Renesas M32R/D architectures:
10093 @table @gcctabopt
10094 @item -m32r2
10095 @opindex m32r2
10096 Generate code for the M32R/2@.
10098 @item -m32rx
10099 @opindex m32rx
10100 Generate code for the M32R/X@.
10102 @item -m32r
10103 @opindex m32r
10104 Generate code for the M32R@.  This is the default.
10106 @item -mmodel=small
10107 @opindex mmodel=small
10108 Assume all objects live in the lower 16MB of memory (so that their addresses
10109 can be loaded with the @code{ld24} instruction), and assume all subroutines
10110 are reachable with the @code{bl} instruction.
10111 This is the default.
10113 The addressability of a particular object can be set with the
10114 @code{model} attribute.
10116 @item -mmodel=medium
10117 @opindex mmodel=medium
10118 Assume objects may be anywhere in the 32-bit address space (the compiler
10119 will generate @code{seth/add3} instructions to load their addresses), and
10120 assume all subroutines are reachable with the @code{bl} instruction.
10122 @item -mmodel=large
10123 @opindex mmodel=large
10124 Assume objects may be anywhere in the 32-bit address space (the compiler
10125 will generate @code{seth/add3} instructions to load their addresses), and
10126 assume subroutines may not be reachable with the @code{bl} instruction
10127 (the compiler will generate the much slower @code{seth/add3/jl}
10128 instruction sequence).
10130 @item -msdata=none
10131 @opindex msdata=none
10132 Disable use of the small data area.  Variables will be put into
10133 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10134 @code{section} attribute has been specified).
10135 This is the default.
10137 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10138 Objects may be explicitly put in the small data area with the
10139 @code{section} attribute using one of these sections.
10141 @item -msdata=sdata
10142 @opindex msdata=sdata
10143 Put small global and static data in the small data area, but do not
10144 generate special code to reference them.
10146 @item -msdata=use
10147 @opindex msdata=use
10148 Put small global and static data in the small data area, and generate
10149 special instructions to reference them.
10151 @item -G @var{num}
10152 @opindex G
10153 @cindex smaller data references
10154 Put global and static objects less than or equal to @var{num} bytes
10155 into the small data or bss sections instead of the normal data or bss
10156 sections.  The default value of @var{num} is 8.
10157 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10158 for this option to have any effect.
10160 All modules should be compiled with the same @option{-G @var{num}} value.
10161 Compiling with different values of @var{num} may or may not work; if it
10162 doesn't the linker will give an error message---incorrect code will not be
10163 generated.
10165 @item -mdebug
10166 @opindex mdebug
10167 Makes the M32R specific code in the compiler display some statistics
10168 that might help in debugging programs.
10170 @item -malign-loops
10171 @opindex malign-loops
10172 Align all loops to a 32-byte boundary.
10174 @item -mno-align-loops
10175 @opindex mno-align-loops
10176 Do not enforce a 32-byte alignment for loops.  This is the default.
10178 @item -missue-rate=@var{number}
10179 @opindex missue-rate=@var{number}
10180 Issue @var{number} instructions per cycle.  @var{number} can only be 1
10181 or 2.
10183 @item -mbranch-cost=@var{number}
10184 @opindex mbranch-cost=@var{number}
10185 @var{number} can only be 1 or 2.  If it is 1 then branches will be
10186 preferred over conditional code, if it is 2, then the opposite will
10187 apply.
10189 @item -mflush-trap=@var{number}
10190 @opindex mflush-trap=@var{number}
10191 Specifies the trap number to use to flush the cache.  The default is
10192 12.  Valid numbers are between 0 and 15 inclusive.
10194 @item -mno-flush-trap
10195 @opindex mno-flush-trap
10196 Specifies that the cache cannot be flushed by using a trap.
10198 @item -mflush-func=@var{name}
10199 @opindex mflush-func=@var{name}
10200 Specifies the name of the operating system function to call to flush
10201 the cache.  The default is @emph{_flush_cache}, but a function call
10202 will only be used if a trap is not available.
10204 @item -mno-flush-func
10205 @opindex mno-flush-func
10206 Indicates that there is no OS function for flushing the cache.
10208 @end table
10210 @node M680x0 Options
10211 @subsection M680x0 Options
10212 @cindex M680x0 options
10214 These are the @samp{-m} options defined for the 68000 series.  The default
10215 values for these options depends on which style of 68000 was selected when
10216 the compiler was configured; the defaults for the most common choices are
10217 given below.
10219 @table @gcctabopt
10220 @item -m68000
10221 @itemx -mc68000
10222 @opindex m68000
10223 @opindex mc68000
10224 Generate output for a 68000.  This is the default
10225 when the compiler is configured for 68000-based systems.
10227 Use this option for microcontrollers with a 68000 or EC000 core,
10228 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10230 @item -m68020
10231 @itemx -mc68020
10232 @opindex m68020
10233 @opindex mc68020
10234 Generate output for a 68020.  This is the default
10235 when the compiler is configured for 68020-based systems.
10237 @item -m68881
10238 @opindex m68881
10239 Generate output containing 68881 instructions for floating point.
10240 This is the default for most 68020 systems unless @option{--nfp} was
10241 specified when the compiler was configured.
10243 @item -m68030
10244 @opindex m68030
10245 Generate output for a 68030.  This is the default when the compiler is
10246 configured for 68030-based systems.
10248 @item -m68040
10249 @opindex m68040
10250 Generate output for a 68040.  This is the default when the compiler is
10251 configured for 68040-based systems.
10253 This option inhibits the use of 68881/68882 instructions that have to be
10254 emulated by software on the 68040.  Use this option if your 68040 does not
10255 have code to emulate those instructions.
10257 @item -m68060
10258 @opindex m68060
10259 Generate output for a 68060.  This is the default when the compiler is
10260 configured for 68060-based systems.
10262 This option inhibits the use of 68020 and 68881/68882 instructions that
10263 have to be emulated by software on the 68060.  Use this option if your 68060
10264 does not have code to emulate those instructions.
10266 @item -mcpu32
10267 @opindex mcpu32
10268 Generate output for a CPU32.  This is the default
10269 when the compiler is configured for CPU32-based systems.
10271 Use this option for microcontrollers with a
10272 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
10273 68336, 68340, 68341, 68349 and 68360.
10275 @item -m5200
10276 @opindex m5200
10277 Generate output for a 520X ``coldfire'' family cpu.  This is the default
10278 when the compiler is configured for 520X-based systems.
10280 Use this option for microcontroller with a 5200 core, including
10281 the MCF5202, MCF5203, MCF5204 and MCF5202.
10283 @item -mcfv4e
10284 @opindex mcfv4e
10285 Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
10286 This includes use of hardware floating point instructions.
10288 @item -m68020-40
10289 @opindex m68020-40
10290 Generate output for a 68040, without using any of the new instructions.
10291 This results in code which can run relatively efficiently on either a
10292 68020/68881 or a 68030 or a 68040.  The generated code does use the
10293 68881 instructions that are emulated on the 68040.
10295 @item -m68020-60
10296 @opindex m68020-60
10297 Generate output for a 68060, without using any of the new instructions.
10298 This results in code which can run relatively efficiently on either a
10299 68020/68881 or a 68030 or a 68040.  The generated code does use the
10300 68881 instructions that are emulated on the 68060.
10302 @item -msoft-float
10303 @opindex msoft-float
10304 Generate output containing library calls for floating point.
10305 @strong{Warning:} the requisite libraries are not available for all m68k
10306 targets.  Normally the facilities of the machine's usual C compiler are
10307 used, but this can't be done directly in cross-compilation.  You must
10308 make your own arrangements to provide suitable library functions for
10309 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
10310 @samp{m68k-*-coff} do provide software floating point support.
10312 @item -mshort
10313 @opindex mshort
10314 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10315 Additionally, parameters passed on the stack are also aligned to a
10316 16-bit boundary even on targets whose API mandates promotion to 32-bit.
10318 @item -mnobitfield
10319 @opindex mnobitfield
10320 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
10321 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10323 @item -mbitfield
10324 @opindex mbitfield
10325 Do use the bit-field instructions.  The @option{-m68020} option implies
10326 @option{-mbitfield}.  This is the default if you use a configuration
10327 designed for a 68020.
10329 @item -mrtd
10330 @opindex mrtd
10331 Use a different function-calling convention, in which functions
10332 that take a fixed number of arguments return with the @code{rtd}
10333 instruction, which pops their arguments while returning.  This
10334 saves one instruction in the caller since there is no need to pop
10335 the arguments there.
10337 This calling convention is incompatible with the one normally
10338 used on Unix, so you cannot use it if you need to call libraries
10339 compiled with the Unix compiler.
10341 Also, you must provide function prototypes for all functions that
10342 take variable numbers of arguments (including @code{printf});
10343 otherwise incorrect code will be generated for calls to those
10344 functions.
10346 In addition, seriously incorrect code will result if you call a
10347 function with too many arguments.  (Normally, extra arguments are
10348 harmlessly ignored.)
10350 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10351 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10353 @item -malign-int
10354 @itemx -mno-align-int
10355 @opindex malign-int
10356 @opindex mno-align-int
10357 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10358 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10359 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10360 Aligning variables on 32-bit boundaries produces code that runs somewhat
10361 faster on processors with 32-bit busses at the expense of more memory.
10363 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10364 align structures containing the above types  differently than
10365 most published application binary interface specifications for the m68k.
10367 @item -mpcrel
10368 @opindex mpcrel
10369 Use the pc-relative addressing mode of the 68000 directly, instead of
10370 using a global offset table.  At present, this option implies @option{-fpic},
10371 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10372 not presently supported with @option{-mpcrel}, though this could be supported for
10373 68020 and higher processors.
10375 @item -mno-strict-align
10376 @itemx -mstrict-align
10377 @opindex mno-strict-align
10378 @opindex mstrict-align
10379 Do not (do) assume that unaligned memory references will be handled by
10380 the system.
10382 @item -msep-data
10383 Generate code that allows the data segment to be located in a different
10384 area of memory from the text segment.  This allows for execute in place in
10385 an environment without virtual memory management.  This option implies
10386 @option{-fPIC}.
10388 @item -mno-sep-data
10389 Generate code that assumes that the data segment follows the text segment.
10390 This is the default.
10392 @item -mid-shared-library
10393 Generate code that supports shared libraries via the library ID method.
10394 This allows for execute in place and shared libraries in an environment
10395 without virtual memory management.  This option implies @option{-fPIC}.
10397 @item -mno-id-shared-library
10398 Generate code that doesn't assume ID based shared libraries are being used.
10399 This is the default.
10401 @item -mshared-library-id=n
10402 Specified the identification number of the ID based shared library being
10403 compiled.  Specifying a value of 0 will generate more compact code, specifying
10404 other values will force the allocation of that number to the current
10405 library but is no more space or time efficient than omitting this option.
10407 @end table
10409 @node M68hc1x Options
10410 @subsection M68hc1x Options
10411 @cindex M68hc1x options
10413 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10414 microcontrollers.  The default values for these options depends on
10415 which style of microcontroller was selected when the compiler was configured;
10416 the defaults for the most common choices are given below.
10418 @table @gcctabopt
10419 @item -m6811
10420 @itemx -m68hc11
10421 @opindex m6811
10422 @opindex m68hc11
10423 Generate output for a 68HC11.  This is the default
10424 when the compiler is configured for 68HC11-based systems.
10426 @item -m6812
10427 @itemx -m68hc12
10428 @opindex m6812
10429 @opindex m68hc12
10430 Generate output for a 68HC12.  This is the default
10431 when the compiler is configured for 68HC12-based systems.
10433 @item -m68S12
10434 @itemx -m68hcs12
10435 @opindex m68S12
10436 @opindex m68hcs12
10437 Generate output for a 68HCS12.
10439 @item -mauto-incdec
10440 @opindex mauto-incdec
10441 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10442 addressing modes.
10444 @item -minmax
10445 @itemx -nominmax
10446 @opindex minmax
10447 @opindex mnominmax
10448 Enable the use of 68HC12 min and max instructions.
10450 @item -mlong-calls
10451 @itemx -mno-long-calls
10452 @opindex mlong-calls
10453 @opindex mno-long-calls
10454 Treat all calls as being far away (near).  If calls are assumed to be
10455 far away, the compiler will use the @code{call} instruction to
10456 call a function and the @code{rtc} instruction for returning.
10458 @item -mshort
10459 @opindex mshort
10460 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10462 @item -msoft-reg-count=@var{count}
10463 @opindex msoft-reg-count
10464 Specify the number of pseudo-soft registers which are used for the
10465 code generation.  The maximum number is 32.  Using more pseudo-soft
10466 register may or may not result in better code depending on the program.
10467 The default is 4 for 68HC11 and 2 for 68HC12.
10469 @end table
10471 @node MCore Options
10472 @subsection MCore Options
10473 @cindex MCore options
10475 These are the @samp{-m} options defined for the Motorola M*Core
10476 processors.
10478 @table @gcctabopt
10480 @item -mhardlit
10481 @itemx -mno-hardlit
10482 @opindex mhardlit
10483 @opindex mno-hardlit
10484 Inline constants into the code stream if it can be done in two
10485 instructions or less.
10487 @item -mdiv
10488 @itemx -mno-div
10489 @opindex mdiv
10490 @opindex mno-div
10491 Use the divide instruction.  (Enabled by default).
10493 @item -mrelax-immediate
10494 @itemx -mno-relax-immediate
10495 @opindex mrelax-immediate
10496 @opindex mno-relax-immediate
10497 Allow arbitrary sized immediates in bit operations.
10499 @item -mwide-bitfields
10500 @itemx -mno-wide-bitfields
10501 @opindex mwide-bitfields
10502 @opindex mno-wide-bitfields
10503 Always treat bit-fields as int-sized.
10505 @item -m4byte-functions
10506 @itemx -mno-4byte-functions
10507 @opindex m4byte-functions
10508 @opindex mno-4byte-functions
10509 Force all functions to be aligned to a four byte boundary.
10511 @item -mcallgraph-data
10512 @itemx -mno-callgraph-data
10513 @opindex mcallgraph-data
10514 @opindex mno-callgraph-data
10515 Emit callgraph information.
10517 @item -mslow-bytes
10518 @itemx -mno-slow-bytes
10519 @opindex mslow-bytes
10520 @opindex mno-slow-bytes
10521 Prefer word access when reading byte quantities.
10523 @item -mlittle-endian
10524 @itemx -mbig-endian
10525 @opindex mlittle-endian
10526 @opindex mbig-endian
10527 Generate code for a little endian target.
10529 @item -m210
10530 @itemx -m340
10531 @opindex m210
10532 @opindex m340
10533 Generate code for the 210 processor.
10534 @end table
10536 @node MIPS Options
10537 @subsection MIPS Options
10538 @cindex MIPS options
10540 @table @gcctabopt
10542 @item -EB
10543 @opindex EB
10544 Generate big-endian code.
10546 @item -EL
10547 @opindex EL
10548 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10549 configurations.
10551 @item -march=@var{arch}
10552 @opindex march
10553 Generate code that will run on @var{arch}, which can be the name of a
10554 generic MIPS ISA, or the name of a particular processor.
10555 The ISA names are:
10556 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10557 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10558 The processor names are:
10559 @samp{4kc}, @samp{4km}, @samp{4kp},
10560 @samp{4kec}, @samp{4kem}, @samp{4kep},
10561 @samp{5kc}, @samp{5kf},
10562 @samp{20kc},
10563 @samp{24kc}, @samp{24kf}, @samp{24kx},
10564 @samp{24kec}, @samp{24kef}, @samp{24kex},
10565 @samp{34kc}, @samp{34kf}, @samp{34kx},
10566 @samp{m4k},
10567 @samp{orion},
10568 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10569 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10570 @samp{rm7000}, @samp{rm9000},
10571 @samp{sb1},
10572 @samp{sr71000},
10573 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10574 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10575 The special value @samp{from-abi} selects the
10576 most compatible architecture for the selected ABI (that is,
10577 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10579 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10580 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10581 @samp{vr} may be written @samp{r}.
10583 GCC defines two macros based on the value of this option.  The first
10584 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10585 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10586 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10587 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10588 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10590 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10591 above.  In other words, it will have the full prefix and will not
10592 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10593 the macro names the resolved architecture (either @samp{"mips1"} or
10594 @samp{"mips3"}).  It names the default architecture when no
10595 @option{-march} option is given.
10597 @item -mtune=@var{arch}
10598 @opindex mtune
10599 Optimize for @var{arch}.  Among other things, this option controls
10600 the way instructions are scheduled, and the perceived cost of arithmetic
10601 operations.  The list of @var{arch} values is the same as for
10602 @option{-march}.
10604 When this option is not used, GCC will optimize for the processor
10605 specified by @option{-march}.  By using @option{-march} and
10606 @option{-mtune} together, it is possible to generate code that will
10607 run on a family of processors, but optimize the code for one
10608 particular member of that family.
10610 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10611 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10612 @samp{-march} ones described above.
10614 @item -mips1
10615 @opindex mips1
10616 Equivalent to @samp{-march=mips1}.
10618 @item -mips2
10619 @opindex mips2
10620 Equivalent to @samp{-march=mips2}.
10622 @item -mips3
10623 @opindex mips3
10624 Equivalent to @samp{-march=mips3}.
10626 @item -mips4
10627 @opindex mips4
10628 Equivalent to @samp{-march=mips4}.
10630 @item -mips32
10631 @opindex mips32
10632 Equivalent to @samp{-march=mips32}.
10634 @item -mips32r2
10635 @opindex mips32r2
10636 Equivalent to @samp{-march=mips32r2}.
10638 @item -mips64
10639 @opindex mips64
10640 Equivalent to @samp{-march=mips64}.
10642 @item -mips16
10643 @itemx -mno-mips16
10644 @opindex mips16
10645 @opindex mno-mips16
10646 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10647 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10649 @item -mabi=32
10650 @itemx -mabi=o64
10651 @itemx -mabi=n32
10652 @itemx -mabi=64
10653 @itemx -mabi=eabi
10654 @opindex mabi=32
10655 @opindex mabi=o64
10656 @opindex mabi=n32
10657 @opindex mabi=64
10658 @opindex mabi=eabi
10659 Generate code for the given ABI@.
10661 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10662 generates 64-bit code when you select a 64-bit architecture, but you
10663 can use @option{-mgp32} to get 32-bit code instead.
10665 For information about the O64 ABI, see
10666 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10668 GCC supports a variant of the o32 ABI in which floating-point registers
10669 are 64 rather than 32 bits wide.  You can select this combination with
10670 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
10671 and @samp{mfhc1} instructions and is therefore only supported for
10672 MIPS32R2 processors.
10674 The register assignments for arguments and return values remain the
10675 same, but each scalar value is passed in a single 64-bit register
10676 rather than a pair of 32-bit registers.  For example, scalar
10677 floating-point values are returned in @samp{$f0} only, not a
10678 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
10679 remains the same, but all 64 bits are saved.
10681 @item -mabicalls
10682 @itemx -mno-abicalls
10683 @opindex mabicalls
10684 @opindex mno-abicalls
10685 Generate (do not generate) code that is suitable for SVR4-style
10686 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
10687 systems.
10689 @item -mshared
10690 @itemx -mno-shared
10691 Generate (do not generate) code that is fully position-independent,
10692 and that can therefore be linked into shared libraries.  This option
10693 only affects @option{-mabicalls}.
10695 All @option{-mabicalls} code has traditionally been position-independent,
10696 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
10697 as an extension, the GNU toolchain allows executables to use absolute
10698 accesses for locally-binding symbols.  It can also use shorter GP
10699 initialization sequences and generate direct calls to locally-defined
10700 functions.  This mode is selected by @option{-mno-shared}.
10702 @option{-mno-shared} depends on binutils 2.16 or higher and generates
10703 objects that can only be linked by the GNU linker.  However, the option
10704 does not affect the ABI of the final executable; it only affects the ABI
10705 of relocatable objects.  Using @option{-mno-shared} will generally make
10706 executables both smaller and quicker.
10708 @option{-mshared} is the default.
10710 @item -mxgot
10711 @itemx -mno-xgot
10712 @opindex mxgot
10713 @opindex mno-xgot
10714 Lift (do not lift) the usual restrictions on the size of the global
10715 offset table.
10717 GCC normally uses a single instruction to load values from the GOT@.
10718 While this is relatively efficient, it will only work if the GOT
10719 is smaller than about 64k.  Anything larger will cause the linker
10720 to report an error such as:
10722 @cindex relocation truncated to fit (MIPS)
10723 @smallexample
10724 relocation truncated to fit: R_MIPS_GOT16 foobar
10725 @end smallexample
10727 If this happens, you should recompile your code with @option{-mxgot}.
10728 It should then work with very large GOTs, although it will also be
10729 less efficient, since it will take three instructions to fetch the
10730 value of a global symbol.
10732 Note that some linkers can create multiple GOTs.  If you have such a
10733 linker, you should only need to use @option{-mxgot} when a single object
10734 file accesses more than 64k's worth of GOT entries.  Very few do.
10736 These options have no effect unless GCC is generating position
10737 independent code.
10739 @item -mgp32
10740 @opindex mgp32
10741 Assume that general-purpose registers are 32 bits wide.
10743 @item -mgp64
10744 @opindex mgp64
10745 Assume that general-purpose registers are 64 bits wide.
10747 @item -mfp32
10748 @opindex mfp32
10749 Assume that floating-point registers are 32 bits wide.
10751 @item -mfp64
10752 @opindex mfp64
10753 Assume that floating-point registers are 64 bits wide.
10755 @item -mhard-float
10756 @opindex mhard-float
10757 Use floating-point coprocessor instructions.
10759 @item -msoft-float
10760 @opindex msoft-float
10761 Do not use floating-point coprocessor instructions.  Implement
10762 floating-point calculations using library calls instead.
10764 @item -msingle-float
10765 @opindex msingle-float
10766 Assume that the floating-point coprocessor only supports single-precision
10767 operations.
10769 @itemx -mdouble-float
10770 @opindex mdouble-float
10771 Assume that the floating-point coprocessor supports double-precision
10772 operations.  This is the default.
10774 @itemx -mdsp
10775 @itemx -mno-dsp
10776 @opindex mdsp
10777 @opindex mno-dsp
10778 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10780 @itemx -mpaired-single
10781 @itemx -mno-paired-single
10782 @opindex mpaired-single
10783 @opindex mno-paired-single
10784 Use (do not use) paired-single floating-point instructions.
10785 @xref{MIPS Paired-Single Support}.  This option can only be used
10786 when generating 64-bit code and requires hardware floating-point
10787 support to be enabled.
10789 @itemx -mips3d
10790 @itemx -mno-mips3d
10791 @opindex mips3d
10792 @opindex mno-mips3d
10793 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10794 The option @option{-mips3d} implies @option{-mpaired-single}.
10796 @item -mlong64
10797 @opindex mlong64
10798 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10799 an explanation of the default and the way that the pointer size is
10800 determined.
10802 @item -mlong32
10803 @opindex mlong32
10804 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10806 The default size of @code{int}s, @code{long}s and pointers depends on
10807 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10808 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10809 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10810 or the same size as integer registers, whichever is smaller.
10812 @item -msym32
10813 @itemx -mno-sym32
10814 @opindex msym32
10815 @opindex mno-sym32
10816 Assume (do not assume) that all symbols have 32-bit values, regardless
10817 of the selected ABI@.  This option is useful in combination with
10818 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10819 to generate shorter and faster references to symbolic addresses.
10821 @item -G @var{num}
10822 @opindex G
10823 @cindex smaller data references (MIPS)
10824 @cindex gp-relative references (MIPS)
10825 Put global and static items less than or equal to @var{num} bytes into
10826 the small data or bss section instead of the normal data or bss section.
10827 This allows the data to be accessed using a single instruction.
10829 All modules should be compiled with the same @option{-G @var{num}}
10830 value.
10832 @item -membedded-data
10833 @itemx -mno-embedded-data
10834 @opindex membedded-data
10835 @opindex mno-embedded-data
10836 Allocate variables to the read-only data section first if possible, then
10837 next in the small data section if possible, otherwise in data.  This gives
10838 slightly slower code than the default, but reduces the amount of RAM required
10839 when executing, and thus may be preferred for some embedded systems.
10841 @item -muninit-const-in-rodata
10842 @itemx -mno-uninit-const-in-rodata
10843 @opindex muninit-const-in-rodata
10844 @opindex mno-uninit-const-in-rodata
10845 Put uninitialized @code{const} variables in the read-only data section.
10846 This option is only meaningful in conjunction with @option{-membedded-data}.
10848 @item -msplit-addresses
10849 @itemx -mno-split-addresses
10850 @opindex msplit-addresses
10851 @opindex mno-split-addresses
10852 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10853 relocation operators.  This option has been superseded by
10854 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10856 @item -mexplicit-relocs
10857 @itemx -mno-explicit-relocs
10858 @opindex mexplicit-relocs
10859 @opindex mno-explicit-relocs
10860 Use (do not use) assembler relocation operators when dealing with symbolic
10861 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10862 is to use assembler macros instead.
10864 @option{-mexplicit-relocs} is the default if GCC was configured
10865 to use an assembler that supports relocation operators.
10867 @item -mcheck-zero-division
10868 @itemx -mno-check-zero-division
10869 @opindex mcheck-zero-division
10870 @opindex mno-check-zero-division
10871 Trap (do not trap) on integer division by zero.  The default is
10872 @option{-mcheck-zero-division}.
10874 @item -mdivide-traps
10875 @itemx -mdivide-breaks
10876 @opindex mdivide-traps
10877 @opindex mdivide-breaks
10878 MIPS systems check for division by zero by generating either a
10879 conditional trap or a break instruction.  Using traps results in
10880 smaller code, but is only supported on MIPS II and later.  Also, some
10881 versions of the Linux kernel have a bug that prevents trap from
10882 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10883 allow conditional traps on architectures that support them and
10884 @option{-mdivide-breaks} to force the use of breaks.
10886 The default is usually @option{-mdivide-traps}, but this can be
10887 overridden at configure time using @option{--with-divide=breaks}.
10888 Divide-by-zero checks can be completely disabled using
10889 @option{-mno-check-zero-division}.
10891 @item -mmemcpy
10892 @itemx -mno-memcpy
10893 @opindex mmemcpy
10894 @opindex mno-memcpy
10895 Force (do not force) the use of @code{memcpy()} for non-trivial block
10896 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10897 most constant-sized copies.
10899 @item -mlong-calls
10900 @itemx -mno-long-calls
10901 @opindex mlong-calls
10902 @opindex mno-long-calls
10903 Disable (do not disable) use of the @code{jal} instruction.  Calling
10904 functions using @code{jal} is more efficient but requires the caller
10905 and callee to be in the same 256 megabyte segment.
10907 This option has no effect on abicalls code.  The default is
10908 @option{-mno-long-calls}.
10910 @item -mmad
10911 @itemx -mno-mad
10912 @opindex mmad
10913 @opindex mno-mad
10914 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10915 instructions, as provided by the R4650 ISA@.
10917 @item -mfused-madd
10918 @itemx -mno-fused-madd
10919 @opindex mfused-madd
10920 @opindex mno-fused-madd
10921 Enable (disable) use of the floating point multiply-accumulate
10922 instructions, when they are available.  The default is
10923 @option{-mfused-madd}.
10925 When multiply-accumulate instructions are used, the intermediate
10926 product is calculated to infinite precision and is not subject to
10927 the FCSR Flush to Zero bit.  This may be undesirable in some
10928 circumstances.
10930 @item -nocpp
10931 @opindex nocpp
10932 Tell the MIPS assembler to not run its preprocessor over user
10933 assembler files (with a @samp{.s} suffix) when assembling them.
10935 @item -mfix-r4000
10936 @itemx -mno-fix-r4000
10937 @opindex mfix-r4000
10938 @opindex mno-fix-r4000
10939 Work around certain R4000 CPU errata:
10940 @itemize @minus
10941 @item
10942 A double-word or a variable shift may give an incorrect result if executed
10943 immediately after starting an integer division.
10944 @item
10945 A double-word or a variable shift may give an incorrect result if executed
10946 while an integer multiplication is in progress.
10947 @item
10948 An integer division may give an incorrect result if started in a delay slot
10949 of a taken branch or a jump.
10950 @end itemize
10952 @item -mfix-r4400
10953 @itemx -mno-fix-r4400
10954 @opindex mfix-r4400
10955 @opindex mno-fix-r4400
10956 Work around certain R4400 CPU errata:
10957 @itemize @minus
10958 @item
10959 A double-word or a variable shift may give an incorrect result if executed
10960 immediately after starting an integer division.
10961 @end itemize
10963 @item -mfix-vr4120
10964 @itemx -mno-fix-vr4120
10965 @opindex mfix-vr4120
10966 Work around certain VR4120 errata:
10967 @itemize @minus
10968 @item
10969 @code{dmultu} does not always produce the correct result.
10970 @item
10971 @code{div} and @code{ddiv} do not always produce the correct result if one
10972 of the operands is negative.
10973 @end itemize
10974 The workarounds for the division errata rely on special functions in
10975 @file{libgcc.a}.  At present, these functions are only provided by
10976 the @code{mips64vr*-elf} configurations.
10978 Other VR4120 errata require a nop to be inserted between certain pairs of
10979 instructions.  These errata are handled by the assembler, not by GCC itself.
10981 @item -mfix-vr4130
10982 @opindex mfix-vr4130
10983 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10984 workarounds are implemented by the assembler rather than by GCC,
10985 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10986 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10987 instructions are available instead.
10989 @item -mfix-sb1
10990 @itemx -mno-fix-sb1
10991 @opindex mfix-sb1
10992 Work around certain SB-1 CPU core errata.
10993 (This flag currently works around the SB-1 revision 2
10994 ``F1'' and ``F2'' floating point errata.)
10996 @item -mflush-func=@var{func}
10997 @itemx -mno-flush-func
10998 @opindex mflush-func
10999 Specifies the function to call to flush the I and D caches, or to not
11000 call any such function.  If called, the function must take the same
11001 arguments as the common @code{_flush_func()}, that is, the address of the
11002 memory range for which the cache is being flushed, the size of the
11003 memory range, and the number 3 (to flush both caches).  The default
11004 depends on the target GCC was configured for, but commonly is either
11005 @samp{_flush_func} or @samp{__cpu_flush}.
11007 @item -mbranch-likely
11008 @itemx -mno-branch-likely
11009 @opindex mbranch-likely
11010 @opindex mno-branch-likely
11011 Enable or disable use of Branch Likely instructions, regardless of the
11012 default for the selected architecture.  By default, Branch Likely
11013 instructions may be generated if they are supported by the selected
11014 architecture.  An exception is for the MIPS32 and MIPS64 architectures
11015 and processors which implement those architectures; for those, Branch
11016 Likely instructions will not be generated by default because the MIPS32
11017 and MIPS64 architectures specifically deprecate their use.
11019 @item -mfp-exceptions
11020 @itemx -mno-fp-exceptions
11021 @opindex mfp-exceptions
11022 Specifies whether FP exceptions are enabled.  This affects how we schedule
11023 FP instructions for some processors.  The default is that FP exceptions are
11024 enabled.
11026 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
11027 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
11028 FP pipe.
11030 @item -mvr4130-align
11031 @itemx -mno-vr4130-align
11032 @opindex mvr4130-align
11033 The VR4130 pipeline is two-way superscalar, but can only issue two
11034 instructions together if the first one is 8-byte aligned.  When this
11035 option is enabled, GCC will align pairs of instructions that it
11036 thinks should execute in parallel.
11038 This option only has an effect when optimizing for the VR4130.
11039 It normally makes code faster, but at the expense of making it bigger.
11040 It is enabled by default at optimization level @option{-O3}.
11041 @end table
11043 @node MMIX Options
11044 @subsection MMIX Options
11045 @cindex MMIX Options
11047 These options are defined for the MMIX:
11049 @table @gcctabopt
11050 @item -mlibfuncs
11051 @itemx -mno-libfuncs
11052 @opindex mlibfuncs
11053 @opindex mno-libfuncs
11054 Specify that intrinsic library functions are being compiled, passing all
11055 values in registers, no matter the size.
11057 @item -mepsilon
11058 @itemx -mno-epsilon
11059 @opindex mepsilon
11060 @opindex mno-epsilon
11061 Generate floating-point comparison instructions that compare with respect
11062 to the @code{rE} epsilon register.
11064 @item -mabi=mmixware
11065 @itemx -mabi=gnu
11066 @opindex mabi-mmixware
11067 @opindex mabi=gnu
11068 Generate code that passes function parameters and return values that (in
11069 the called function) are seen as registers @code{$0} and up, as opposed to
11070 the GNU ABI which uses global registers @code{$231} and up.
11072 @item -mzero-extend
11073 @itemx -mno-zero-extend
11074 @opindex mzero-extend
11075 @opindex mno-zero-extend
11076 When reading data from memory in sizes shorter than 64 bits, use (do not
11077 use) zero-extending load instructions by default, rather than
11078 sign-extending ones.
11080 @item -mknuthdiv
11081 @itemx -mno-knuthdiv
11082 @opindex mknuthdiv
11083 @opindex mno-knuthdiv
11084 Make the result of a division yielding a remainder have the same sign as
11085 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
11086 remainder follows the sign of the dividend.  Both methods are
11087 arithmetically valid, the latter being almost exclusively used.
11089 @item -mtoplevel-symbols
11090 @itemx -mno-toplevel-symbols
11091 @opindex mtoplevel-symbols
11092 @opindex mno-toplevel-symbols
11093 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11094 code can be used with the @code{PREFIX} assembly directive.
11096 @item -melf
11097 @opindex melf
11098 Generate an executable in the ELF format, rather than the default
11099 @samp{mmo} format used by the @command{mmix} simulator.
11101 @item -mbranch-predict
11102 @itemx -mno-branch-predict
11103 @opindex mbranch-predict
11104 @opindex mno-branch-predict
11105 Use (do not use) the probable-branch instructions, when static branch
11106 prediction indicates a probable branch.
11108 @item -mbase-addresses
11109 @itemx -mno-base-addresses
11110 @opindex mbase-addresses
11111 @opindex mno-base-addresses
11112 Generate (do not generate) code that uses @emph{base addresses}.  Using a
11113 base address automatically generates a request (handled by the assembler
11114 and the linker) for a constant to be set up in a global register.  The
11115 register is used for one or more base address requests within the range 0
11116 to 255 from the value held in the register.  The generally leads to short
11117 and fast code, but the number of different data items that can be
11118 addressed is limited.  This means that a program that uses lots of static
11119 data may require @option{-mno-base-addresses}.
11121 @item -msingle-exit
11122 @itemx -mno-single-exit
11123 @opindex msingle-exit
11124 @opindex mno-single-exit
11125 Force (do not force) generated code to have a single exit point in each
11126 function.
11127 @end table
11129 @node MN10300 Options
11130 @subsection MN10300 Options
11131 @cindex MN10300 options
11133 These @option{-m} options are defined for Matsushita MN10300 architectures:
11135 @table @gcctabopt
11136 @item -mmult-bug
11137 @opindex mmult-bug
11138 Generate code to avoid bugs in the multiply instructions for the MN10300
11139 processors.  This is the default.
11141 @item -mno-mult-bug
11142 @opindex mno-mult-bug
11143 Do not generate code to avoid bugs in the multiply instructions for the
11144 MN10300 processors.
11146 @item -mam33
11147 @opindex mam33
11148 Generate code which uses features specific to the AM33 processor.
11150 @item -mno-am33
11151 @opindex mno-am33
11152 Do not generate code which uses features specific to the AM33 processor.  This
11153 is the default.
11155 @item -mreturn-pointer-on-d0
11156 @opindex mreturn-pointer-on-d0
11157 When generating a function which returns a pointer, return the pointer
11158 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
11159 only in a0, and attempts to call such functions without a prototype
11160 would result in errors.  Note that this option is on by default; use
11161 @option{-mno-return-pointer-on-d0} to disable it.
11163 @item -mno-crt0
11164 @opindex mno-crt0
11165 Do not link in the C run-time initialization object file.
11167 @item -mrelax
11168 @opindex mrelax
11169 Indicate to the linker that it should perform a relaxation optimization pass
11170 to shorten branches, calls and absolute memory addresses.  This option only
11171 has an effect when used on the command line for the final link step.
11173 This option makes symbolic debugging impossible.
11174 @end table
11176 @node MT Options
11177 @subsection MT Options
11178 @cindex MT options
11180 These @option{-m} options are defined for Morpho MT architectures:
11182 @table @gcctabopt
11184 @item -march=@var{cpu-type}
11185 @opindex march
11186 Generate code that will run on @var{cpu-type}, which is the name of a system
11187 representing a certain processor type.  Possible values for
11188 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11189 @samp{ms1-16-003} and @samp{ms2}.
11191 When this option is not used, the default is @option{-march=ms1-16-002}.
11193 @item -mbacc
11194 @opindex mbacc
11195 Use byte loads and stores when generating code.
11197 @item -mno-bacc
11198 @opindex mno-bacc
11199 Do not use byte loads and stores when generating code.
11201 @item -msim
11202 @opindex msim
11203 Use simulator runtime
11205 @item -mno-crt0
11206 @opindex mno-crt0
11207 Do not link in the C run-time initialization object file
11208 @file{crti.o}.  Other run-time initialization and termination files
11209 such as @file{startup.o} and @file{exit.o} are still included on the
11210 linker command line.
11212 @end table
11214 @node PDP-11 Options
11215 @subsection PDP-11 Options
11216 @cindex PDP-11 Options
11218 These options are defined for the PDP-11:
11220 @table @gcctabopt
11221 @item -mfpu
11222 @opindex mfpu
11223 Use hardware FPP floating point.  This is the default.  (FIS floating
11224 point on the PDP-11/40 is not supported.)
11226 @item -msoft-float
11227 @opindex msoft-float
11228 Do not use hardware floating point.
11230 @item -mac0
11231 @opindex mac0
11232 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11234 @item -mno-ac0
11235 @opindex mno-ac0
11236 Return floating-point results in memory.  This is the default.
11238 @item -m40
11239 @opindex m40
11240 Generate code for a PDP-11/40.
11242 @item -m45
11243 @opindex m45
11244 Generate code for a PDP-11/45.  This is the default.
11246 @item -m10
11247 @opindex m10
11248 Generate code for a PDP-11/10.
11250 @item -mbcopy-builtin
11251 @opindex bcopy-builtin
11252 Use inline @code{movmemhi} patterns for copying memory.  This is the
11253 default.
11255 @item -mbcopy
11256 @opindex mbcopy
11257 Do not use inline @code{movmemhi} patterns for copying memory.
11259 @item -mint16
11260 @itemx -mno-int32
11261 @opindex mint16
11262 @opindex mno-int32
11263 Use 16-bit @code{int}.  This is the default.
11265 @item -mint32
11266 @itemx -mno-int16
11267 @opindex mint32
11268 @opindex mno-int16
11269 Use 32-bit @code{int}.
11271 @item -mfloat64
11272 @itemx -mno-float32
11273 @opindex mfloat64
11274 @opindex mno-float32
11275 Use 64-bit @code{float}.  This is the default.
11277 @item -mfloat32
11278 @itemx -mno-float64
11279 @opindex mfloat32
11280 @opindex mno-float64
11281 Use 32-bit @code{float}.
11283 @item -mabshi
11284 @opindex mabshi
11285 Use @code{abshi2} pattern.  This is the default.
11287 @item -mno-abshi
11288 @opindex mno-abshi
11289 Do not use @code{abshi2} pattern.
11291 @item -mbranch-expensive
11292 @opindex mbranch-expensive
11293 Pretend that branches are expensive.  This is for experimenting with
11294 code generation only.
11296 @item -mbranch-cheap
11297 @opindex mbranch-cheap
11298 Do not pretend that branches are expensive.  This is the default.
11300 @item -msplit
11301 @opindex msplit
11302 Generate code for a system with split I&D@.
11304 @item -mno-split
11305 @opindex mno-split
11306 Generate code for a system without split I&D@.  This is the default.
11308 @item -munix-asm
11309 @opindex munix-asm
11310 Use Unix assembler syntax.  This is the default when configured for
11311 @samp{pdp11-*-bsd}.
11313 @item -mdec-asm
11314 @opindex mdec-asm
11315 Use DEC assembler syntax.  This is the default when configured for any
11316 PDP-11 target other than @samp{pdp11-*-bsd}.
11317 @end table
11319 @node PowerPC Options
11320 @subsection PowerPC Options
11321 @cindex PowerPC options
11323 These are listed under @xref{RS/6000 and PowerPC Options}.
11325 @node RS/6000 and PowerPC Options
11326 @subsection IBM RS/6000 and PowerPC Options
11327 @cindex RS/6000 and PowerPC Options
11328 @cindex IBM RS/6000 and PowerPC Options
11330 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11331 @table @gcctabopt
11332 @item -mpower
11333 @itemx -mno-power
11334 @itemx -mpower2
11335 @itemx -mno-power2
11336 @itemx -mpowerpc
11337 @itemx -mno-powerpc
11338 @itemx -mpowerpc-gpopt
11339 @itemx -mno-powerpc-gpopt
11340 @itemx -mpowerpc-gfxopt
11341 @itemx -mno-powerpc-gfxopt
11342 @itemx -mpowerpc64
11343 @itemx -mno-powerpc64
11344 @itemx -mmfcrf
11345 @itemx -mno-mfcrf
11346 @itemx -mpopcntb
11347 @itemx -mno-popcntb
11348 @itemx -mfprnd
11349 @itemx -mno-fprnd
11350 @itemx -mmfpgpr
11351 @itemx -mno-mfpgpr
11352 @opindex mpower
11353 @opindex mno-power
11354 @opindex mpower2
11355 @opindex mno-power2
11356 @opindex mpowerpc
11357 @opindex mno-powerpc
11358 @opindex mpowerpc-gpopt
11359 @opindex mno-powerpc-gpopt
11360 @opindex mpowerpc-gfxopt
11361 @opindex mno-powerpc-gfxopt
11362 @opindex mpowerpc64
11363 @opindex mno-powerpc64
11364 @opindex mmfcrf
11365 @opindex mno-mfcrf
11366 @opindex mpopcntb
11367 @opindex mno-popcntb
11368 @opindex mfprnd
11369 @opindex mno-fprnd
11370 @opindex mmfpgpr
11371 @opindex mno-mfpgpr
11372 GCC supports two related instruction set architectures for the
11373 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11374 instructions supported by the @samp{rios} chip set used in the original
11375 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11376 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11377 the IBM 4xx, 6xx, and follow-on microprocessors.
11379 Neither architecture is a subset of the other.  However there is a
11380 large common subset of instructions supported by both.  An MQ
11381 register is included in processors supporting the POWER architecture.
11383 You use these options to specify which instructions are available on the
11384 processor you are using.  The default value of these options is
11385 determined when configuring GCC@.  Specifying the
11386 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11387 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11388 rather than the options listed above.
11390 The @option{-mpower} option allows GCC to generate instructions that
11391 are found only in the POWER architecture and to use the MQ register.
11392 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11393 to generate instructions that are present in the POWER2 architecture but
11394 not the original POWER architecture.
11396 The @option{-mpowerpc} option allows GCC to generate instructions that
11397 are found only in the 32-bit subset of the PowerPC architecture.
11398 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11399 GCC to use the optional PowerPC architecture instructions in the
11400 General Purpose group, including floating-point square root.  Specifying
11401 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11402 use the optional PowerPC architecture instructions in the Graphics
11403 group, including floating-point select.
11405 The @option{-mmfcrf} option allows GCC to generate the move from
11406 condition register field instruction implemented on the POWER4
11407 processor and other processors that support the PowerPC V2.01
11408 architecture.
11409 The @option{-mpopcntb} option allows GCC to generate the popcount and
11410 double precision FP reciprocal estimate instruction implemented on the
11411 POWER5 processor and other processors that support the PowerPC V2.02
11412 architecture.
11413 The @option{-mfprnd} option allows GCC to generate the FP round to
11414 integer instructions implemented on the POWER5+ processor and other
11415 processors that support the PowerPC V2.03 architecture.
11416 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
11417 general purpose register instructions implemented on the POWER6X
11418 processor and other processors that support the extended PowerPC V2.05
11419 architecture.
11421 The @option{-mpowerpc64} option allows GCC to generate the additional
11422 64-bit instructions that are found in the full PowerPC64 architecture
11423 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11424 @option{-mno-powerpc64}.
11426 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11427 will use only the instructions in the common subset of both
11428 architectures plus some special AIX common-mode calls, and will not use
11429 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11430 permits GCC to use any instruction from either architecture and to
11431 allow use of the MQ register; specify this for the Motorola MPC601.
11433 @item -mnew-mnemonics
11434 @itemx -mold-mnemonics
11435 @opindex mnew-mnemonics
11436 @opindex mold-mnemonics
11437 Select which mnemonics to use in the generated assembler code.  With
11438 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11439 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11440 assembler mnemonics defined for the POWER architecture.  Instructions
11441 defined in only one architecture have only one mnemonic; GCC uses that
11442 mnemonic irrespective of which of these options is specified.
11444 GCC defaults to the mnemonics appropriate for the architecture in
11445 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11446 value of these option.  Unless you are building a cross-compiler, you
11447 should normally not specify either @option{-mnew-mnemonics} or
11448 @option{-mold-mnemonics}, but should instead accept the default.
11450 @item -mcpu=@var{cpu_type}
11451 @opindex mcpu
11452 Set architecture type, register usage, choice of mnemonics, and
11453 instruction scheduling parameters for machine type @var{cpu_type}.
11454 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11455 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11456 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11457 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11458 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11459 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11460 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11461 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11462 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
11463 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11465 @option{-mcpu=common} selects a completely generic processor.  Code
11466 generated under this option will run on any POWER or PowerPC processor.
11467 GCC will use only the instructions in the common subset of both
11468 architectures, and will not use the MQ register.  GCC assumes a generic
11469 processor model for scheduling purposes.
11471 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11472 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11473 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11474 types, with an appropriate, generic processor model assumed for
11475 scheduling purposes.
11477 The other options specify a specific processor.  Code generated under
11478 those options will run best on that processor, and may not run at all on
11479 others.
11481 The @option{-mcpu} options automatically enable or disable the
11482 following options: @option{-maltivec}, @option{-mfprnd},
11483 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11484 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11485 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11486 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw},
11487 @option{-mdlmzb}, @option{-mmfpgpr}.
11488 The particular options set for any particular CPU will vary between
11489 compiler versions, depending on what setting seems to produce optimal
11490 code for that CPU; it doesn't necessarily reflect the actual hardware's
11491 capabilities.  If you wish to set an individual option to a particular
11492 value, you may specify it after the @option{-mcpu} option, like
11493 @samp{-mcpu=970 -mno-altivec}.
11495 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11496 not enabled or disabled by the @option{-mcpu} option at present because
11497 AIX does not have full support for these options.  You may still
11498 enable or disable them individually if you're sure it'll work in your
11499 environment.
11501 @item -mtune=@var{cpu_type}
11502 @opindex mtune
11503 Set the instruction scheduling parameters for machine type
11504 @var{cpu_type}, but do not set the architecture type, register usage, or
11505 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11506 values for @var{cpu_type} are used for @option{-mtune} as for
11507 @option{-mcpu}.  If both are specified, the code generated will use the
11508 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11509 scheduling parameters set by @option{-mtune}.
11511 @item -mswdiv
11512 @itemx -mno-swdiv
11513 @opindex mswdiv
11514 @opindex mno-swdiv
11515 Generate code to compute division as reciprocal estimate and iterative
11516 refinement, creating opportunities for increased throughput.  This
11517 feature requires: optional PowerPC Graphics instruction set for single
11518 precision and FRE instruction for double precision, assuming divides
11519 cannot generate user-visible traps, and the domain values not include
11520 Infinities, denormals or zero denominator.
11522 @item -maltivec
11523 @itemx -mno-altivec
11524 @opindex maltivec
11525 @opindex mno-altivec
11526 Generate code that uses (does not use) AltiVec instructions, and also
11527 enable the use of built-in functions that allow more direct access to
11528 the AltiVec instruction set.  You may also need to set
11529 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11530 enhancements.
11532 @item -mvrsave
11533 @item -mno-vrsave
11534 @opindex mvrsave
11535 @opindex mno-vrsave
11536 Generate VRSAVE instructions when generating AltiVec code.
11538 @item -msecure-plt
11539 @opindex msecure-plt
11540 Generate code that allows ld and ld.so to build executables and shared
11541 libraries with non-exec .plt and .got sections.  This is a PowerPC
11542 32-bit SYSV ABI option.
11544 @item -mbss-plt
11545 @opindex mbss-plt
11546 Generate code that uses a BSS .plt section that ld.so fills in, and
11547 requires .plt and .got sections that are both writable and executable.
11548 This is a PowerPC 32-bit SYSV ABI option.
11550 @item -misel
11551 @itemx -mno-isel
11552 @opindex misel
11553 @opindex mno-isel
11554 This switch enables or disables the generation of ISEL instructions.
11556 @item -misel=@var{yes/no}
11557 This switch has been deprecated.  Use @option{-misel} and
11558 @option{-mno-isel} instead.
11560 @item -mspe
11561 @itemx -mno-spe
11562 @opindex mspe
11563 @opindex mno-spe
11564 This switch enables or disables the generation of SPE simd
11565 instructions.
11567 @item -mspe=@var{yes/no}
11568 This option has been deprecated.  Use @option{-mspe} and
11569 @option{-mno-spe} instead.
11571 @item -mfloat-gprs=@var{yes/single/double/no}
11572 @itemx -mfloat-gprs
11573 @opindex mfloat-gprs
11574 This switch enables or disables the generation of floating point
11575 operations on the general purpose registers for architectures that
11576 support it.
11578 The argument @var{yes} or @var{single} enables the use of
11579 single-precision floating point operations.
11581 The argument @var{double} enables the use of single and
11582 double-precision floating point operations.
11584 The argument @var{no} disables floating point operations on the
11585 general purpose registers.
11587 This option is currently only available on the MPC854x.
11589 @item -m32
11590 @itemx -m64
11591 @opindex m32
11592 @opindex m64
11593 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11594 targets (including GNU/Linux).  The 32-bit environment sets int, long
11595 and pointer to 32 bits and generates code that runs on any PowerPC
11596 variant.  The 64-bit environment sets int to 32 bits and long and
11597 pointer to 64 bits, and generates code for PowerPC64, as for
11598 @option{-mpowerpc64}.
11600 @item -mfull-toc
11601 @itemx -mno-fp-in-toc
11602 @itemx -mno-sum-in-toc
11603 @itemx -mminimal-toc
11604 @opindex mfull-toc
11605 @opindex mno-fp-in-toc
11606 @opindex mno-sum-in-toc
11607 @opindex mminimal-toc
11608 Modify generation of the TOC (Table Of Contents), which is created for
11609 every executable file.  The @option{-mfull-toc} option is selected by
11610 default.  In that case, GCC will allocate at least one TOC entry for
11611 each unique non-automatic variable reference in your program.  GCC
11612 will also place floating-point constants in the TOC@.  However, only
11613 16,384 entries are available in the TOC@.
11615 If you receive a linker error message that saying you have overflowed
11616 the available TOC space, you can reduce the amount of TOC space used
11617 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11618 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11619 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11620 generate code to calculate the sum of an address and a constant at
11621 run-time instead of putting that sum into the TOC@.  You may specify one
11622 or both of these options.  Each causes GCC to produce very slightly
11623 slower and larger code at the expense of conserving TOC space.
11625 If you still run out of space in the TOC even when you specify both of
11626 these options, specify @option{-mminimal-toc} instead.  This option causes
11627 GCC to make only one TOC entry for every file.  When you specify this
11628 option, GCC will produce code that is slower and larger but which
11629 uses extremely little TOC space.  You may wish to use this option
11630 only on files that contain less frequently executed code.
11632 @item -maix64
11633 @itemx -maix32
11634 @opindex maix64
11635 @opindex maix32
11636 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11637 @code{long} type, and the infrastructure needed to support them.
11638 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11639 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11640 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11642 @item -mxl-compat
11643 @itemx -mno-xl-compat
11644 @opindex mxl-compat
11645 @opindex mno-xl-compat
11646 Produce code that conforms more closely to IBM XL compiler semantics
11647 when using AIX-compatible ABI.  Pass floating-point arguments to
11648 prototyped functions beyond the register save area (RSA) on the stack
11649 in addition to argument FPRs.  Do not assume that most significant
11650 double in 128-bit long double value is properly rounded when comparing
11651 values and converting to double.  Use XL symbol names for long double
11652 support routines.
11654 The AIX calling convention was extended but not initially documented to
11655 handle an obscure K&R C case of calling a function that takes the
11656 address of its arguments with fewer arguments than declared.  IBM XL
11657 compilers access floating point arguments which do not fit in the
11658 RSA from the stack when a subroutine is compiled without
11659 optimization.  Because always storing floating-point arguments on the
11660 stack is inefficient and rarely needed, this option is not enabled by
11661 default and only is necessary when calling subroutines compiled by IBM
11662 XL compilers without optimization.
11664 @item -mpe
11665 @opindex mpe
11666 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11667 application written to use message passing with special startup code to
11668 enable the application to run.  The system must have PE installed in the
11669 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11670 must be overridden with the @option{-specs=} option to specify the
11671 appropriate directory location.  The Parallel Environment does not
11672 support threads, so the @option{-mpe} option and the @option{-pthread}
11673 option are incompatible.
11675 @item -malign-natural
11676 @itemx -malign-power
11677 @opindex malign-natural
11678 @opindex malign-power
11679 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11680 @option{-malign-natural} overrides the ABI-defined alignment of larger
11681 types, such as floating-point doubles, on their natural size-based boundary.
11682 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11683 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11685 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11686 is not supported.
11688 @item -msoft-float
11689 @itemx -mhard-float
11690 @opindex msoft-float
11691 @opindex mhard-float
11692 Generate code that does not use (uses) the floating-point register set.
11693 Software floating point emulation is provided if you use the
11694 @option{-msoft-float} option, and pass the option to GCC when linking.
11696 @item -mmultiple
11697 @itemx -mno-multiple
11698 @opindex mmultiple
11699 @opindex mno-multiple
11700 Generate code that uses (does not use) the load multiple word
11701 instructions and the store multiple word instructions.  These
11702 instructions are generated by default on POWER systems, and not
11703 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11704 endian PowerPC systems, since those instructions do not work when the
11705 processor is in little endian mode.  The exceptions are PPC740 and
11706 PPC750 which permit the instructions usage in little endian mode.
11708 @item -mstring
11709 @itemx -mno-string
11710 @opindex mstring
11711 @opindex mno-string
11712 Generate code that uses (does not use) the load string instructions
11713 and the store string word instructions to save multiple registers and
11714 do small block moves.  These instructions are generated by default on
11715 POWER systems, and not generated on PowerPC systems.  Do not use
11716 @option{-mstring} on little endian PowerPC systems, since those
11717 instructions do not work when the processor is in little endian mode.
11718 The exceptions are PPC740 and PPC750 which permit the instructions
11719 usage in little endian mode.
11721 @item -mupdate
11722 @itemx -mno-update
11723 @opindex mupdate
11724 @opindex mno-update
11725 Generate code that uses (does not use) the load or store instructions
11726 that update the base register to the address of the calculated memory
11727 location.  These instructions are generated by default.  If you use
11728 @option{-mno-update}, there is a small window between the time that the
11729 stack pointer is updated and the address of the previous frame is
11730 stored, which means code that walks the stack frame across interrupts or
11731 signals may get corrupted data.
11733 @item -mfused-madd
11734 @itemx -mno-fused-madd
11735 @opindex mfused-madd
11736 @opindex mno-fused-madd
11737 Generate code that uses (does not use) the floating point multiply and
11738 accumulate instructions.  These instructions are generated by default if
11739 hardware floating is used.
11741 @item -mmulhw
11742 @itemx -mno-mulhw
11743 @opindex mmulhw
11744 @opindex mno-mulhw
11745 Generate code that uses (does not use) the half-word multiply and
11746 multiply-accumulate instructions on the IBM 405 and 440 processors.
11747 These instructions are generated by default when targetting those
11748 processors.
11750 @item -mdlmzb
11751 @itemx -mno-dlmzb
11752 @opindex mdlmzb
11753 @opindex mno-dlmzb
11754 Generate code that uses (does not use) the string-search @samp{dlmzb}
11755 instruction on the IBM 405 and 440 processors.  This instruction is
11756 generated by default when targetting those processors.
11758 @item -mno-bit-align
11759 @itemx -mbit-align
11760 @opindex mno-bit-align
11761 @opindex mbit-align
11762 On System V.4 and embedded PowerPC systems do not (do) force structures
11763 and unions that contain bit-fields to be aligned to the base type of the
11764 bit-field.
11766 For example, by default a structure containing nothing but 8
11767 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11768 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11769 the structure would be aligned to a 1 byte boundary and be one byte in
11770 size.
11772 @item -mno-strict-align
11773 @itemx -mstrict-align
11774 @opindex mno-strict-align
11775 @opindex mstrict-align
11776 On System V.4 and embedded PowerPC systems do not (do) assume that
11777 unaligned memory references will be handled by the system.
11779 @item -mrelocatable
11780 @itemx -mno-relocatable
11781 @opindex mrelocatable
11782 @opindex mno-relocatable
11783 On embedded PowerPC systems generate code that allows (does not allow)
11784 the program to be relocated to a different address at runtime.  If you
11785 use @option{-mrelocatable} on any module, all objects linked together must
11786 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11788 @item -mrelocatable-lib
11789 @itemx -mno-relocatable-lib
11790 @opindex mrelocatable-lib
11791 @opindex mno-relocatable-lib
11792 On embedded PowerPC systems generate code that allows (does not allow)
11793 the program to be relocated to a different address at runtime.  Modules
11794 compiled with @option{-mrelocatable-lib} can be linked with either modules
11795 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11796 with modules compiled with the @option{-mrelocatable} options.
11798 @item -mno-toc
11799 @itemx -mtoc
11800 @opindex mno-toc
11801 @opindex mtoc
11802 On System V.4 and embedded PowerPC systems do not (do) assume that
11803 register 2 contains a pointer to a global area pointing to the addresses
11804 used in the program.
11806 @item -mlittle
11807 @itemx -mlittle-endian
11808 @opindex mlittle
11809 @opindex mlittle-endian
11810 On System V.4 and embedded PowerPC systems compile code for the
11811 processor in little endian mode.  The @option{-mlittle-endian} option is
11812 the same as @option{-mlittle}.
11814 @item -mbig
11815 @itemx -mbig-endian
11816 @opindex mbig
11817 @opindex mbig-endian
11818 On System V.4 and embedded PowerPC systems compile code for the
11819 processor in big endian mode.  The @option{-mbig-endian} option is
11820 the same as @option{-mbig}.
11822 @item -mdynamic-no-pic
11823 @opindex mdynamic-no-pic
11824 On Darwin and Mac OS X systems, compile code so that it is not
11825 relocatable, but that its external references are relocatable.  The
11826 resulting code is suitable for applications, but not shared
11827 libraries.
11829 @item -mprioritize-restricted-insns=@var{priority}
11830 @opindex mprioritize-restricted-insns
11831 This option controls the priority that is assigned to
11832 dispatch-slot restricted instructions during the second scheduling
11833 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11834 @var{no/highest/second-highest} priority to dispatch slot restricted
11835 instructions.
11837 @item -msched-costly-dep=@var{dependence_type}
11838 @opindex msched-costly-dep
11839 This option controls which dependences are considered costly
11840 by the target during instruction scheduling.  The argument
11841 @var{dependence_type} takes one of the following values:
11842 @var{no}: no dependence is costly,
11843 @var{all}: all dependences are costly,
11844 @var{true_store_to_load}: a true dependence from store to load is costly,
11845 @var{store_to_load}: any dependence from store to load is costly,
11846 @var{number}: any dependence which latency >= @var{number} is costly.
11848 @item -minsert-sched-nops=@var{scheme}
11849 @opindex minsert-sched-nops
11850 This option controls which nop insertion scheme will be used during
11851 the second scheduling pass.  The argument @var{scheme} takes one of the
11852 following values:
11853 @var{no}: Don't insert nops.
11854 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11855 according to the scheduler's grouping.
11856 @var{regroup_exact}: Insert nops to force costly dependent insns into
11857 separate groups.  Insert exactly as many nops as needed to force an insn
11858 to a new group, according to the estimated processor grouping.
11859 @var{number}: Insert nops to force costly dependent insns into
11860 separate groups.  Insert @var{number} nops to force an insn to a new group.
11862 @item -mcall-sysv
11863 @opindex mcall-sysv
11864 On System V.4 and embedded PowerPC systems compile code using calling
11865 conventions that adheres to the March 1995 draft of the System V
11866 Application Binary Interface, PowerPC processor supplement.  This is the
11867 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11869 @item -mcall-sysv-eabi
11870 @opindex mcall-sysv-eabi
11871 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11873 @item -mcall-sysv-noeabi
11874 @opindex mcall-sysv-noeabi
11875 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11877 @item -mcall-solaris
11878 @opindex mcall-solaris
11879 On System V.4 and embedded PowerPC systems compile code for the Solaris
11880 operating system.
11882 @item -mcall-linux
11883 @opindex mcall-linux
11884 On System V.4 and embedded PowerPC systems compile code for the
11885 Linux-based GNU system.
11887 @item -mcall-gnu
11888 @opindex mcall-gnu
11889 On System V.4 and embedded PowerPC systems compile code for the
11890 Hurd-based GNU system.
11892 @item -mcall-netbsd
11893 @opindex mcall-netbsd
11894 On System V.4 and embedded PowerPC systems compile code for the
11895 NetBSD operating system.
11897 @item -maix-struct-return
11898 @opindex maix-struct-return
11899 Return all structures in memory (as specified by the AIX ABI)@.
11901 @item -msvr4-struct-return
11902 @opindex msvr4-struct-return
11903 Return structures smaller than 8 bytes in registers (as specified by the
11904 SVR4 ABI)@.
11906 @item -mabi=@var{abi-type}
11907 @opindex mabi
11908 Extend the current ABI with a particular extension, or remove such extension.
11909 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11910 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11912 @item -mabi=spe
11913 @opindex mabi=spe
11914 Extend the current ABI with SPE ABI extensions.  This does not change
11915 the default ABI, instead it adds the SPE ABI extensions to the current
11916 ABI@.
11918 @item -mabi=no-spe
11919 @opindex mabi=no-spe
11920 Disable Booke SPE ABI extensions for the current ABI@.
11922 @item -mabi=ibmlongdouble
11923 @opindex mabi=ibmlongdouble
11924 Change the current ABI to use IBM extended precision long double.
11925 This is a PowerPC 32-bit SYSV ABI option.
11927 @item -mabi=ieeelongdouble
11928 @opindex mabi=ieeelongdouble
11929 Change the current ABI to use IEEE extended precision long double.
11930 This is a PowerPC 32-bit Linux ABI option.
11932 @item -mprototype
11933 @itemx -mno-prototype
11934 @opindex mprototype
11935 @opindex mno-prototype
11936 On System V.4 and embedded PowerPC systems assume that all calls to
11937 variable argument functions are properly prototyped.  Otherwise, the
11938 compiler must insert an instruction before every non prototyped call to
11939 set or clear bit 6 of the condition code register (@var{CR}) to
11940 indicate whether floating point values were passed in the floating point
11941 registers in case the function takes a variable arguments.  With
11942 @option{-mprototype}, only calls to prototyped variable argument functions
11943 will set or clear the bit.
11945 @item -msim
11946 @opindex msim
11947 On embedded PowerPC systems, assume that the startup module is called
11948 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11949 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11950 configurations.
11952 @item -mmvme
11953 @opindex mmvme
11954 On embedded PowerPC systems, assume that the startup module is called
11955 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11956 @file{libc.a}.
11958 @item -mads
11959 @opindex mads
11960 On embedded PowerPC systems, assume that the startup module is called
11961 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11962 @file{libc.a}.
11964 @item -myellowknife
11965 @opindex myellowknife
11966 On embedded PowerPC systems, assume that the startup module is called
11967 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11968 @file{libc.a}.
11970 @item -mvxworks
11971 @opindex mvxworks
11972 On System V.4 and embedded PowerPC systems, specify that you are
11973 compiling for a VxWorks system.
11975 @item -mwindiss
11976 @opindex mwindiss
11977 Specify that you are compiling for the WindISS simulation environment.
11979 @item -memb
11980 @opindex memb
11981 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11982 header to indicate that @samp{eabi} extended relocations are used.
11984 @item -meabi
11985 @itemx -mno-eabi
11986 @opindex meabi
11987 @opindex mno-eabi
11988 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11989 Embedded Applications Binary Interface (eabi) which is a set of
11990 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11991 means that the stack is aligned to an 8 byte boundary, a function
11992 @code{__eabi} is called to from @code{main} to set up the eabi
11993 environment, and the @option{-msdata} option can use both @code{r2} and
11994 @code{r13} to point to two separate small data areas.  Selecting
11995 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11996 do not call an initialization function from @code{main}, and the
11997 @option{-msdata} option will only use @code{r13} to point to a single
11998 small data area.  The @option{-meabi} option is on by default if you
11999 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
12001 @item -msdata=eabi
12002 @opindex msdata=eabi
12003 On System V.4 and embedded PowerPC systems, put small initialized
12004 @code{const} global and static data in the @samp{.sdata2} section, which
12005 is pointed to by register @code{r2}.  Put small initialized
12006 non-@code{const} global and static data in the @samp{.sdata} section,
12007 which is pointed to by register @code{r13}.  Put small uninitialized
12008 global and static data in the @samp{.sbss} section, which is adjacent to
12009 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
12010 incompatible with the @option{-mrelocatable} option.  The
12011 @option{-msdata=eabi} option also sets the @option{-memb} option.
12013 @item -msdata=sysv
12014 @opindex msdata=sysv
12015 On System V.4 and embedded PowerPC systems, put small global and static
12016 data in the @samp{.sdata} section, which is pointed to by register
12017 @code{r13}.  Put small uninitialized global and static data in the
12018 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12019 The @option{-msdata=sysv} option is incompatible with the
12020 @option{-mrelocatable} option.
12022 @item -msdata=default
12023 @itemx -msdata
12024 @opindex msdata=default
12025 @opindex msdata
12026 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12027 compile code the same as @option{-msdata=eabi}, otherwise compile code the
12028 same as @option{-msdata=sysv}.
12030 @item -msdata-data
12031 @opindex msdata-data
12032 On System V.4 and embedded PowerPC systems, put small global
12033 data in the @samp{.sdata} section.  Put small uninitialized global
12034 data in the @samp{.sbss} section.  Do not use register @code{r13}
12035 to address small data however.  This is the default behavior unless
12036 other @option{-msdata} options are used.
12038 @item -msdata=none
12039 @itemx -mno-sdata
12040 @opindex msdata=none
12041 @opindex mno-sdata
12042 On embedded PowerPC systems, put all initialized global and static data
12043 in the @samp{.data} section, and all uninitialized data in the
12044 @samp{.bss} section.
12046 @item -G @var{num}
12047 @opindex G
12048 @cindex smaller data references (PowerPC)
12049 @cindex .sdata/.sdata2 references (PowerPC)
12050 On embedded PowerPC systems, put global and static items less than or
12051 equal to @var{num} bytes into the small data or bss sections instead of
12052 the normal data or bss section.  By default, @var{num} is 8.  The
12053 @option{-G @var{num}} switch is also passed to the linker.
12054 All modules should be compiled with the same @option{-G @var{num}} value.
12056 @item -mregnames
12057 @itemx -mno-regnames
12058 @opindex mregnames
12059 @opindex mno-regnames
12060 On System V.4 and embedded PowerPC systems do (do not) emit register
12061 names in the assembly language output using symbolic forms.
12063 @item -mlongcall
12064 @itemx -mno-longcall
12065 @opindex mlongcall
12066 @opindex mno-longcall
12067 By default assume that all calls are far away so that a longer more
12068 expensive calling sequence is required.  This is required for calls
12069 further than 32 megabytes (33,554,432 bytes) from the current location.
12070 A short call will be generated if the compiler knows
12071 the call cannot be that far away.  This setting can be overridden by
12072 the @code{shortcall} function attribute, or by @code{#pragma
12073 longcall(0)}.
12075 Some linkers are capable of detecting out-of-range calls and generating
12076 glue code on the fly.  On these systems, long calls are unnecessary and
12077 generate slower code.  As of this writing, the AIX linker can do this,
12078 as can the GNU linker for PowerPC/64.  It is planned to add this feature
12079 to the GNU linker for 32-bit PowerPC systems as well.
12081 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12082 callee, L42'', plus a ``branch island'' (glue code).  The two target
12083 addresses represent the callee and the ``branch island''.  The
12084 Darwin/PPC linker will prefer the first address and generate a ``bl
12085 callee'' if the PPC ``bl'' instruction will reach the callee directly;
12086 otherwise, the linker will generate ``bl L42'' to call the ``branch
12087 island''.  The ``branch island'' is appended to the body of the
12088 calling function; it computes the full 32-bit address of the callee
12089 and jumps to it.
12091 On Mach-O (Darwin) systems, this option directs the compiler emit to
12092 the glue for every direct call, and the Darwin linker decides whether
12093 to use or discard it.
12095 In the future, we may cause GCC to ignore all longcall specifications
12096 when the linker is known to generate glue.
12098 @item -pthread
12099 @opindex pthread
12100 Adds support for multithreading with the @dfn{pthreads} library.
12101 This option sets flags for both the preprocessor and linker.
12103 @end table
12105 @node S/390 and zSeries Options
12106 @subsection S/390 and zSeries Options
12107 @cindex S/390 and zSeries Options
12109 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
12111 @table @gcctabopt
12112 @item -mhard-float
12113 @itemx -msoft-float
12114 @opindex mhard-float
12115 @opindex msoft-float
12116 Use (do not use) the hardware floating-point instructions and registers
12117 for floating-point operations.  When @option{-msoft-float} is specified,
12118 functions in @file{libgcc.a} will be used to perform floating-point
12119 operations.  When @option{-mhard-float} is specified, the compiler
12120 generates IEEE floating-point instructions.  This is the default.
12122 @item -mlong-double-64
12123 @itemx -mlong-double-128
12124 @opindex mlong-double-64
12125 @opindex mlong-double-128
12126 These switches control the size of @code{long double} type. A size
12127 of 64bit makes the @code{long double} type equivalent to the @code{double}
12128 type. This is the default.
12130 @item -mbackchain
12131 @itemx -mno-backchain
12132 @opindex mbackchain
12133 @opindex mno-backchain
12134 Store (do not store) the address of the caller's frame as backchain pointer
12135 into the callee's stack frame.
12136 A backchain may be needed to allow debugging using tools that do not understand
12137 DWARF-2 call frame information.
12138 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12139 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12140 the backchain is placed into the topmost word of the 96/160 byte register
12141 save area.
12143 In general, code compiled with @option{-mbackchain} is call-compatible with
12144 code compiled with @option{-mmo-backchain}; however, use of the backchain
12145 for debugging purposes usually requires that the whole binary is built with
12146 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
12147 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12148 to build a linux kernel use @option{-msoft-float}.
12150 The default is to not maintain the backchain.
12152 @item -mpacked-stack
12153 @item -mno-packed-stack
12154 @opindex mpacked-stack
12155 @opindex mno-packed-stack
12156 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
12157 specified, the compiler uses the all fields of the 96/160 byte register save
12158 area only for their default purpose; unused fields still take up stack space.
12159 When @option{-mpacked-stack} is specified, register save slots are densely
12160 packed at the top of the register save area; unused space is reused for other
12161 purposes, allowing for more efficient use of the available stack space.
12162 However, when @option{-mbackchain} is also in effect, the topmost word of
12163 the save area is always used to store the backchain, and the return address
12164 register is always saved two words below the backchain.
12166 As long as the stack frame backchain is not used, code generated with
12167 @option{-mpacked-stack} is call-compatible with code generated with
12168 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
12169 S/390 or zSeries generated code that uses the stack frame backchain at run
12170 time, not just for debugging purposes.  Such code is not call-compatible
12171 with code compiled with @option{-mpacked-stack}.  Also, note that the
12172 combination of @option{-mbackchain},
12173 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12174 to build a linux kernel use @option{-msoft-float}.
12176 The default is to not use the packed stack layout.
12178 @item -msmall-exec
12179 @itemx -mno-small-exec
12180 @opindex msmall-exec
12181 @opindex mno-small-exec
12182 Generate (or do not generate) code using the @code{bras} instruction
12183 to do subroutine calls.
12184 This only works reliably if the total executable size does not
12185 exceed 64k.  The default is to use the @code{basr} instruction instead,
12186 which does not have this limitation.
12188 @item -m64
12189 @itemx -m31
12190 @opindex m64
12191 @opindex m31
12192 When @option{-m31} is specified, generate code compliant to the
12193 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
12194 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
12195 particular to generate 64-bit instructions.  For the @samp{s390}
12196 targets, the default is @option{-m31}, while the @samp{s390x}
12197 targets default to @option{-m64}.
12199 @item -mzarch
12200 @itemx -mesa
12201 @opindex mzarch
12202 @opindex mesa
12203 When @option{-mzarch} is specified, generate code using the
12204 instructions available on z/Architecture.
12205 When @option{-mesa} is specified, generate code using the
12206 instructions available on ESA/390.  Note that @option{-mesa} is
12207 not possible with @option{-m64}.
12208 When generating code compliant to the GNU/Linux for S/390 ABI,
12209 the default is @option{-mesa}.  When generating code compliant
12210 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12212 @item -mmvcle
12213 @itemx -mno-mvcle
12214 @opindex mmvcle
12215 @opindex mno-mvcle
12216 Generate (or do not generate) code using the @code{mvcle} instruction
12217 to perform block moves.  When @option{-mno-mvcle} is specified,
12218 use a @code{mvc} loop instead.  This is the default unless optimizing for
12219 size.
12221 @item -mdebug
12222 @itemx -mno-debug
12223 @opindex mdebug
12224 @opindex mno-debug
12225 Print (or do not print) additional debug information when compiling.
12226 The default is to not print debug information.
12228 @item -march=@var{cpu-type}
12229 @opindex march
12230 Generate code that will run on @var{cpu-type}, which is the name of a system
12231 representing a certain processor type.  Possible values for
12232 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12233 When generating code using the instructions available on z/Architecture,
12234 the default is @option{-march=z900}.  Otherwise, the default is
12235 @option{-march=g5}.
12237 @item -mtune=@var{cpu-type}
12238 @opindex mtune
12239 Tune to @var{cpu-type} everything applicable about the generated code,
12240 except for the ABI and the set of available instructions.
12241 The list of @var{cpu-type} values is the same as for @option{-march}.
12242 The default is the value used for @option{-march}.
12244 @item -mtpf-trace
12245 @itemx -mno-tpf-trace
12246 @opindex mtpf-trace
12247 @opindex mno-tpf-trace
12248 Generate code that adds (does not add) in TPF OS specific branches to trace
12249 routines in the operating system.  This option is off by default, even
12250 when compiling for the TPF OS@.
12252 @item -mfused-madd
12253 @itemx -mno-fused-madd
12254 @opindex mfused-madd
12255 @opindex mno-fused-madd
12256 Generate code that uses (does not use) the floating point multiply and
12257 accumulate instructions.  These instructions are generated by default if
12258 hardware floating point is used.
12260 @item -mwarn-framesize=@var{framesize}
12261 @opindex mwarn-framesize
12262 Emit a warning if the current function exceeds the given frame size.  Because
12263 this is a compile time check it doesn't need to be a real problem when the program
12264 runs.  It is intended to identify functions which most probably cause
12265 a stack overflow.  It is useful to be used in an environment with limited stack
12266 size e.g.@: the linux kernel.
12268 @item -mwarn-dynamicstack
12269 @opindex mwarn-dynamicstack
12270 Emit a warning if the function calls alloca or uses dynamically
12271 sized arrays.  This is generally a bad idea with a limited stack size.
12273 @item -mstack-guard=@var{stack-guard}
12274 @item -mstack-size=@var{stack-size}
12275 @opindex mstack-guard
12276 @opindex mstack-size
12277 These arguments always have to be used in conjunction.  If they are present the s390
12278 back end emits additional instructions in the function prologue which trigger a trap
12279 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12280 (remember that the stack on s390 grows downward).  These options are intended to
12281 be used to help debugging stack overflow problems.  The additionally emitted code
12282 causes only little overhead and hence can also be used in production like systems
12283 without greater performance degradation.  The given values have to be exact
12284 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12285 exceeding 64k.
12286 In order to be efficient the extra code makes the assumption that the stack starts
12287 at an address aligned to the value given by @var{stack-size}.
12288 @end table
12290 @node Score Options
12291 @subsection Score Options
12292 @cindex Score Options
12294 These options are defined for Score implementations:
12296 @table @gcctabopt
12297 @item -mel
12298 @opindex -mel
12299 Compile code for little endian mode. 
12301 @item -meb
12302 @opindex meb
12303 Compile code for big endian mode.  This is the default.
12305 @item -mmac
12306 @opindex mmac
12307 Enable the use of multiply-accumulate instructions. Disabled by default. 
12309 @item -mscore5u
12310 @opindex mscore5u
12311 Specify the SCORE5U of the target architecture.
12313 @item -mscore7
12314 @opindex mscore7
12315 Specify the SCORE7 of the target architecture. This is the default.
12316 @end table
12318 @node SH Options
12319 @subsection SH Options
12321 These @samp{-m} options are defined for the SH implementations:
12323 @table @gcctabopt
12324 @item -m1
12325 @opindex m1
12326 Generate code for the SH1.
12328 @item -m2
12329 @opindex m2
12330 Generate code for the SH2.
12332 @item -m2e
12333 Generate code for the SH2e.
12335 @item -m3
12336 @opindex m3
12337 Generate code for the SH3.
12339 @item -m3e
12340 @opindex m3e
12341 Generate code for the SH3e.
12343 @item -m4-nofpu
12344 @opindex m4-nofpu
12345 Generate code for the SH4 without a floating-point unit.
12347 @item -m4-single-only
12348 @opindex m4-single-only
12349 Generate code for the SH4 with a floating-point unit that only
12350 supports single-precision arithmetic.
12352 @item -m4-single
12353 @opindex m4-single
12354 Generate code for the SH4 assuming the floating-point unit is in
12355 single-precision mode by default.
12357 @item -m4
12358 @opindex m4
12359 Generate code for the SH4.
12361 @item -m4a-nofpu
12362 @opindex m4a-nofpu
12363 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12364 floating-point unit is not used.
12366 @item -m4a-single-only
12367 @opindex m4a-single-only
12368 Generate code for the SH4a, in such a way that no double-precision
12369 floating point operations are used.
12371 @item -m4a-single
12372 @opindex m4a-single
12373 Generate code for the SH4a assuming the floating-point unit is in
12374 single-precision mode by default.
12376 @item -m4a
12377 @opindex m4a
12378 Generate code for the SH4a.
12380 @item -m4al
12381 @opindex m4al
12382 Same as @option{-m4a-nofpu}, except that it implicitly passes
12383 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
12384 instructions at the moment.
12386 @item -mb
12387 @opindex mb
12388 Compile code for the processor in big endian mode.
12390 @item -ml
12391 @opindex ml
12392 Compile code for the processor in little endian mode.
12394 @item -mdalign
12395 @opindex mdalign
12396 Align doubles at 64-bit boundaries.  Note that this changes the calling
12397 conventions, and thus some functions from the standard C library will
12398 not work unless you recompile it first with @option{-mdalign}.
12400 @item -mrelax
12401 @opindex mrelax
12402 Shorten some address references at link time, when possible; uses the
12403 linker option @option{-relax}.
12405 @item -mbigtable
12406 @opindex mbigtable
12407 Use 32-bit offsets in @code{switch} tables.  The default is to use
12408 16-bit offsets.
12410 @item -mfmovd
12411 @opindex mfmovd
12412 Enable the use of the instruction @code{fmovd}.
12414 @item -mhitachi
12415 @opindex mhitachi
12416 Comply with the calling conventions defined by Renesas.
12418 @item -mrenesas
12419 @opindex mhitachi
12420 Comply with the calling conventions defined by Renesas.
12422 @item -mno-renesas
12423 @opindex mhitachi
12424 Comply with the calling conventions defined for GCC before the Renesas
12425 conventions were available.  This option is the default for all
12426 targets of the SH toolchain except for @samp{sh-symbianelf}.
12428 @item -mnomacsave
12429 @opindex mnomacsave
12430 Mark the @code{MAC} register as call-clobbered, even if
12431 @option{-mhitachi} is given.
12433 @item -mieee
12434 @opindex mieee
12435 Increase IEEE-compliance of floating-point code.
12436 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12437 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12438 comparisons of NANs / infinities incurs extra overhead in every
12439 floating point comparison, therefore the default is set to
12440 @option{-ffinite-math-only}.
12442 @item -minline-ic_invalidate
12443 @opindex minline-ic_invalidate
12444 Inline code to invalidate instruction cache entries after setting up
12445 nested function trampolines.
12446 This option has no effect if -musermode is in effect and the selected
12447 code generation option (e.g. -m4) does not allow the use of the icbi
12448 instruction.
12449 If the selected code generation option does not allow the use of the icbi
12450 instruction, and -musermode is not in effect, the inlined code will
12451 manipulate the instruction cache address array directly with an associative
12452 write.  This not only requires privileged mode, but it will also
12453 fail if the cache line had been mapped via the TLB and has become unmapped.
12455 @item -misize
12456 @opindex misize
12457 Dump instruction size and location in the assembly code.
12459 @item -mpadstruct
12460 @opindex mpadstruct
12461 This option is deprecated.  It pads structures to multiple of 4 bytes,
12462 which is incompatible with the SH ABI@.
12464 @item -mspace
12465 @opindex mspace
12466 Optimize for space instead of speed.  Implied by @option{-Os}.
12468 @item -mprefergot
12469 @opindex mprefergot
12470 When generating position-independent code, emit function calls using
12471 the Global Offset Table instead of the Procedure Linkage Table.
12473 @item -musermode
12474 @opindex musermode
12475 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
12476 if the inlined code would not work in user mode.
12477 This is the default when the target is @code{sh-*-linux*}.
12479 @item -multcost=@var{number}
12480 @opindex multcost=@var{number}
12481 Set the cost to assume for a multiply insn.
12483 @item -mdiv=@var{strategy}
12484 @opindex mdiv=@var{strategy}
12485 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12486 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12487 inv:call2, inv:fp .
12488 "fp" performs the operation in floating point.  This has a very high latency,
12489 but needs only a few instructions, so it might be a good choice if
12490 your code has enough easily exploitable ILP to allow the compiler to
12491 schedule the floating point instructions together with other instructions.
12492 Division by zero causes a floating point exception.
12493 "inv" uses integer operations to calculate the inverse of the divisor,
12494 and then multiplies the dividend with the inverse.  This strategy allows
12495 cse and hoisting of the inverse calculation.  Division by zero calculates
12496 an unspecified result, but does not trap.
12497 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12498 have been found, or if the entire operation has been hoisted to the same
12499 place, the last stages of the inverse calculation are intertwined with the
12500 final multiply to reduce the overall latency, at the expense of using a few
12501 more instructions, and thus offering fewer scheduling opportunities with
12502 other code.
12503 "call" calls a library function that usually implements the inv:minlat
12504 strategy.
12505 This gives high code density for m5-*media-nofpu compilations.
12506 "call2" uses a different entry point of the same library function, where it
12507 assumes that a pointer to a lookup table has already been set up, which
12508 exposes the pointer load to cse / code hoisting optimizations.
12509 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12510 code generation, but if the code stays unoptimized, revert to the "call",
12511 "call2", or "fp" strategies, respectively.  Note that the
12512 potentially-trapping side effect of division by zero is carried by a
12513 separate instruction, so it is possible that all the integer instructions
12514 are hoisted out, but the marker for the side effect stays where it is.
12515 A recombination to fp operations or a call is not possible in that case.
12516 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12517 that the inverse calculation was nor separated from the multiply, they speed
12518 up division where the dividend fits into 20 bits (plus sign where applicable),
12519 by inserting a test to skip a number of operations in this case; this test
12520 slows down the case of larger dividends.  inv20u assumes the case of a such
12521 a small dividend to be unlikely, and inv20l assumes it to be likely.
12523 @item -mdivsi3_libfunc=@var{name}
12524 @opindex mdivsi3_libfunc=@var{name}
12525 Set the name of the library function used for 32 bit signed division to
12526 @var{name}.  This only affect the name used in the call and inv:call
12527 division strategies, and the compiler will still expect the same
12528 sets of input/output/clobbered registers as if this option was not present.
12530 @item -madjust-unroll
12531 @opindex madjust-unroll
12532 Throttle unrolling to avoid thrashing target registers.
12533 This option only has an effect if the gcc code base supports the
12534 TARGET_ADJUST_UNROLL_MAX target hook.
12536 @item -mindexed-addressing
12537 @opindex mindexed-addressing
12538 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12539 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12540 semantics for the indexed addressing mode.  The architecture allows the
12541 implementation of processors with 64 bit MMU, which the OS could use to
12542 get 32 bit addressing, but since no current hardware implementation supports
12543 this or any other way to make the indexed addressing mode safe to use in
12544 the 32 bit ABI, the default is -mno-indexed-addressing.
12546 @item -mgettrcost=@var{number}
12547 @opindex mgettrcost=@var{number}
12548 Set the cost assumed for the gettr instruction to @var{number}.
12549 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12551 @item -mpt-fixed
12552 @opindex mpt-fixed
12553 Assume pt* instructions won't trap.  This will generally generate better
12554 scheduled code, but is unsafe on current hardware.  The current architecture
12555 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12556 This has the unintentional effect of making it unsafe to schedule ptabs /
12557 ptrel before a branch, or hoist it out of a loop.  For example,
12558 __do_global_ctors, a part of libgcc that runs constructors at program
12559 startup, calls functions in a list which is delimited by -1.  With the
12560 -mpt-fixed option, the ptabs will be done before testing against -1.
12561 That means that all the constructors will be run a bit quicker, but when
12562 the loop comes to the end of the list, the program crashes because ptabs
12563 loads -1 into a target register.  Since this option is unsafe for any
12564 hardware implementing the current architecture specification, the default
12565 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12566 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12567 this deters register allocation using target registers for storing
12568 ordinary integers.
12570 @item -minvalid-symbols
12571 @opindex minvalid-symbols
12572 Assume symbols might be invalid.  Ordinary function symbols generated by
12573 the compiler will always be valid to load with movi/shori/ptabs or
12574 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12575 to generate symbols that will cause ptabs / ptrel to trap.
12576 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12577 It will then prevent cross-basic-block cse, hoisting and most scheduling
12578 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12579 @end table
12581 @node SPARC Options
12582 @subsection SPARC Options
12583 @cindex SPARC options
12585 These @samp{-m} options are supported on the SPARC:
12587 @table @gcctabopt
12588 @item -mno-app-regs
12589 @itemx -mapp-regs
12590 @opindex mno-app-regs
12591 @opindex mapp-regs
12592 Specify @option{-mapp-regs} to generate output using the global registers
12593 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12594 is the default.
12596 To be fully SVR4 ABI compliant at the cost of some performance loss,
12597 specify @option{-mno-app-regs}.  You should compile libraries and system
12598 software with this option.
12600 @item -mfpu
12601 @itemx -mhard-float
12602 @opindex mfpu
12603 @opindex mhard-float
12604 Generate output containing floating point instructions.  This is the
12605 default.
12607 @item -mno-fpu
12608 @itemx -msoft-float
12609 @opindex mno-fpu
12610 @opindex msoft-float
12611 Generate output containing library calls for floating point.
12612 @strong{Warning:} the requisite libraries are not available for all SPARC
12613 targets.  Normally the facilities of the machine's usual C compiler are
12614 used, but this cannot be done directly in cross-compilation.  You must make
12615 your own arrangements to provide suitable library functions for
12616 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12617 @samp{sparclite-*-*} do provide software floating point support.
12619 @option{-msoft-float} changes the calling convention in the output file;
12620 therefore, it is only useful if you compile @emph{all} of a program with
12621 this option.  In particular, you need to compile @file{libgcc.a}, the
12622 library that comes with GCC, with @option{-msoft-float} in order for
12623 this to work.
12625 @item -mhard-quad-float
12626 @opindex mhard-quad-float
12627 Generate output containing quad-word (long double) floating point
12628 instructions.
12630 @item -msoft-quad-float
12631 @opindex msoft-quad-float
12632 Generate output containing library calls for quad-word (long double)
12633 floating point instructions.  The functions called are those specified
12634 in the SPARC ABI@.  This is the default.
12636 As of this writing, there are no SPARC implementations that have hardware
12637 support for the quad-word floating point instructions.  They all invoke
12638 a trap handler for one of these instructions, and then the trap handler
12639 emulates the effect of the instruction.  Because of the trap handler overhead,
12640 this is much slower than calling the ABI library routines.  Thus the
12641 @option{-msoft-quad-float} option is the default.
12643 @item -mno-unaligned-doubles
12644 @itemx -munaligned-doubles
12645 @opindex mno-unaligned-doubles
12646 @opindex munaligned-doubles
12647 Assume that doubles have 8 byte alignment.  This is the default.
12649 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12650 alignment only if they are contained in another type, or if they have an
12651 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12652 Specifying this option avoids some rare compatibility problems with code
12653 generated by other compilers.  It is not the default because it results
12654 in a performance loss, especially for floating point code.
12656 @item -mno-faster-structs
12657 @itemx -mfaster-structs
12658 @opindex mno-faster-structs
12659 @opindex mfaster-structs
12660 With @option{-mfaster-structs}, the compiler assumes that structures
12661 should have 8 byte alignment.  This enables the use of pairs of
12662 @code{ldd} and @code{std} instructions for copies in structure
12663 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12664 However, the use of this changed alignment directly violates the SPARC
12665 ABI@.  Thus, it's intended only for use on targets where the developer
12666 acknowledges that their resulting code will not be directly in line with
12667 the rules of the ABI@.
12669 @item -mimpure-text
12670 @opindex mimpure-text
12671 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12672 the compiler to not pass @option{-z text} to the linker when linking a
12673 shared object.  Using this option, you can link position-dependent
12674 code into a shared object.
12676 @option{-mimpure-text} suppresses the ``relocations remain against
12677 allocatable but non-writable sections'' linker error message.
12678 However, the necessary relocations will trigger copy-on-write, and the
12679 shared object is not actually shared across processes.  Instead of
12680 using @option{-mimpure-text}, you should compile all source code with
12681 @option{-fpic} or @option{-fPIC}.
12683 This option is only available on SunOS and Solaris.
12685 @item -mcpu=@var{cpu_type}
12686 @opindex mcpu
12687 Set the instruction set, register set, and instruction scheduling parameters
12688 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12689 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12690 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12691 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12692 @samp{ultrasparc3}, and @samp{niagara}.
12694 Default instruction scheduling parameters are used for values that select
12695 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12696 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12698 Here is a list of each supported architecture and their supported
12699 implementations.
12701 @smallexample
12702     v7:             cypress
12703     v8:             supersparc, hypersparc
12704     sparclite:      f930, f934, sparclite86x
12705     sparclet:       tsc701
12706     v9:             ultrasparc, ultrasparc3, niagara
12707 @end smallexample
12709 By default (unless configured otherwise), GCC generates code for the V7
12710 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12711 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12712 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12713 SPARCStation 1, 2, IPX etc.
12715 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12716 architecture.  The only difference from V7 code is that the compiler emits
12717 the integer multiply and integer divide instructions which exist in SPARC-V8
12718 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12719 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12720 2000 series.
12722 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12723 the SPARC architecture.  This adds the integer multiply, integer divide step
12724 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12725 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12726 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12727 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12728 MB86934 chip, which is the more recent SPARClite with FPU@.
12730 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12731 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12732 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12733 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12734 optimizes it for the TEMIC SPARClet chip.
12736 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12737 architecture.  This adds 64-bit integer and floating-point move instructions,
12738 3 additional floating-point condition code registers and conditional move
12739 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12740 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
12741 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12742 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
12743 @option{-mcpu=niagara}, the compiler additionally optimizes it for
12744 Sun UltraSPARC T1 chips.
12746 @item -mtune=@var{cpu_type}
12747 @opindex mtune
12748 Set the instruction scheduling parameters for machine type
12749 @var{cpu_type}, but do not set the instruction set or register set that the
12750 option @option{-mcpu=@var{cpu_type}} would.
12752 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12753 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12754 that select a particular cpu implementation.  Those are @samp{cypress},
12755 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12756 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
12757 @samp{ultrasparc3}, and @samp{niagara}.
12759 @item -mv8plus
12760 @itemx -mno-v8plus
12761 @opindex mv8plus
12762 @opindex mno-v8plus
12763 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12764 difference from the V8 ABI is that the global and out registers are
12765 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12766 mode for all SPARC-V9 processors.
12768 @item -mvis
12769 @itemx -mno-vis
12770 @opindex mvis
12771 @opindex mno-vis
12772 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12773 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12774 @end table
12776 These @samp{-m} options are supported in addition to the above
12777 on SPARC-V9 processors in 64-bit environments:
12779 @table @gcctabopt
12780 @item -mlittle-endian
12781 @opindex mlittle-endian
12782 Generate code for a processor running in little-endian mode.  It is only
12783 available for a few configurations and most notably not on Solaris and Linux.
12785 @item -m32
12786 @itemx -m64
12787 @opindex m32
12788 @opindex m64
12789 Generate code for a 32-bit or 64-bit environment.
12790 The 32-bit environment sets int, long and pointer to 32 bits.
12791 The 64-bit environment sets int to 32 bits and long and pointer
12792 to 64 bits.
12794 @item -mcmodel=medlow
12795 @opindex mcmodel=medlow
12796 Generate code for the Medium/Low code model: 64-bit addresses, programs
12797 must be linked in the low 32 bits of memory.  Programs can be statically
12798 or dynamically linked.
12800 @item -mcmodel=medmid
12801 @opindex mcmodel=medmid
12802 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12803 must be linked in the low 44 bits of memory, the text and data segments must
12804 be less than 2GB in size and the data segment must be located within 2GB of
12805 the text segment.
12807 @item -mcmodel=medany
12808 @opindex mcmodel=medany
12809 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12810 may be linked anywhere in memory, the text and data segments must be less
12811 than 2GB in size and the data segment must be located within 2GB of the
12812 text segment.
12814 @item -mcmodel=embmedany
12815 @opindex mcmodel=embmedany
12816 Generate code for the Medium/Anywhere code model for embedded systems:
12817 64-bit addresses, the text and data segments must be less than 2GB in
12818 size, both starting anywhere in memory (determined at link time).  The
12819 global register %g4 points to the base of the data segment.  Programs
12820 are statically linked and PIC is not supported.
12822 @item -mstack-bias
12823 @itemx -mno-stack-bias
12824 @opindex mstack-bias
12825 @opindex mno-stack-bias
12826 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12827 frame pointer if present, are offset by @minus{}2047 which must be added back
12828 when making stack frame references.  This is the default in 64-bit mode.
12829 Otherwise, assume no such offset is present.
12830 @end table
12832 These switches are supported in addition to the above on Solaris:
12834 @table @gcctabopt
12835 @item -threads
12836 @opindex threads
12837 Add support for multithreading using the Solaris threads library.  This
12838 option sets flags for both the preprocessor and linker.  This option does
12839 not affect the thread safety of object code produced by the compiler or
12840 that of libraries supplied with it.
12842 @item -pthreads
12843 @opindex pthreads
12844 Add support for multithreading using the POSIX threads library.  This
12845 option sets flags for both the preprocessor and linker.  This option does
12846 not affect the thread safety of object code produced  by the compiler or
12847 that of libraries supplied with it.
12849 @item -pthread
12850 @opindex pthread
12851 This is a synonym for @option{-pthreads}.
12852 @end table
12854 @node SPU Options
12855 @subsection SPU Options
12856 @cindex SPU options
12858 These @samp{-m} options are supported on the SPU:
12860 @table @gcctabopt
12861 @item -mwarn-reloc
12862 @itemx -merror-reloc
12863 @opindex mwarn-reloc
12864 @opindex merror-reloc
12866 The loader for SPU does not handle dynamic relocations.  By default, GCC
12867 will give an error when it generates code that requires a dynamic
12868 relocation.  @option{-mno-error-reloc} disables the error,
12869 @option{-mwarn-reloc} will generate a warning instead.
12871 @item -msafe-dma
12872 @itemx -munsafe-dma
12873 @opindex msafe-dma
12874 @opindex munsafe-dma
12876 Instructions which initiate or test completion of DMA must not be
12877 reordered with respect to loads and stores of the memory which is being
12878 accessed.  Users typically address this problem using the volatile
12879 keyword, but that can lead to inefficient code in places where the
12880 memory is known to not change.  Rather than mark the memory as volatile
12881 we treat the DMA instructions as potentially effecting all memory.  With
12882 @option{-munsafe-dma} users must use the volatile keyword to protect
12883 memory accesses.
12885 @item -mbranch-hints
12886 @opindex mbranch-hints
12888 By default, GCC will generate a branch hint instruction to avoid
12889 pipeline stalls for always taken or probably taken branches.  A hint
12890 will not be generated closer than 8 instructions away from its branch.
12891 There is little reason to disable them, except for debugging purposes,
12892 or to make an object a little bit smaller.
12894 @item -msmall-mem
12895 @itemx -mlarge-mem
12896 @opindex msmall-mem
12897 @opindex mlarge-mem
12899 By default, GCC generates code assuming that addresses are never larger
12900 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
12901 a full 32 bit address.
12903 @item -mstdmain
12904 @opindex mstdmain
12906 By default, GCC links against startup code that assumes the SPU-style
12907 main function interface (which has an unconventional parameter list).
12908 With @option{-mstdmain}, GCC will link your program against startup
12909 code that assumes a C99-style interface to @code{main}, including a
12910 local copy of @code{argv} strings.
12912 @end table
12914 @node System V Options
12915 @subsection Options for System V
12917 These additional options are available on System V Release 4 for
12918 compatibility with other compilers on those systems:
12920 @table @gcctabopt
12921 @item -G
12922 @opindex G
12923 Create a shared object.
12924 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12926 @item -Qy
12927 @opindex Qy
12928 Identify the versions of each tool used by the compiler, in a
12929 @code{.ident} assembler directive in the output.
12931 @item -Qn
12932 @opindex Qn
12933 Refrain from adding @code{.ident} directives to the output file (this is
12934 the default).
12936 @item -YP,@var{dirs}
12937 @opindex YP
12938 Search the directories @var{dirs}, and no others, for libraries
12939 specified with @option{-l}.
12941 @item -Ym,@var{dir}
12942 @opindex Ym
12943 Look in the directory @var{dir} to find the M4 preprocessor.
12944 The assembler uses this option.
12945 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12946 @c the generic assembler that comes with Solaris takes just -Ym.
12947 @end table
12949 @node TMS320C3x/C4x Options
12950 @subsection TMS320C3x/C4x Options
12951 @cindex TMS320C3x/C4x Options
12953 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12955 @table @gcctabopt
12957 @item -mcpu=@var{cpu_type}
12958 @opindex mcpu
12959 Set the instruction set, register set, and instruction scheduling
12960 parameters for machine type @var{cpu_type}.  Supported values for
12961 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12962 @samp{c44}.  The default is @samp{c40} to generate code for the
12963 TMS320C40.
12965 @item -mbig-memory
12966 @itemx -mbig
12967 @itemx -msmall-memory
12968 @itemx -msmall
12969 @opindex mbig-memory
12970 @opindex mbig
12971 @opindex msmall-memory
12972 @opindex msmall
12973 Generates code for the big or small memory model.  The small memory
12974 model assumed that all data fits into one 64K word page.  At run-time
12975 the data page (DP) register must be set to point to the 64K page
12976 containing the .bss and .data program sections.  The big memory model is
12977 the default and requires reloading of the DP register for every direct
12978 memory access.
12980 @item -mbk
12981 @itemx -mno-bk
12982 @opindex mbk
12983 @opindex mno-bk
12984 Allow (disallow) allocation of general integer operands into the block
12985 count register BK@.
12987 @item -mdb
12988 @itemx -mno-db
12989 @opindex mdb
12990 @opindex mno-db
12991 Enable (disable) generation of code using decrement and branch,
12992 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12993 on the safe side, this is disabled for the C3x, since the maximum
12994 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12995 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12996 that it can utilize the decrement and branch instruction, but will give
12997 up if there is more than one memory reference in the loop.  Thus a loop
12998 where the loop counter is decremented can generate slightly more
12999 efficient code, in cases where the RPTB instruction cannot be utilized.
13001 @item -mdp-isr-reload
13002 @itemx -mparanoid
13003 @opindex mdp-isr-reload
13004 @opindex mparanoid
13005 Force the DP register to be saved on entry to an interrupt service
13006 routine (ISR), reloaded to point to the data section, and restored on
13007 exit from the ISR@.  This should not be required unless someone has
13008 violated the small memory model by modifying the DP register, say within
13009 an object library.
13011 @item -mmpyi
13012 @itemx -mno-mpyi
13013 @opindex mmpyi
13014 @opindex mno-mpyi
13015 For the C3x use the 24-bit MPYI instruction for integer multiplies
13016 instead of a library call to guarantee 32-bit results.  Note that if one
13017 of the operands is a constant, then the multiplication will be performed
13018 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
13019 then squaring operations are performed inline instead of a library call.
13021 @item -mfast-fix
13022 @itemx -mno-fast-fix
13023 @opindex mfast-fix
13024 @opindex mno-fast-fix
13025 The C3x/C4x FIX instruction to convert a floating point value to an
13026 integer value chooses the nearest integer less than or equal to the
13027 floating point value rather than to the nearest integer.  Thus if the
13028 floating point number is negative, the result will be incorrectly
13029 truncated an additional code is necessary to detect and correct this
13030 case.  This option can be used to disable generation of the additional
13031 code required to correct the result.
13033 @item -mrptb
13034 @itemx -mno-rptb
13035 @opindex mrptb
13036 @opindex mno-rptb
13037 Enable (disable) generation of repeat block sequences using the RPTB
13038 instruction for zero overhead looping.  The RPTB construct is only used
13039 for innermost loops that do not call functions or jump across the loop
13040 boundaries.  There is no advantage having nested RPTB loops due to the
13041 overhead required to save and restore the RC, RS, and RE registers.
13042 This is enabled by default with @option{-O2}.
13044 @item -mrpts=@var{count}
13045 @itemx -mno-rpts
13046 @opindex mrpts
13047 @opindex mno-rpts
13048 Enable (disable) the use of the single instruction repeat instruction
13049 RPTS@.  If a repeat block contains a single instruction, and the loop
13050 count can be guaranteed to be less than the value @var{count}, GCC will
13051 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
13052 then a RPTS will be emitted even if the loop count cannot be determined
13053 at compile time.  Note that the repeated instruction following RPTS does
13054 not have to be reloaded from memory each iteration, thus freeing up the
13055 CPU buses for operands.  However, since interrupts are blocked by this
13056 instruction, it is disabled by default.
13058 @item -mloop-unsigned
13059 @itemx -mno-loop-unsigned
13060 @opindex mloop-unsigned
13061 @opindex mno-loop-unsigned
13062 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
13063 is @math{2^{31} + 1} since these instructions test if the iteration count is
13064 negative to terminate the loop.  If the iteration count is unsigned
13065 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
13066 exceeded.  This switch allows an unsigned iteration count.
13068 @item -mti
13069 @opindex mti
13070 Try to emit an assembler syntax that the TI assembler (asm30) is happy
13071 with.  This also enforces compatibility with the API employed by the TI
13072 C3x C compiler.  For example, long doubles are passed as structures
13073 rather than in floating point registers.
13075 @item -mregparm
13076 @itemx -mmemparm
13077 @opindex mregparm
13078 @opindex mmemparm
13079 Generate code that uses registers (stack) for passing arguments to functions.
13080 By default, arguments are passed in registers where possible rather
13081 than by pushing arguments on to the stack.
13083 @item -mparallel-insns
13084 @itemx -mno-parallel-insns
13085 @opindex mparallel-insns
13086 @opindex mno-parallel-insns
13087 Allow the generation of parallel instructions.  This is enabled by
13088 default with @option{-O2}.
13090 @item -mparallel-mpy
13091 @itemx -mno-parallel-mpy
13092 @opindex mparallel-mpy
13093 @opindex mno-parallel-mpy
13094 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
13095 provided @option{-mparallel-insns} is also specified.  These instructions have
13096 tight register constraints which can pessimize the code generation
13097 of large functions.
13099 @end table
13101 @node V850 Options
13102 @subsection V850 Options
13103 @cindex V850 Options
13105 These @samp{-m} options are defined for V850 implementations:
13107 @table @gcctabopt
13108 @item -mlong-calls
13109 @itemx -mno-long-calls
13110 @opindex mlong-calls
13111 @opindex mno-long-calls
13112 Treat all calls as being far away (near).  If calls are assumed to be
13113 far away, the compiler will always load the functions address up into a
13114 register, and call indirect through the pointer.
13116 @item -mno-ep
13117 @itemx -mep
13118 @opindex mno-ep
13119 @opindex mep
13120 Do not optimize (do optimize) basic blocks that use the same index
13121 pointer 4 or more times to copy pointer into the @code{ep} register, and
13122 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
13123 option is on by default if you optimize.
13125 @item -mno-prolog-function
13126 @itemx -mprolog-function
13127 @opindex mno-prolog-function
13128 @opindex mprolog-function
13129 Do not use (do use) external functions to save and restore registers
13130 at the prologue and epilogue of a function.  The external functions
13131 are slower, but use less code space if more than one function saves
13132 the same number of registers.  The @option{-mprolog-function} option
13133 is on by default if you optimize.
13135 @item -mspace
13136 @opindex mspace
13137 Try to make the code as small as possible.  At present, this just turns
13138 on the @option{-mep} and @option{-mprolog-function} options.
13140 @item -mtda=@var{n}
13141 @opindex mtda
13142 Put static or global variables whose size is @var{n} bytes or less into
13143 the tiny data area that register @code{ep} points to.  The tiny data
13144 area can hold up to 256 bytes in total (128 bytes for byte references).
13146 @item -msda=@var{n}
13147 @opindex msda
13148 Put static or global variables whose size is @var{n} bytes or less into
13149 the small data area that register @code{gp} points to.  The small data
13150 area can hold up to 64 kilobytes.
13152 @item -mzda=@var{n}
13153 @opindex mzda
13154 Put static or global variables whose size is @var{n} bytes or less into
13155 the first 32 kilobytes of memory.
13157 @item -mv850
13158 @opindex mv850
13159 Specify that the target processor is the V850.
13161 @item -mbig-switch
13162 @opindex mbig-switch
13163 Generate code suitable for big switch tables.  Use this option only if
13164 the assembler/linker complain about out of range branches within a switch
13165 table.
13167 @item -mapp-regs
13168 @opindex mapp-regs
13169 This option will cause r2 and r5 to be used in the code generated by
13170 the compiler.  This setting is the default.
13172 @item -mno-app-regs
13173 @opindex mno-app-regs
13174 This option will cause r2 and r5 to be treated as fixed registers.
13176 @item -mv850e1
13177 @opindex mv850e1
13178 Specify that the target processor is the V850E1.  The preprocessor
13179 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
13180 this option is used.
13182 @item -mv850e
13183 @opindex mv850e
13184 Specify that the target processor is the V850E@.  The preprocessor
13185 constant @samp{__v850e__} will be defined if this option is used.
13187 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13188 are defined then a default target processor will be chosen and the
13189 relevant @samp{__v850*__} preprocessor constant will be defined.
13191 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13192 defined, regardless of which processor variant is the target.
13194 @item -mdisable-callt
13195 @opindex mdisable-callt
13196 This option will suppress generation of the CALLT instruction for the
13197 v850e and v850e1 flavors of the v850 architecture.  The default is
13198 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
13200 @end table
13202 @node VAX Options
13203 @subsection VAX Options
13204 @cindex VAX options
13206 These @samp{-m} options are defined for the VAX:
13208 @table @gcctabopt
13209 @item -munix
13210 @opindex munix
13211 Do not output certain jump instructions (@code{aobleq} and so on)
13212 that the Unix assembler for the VAX cannot handle across long
13213 ranges.
13215 @item -mgnu
13216 @opindex mgnu
13217 Do output those jump instructions, on the assumption that you
13218 will assemble with the GNU assembler.
13220 @item -mg
13221 @opindex mg
13222 Output code for g-format floating point numbers instead of d-format.
13223 @end table
13225 @node x86-64 Options
13226 @subsection x86-64 Options
13227 @cindex x86-64 options
13229 These are listed under @xref{i386 and x86-64 Options}.
13231 @node Xstormy16 Options
13232 @subsection Xstormy16 Options
13233 @cindex Xstormy16 Options
13235 These options are defined for Xstormy16:
13237 @table @gcctabopt
13238 @item -msim
13239 @opindex msim
13240 Choose startup files and linker script suitable for the simulator.
13241 @end table
13243 @node Xtensa Options
13244 @subsection Xtensa Options
13245 @cindex Xtensa Options
13247 These options are supported for Xtensa targets:
13249 @table @gcctabopt
13250 @item -mconst16
13251 @itemx -mno-const16
13252 @opindex mconst16
13253 @opindex mno-const16
13254 Enable or disable use of @code{CONST16} instructions for loading
13255 constant values.  The @code{CONST16} instruction is currently not a
13256 standard option from Tensilica.  When enabled, @code{CONST16}
13257 instructions are always used in place of the standard @code{L32R}
13258 instructions.  The use of @code{CONST16} is enabled by default only if
13259 the @code{L32R} instruction is not available.
13261 @item -mfused-madd
13262 @itemx -mno-fused-madd
13263 @opindex mfused-madd
13264 @opindex mno-fused-madd
13265 Enable or disable use of fused multiply/add and multiply/subtract
13266 instructions in the floating-point option.  This has no effect if the
13267 floating-point option is not also enabled.  Disabling fused multiply/add
13268 and multiply/subtract instructions forces the compiler to use separate
13269 instructions for the multiply and add/subtract operations.  This may be
13270 desirable in some cases where strict IEEE 754-compliant results are
13271 required: the fused multiply add/subtract instructions do not round the
13272 intermediate result, thereby producing results with @emph{more} bits of
13273 precision than specified by the IEEE standard.  Disabling fused multiply
13274 add/subtract instructions also ensures that the program output is not
13275 sensitive to the compiler's ability to combine multiply and add/subtract
13276 operations.
13278 @item -mtext-section-literals
13279 @itemx -mno-text-section-literals
13280 @opindex mtext-section-literals
13281 @opindex mno-text-section-literals
13282 Control the treatment of literal pools.  The default is
13283 @option{-mno-text-section-literals}, which places literals in a separate
13284 section in the output file.  This allows the literal pool to be placed
13285 in a data RAM/ROM, and it also allows the linker to combine literal
13286 pools from separate object files to remove redundant literals and
13287 improve code size.  With @option{-mtext-section-literals}, the literals
13288 are interspersed in the text section in order to keep them as close as
13289 possible to their references.  This may be necessary for large assembly
13290 files.
13292 @item -mtarget-align
13293 @itemx -mno-target-align
13294 @opindex mtarget-align
13295 @opindex mno-target-align
13296 When this option is enabled, GCC instructs the assembler to
13297 automatically align instructions to reduce branch penalties at the
13298 expense of some code density.  The assembler attempts to widen density
13299 instructions to align branch targets and the instructions following call
13300 instructions.  If there are not enough preceding safe density
13301 instructions to align a target, no widening will be performed.  The
13302 default is @option{-mtarget-align}.  These options do not affect the
13303 treatment of auto-aligned instructions like @code{LOOP}, which the
13304 assembler will always align, either by widening density instructions or
13305 by inserting no-op instructions.
13307 @item -mlongcalls
13308 @itemx -mno-longcalls
13309 @opindex mlongcalls
13310 @opindex mno-longcalls
13311 When this option is enabled, GCC instructs the assembler to translate
13312 direct calls to indirect calls unless it can determine that the target
13313 of a direct call is in the range allowed by the call instruction.  This
13314 translation typically occurs for calls to functions in other source
13315 files.  Specifically, the assembler translates a direct @code{CALL}
13316 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13317 The default is @option{-mno-longcalls}.  This option should be used in
13318 programs where the call target can potentially be out of range.  This
13319 option is implemented in the assembler, not the compiler, so the
13320 assembly code generated by GCC will still show direct call
13321 instructions---look at the disassembled object code to see the actual
13322 instructions.  Note that the assembler will use an indirect call for
13323 every cross-file call, not just those that really will be out of range.
13324 @end table
13326 @node zSeries Options
13327 @subsection zSeries Options
13328 @cindex zSeries options
13330 These are listed under @xref{S/390 and zSeries Options}.
13332 @node Code Gen Options
13333 @section Options for Code Generation Conventions
13334 @cindex code generation conventions
13335 @cindex options, code generation
13336 @cindex run-time options
13338 These machine-independent options control the interface conventions
13339 used in code generation.
13341 Most of them have both positive and negative forms; the negative form
13342 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
13343 one of the forms is listed---the one which is not the default.  You
13344 can figure out the other form by either removing @samp{no-} or adding
13347 @table @gcctabopt
13348 @item -fbounds-check
13349 @opindex fbounds-check
13350 For front-ends that support it, generate additional code to check that
13351 indices used to access arrays are within the declared range.  This is
13352 currently only supported by the Java and Fortran front-ends, where
13353 this option defaults to true and false respectively.
13355 @item -ftrapv
13356 @opindex ftrapv
13357 This option generates traps for signed overflow on addition, subtraction,
13358 multiplication operations.
13360 @item -fwrapv
13361 @opindex fwrapv
13362 This option instructs the compiler to assume that signed arithmetic
13363 overflow of addition, subtraction and multiplication wraps around
13364 using twos-complement representation.  This flag enables some optimizations
13365 and disables others.  This option is enabled by default for the Java
13366 front-end, as required by the Java language specification.
13368 @item -fexceptions
13369 @opindex fexceptions
13370 Enable exception handling.  Generates extra code needed to propagate
13371 exceptions.  For some targets, this implies GCC will generate frame
13372 unwind information for all functions, which can produce significant data
13373 size overhead, although it does not affect execution.  If you do not
13374 specify this option, GCC will enable it by default for languages like
13375 C++ which normally require exception handling, and disable it for
13376 languages like C that do not normally require it.  However, you may need
13377 to enable this option when compiling C code that needs to interoperate
13378 properly with exception handlers written in C++.  You may also wish to
13379 disable this option if you are compiling older C++ programs that don't
13380 use exception handling.
13382 @item -fnon-call-exceptions
13383 @opindex fnon-call-exceptions
13384 Generate code that allows trapping instructions to throw exceptions.
13385 Note that this requires platform-specific runtime support that does
13386 not exist everywhere.  Moreover, it only allows @emph{trapping}
13387 instructions to throw exceptions, i.e.@: memory references or floating
13388 point instructions.  It does not allow exceptions to be thrown from
13389 arbitrary signal handlers such as @code{SIGALRM}.
13391 @item -funwind-tables
13392 @opindex funwind-tables
13393 Similar to @option{-fexceptions}, except that it will just generate any needed
13394 static data, but will not affect the generated code in any other way.
13395 You will normally not enable this option; instead, a language processor
13396 that needs this handling would enable it on your behalf.
13398 @item -fasynchronous-unwind-tables
13399 @opindex fasynchronous-unwind-tables
13400 Generate unwind table in dwarf2 format, if supported by target machine.  The
13401 table is exact at each instruction boundary, so it can be used for stack
13402 unwinding from asynchronous events (such as debugger or garbage collector).
13404 @item -fpcc-struct-return
13405 @opindex fpcc-struct-return
13406 Return ``short'' @code{struct} and @code{union} values in memory like
13407 longer ones, rather than in registers.  This convention is less
13408 efficient, but it has the advantage of allowing intercallability between
13409 GCC-compiled files and files compiled with other compilers, particularly
13410 the Portable C Compiler (pcc).
13412 The precise convention for returning structures in memory depends
13413 on the target configuration macros.
13415 Short structures and unions are those whose size and alignment match
13416 that of some integer type.
13418 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13419 switch is not binary compatible with code compiled with the
13420 @option{-freg-struct-return} switch.
13421 Use it to conform to a non-default application binary interface.
13423 @item -freg-struct-return
13424 @opindex freg-struct-return
13425 Return @code{struct} and @code{union} values in registers when possible.
13426 This is more efficient for small structures than
13427 @option{-fpcc-struct-return}.
13429 If you specify neither @option{-fpcc-struct-return} nor
13430 @option{-freg-struct-return}, GCC defaults to whichever convention is
13431 standard for the target.  If there is no standard convention, GCC
13432 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13433 the principal compiler.  In those cases, we can choose the standard, and
13434 we chose the more efficient register return alternative.
13436 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13437 switch is not binary compatible with code compiled with the
13438 @option{-fpcc-struct-return} switch.
13439 Use it to conform to a non-default application binary interface.
13441 @item -fshort-enums
13442 @opindex fshort-enums
13443 Allocate to an @code{enum} type only as many bytes as it needs for the
13444 declared range of possible values.  Specifically, the @code{enum} type
13445 will be equivalent to the smallest integer type which has enough room.
13447 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13448 code that is not binary compatible with code generated without that switch.
13449 Use it to conform to a non-default application binary interface.
13451 @item -fshort-double
13452 @opindex fshort-double
13453 Use the same size for @code{double} as for @code{float}.
13455 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13456 code that is not binary compatible with code generated without that switch.
13457 Use it to conform to a non-default application binary interface.
13459 @item -fshort-wchar
13460 @opindex fshort-wchar
13461 Override the underlying type for @samp{wchar_t} to be @samp{short
13462 unsigned int} instead of the default for the target.  This option is
13463 useful for building programs to run under WINE@.
13465 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13466 code that is not binary compatible with code generated without that switch.
13467 Use it to conform to a non-default application binary interface.
13469 @item -fno-common
13470 @opindex fno-common
13471 In C, allocate even uninitialized global variables in the data section of the
13472 object file, rather than generating them as common blocks.  This has the
13473 effect that if the same variable is declared (without @code{extern}) in
13474 two different compilations, you will get an error when you link them.
13475 The only reason this might be useful is if you wish to verify that the
13476 program will work on other systems which always work this way.
13478 @item -fno-ident
13479 @opindex fno-ident
13480 Ignore the @samp{#ident} directive.
13482 @item -finhibit-size-directive
13483 @opindex finhibit-size-directive
13484 Don't output a @code{.size} assembler directive, or anything else that
13485 would cause trouble if the function is split in the middle, and the
13486 two halves are placed at locations far apart in memory.  This option is
13487 used when compiling @file{crtstuff.c}; you should not need to use it
13488 for anything else.
13490 @item -fverbose-asm
13491 @opindex fverbose-asm
13492 Put extra commentary information in the generated assembly code to
13493 make it more readable.  This option is generally only of use to those
13494 who actually need to read the generated assembly code (perhaps while
13495 debugging the compiler itself).
13497 @option{-fno-verbose-asm}, the default, causes the
13498 extra information to be omitted and is useful when comparing two assembler
13499 files.
13501 @item -frecord-gcc-switches
13502 @opindex frecord-gcc-switches
13503 This switch causes the command line that was used to invoke the
13504 compiler to be recorded into the object file that is being created.
13505 This switch is only implemented on some targets and the exact format
13506 of the recording is target and binary file format dependent, but it
13507 usually takes the form of a section containing ASCII text.  This
13508 switch is related to the @option{-fverbose-asm} switch, but that
13509 switch only records information in the assembler output file as
13510 comments, so it never reaches the object file.
13512 @item -fpic
13513 @opindex fpic
13514 @cindex global offset table
13515 @cindex PIC
13516 Generate position-independent code (PIC) suitable for use in a shared
13517 library, if supported for the target machine.  Such code accesses all
13518 constant addresses through a global offset table (GOT)@.  The dynamic
13519 loader resolves the GOT entries when the program starts (the dynamic
13520 loader is not part of GCC; it is part of the operating system).  If
13521 the GOT size for the linked executable exceeds a machine-specific
13522 maximum size, you get an error message from the linker indicating that
13523 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13524 instead.  (These maximums are 8k on the SPARC and 32k
13525 on the m68k and RS/6000.  The 386 has no such limit.)
13527 Position-independent code requires special support, and therefore works
13528 only on certain machines.  For the 386, GCC supports PIC for System V
13529 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13530 position-independent.
13532 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13533 are defined to 1.
13535 @item -fPIC
13536 @opindex fPIC
13537 If supported for the target machine, emit position-independent code,
13538 suitable for dynamic linking and avoiding any limit on the size of the
13539 global offset table.  This option makes a difference on the m68k,
13540 PowerPC and SPARC@.
13542 Position-independent code requires special support, and therefore works
13543 only on certain machines.
13545 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13546 are defined to 2.
13548 @item -fpie
13549 @itemx -fPIE
13550 @opindex fpie
13551 @opindex fPIE
13552 These options are similar to @option{-fpic} and @option{-fPIC}, but
13553 generated position independent code can be only linked into executables.
13554 Usually these options are used when @option{-pie} GCC option will be
13555 used during linking.
13557 @item -fno-jump-tables
13558 @opindex fno-jump-tables
13559 Do not use jump tables for switch statements even where it would be
13560 more efficient than other code generation strategies.  This option is
13561 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13562 building code which forms part of a dynamic linker and cannot
13563 reference the address of a jump table.  On some targets, jump tables
13564 do not require a GOT and this option is not needed.
13566 @item -ffixed-@var{reg}
13567 @opindex ffixed
13568 Treat the register named @var{reg} as a fixed register; generated code
13569 should never refer to it (except perhaps as a stack pointer, frame
13570 pointer or in some other fixed role).
13572 @var{reg} must be the name of a register.  The register names accepted
13573 are machine-specific and are defined in the @code{REGISTER_NAMES}
13574 macro in the machine description macro file.
13576 This flag does not have a negative form, because it specifies a
13577 three-way choice.
13579 @item -fcall-used-@var{reg}
13580 @opindex fcall-used
13581 Treat the register named @var{reg} as an allocable register that is
13582 clobbered by function calls.  It may be allocated for temporaries or
13583 variables that do not live across a call.  Functions compiled this way
13584 will not save and restore the register @var{reg}.
13586 It is an error to used this flag with the frame pointer or stack pointer.
13587 Use of this flag for other registers that have fixed pervasive roles in
13588 the machine's execution model will produce disastrous results.
13590 This flag does not have a negative form, because it specifies a
13591 three-way choice.
13593 @item -fcall-saved-@var{reg}
13594 @opindex fcall-saved
13595 Treat the register named @var{reg} as an allocable register saved by
13596 functions.  It may be allocated even for temporaries or variables that
13597 live across a call.  Functions compiled this way will save and restore
13598 the register @var{reg} if they use it.
13600 It is an error to used this flag with the frame pointer or stack pointer.
13601 Use of this flag for other registers that have fixed pervasive roles in
13602 the machine's execution model will produce disastrous results.
13604 A different sort of disaster will result from the use of this flag for
13605 a register in which function values may be returned.
13607 This flag does not have a negative form, because it specifies a
13608 three-way choice.
13610 @item -fpack-struct[=@var{n}]
13611 @opindex fpack-struct
13612 Without a value specified, pack all structure members together without
13613 holes.  When a value is specified (which must be a small power of two), pack
13614 structure members according to this value, representing the maximum
13615 alignment (that is, objects with default alignment requirements larger than
13616 this will be output potentially unaligned at the next fitting location.
13618 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13619 code that is not binary compatible with code generated without that switch.
13620 Additionally, it makes the code suboptimal.
13621 Use it to conform to a non-default application binary interface.
13623 @item -finstrument-functions
13624 @opindex finstrument-functions
13625 Generate instrumentation calls for entry and exit to functions.  Just
13626 after function entry and just before function exit, the following
13627 profiling functions will be called with the address of the current
13628 function and its call site.  (On some platforms,
13629 @code{__builtin_return_address} does not work beyond the current
13630 function, so the call site information may not be available to the
13631 profiling functions otherwise.)
13633 @smallexample
13634 void __cyg_profile_func_enter (void *this_fn,
13635                                void *call_site);
13636 void __cyg_profile_func_exit  (void *this_fn,
13637                                void *call_site);
13638 @end smallexample
13640 The first argument is the address of the start of the current function,
13641 which may be looked up exactly in the symbol table.
13643 This instrumentation is also done for functions expanded inline in other
13644 functions.  The profiling calls will indicate where, conceptually, the
13645 inline function is entered and exited.  This means that addressable
13646 versions of such functions must be available.  If all your uses of a
13647 function are expanded inline, this may mean an additional expansion of
13648 code size.  If you use @samp{extern inline} in your C code, an
13649 addressable version of such functions must be provided.  (This is
13650 normally the case anyways, but if you get lucky and the optimizer always
13651 expands the functions inline, you might have gotten away without
13652 providing static copies.)
13654 A function may be given the attribute @code{no_instrument_function}, in
13655 which case this instrumentation will not be done.  This can be used, for
13656 example, for the profiling functions listed above, high-priority
13657 interrupt routines, and any functions from which the profiling functions
13658 cannot safely be called (perhaps signal handlers, if the profiling
13659 routines generate output or allocate memory).
13661 @item -fstack-check
13662 @opindex fstack-check
13663 Generate code to verify that you do not go beyond the boundary of the
13664 stack.  You should specify this flag if you are running in an
13665 environment with multiple threads, but only rarely need to specify it in
13666 a single-threaded environment since stack overflow is automatically
13667 detected on nearly all systems if there is only one stack.
13669 Note that this switch does not actually cause checking to be done; the
13670 operating system must do that.  The switch causes generation of code
13671 to ensure that the operating system sees the stack being extended.
13673 @item -fstack-limit-register=@var{reg}
13674 @itemx -fstack-limit-symbol=@var{sym}
13675 @itemx -fno-stack-limit
13676 @opindex fstack-limit-register
13677 @opindex fstack-limit-symbol
13678 @opindex fno-stack-limit
13679 Generate code to ensure that the stack does not grow beyond a certain value,
13680 either the value of a register or the address of a symbol.  If the stack
13681 would grow beyond the value, a signal is raised.  For most targets,
13682 the signal is raised before the stack overruns the boundary, so
13683 it is possible to catch the signal without taking special precautions.
13685 For instance, if the stack starts at absolute address @samp{0x80000000}
13686 and grows downwards, you can use the flags
13687 @option{-fstack-limit-symbol=__stack_limit} and
13688 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13689 of 128KB@.  Note that this may only work with the GNU linker.
13691 @cindex aliasing of parameters
13692 @cindex parameters, aliased
13693 @item -fargument-alias
13694 @itemx -fargument-noalias
13695 @itemx -fargument-noalias-global
13696 @itemx -fargument-noalias-anything
13697 @opindex fargument-alias
13698 @opindex fargument-noalias
13699 @opindex fargument-noalias-global
13700 @opindex fargument-noalias-anything
13701 Specify the possible relationships among parameters and between
13702 parameters and global data.
13704 @option{-fargument-alias} specifies that arguments (parameters) may
13705 alias each other and may alias global storage.@*
13706 @option{-fargument-noalias} specifies that arguments do not alias
13707 each other, but may alias global storage.@*
13708 @option{-fargument-noalias-global} specifies that arguments do not
13709 alias each other and do not alias global storage.
13710 @option{-fargument-noalias-anything} specifies that arguments do not
13711 alias any other storage.
13713 Each language will automatically use whatever option is required by
13714 the language standard.  You should not need to use these options yourself.
13716 @item -fleading-underscore
13717 @opindex fleading-underscore
13718 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13719 change the way C symbols are represented in the object file.  One use
13720 is to help link with legacy assembly code.
13722 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13723 generate code that is not binary compatible with code generated without that
13724 switch.  Use it to conform to a non-default application binary interface.
13725 Not all targets provide complete support for this switch.
13727 @item -ftls-model=@var{model}
13728 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13729 The @var{model} argument should be one of @code{global-dynamic},
13730 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13732 The default without @option{-fpic} is @code{initial-exec}; with
13733 @option{-fpic} the default is @code{global-dynamic}.
13735 @item -fvisibility=@var{default|internal|hidden|protected}
13736 @opindex fvisibility
13737 Set the default ELF image symbol visibility to the specified option---all
13738 symbols will be marked with this unless overridden within the code.
13739 Using this feature can very substantially improve linking and
13740 load times of shared object libraries, produce more optimized
13741 code, provide near-perfect API export and prevent symbol clashes.
13742 It is @strong{strongly} recommended that you use this in any shared objects
13743 you distribute.
13745 Despite the nomenclature, @code{default} always means public ie;
13746 available to be linked against from outside the shared object.
13747 @code{protected} and @code{internal} are pretty useless in real-world
13748 usage so the only other commonly used option will be @code{hidden}.
13749 The default if @option{-fvisibility} isn't specified is
13750 @code{default}, i.e., make every
13751 symbol public---this causes the same behavior as previous versions of
13752 GCC@.
13754 A good explanation of the benefits offered by ensuring ELF
13755 symbols have the correct visibility is given by ``How To Write
13756 Shared Libraries'' by Ulrich Drepper (which can be found at
13757 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13758 solution made possible by this option to marking things hidden when
13759 the default is public is to make the default hidden and mark things
13760 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13761 and @code{__attribute__ ((visibility("default")))} instead of
13762 @code{__declspec(dllexport)} you get almost identical semantics with
13763 identical syntax.  This is a great boon to those working with
13764 cross-platform projects.
13766 For those adding visibility support to existing code, you may find
13767 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13768 the declarations you wish to set visibility for with (for example)
13769 @samp{#pragma GCC visibility push(hidden)} and
13770 @samp{#pragma GCC visibility pop}.
13771 Bear in mind that symbol visibility should be viewed @strong{as
13772 part of the API interface contract} and thus all new code should
13773 always specify visibility when it is not the default ie; declarations
13774 only for use within the local DSO should @strong{always} be marked explicitly
13775 as hidden as so to avoid PLT indirection overheads---making this
13776 abundantly clear also aids readability and self-documentation of the code.
13777 Note that due to ISO C++ specification requirements, operator new and
13778 operator delete must always be of default visibility.
13780 Be aware that headers from outside your project, in particular system
13781 headers and headers from any other library you use, may not be
13782 expecting to be compiled with visibility other than the default.  You
13783 may need to explicitly say @samp{#pragma GCC visibility push(default)}
13784 before including any such headers.
13786 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
13787 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
13788 no modifications.  However, this means that calls to @samp{extern}
13789 functions with no explicit visibility will use the PLT, so it is more
13790 effective to use @samp{__attribute ((visibility))} and/or
13791 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
13792 declarations should be treated as hidden.
13794 Note that @samp{-fvisibility} does affect C++ vague linkage
13795 entities. This means that, for instance, an exception class that will
13796 be thrown between DSOs must be explicitly marked with default
13797 visibility so that the @samp{type_info} nodes will be unified between
13798 the DSOs.
13800 An overview of these techniques, their benefits and how to use them
13801 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13803 @end table
13805 @c man end
13807 @node Environment Variables
13808 @section Environment Variables Affecting GCC
13809 @cindex environment variables
13811 @c man begin ENVIRONMENT
13812 This section describes several environment variables that affect how GCC
13813 operates.  Some of them work by specifying directories or prefixes to use
13814 when searching for various kinds of files.  Some are used to specify other
13815 aspects of the compilation environment.
13817 Note that you can also specify places to search using options such as
13818 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13819 take precedence over places specified using environment variables, which
13820 in turn take precedence over those specified by the configuration of GCC@.
13821 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13822 GNU Compiler Collection (GCC) Internals}.
13824 @table @env
13825 @item LANG
13826 @itemx LC_CTYPE
13827 @c @itemx LC_COLLATE
13828 @itemx LC_MESSAGES
13829 @c @itemx LC_MONETARY
13830 @c @itemx LC_NUMERIC
13831 @c @itemx LC_TIME
13832 @itemx LC_ALL
13833 @findex LANG
13834 @findex LC_CTYPE
13835 @c @findex LC_COLLATE
13836 @findex LC_MESSAGES
13837 @c @findex LC_MONETARY
13838 @c @findex LC_NUMERIC
13839 @c @findex LC_TIME
13840 @findex LC_ALL
13841 @cindex locale
13842 These environment variables control the way that GCC uses
13843 localization information that allow GCC to work with different
13844 national conventions.  GCC inspects the locale categories
13845 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13846 so.  These locale categories can be set to any value supported by your
13847 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13848 Kingdom encoded in UTF-8.
13850 The @env{LC_CTYPE} environment variable specifies character
13851 classification.  GCC uses it to determine the character boundaries in
13852 a string; this is needed for some multibyte encodings that contain quote
13853 and escape characters that would otherwise be interpreted as a string
13854 end or escape.
13856 The @env{LC_MESSAGES} environment variable specifies the language to
13857 use in diagnostic messages.
13859 If the @env{LC_ALL} environment variable is set, it overrides the value
13860 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13861 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13862 environment variable.  If none of these variables are set, GCC
13863 defaults to traditional C English behavior.
13865 @item TMPDIR
13866 @findex TMPDIR
13867 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13868 files.  GCC uses temporary files to hold the output of one stage of
13869 compilation which is to be used as input to the next stage: for example,
13870 the output of the preprocessor, which is the input to the compiler
13871 proper.
13873 @item GCC_EXEC_PREFIX
13874 @findex GCC_EXEC_PREFIX
13875 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13876 names of the subprograms executed by the compiler.  No slash is added
13877 when this prefix is combined with the name of a subprogram, but you can
13878 specify a prefix that ends with a slash if you wish.
13880 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13881 an appropriate prefix to use based on the pathname it was invoked with.
13883 If GCC cannot find the subprogram using the specified prefix, it
13884 tries looking in the usual places for the subprogram.
13886 The default value of @env{GCC_EXEC_PREFIX} is
13887 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13888 of @code{prefix} when you ran the @file{configure} script.
13890 Other prefixes specified with @option{-B} take precedence over this prefix.
13892 This prefix is also used for finding files such as @file{crt0.o} that are
13893 used for linking.
13895 In addition, the prefix is used in an unusual way in finding the
13896 directories to search for header files.  For each of the standard
13897 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13898 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13899 replacing that beginning with the specified prefix to produce an
13900 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13901 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13902 These alternate directories are searched first; the standard directories
13903 come next.
13905 @item COMPILER_PATH
13906 @findex COMPILER_PATH
13907 The value of @env{COMPILER_PATH} is a colon-separated list of
13908 directories, much like @env{PATH}.  GCC tries the directories thus
13909 specified when searching for subprograms, if it can't find the
13910 subprograms using @env{GCC_EXEC_PREFIX}.
13912 @item LIBRARY_PATH
13913 @findex LIBRARY_PATH
13914 The value of @env{LIBRARY_PATH} is a colon-separated list of
13915 directories, much like @env{PATH}.  When configured as a native compiler,
13916 GCC tries the directories thus specified when searching for special
13917 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13918 using GCC also uses these directories when searching for ordinary
13919 libraries for the @option{-l} option (but directories specified with
13920 @option{-L} come first).
13922 @item LANG
13923 @findex LANG
13924 @cindex locale definition
13925 This variable is used to pass locale information to the compiler.  One way in
13926 which this information is used is to determine the character set to be used
13927 when character literals, string literals and comments are parsed in C and C++.
13928 When the compiler is configured to allow multibyte characters,
13929 the following values for @env{LANG} are recognized:
13931 @table @samp
13932 @item C-JIS
13933 Recognize JIS characters.
13934 @item C-SJIS
13935 Recognize SJIS characters.
13936 @item C-EUCJP
13937 Recognize EUCJP characters.
13938 @end table
13940 If @env{LANG} is not defined, or if it has some other value, then the
13941 compiler will use mblen and mbtowc as defined by the default locale to
13942 recognize and translate multibyte characters.
13943 @end table
13945 @noindent
13946 Some additional environments variables affect the behavior of the
13947 preprocessor.
13949 @include cppenv.texi
13951 @c man end
13953 @node Precompiled Headers
13954 @section Using Precompiled Headers
13955 @cindex precompiled headers
13956 @cindex speed of compilation
13958 Often large projects have many header files that are included in every
13959 source file.  The time the compiler takes to process these header files
13960 over and over again can account for nearly all of the time required to
13961 build the project.  To make builds faster, GCC allows users to
13962 `precompile' a header file; then, if builds can use the precompiled
13963 header file they will be much faster.
13965 To create a precompiled header file, simply compile it as you would any
13966 other file, if necessary using the @option{-x} option to make the driver
13967 treat it as a C or C++ header file.  You will probably want to use a
13968 tool like @command{make} to keep the precompiled header up-to-date when
13969 the headers it contains change.
13971 A precompiled header file will be searched for when @code{#include} is
13972 seen in the compilation.  As it searches for the included file
13973 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13974 compiler looks for a precompiled header in each directory just before it
13975 looks for the include file in that directory.  The name searched for is
13976 the name specified in the @code{#include} with @samp{.gch} appended.  If
13977 the precompiled header file can't be used, it is ignored.
13979 For instance, if you have @code{#include "all.h"}, and you have
13980 @file{all.h.gch} in the same directory as @file{all.h}, then the
13981 precompiled header file will be used if possible, and the original
13982 header will be used otherwise.
13984 Alternatively, you might decide to put the precompiled header file in a
13985 directory and use @option{-I} to ensure that directory is searched
13986 before (or instead of) the directory containing the original header.
13987 Then, if you want to check that the precompiled header file is always
13988 used, you can put a file of the same name as the original header in this
13989 directory containing an @code{#error} command.
13991 This also works with @option{-include}.  So yet another way to use
13992 precompiled headers, good for projects not designed with precompiled
13993 header files in mind, is to simply take most of the header files used by
13994 a project, include them from another header file, precompile that header
13995 file, and @option{-include} the precompiled header.  If the header files
13996 have guards against multiple inclusion, they will be skipped because
13997 they've already been included (in the precompiled header).
13999 If you need to precompile the same header file for different
14000 languages, targets, or compiler options, you can instead make a
14001 @emph{directory} named like @file{all.h.gch}, and put each precompiled
14002 header in the directory, perhaps using @option{-o}.  It doesn't matter
14003 what you call the files in the directory, every precompiled header in
14004 the directory will be considered.  The first precompiled header
14005 encountered in the directory that is valid for this compilation will
14006 be used; they're searched in no particular order.
14008 There are many other possibilities, limited only by your imagination,
14009 good sense, and the constraints of your build system.
14011 A precompiled header file can be used only when these conditions apply:
14013 @itemize
14014 @item
14015 Only one precompiled header can be used in a particular compilation.
14017 @item
14018 A precompiled header can't be used once the first C token is seen.  You
14019 can have preprocessor directives before a precompiled header; you can
14020 even include a precompiled header from inside another header, so long as
14021 there are no C tokens before the @code{#include}.
14023 @item
14024 The precompiled header file must be produced for the same language as
14025 the current compilation.  You can't use a C precompiled header for a C++
14026 compilation.
14028 @item
14029 The precompiled header file must have been produced by the same compiler
14030 binary as the current compilation is using.
14032 @item
14033 Any macros defined before the precompiled header is included must
14034 either be defined in the same way as when the precompiled header was
14035 generated, or must not affect the precompiled header, which usually
14036 means that they don't appear in the precompiled header at all.
14038 The @option{-D} option is one way to define a macro before a
14039 precompiled header is included; using a @code{#define} can also do it.
14040 There are also some options that define macros implicitly, like
14041 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
14042 defined this way.
14044 @item If debugging information is output when using the precompiled
14045 header, using @option{-g} or similar, the same kind of debugging information
14046 must have been output when building the precompiled header.  However,
14047 a precompiled header built using @option{-g} can be used in a compilation
14048 when no debugging information is being output.
14050 @item The same @option{-m} options must generally be used when building
14051 and using the precompiled header.  @xref{Submodel Options},
14052 for any cases where this rule is relaxed.
14054 @item Each of the following options must be the same when building and using
14055 the precompiled header:
14057 @gccoptlist{-fexceptions -funit-at-a-time}
14059 @item
14060 Some other command-line options starting with @option{-f},
14061 @option{-p}, or @option{-O} must be defined in the same way as when
14062 the precompiled header was generated.  At present, it's not clear
14063 which options are safe to change and which are not; the safest choice
14064 is to use exactly the same options when generating and using the
14065 precompiled header.  The following are known to be safe:
14067 @gccoptlist{-fmessage-length= -fpreprocessed
14068 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
14069 -fsched-verbose=<number> -fschedule-insns -fvisibility=
14070 -pedantic-errors}
14072 @end itemize
14074 For all of these except the last, the compiler will automatically
14075 ignore the precompiled header if the conditions aren't met.  If you
14076 find an option combination that doesn't work and doesn't cause the
14077 precompiled header to be ignored, please consider filing a bug report,
14078 see @ref{Bugs}.
14080 If you do use differing options when generating and using the
14081 precompiled header, the actual behavior will be a mixture of the
14082 behavior for the options.  For instance, if you use @option{-g} to
14083 generate the precompiled header but not when using it, you may or may
14084 not get debugging information for routines in the precompiled header.
14086 @node Running Protoize
14087 @section Running Protoize
14089 The program @code{protoize} is an optional part of GCC@.  You can use
14090 it to add prototypes to a program, thus converting the program to ISO
14091 C in one respect.  The companion program @code{unprotoize} does the
14092 reverse: it removes argument types from any prototypes that are found.
14094 When you run these programs, you must specify a set of source files as
14095 command line arguments.  The conversion programs start out by compiling
14096 these files to see what functions they define.  The information gathered
14097 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
14099 After scanning comes actual conversion.  The specified files are all
14100 eligible to be converted; any files they include (whether sources or
14101 just headers) are eligible as well.
14103 But not all the eligible files are converted.  By default,
14104 @code{protoize} and @code{unprotoize} convert only source and header
14105 files in the current directory.  You can specify additional directories
14106 whose files should be converted with the @option{-d @var{directory}}
14107 option.  You can also specify particular files to exclude with the
14108 @option{-x @var{file}} option.  A file is converted if it is eligible, its
14109 directory name matches one of the specified directory names, and its
14110 name within the directory has not been excluded.
14112 Basic conversion with @code{protoize} consists of rewriting most
14113 function definitions and function declarations to specify the types of
14114 the arguments.  The only ones not rewritten are those for varargs
14115 functions.
14117 @code{protoize} optionally inserts prototype declarations at the
14118 beginning of the source file, to make them available for any calls that
14119 precede the function's definition.  Or it can insert prototype
14120 declarations with block scope in the blocks where undeclared functions
14121 are called.
14123 Basic conversion with @code{unprotoize} consists of rewriting most
14124 function declarations to remove any argument types, and rewriting
14125 function definitions to the old-style pre-ISO form.
14127 Both conversion programs print a warning for any function declaration or
14128 definition that they can't convert.  You can suppress these warnings
14129 with @option{-q}.
14131 The output from @code{protoize} or @code{unprotoize} replaces the
14132 original source file.  The original file is renamed to a name ending
14133 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
14134 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
14135 for DOS) file already exists, then the source file is simply discarded.
14137 @code{protoize} and @code{unprotoize} both depend on GCC itself to
14138 scan the program and collect information about the functions it uses.
14139 So neither of these programs will work until GCC is installed.
14141 Here is a table of the options you can use with @code{protoize} and
14142 @code{unprotoize}.  Each option works with both programs unless
14143 otherwise stated.
14145 @table @code
14146 @item -B @var{directory}
14147 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
14148 usual directory (normally @file{/usr/local/lib}).  This file contains
14149 prototype information about standard system functions.  This option
14150 applies only to @code{protoize}.
14152 @item -c @var{compilation-options}
14153 Use @var{compilation-options} as the options when running @command{gcc} to
14154 produce the @samp{.X} files.  The special option @option{-aux-info} is
14155 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
14157 Note that the compilation options must be given as a single argument to
14158 @code{protoize} or @code{unprotoize}.  If you want to specify several
14159 @command{gcc} options, you must quote the entire set of compilation options
14160 to make them a single word in the shell.
14162 There are certain @command{gcc} arguments that you cannot use, because they
14163 would produce the wrong kind of output.  These include @option{-g},
14164 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
14165 the @var{compilation-options}, they are ignored.
14167 @item -C
14168 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
14169 systems) instead of @samp{.c}.  This is convenient if you are converting
14170 a C program to C++.  This option applies only to @code{protoize}.
14172 @item -g
14173 Add explicit global declarations.  This means inserting explicit
14174 declarations at the beginning of each source file for each function
14175 that is called in the file and was not declared.  These declarations
14176 precede the first function definition that contains a call to an
14177 undeclared function.  This option applies only to @code{protoize}.
14179 @item -i @var{string}
14180 Indent old-style parameter declarations with the string @var{string}.
14181 This option applies only to @code{protoize}.
14183 @code{unprotoize} converts prototyped function definitions to old-style
14184 function definitions, where the arguments are declared between the
14185 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
14186 uses five spaces as the indentation.  If you want to indent with just
14187 one space instead, use @option{-i " "}.
14189 @item -k
14190 Keep the @samp{.X} files.  Normally, they are deleted after conversion
14191 is finished.
14193 @item -l
14194 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
14195 a prototype declaration for each function in each block which calls the
14196 function without any declaration.  This option applies only to
14197 @code{protoize}.
14199 @item -n
14200 Make no real changes.  This mode just prints information about the conversions
14201 that would have been done without @option{-n}.
14203 @item -N
14204 Make no @samp{.save} files.  The original files are simply deleted.
14205 Use this option with caution.
14207 @item -p @var{program}
14208 Use the program @var{program} as the compiler.  Normally, the name
14209 @file{gcc} is used.
14211 @item -q
14212 Work quietly.  Most warnings are suppressed.
14214 @item -v
14215 Print the version number, just like @option{-v} for @command{gcc}.
14216 @end table
14218 If you need special compiler options to compile one of your program's
14219 source files, then you should generate that file's @samp{.X} file
14220 specially, by running @command{gcc} on that source file with the
14221 appropriate options and the option @option{-aux-info}.  Then run
14222 @code{protoize} on the entire set of files.  @code{protoize} will use
14223 the existing @samp{.X} file because it is newer than the source file.
14224 For example:
14226 @smallexample
14227 gcc -Dfoo=bar file1.c -aux-info file1.X
14228 protoize *.c
14229 @end smallexample
14231 @noindent
14232 You need to include the special files along with the rest in the
14233 @code{protoize} command, even though their @samp{.X} files already
14234 exist, because otherwise they won't get converted.
14236 @xref{Protoize Caveats}, for more information on how to use
14237 @code{protoize} successfully.