* check-init.c, decl.c, expr.c, gcj.texi, java-tree.h,
[official-gcc.git] / gcc / doc / invoke.texi
blobd31523ac44601677b2a70e3aa6b23d592494edd0
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstack-protector @gol
242 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
243 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
244 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
245 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
246 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
247 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
248 -Wwrite-strings}
250 @item C-only Warning Options
251 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
252 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
253 -Wstrict-prototypes  -Wtraditional @gol
254 -Wdeclaration-after-statement -Wno-pointer-sign}
256 @item Debugging Options
257 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
258 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
259 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
260 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
261 -fdump-ipa-all -fdump-ipa-cgraph @gol
262 -fdump-tree-all @gol
263 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
264 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
267 -fdump-tree-ch @gol
268 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-nrv -fdump-tree-vect @gol
277 -fdump-tree-sink @gol
278 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-salias @gol
280 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
282 -ftree-vectorizer-verbose=@var{n} @gol
283 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
284 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
285 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
286 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
287 -ftest-coverage  -ftime-report -fvar-tracking @gol
288 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
289 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
290 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
291 -print-multi-directory  -print-multi-lib @gol
292 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
293 -save-temps  -time}
295 @item Optimization Options
296 @xref{Optimize Options,,Options that Control Optimization}.
297 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
298 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
299 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
300 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
301 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
302 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
303 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
304 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
305 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
306 -fforce-addr  -ffunction-sections @gol
307 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
308 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
309 -finline-functions  -finline-functions-called-once @gol
310 -finline-limit=@var{n}  -fkeep-inline-functions @gol
311 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
312 -fmodulo-sched -fno-branch-count-reg @gol
313 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
314 -fno-function-cse  -fno-guess-branch-probability @gol
315 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
316 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
317 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
318 -fomit-frame-pointer  -foptimize-register-move @gol
319 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
320 -fprofile-generate -fprofile-use @gol
321 -fregmove  -frename-registers @gol
322 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
323 -frerun-cse-after-loop  -frerun-loop-opt @gol
324 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
325 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
326 -fsched-spec-load-dangerous  @gol
327 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
328 -fsched2-use-superblocks @gol
329 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
330 -fsignaling-nans -fsingle-precision-constant  @gol
331 -fstack-protector  -fstack-protector-all @gol
332 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
333 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
334 -fsplit-ivs-in-unroller -funswitch-loops @gol
335 -fvariable-expansion-in-unroller @gol
336 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
337 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
338 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
339 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
340 -ftree-salias -fweb @gol
341 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
342 --param @var{name}=@var{value}
343 -O  -O0  -O1  -O2  -O3  -Os}
345 @item Preprocessor Options
346 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
347 @gccoptlist{-A@var{question}=@var{answer} @gol
348 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
349 -C  -dD  -dI  -dM  -dN @gol
350 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
351 -idirafter @var{dir} @gol
352 -include @var{file}  -imacros @var{file} @gol
353 -iprefix @var{file}  -iwithprefix @var{dir} @gol
354 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
355 -isysroot @var{dir} @gol
356 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
357 -P  -fworking-directory  -remap @gol
358 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
359 -Xpreprocessor @var{option}}
361 @item Assembler Option
362 @xref{Assembler Options,,Passing Options to the Assembler}.
363 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
365 @item Linker Options
366 @xref{Link Options,,Options for Linking}.
367 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
368 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
369 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
370 -Wl,@var{option}  -Xlinker @var{option} @gol
371 -u @var{symbol}}
373 @item Directory Options
374 @xref{Directory Options,,Options for Directory Search}.
375 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
376 -specs=@var{file}  -I- --sysroot=@var{dir}}
378 @item Target Options
379 @c I wrote this xref this way to avoid overfull hbox. -- rms
380 @xref{Target Options}.
381 @gccoptlist{-V @var{version}  -b @var{machine}}
383 @item Machine Dependent Options
384 @xref{Submodel Options,,Hardware Models and Configurations}.
385 @c This list is ordered alphanumerically by subsection name.
386 @c Try and put the significant identifier (CPU or system) first,
387 @c so users have a clue at guessing where the ones they want will be.
389 @emph{ARC Options}
390 @gccoptlist{-EB  -EL @gol
391 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
392 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
394 @emph{ARM Options}
395 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
396 -mabi=@var{name} @gol
397 -mapcs-stack-check  -mno-apcs-stack-check @gol
398 -mapcs-float  -mno-apcs-float @gol
399 -mapcs-reentrant  -mno-apcs-reentrant @gol
400 -msched-prolog  -mno-sched-prolog @gol
401 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
402 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
403 -mthumb-interwork  -mno-thumb-interwork @gol
404 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
405 -mstructure-size-boundary=@var{n} @gol
406 -mabort-on-noreturn @gol
407 -mlong-calls  -mno-long-calls @gol
408 -msingle-pic-base  -mno-single-pic-base @gol
409 -mpic-register=@var{reg} @gol
410 -mnop-fun-dllimport @gol
411 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
412 -mpoke-function-name @gol
413 -mthumb  -marm @gol
414 -mtpcs-frame  -mtpcs-leaf-frame @gol
415 -mcaller-super-interworking  -mcallee-super-interworking}
417 @emph{AVR Options}
418 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
419 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
421 @emph{Blackfin Options}
422 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
423 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
424 -mlow-64k -mno-low64k -mid-shared-library @gol
425 -mno-id-shared-library -mshared-library-id=@var{n} @gol
426 -mlong-calls  -mno-long-calls}
428 @emph{CRIS Options}
429 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
430 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
431 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
432 -mstack-align  -mdata-align  -mconst-align @gol
433 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
434 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
435 -mmul-bug-workaround  -mno-mul-bug-workaround}
437 @emph{CRX Options}
438 @gccoptlist{-mmac -mpush-args}
440 @emph{Darwin Options}
441 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
442 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
443 -client_name  -compatibility_version  -current_version @gol
444 -dead_strip @gol
445 -dependency-file  -dylib_file  -dylinker_install_name @gol
446 -dynamic  -dynamiclib  -exported_symbols_list @gol
447 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
448 -force_flat_namespace  -headerpad_max_install_names @gol
449 -image_base  -init  -install_name  -keep_private_externs @gol
450 -multi_module  -multiply_defined  -multiply_defined_unused @gol
451 -noall_load   -no_dead_strip_inits_and_terms @gol
452 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
453 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
454 -private_bundle  -read_only_relocs  -sectalign @gol
455 -sectobjectsymbols  -whyload  -seg1addr @gol
456 -sectcreate  -sectobjectsymbols  -sectorder @gol
457 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
458 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
459 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
460 -single_module  -static  -sub_library  -sub_umbrella @gol
461 -twolevel_namespace  -umbrella  -undefined @gol
462 -unexported_symbols_list  -weak_reference_mismatches @gol
463 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
464 -mone-byte-bool}
466 @emph{DEC Alpha Options}
467 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
468 -mieee  -mieee-with-inexact  -mieee-conformant @gol
469 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
470 -mtrap-precision=@var{mode}  -mbuild-constants @gol
471 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
472 -mbwx  -mmax  -mfix  -mcix @gol
473 -mfloat-vax  -mfloat-ieee @gol
474 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
475 -msmall-text  -mlarge-text @gol
476 -mmemory-latency=@var{time}}
478 @emph{DEC Alpha/VMS Options}
479 @gccoptlist{-mvms-return-codes}
481 @emph{FRV Options}
482 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
483 -mhard-float  -msoft-float @gol
484 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
485 -mdouble  -mno-double @gol
486 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
487 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
488 -mlinked-fp  -mlong-calls  -malign-labels @gol
489 -mlibrary-pic  -macc-4  -macc-8 @gol
490 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
491 -moptimize-membar -mno-optimize-membar @gol
492 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
493 -mvliw-branch  -mno-vliw-branch @gol
494 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
495 -mno-nested-cond-exec  -mtomcat-stats @gol
496 -mTLS -mtls @gol
497 -mcpu=@var{cpu}}
499 @emph{H8/300 Options}
500 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
502 @emph{HPPA Options}
503 @gccoptlist{-march=@var{architecture-type} @gol
504 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
505 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
506 -mfixed-range=@var{register-range} @gol
507 -mjump-in-delay -mlinker-opt -mlong-calls @gol
508 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
509 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
510 -mno-jump-in-delay  -mno-long-load-store @gol
511 -mno-portable-runtime  -mno-soft-float @gol
512 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
513 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
514 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
515 -munix=@var{unix-std}  -nolibdld  -static  -threads}
517 @emph{i386 and x86-64 Options}
518 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
519 -mfpmath=@var{unit} @gol
520 -masm=@var{dialect}  -mno-fancy-math-387 @gol
521 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
522 -mno-wide-multiply  -mrtd  -malign-double @gol
523 -mpreferred-stack-boundary=@var{num} @gol
524 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
525 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
526 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
527 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
528 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
529 -mcmodel=@var{code-model} @gol
530 -m32  -m64 -mlarge-data-threshold=@var{num}}
532 @emph{IA-64 Options}
533 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
534 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
535 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
536 -minline-float-divide-max-throughput @gol
537 -minline-int-divide-min-latency @gol
538 -minline-int-divide-max-throughput  @gol
539 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
540 -mno-dwarf2-asm -mearly-stop-bits @gol
541 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
542 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
544 @emph{M32R/D Options}
545 @gccoptlist{-m32r2 -m32rx -m32r @gol
546 -mdebug @gol
547 -malign-loops -mno-align-loops @gol
548 -missue-rate=@var{number} @gol
549 -mbranch-cost=@var{number} @gol
550 -mmodel=@var{code-size-model-type} @gol
551 -msdata=@var{sdata-type} @gol
552 -mno-flush-func -mflush-func=@var{name} @gol
553 -mno-flush-trap -mflush-trap=@var{number} @gol
554 -G @var{num}}
556 @emph{M32C Options}
557 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
559 @emph{M680x0 Options}
560 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
561 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
562 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
563 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
564 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
566 @emph{M68hc1x Options}
567 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
568 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
569 -msoft-reg-count=@var{count}}
571 @emph{MCore Options}
572 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
573 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
574 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
575 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
576 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
578 @emph{MIPS Options}
579 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
580 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
581 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
582 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
583 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
584 -mdsp  -mpaired-single  -mips3d @gol
585 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
586 -G@var{num}  -membedded-data  -mno-embedded-data @gol
587 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
588 -msplit-addresses  -mno-split-addresses  @gol
589 -mexplicit-relocs  -mno-explicit-relocs  @gol
590 -mcheck-zero-division  -mno-check-zero-division @gol
591 -mdivide-traps  -mdivide-breaks @gol
592 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
593 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
594 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
595 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
596 -mfix-sb1  -mno-fix-sb1 @gol
597 -mflush-func=@var{func}  -mno-flush-func @gol
598 -mbranch-likely  -mno-branch-likely @gol
599 -mfp-exceptions -mno-fp-exceptions @gol
600 -mvr4130-align -mno-vr4130-align}
602 @emph{MMIX Options}
603 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
604 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
605 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
606 -mno-base-addresses  -msingle-exit  -mno-single-exit}
608 @emph{MN10300 Options}
609 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
610 -mam33  -mno-am33 @gol
611 -mam33-2  -mno-am33-2 @gol
612 -mno-crt0  -mrelax}
614 @emph{MS1 Options}
615 @gccoptlist{-mno-crt0 -mmul -mbacc -msim @gol
616 -march=@var{cpu-type} }
618 @emph{PDP-11 Options}
619 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
620 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
621 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
622 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
623 -mbranch-expensive  -mbranch-cheap @gol
624 -msplit  -mno-split  -munix-asm  -mdec-asm}
626 @emph{PowerPC Options}
627 See RS/6000 and PowerPC Options.
629 @emph{RS/6000 and PowerPC Options}
630 @gccoptlist{-mcpu=@var{cpu-type} @gol
631 -mtune=@var{cpu-type} @gol
632 -mpower  -mno-power  -mpower2  -mno-power2 @gol
633 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
634 -maltivec  -mno-altivec @gol
635 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
636 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
637 -mnew-mnemonics  -mold-mnemonics @gol
638 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
639 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
640 -malign-power  -malign-natural @gol
641 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
642 -mstring  -mno-string  -mupdate  -mno-update @gol
643 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
644 -mstrict-align  -mno-strict-align  -mrelocatable @gol
645 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
646 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
647 -mdynamic-no-pic  -maltivec  -mswdiv @gol
648 -mprioritize-restricted-insns=@var{priority} @gol
649 -msched-costly-dep=@var{dependence_type} @gol
650 -minsert-sched-nops=@var{scheme} @gol
651 -mcall-sysv  -mcall-netbsd @gol
652 -maix-struct-return  -msvr4-struct-return @gol
653 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
654 -misel -mno-isel @gol
655 -misel=yes  -misel=no @gol
656 -mspe -mno-spe @gol
657 -mspe=yes  -mspe=no @gol
658 -mvrsave -mno-vrsave @gol
659 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
660 -mprototype  -mno-prototype @gol
661 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
662 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
664 @emph{S/390 and zSeries Options}
665 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
666 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
667 -mpacked-stack  -mno-packed-stack @gol
668 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
669 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
670 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
671 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
673 @emph{SH Options}
674 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
675 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
676 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
677 -m5-64media  -m5-64media-nofpu @gol
678 -m5-32media  -m5-32media-nofpu @gol
679 -m5-compact  -m5-compact-nofpu @gol
680 -mb  -ml  -mdalign  -mrelax @gol
681 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
682 -mieee  -misize  -mpadstruct  -mspace @gol
683 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
684 -mdivsi3_libfunc=@var{name}  @gol
685 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
686  -minvalid-symbols}
688 @emph{SPARC Options}
689 @gccoptlist{-mcpu=@var{cpu-type} @gol
690 -mtune=@var{cpu-type} @gol
691 -mcmodel=@var{code-model} @gol
692 -m32  -m64  -mapp-regs  -mno-app-regs @gol
693 -mfaster-structs  -mno-faster-structs @gol
694 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
695 -mhard-quad-float  -msoft-quad-float @gol
696 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
697 -mstack-bias  -mno-stack-bias @gol
698 -munaligned-doubles  -mno-unaligned-doubles @gol
699 -mv8plus  -mno-v8plus  -mvis  -mno-vis
700 -threads -pthreads}
702 @emph{System V Options}
703 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
705 @emph{TMS320C3x/C4x Options}
706 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
707 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
708 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
709 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
711 @emph{V850 Options}
712 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
713 -mprolog-function  -mno-prolog-function  -mspace @gol
714 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
715 -mapp-regs  -mno-app-regs @gol
716 -mdisable-callt  -mno-disable-callt @gol
717 -mv850e1 @gol
718 -mv850e @gol
719 -mv850  -mbig-switch}
721 @emph{VAX Options}
722 @gccoptlist{-mg  -mgnu  -munix}
724 @emph{x86-64 Options}
725 See i386 and x86-64 Options.
727 @emph{Xstormy16 Options}
728 @gccoptlist{-msim}
730 @emph{Xtensa Options}
731 @gccoptlist{-mconst16 -mno-const16 @gol
732 -mfused-madd  -mno-fused-madd @gol
733 -mtext-section-literals  -mno-text-section-literals @gol
734 -mtarget-align  -mno-target-align @gol
735 -mlongcalls  -mno-longcalls}
737 @emph{zSeries Options}
738 See S/390 and zSeries Options.
740 @item Code Generation Options
741 @xref{Code Gen Options,,Options for Code Generation Conventions}.
742 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
743 -ffixed-@var{reg}  -fexceptions @gol
744 -fnon-call-exceptions  -funwind-tables @gol
745 -fasynchronous-unwind-tables @gol
746 -finhibit-size-directive  -finstrument-functions @gol
747 -fno-common  -fno-ident @gol
748 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
749 -fno-jump-tables @gol
750 -freg-struct-return  -fshared-data  -fshort-enums @gol
751 -fshort-double  -fshort-wchar @gol
752 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
753 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
754 -fargument-alias  -fargument-noalias @gol
755 -fargument-noalias-global  -fleading-underscore @gol
756 -ftls-model=@var{model} @gol
757 -ftrapv  -fwrapv  -fbounds-check @gol
758 -fvisibility}
759 @end table
761 @menu
762 * Overall Options::     Controlling the kind of output:
763                         an executable, object files, assembler files,
764                         or preprocessed source.
765 * C Dialect Options::   Controlling the variant of C language compiled.
766 * C++ Dialect Options:: Variations on C++.
767 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
768                         and Objective-C++.
769 * Language Independent Options:: Controlling how diagnostics should be
770                         formatted.
771 * Warning Options::     How picky should the compiler be?
772 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
773 * Optimize Options::    How much optimization?
774 * Preprocessor Options:: Controlling header files and macro definitions.
775                          Also, getting dependency information for Make.
776 * Assembler Options::   Passing options to the assembler.
777 * Link Options::        Specifying libraries and so on.
778 * Directory Options::   Where to find header files and libraries.
779                         Where to find the compiler executable files.
780 * Spec Files::          How to pass switches to sub-processes.
781 * Target Options::      Running a cross-compiler, or an old version of GCC.
782 @end menu
784 @node Overall Options
785 @section Options Controlling the Kind of Output
787 Compilation can involve up to four stages: preprocessing, compilation
788 proper, assembly and linking, always in that order.  GCC is capable of
789 preprocessing and compiling several files either into several
790 assembler input files, or into one assembler input file; then each
791 assembler input file produces an object file, and linking combines all
792 the object files (those newly compiled, and those specified as input)
793 into an executable file.
795 @cindex file name suffix
796 For any given input file, the file name suffix determines what kind of
797 compilation is done:
799 @table @gcctabopt
800 @item @var{file}.c
801 C source code which must be preprocessed.
803 @item @var{file}.i
804 C source code which should not be preprocessed.
806 @item @var{file}.ii
807 C++ source code which should not be preprocessed.
809 @item @var{file}.m
810 Objective-C source code.  Note that you must link with the @file{libobjc}
811 library to make an Objective-C program work.
813 @item @var{file}.mi
814 Objective-C source code which should not be preprocessed.
816 @item @var{file}.mm
817 @itemx @var{file}.M
818 Objective-C++ source code.  Note that you must link with the @file{libobjc}
819 library to make an Objective-C++ program work.  Note that @samp{.M} refers
820 to a literal capital M@.
822 @item @var{file}.mii
823 Objective-C++ source code which should not be preprocessed.
825 @item @var{file}.h
826 C, C++, Objective-C or Objective-C++ header file to be turned into a
827 precompiled header.
829 @item @var{file}.cc
830 @itemx @var{file}.cp
831 @itemx @var{file}.cxx
832 @itemx @var{file}.cpp
833 @itemx @var{file}.CPP
834 @itemx @var{file}.c++
835 @itemx @var{file}.C
836 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
837 the last two letters must both be literally @samp{x}.  Likewise,
838 @samp{.C} refers to a literal capital C@.
840 @item @var{file}.mm
841 @itemx @var{file}.M
842 Objective-C++ source code which must be preprocessed.
844 @item @var{file}.mii
845 Objective-C++ source code which should not be preprocessed.
847 @item @var{file}.hh
848 @itemx @var{file}.H
849 C++ header file to be turned into a precompiled header.
851 @item @var{file}.f
852 @itemx @var{file}.for
853 @itemx @var{file}.FOR
854 Fortran source code which should not be preprocessed.
856 @item @var{file}.F
857 @itemx @var{file}.fpp
858 @itemx @var{file}.FPP
859 Fortran source code which must be preprocessed (with the traditional
860 preprocessor).
862 @item @var{file}.r
863 Fortran source code which must be preprocessed with a RATFOR
864 preprocessor (not included with GCC)@.
866 @item @var{file}.f90
867 @itemx @var{file}.f95
868 Fortran 90/95 source code which should not be preprocessed.
870 @item @var{file}.F90
871 @itemx @var{file}.F95
872 Fortran 90/95 source code which must be preprocessed (with the
873 traditional preprocessor).
875 @c FIXME: Descriptions of Java file types.
876 @c @var{file}.java
877 @c @var{file}.class
878 @c @var{file}.zip
879 @c @var{file}.jar
881 @item @var{file}.ads
882 Ada source code file which contains a library unit declaration (a
883 declaration of a package, subprogram, or generic, or a generic
884 instantiation), or a library unit renaming declaration (a package,
885 generic, or subprogram renaming declaration).  Such files are also
886 called @dfn{specs}.
888 @itemx @var{file}.adb
889 Ada source code file containing a library unit body (a subprogram or
890 package body).  Such files are also called @dfn{bodies}.
892 @c GCC also knows about some suffixes for languages not yet included:
893 @c Pascal:
894 @c @var{file}.p
895 @c @var{file}.pas
897 @item @var{file}.s
898 Assembler code.
900 @item @var{file}.S
901 Assembler code which must be preprocessed.
903 @item @var{other}
904 An object file to be fed straight into linking.
905 Any file name with no recognized suffix is treated this way.
906 @end table
908 @opindex x
909 You can specify the input language explicitly with the @option{-x} option:
911 @table @gcctabopt
912 @item -x @var{language}
913 Specify explicitly the @var{language} for the following input files
914 (rather than letting the compiler choose a default based on the file
915 name suffix).  This option applies to all following input files until
916 the next @option{-x} option.  Possible values for @var{language} are:
917 @smallexample
918 c  c-header  c-cpp-output
919 c++  c++-header  c++-cpp-output
920 objective-c  objective-c-header  objective-c-cpp-output
921 objective-c++ objective-c++-header objective-c++-cpp-output
922 assembler  assembler-with-cpp
924 f77  f77-cpp-input  ratfor
926 java
927 treelang
928 @end smallexample
930 @item -x none
931 Turn off any specification of a language, so that subsequent files are
932 handled according to their file name suffixes (as they are if @option{-x}
933 has not been used at all).
935 @item -pass-exit-codes
936 @opindex pass-exit-codes
937 Normally the @command{gcc} program will exit with the code of 1 if any
938 phase of the compiler returns a non-success return code.  If you specify
939 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
940 numerically highest error produced by any phase that returned an error
941 indication.
942 @end table
944 If you only want some of the stages of compilation, you can use
945 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
946 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
947 @command{gcc} is to stop.  Note that some combinations (for example,
948 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
950 @table @gcctabopt
951 @item -c
952 @opindex c
953 Compile or assemble the source files, but do not link.  The linking
954 stage simply is not done.  The ultimate output is in the form of an
955 object file for each source file.
957 By default, the object file name for a source file is made by replacing
958 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
960 Unrecognized input files, not requiring compilation or assembly, are
961 ignored.
963 @item -S
964 @opindex S
965 Stop after the stage of compilation proper; do not assemble.  The output
966 is in the form of an assembler code file for each non-assembler input
967 file specified.
969 By default, the assembler file name for a source file is made by
970 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
972 Input files that don't require compilation are ignored.
974 @item -E
975 @opindex E
976 Stop after the preprocessing stage; do not run the compiler proper.  The
977 output is in the form of preprocessed source code, which is sent to the
978 standard output.
980 Input files which don't require preprocessing are ignored.
982 @cindex output file option
983 @item -o @var{file}
984 @opindex o
985 Place output in file @var{file}.  This applies regardless to whatever
986 sort of output is being produced, whether it be an executable file,
987 an object file, an assembler file or preprocessed C code.
989 If @option{-o} is not specified, the default is to put an executable
990 file in @file{a.out}, the object file for
991 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
992 assembler file in @file{@var{source}.s}, a precompiled header file in
993 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
994 standard output.
996 @item -v
997 @opindex v
998 Print (on standard error output) the commands executed to run the stages
999 of compilation.  Also print the version number of the compiler driver
1000 program and of the preprocessor and the compiler proper.
1002 @item -###
1003 @opindex ###
1004 Like @option{-v} except the commands are not executed and all command
1005 arguments are quoted.  This is useful for shell scripts to capture the
1006 driver-generated command lines.
1008 @item -pipe
1009 @opindex pipe
1010 Use pipes rather than temporary files for communication between the
1011 various stages of compilation.  This fails to work on some systems where
1012 the assembler is unable to read from a pipe; but the GNU assembler has
1013 no trouble.
1015 @item -combine
1016 @opindex combine
1017 If you are compiling multiple source files, this option tells the driver
1018 to pass all the source files to the compiler at once (for those
1019 languages for which the compiler can handle this).  This will allow
1020 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1021 language for which this is supported is C@.  If you pass source files for
1022 multiple languages to the driver, using this option, the driver will invoke
1023 the compiler(s) that support IMA once each, passing each compiler all the
1024 source files appropriate for it.  For those languages that do not support
1025 IMA this option will be ignored, and the compiler will be invoked once for
1026 each source file in that language.  If you use this option in conjunction
1027 with @option{-save-temps}, the compiler will generate multiple
1028 pre-processed files
1029 (one for each source file), but only one (combined) @file{.o} or
1030 @file{.s} file.
1032 @item --help
1033 @opindex help
1034 Print (on the standard output) a description of the command line options
1035 understood by @command{gcc}.  If the @option{-v} option is also specified
1036 then @option{--help} will also be passed on to the various processes
1037 invoked by @command{gcc}, so that they can display the command line options
1038 they accept.  If the @option{-Wextra} option is also specified then command
1039 line options which have no documentation associated with them will also
1040 be displayed.
1042 @item --target-help
1043 @opindex target-help
1044 Print (on the standard output) a description of target specific command
1045 line options for each tool.
1047 @item --version
1048 @opindex version
1049 Display the version number and copyrights of the invoked GCC@.
1050 @end table
1052 @node Invoking G++
1053 @section Compiling C++ Programs
1055 @cindex suffixes for C++ source
1056 @cindex C++ source file suffixes
1057 C++ source files conventionally use one of the suffixes @samp{.C},
1058 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1059 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1060 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1061 files with these names and compiles them as C++ programs even if you
1062 call the compiler the same way as for compiling C programs (usually
1063 with the name @command{gcc}).
1065 @findex g++
1066 @findex c++
1067 However, C++ programs often require class libraries as well as a
1068 compiler that understands the C++ language---and under some
1069 circumstances, you might want to compile programs or header files from
1070 standard input, or otherwise without a suffix that flags them as C++
1071 programs.  You might also like to precompile a C header file with a
1072 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1073 program that calls GCC with the default language set to C++, and
1074 automatically specifies linking against the C++ library.  On many
1075 systems, @command{g++} is also installed with the name @command{c++}.
1077 @cindex invoking @command{g++}
1078 When you compile C++ programs, you may specify many of the same
1079 command-line options that you use for compiling programs in any
1080 language; or command-line options meaningful for C and related
1081 languages; or options that are meaningful only for C++ programs.
1082 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1083 explanations of options for languages related to C@.
1084 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1085 explanations of options that are meaningful only for C++ programs.
1087 @node C Dialect Options
1088 @section Options Controlling C Dialect
1089 @cindex dialect options
1090 @cindex language dialect options
1091 @cindex options, dialect
1093 The following options control the dialect of C (or languages derived
1094 from C, such as C++, Objective-C and Objective-C++) that the compiler
1095 accepts:
1097 @table @gcctabopt
1098 @cindex ANSI support
1099 @cindex ISO support
1100 @item -ansi
1101 @opindex ansi
1102 In C mode, support all ISO C90 programs.  In C++ mode,
1103 remove GNU extensions that conflict with ISO C++.
1105 This turns off certain features of GCC that are incompatible with ISO
1106 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1107 such as the @code{asm} and @code{typeof} keywords, and
1108 predefined macros such as @code{unix} and @code{vax} that identify the
1109 type of system you are using.  It also enables the undesirable and
1110 rarely used ISO trigraph feature.  For the C compiler,
1111 it disables recognition of C++ style @samp{//} comments as well as
1112 the @code{inline} keyword.
1114 The alternate keywords @code{__asm__}, @code{__extension__},
1115 @code{__inline__} and @code{__typeof__} continue to work despite
1116 @option{-ansi}.  You would not want to use them in an ISO C program, of
1117 course, but it is useful to put them in header files that might be included
1118 in compilations done with @option{-ansi}.  Alternate predefined macros
1119 such as @code{__unix__} and @code{__vax__} are also available, with or
1120 without @option{-ansi}.
1122 The @option{-ansi} option does not cause non-ISO programs to be
1123 rejected gratuitously.  For that, @option{-pedantic} is required in
1124 addition to @option{-ansi}.  @xref{Warning Options}.
1126 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1127 option is used.  Some header files may notice this macro and refrain
1128 from declaring certain functions or defining certain macros that the
1129 ISO standard doesn't call for; this is to avoid interfering with any
1130 programs that might use these names for other things.
1132 Functions which would normally be built in but do not have semantics
1133 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1134 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1135 built-in functions provided by GCC}, for details of the functions
1136 affected.
1138 @item -std=
1139 @opindex std
1140 Determine the language standard.  This option is currently only
1141 supported when compiling C or C++.  A value for this option must be
1142 provided; possible values are
1144 @table @samp
1145 @item c89
1146 @itemx iso9899:1990
1147 ISO C90 (same as @option{-ansi}).
1149 @item iso9899:199409
1150 ISO C90 as modified in amendment 1.
1152 @item c99
1153 @itemx c9x
1154 @itemx iso9899:1999
1155 @itemx iso9899:199x
1156 ISO C99.  Note that this standard is not yet fully supported; see
1157 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1158 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1160 @item gnu89
1161 Default, ISO C90 plus GNU extensions (including some C99 features).
1163 @item gnu99
1164 @itemx gnu9x
1165 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1166 this will become the default.  The name @samp{gnu9x} is deprecated.
1168 @item c++98
1169 The 1998 ISO C++ standard plus amendments.
1171 @item gnu++98
1172 The same as @option{-std=c++98} plus GNU extensions.  This is the
1173 default for C++ code.
1174 @end table
1176 Even when this option is not specified, you can still use some of the
1177 features of newer standards in so far as they do not conflict with
1178 previous C standards.  For example, you may use @code{__restrict__} even
1179 when @option{-std=c99} is not specified.
1181 The @option{-std} options specifying some version of ISO C have the same
1182 effects as @option{-ansi}, except that features that were not in ISO C90
1183 but are in the specified version (for example, @samp{//} comments and
1184 the @code{inline} keyword in ISO C99) are not disabled.
1186 @xref{Standards,,Language Standards Supported by GCC}, for details of
1187 these standard versions.
1189 @item -aux-info @var{filename}
1190 @opindex aux-info
1191 Output to the given filename prototyped declarations for all functions
1192 declared and/or defined in a translation unit, including those in header
1193 files.  This option is silently ignored in any language other than C@.
1195 Besides declarations, the file indicates, in comments, the origin of
1196 each declaration (source file and line), whether the declaration was
1197 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1198 @samp{O} for old, respectively, in the first character after the line
1199 number and the colon), and whether it came from a declaration or a
1200 definition (@samp{C} or @samp{F}, respectively, in the following
1201 character).  In the case of function definitions, a K&R-style list of
1202 arguments followed by their declarations is also provided, inside
1203 comments, after the declaration.
1205 @item -fno-asm
1206 @opindex fno-asm
1207 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1208 keyword, so that code can use these words as identifiers.  You can use
1209 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1210 instead.  @option{-ansi} implies @option{-fno-asm}.
1212 In C++, this switch only affects the @code{typeof} keyword, since
1213 @code{asm} and @code{inline} are standard keywords.  You may want to
1214 use the @option{-fno-gnu-keywords} flag instead, which has the same
1215 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1216 switch only affects the @code{asm} and @code{typeof} keywords, since
1217 @code{inline} is a standard keyword in ISO C99.
1219 @item -fno-builtin
1220 @itemx -fno-builtin-@var{function}
1221 @opindex fno-builtin
1222 @cindex built-in functions
1223 Don't recognize built-in functions that do not begin with
1224 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1225 functions provided by GCC}, for details of the functions affected,
1226 including those which are not built-in functions when @option{-ansi} or
1227 @option{-std} options for strict ISO C conformance are used because they
1228 do not have an ISO standard meaning.
1230 GCC normally generates special code to handle certain built-in functions
1231 more efficiently; for instance, calls to @code{alloca} may become single
1232 instructions that adjust the stack directly, and calls to @code{memcpy}
1233 may become inline copy loops.  The resulting code is often both smaller
1234 and faster, but since the function calls no longer appear as such, you
1235 cannot set a breakpoint on those calls, nor can you change the behavior
1236 of the functions by linking with a different library.  In addition,
1237 when a function is recognized as a built-in function, GCC may use
1238 information about that function to warn about problems with calls to
1239 that function, or to generate more efficient code, even if the
1240 resulting code still contains calls to that function.  For example,
1241 warnings are given with @option{-Wformat} for bad calls to
1242 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1243 known not to modify global memory.
1245 With the @option{-fno-builtin-@var{function}} option
1246 only the built-in function @var{function} is
1247 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1248 function is named this is not built-in in this version of GCC, this
1249 option is ignored.  There is no corresponding
1250 @option{-fbuiltin-@var{function}} option; if you wish to enable
1251 built-in functions selectively when using @option{-fno-builtin} or
1252 @option{-ffreestanding}, you may define macros such as:
1254 @smallexample
1255 #define abs(n)          __builtin_abs ((n))
1256 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1257 @end smallexample
1259 @item -fhosted
1260 @opindex fhosted
1261 @cindex hosted environment
1263 Assert that compilation takes place in a hosted environment.  This implies
1264 @option{-fbuiltin}.  A hosted environment is one in which the
1265 entire standard library is available, and in which @code{main} has a return
1266 type of @code{int}.  Examples are nearly everything except a kernel.
1267 This is equivalent to @option{-fno-freestanding}.
1269 @item -ffreestanding
1270 @opindex ffreestanding
1271 @cindex hosted environment
1273 Assert that compilation takes place in a freestanding environment.  This
1274 implies @option{-fno-builtin}.  A freestanding environment
1275 is one in which the standard library may not exist, and program startup may
1276 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1277 This is equivalent to @option{-fno-hosted}.
1279 @xref{Standards,,Language Standards Supported by GCC}, for details of
1280 freestanding and hosted environments.
1282 @item -fms-extensions
1283 @opindex fms-extensions
1284 Accept some non-standard constructs used in Microsoft header files.
1286 Some cases of unnamed fields in structures and unions are only
1287 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1288 fields within structs/unions}, for details.
1290 @item -trigraphs
1291 @opindex trigraphs
1292 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1293 options for strict ISO C conformance) implies @option{-trigraphs}.
1295 @item -no-integrated-cpp
1296 @opindex no-integrated-cpp
1297 Performs a compilation in two passes: preprocessing and compiling.  This
1298 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1299 @option{-B} option.  The user supplied compilation step can then add in
1300 an additional preprocessing step after normal preprocessing but before
1301 compiling.  The default is to use the integrated cpp (internal cpp)
1303 The semantics of this option will change if "cc1", "cc1plus", and
1304 "cc1obj" are merged.
1306 @cindex traditional C language
1307 @cindex C language, traditional
1308 @item -traditional
1309 @itemx -traditional-cpp
1310 @opindex traditional-cpp
1311 @opindex traditional
1312 Formerly, these options caused GCC to attempt to emulate a pre-standard
1313 C compiler.  They are now only supported with the @option{-E} switch.
1314 The preprocessor continues to support a pre-standard mode.  See the GNU
1315 CPP manual for details.
1317 @item -fcond-mismatch
1318 @opindex fcond-mismatch
1319 Allow conditional expressions with mismatched types in the second and
1320 third arguments.  The value of such an expression is void.  This option
1321 is not supported for C++.
1323 @item -funsigned-char
1324 @opindex funsigned-char
1325 Let the type @code{char} be unsigned, like @code{unsigned char}.
1327 Each kind of machine has a default for what @code{char} should
1328 be.  It is either like @code{unsigned char} by default or like
1329 @code{signed char} by default.
1331 Ideally, a portable program should always use @code{signed char} or
1332 @code{unsigned char} when it depends on the signedness of an object.
1333 But many programs have been written to use plain @code{char} and
1334 expect it to be signed, or expect it to be unsigned, depending on the
1335 machines they were written for.  This option, and its inverse, let you
1336 make such a program work with the opposite default.
1338 The type @code{char} is always a distinct type from each of
1339 @code{signed char} or @code{unsigned char}, even though its behavior
1340 is always just like one of those two.
1342 @item -fsigned-char
1343 @opindex fsigned-char
1344 Let the type @code{char} be signed, like @code{signed char}.
1346 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1347 the negative form of @option{-funsigned-char}.  Likewise, the option
1348 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1350 @item -fsigned-bitfields
1351 @itemx -funsigned-bitfields
1352 @itemx -fno-signed-bitfields
1353 @itemx -fno-unsigned-bitfields
1354 @opindex fsigned-bitfields
1355 @opindex funsigned-bitfields
1356 @opindex fno-signed-bitfields
1357 @opindex fno-unsigned-bitfields
1358 These options control whether a bit-field is signed or unsigned, when the
1359 declaration does not use either @code{signed} or @code{unsigned}.  By
1360 default, such a bit-field is signed, because this is consistent: the
1361 basic integer types such as @code{int} are signed types.
1362 @end table
1364 @node C++ Dialect Options
1365 @section Options Controlling C++ Dialect
1367 @cindex compiler options, C++
1368 @cindex C++ options, command line
1369 @cindex options, C++
1370 This section describes the command-line options that are only meaningful
1371 for C++ programs; but you can also use most of the GNU compiler options
1372 regardless of what language your program is in.  For example, you
1373 might compile a file @code{firstClass.C} like this:
1375 @smallexample
1376 g++ -g -frepo -O -c firstClass.C
1377 @end smallexample
1379 @noindent
1380 In this example, only @option{-frepo} is an option meant
1381 only for C++ programs; you can use the other options with any
1382 language supported by GCC@.
1384 Here is a list of options that are @emph{only} for compiling C++ programs:
1386 @table @gcctabopt
1388 @item -fabi-version=@var{n}
1389 @opindex fabi-version
1390 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1391 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1392 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1393 the version that conforms most closely to the C++ ABI specification.
1394 Therefore, the ABI obtained using version 0 will change as ABI bugs
1395 are fixed.
1397 The default is version 2.
1399 @item -fno-access-control
1400 @opindex fno-access-control
1401 Turn off all access checking.  This switch is mainly useful for working
1402 around bugs in the access control code.
1404 @item -fcheck-new
1405 @opindex fcheck-new
1406 Check that the pointer returned by @code{operator new} is non-null
1407 before attempting to modify the storage allocated.  This check is
1408 normally unnecessary because the C++ standard specifies that
1409 @code{operator new} will only return @code{0} if it is declared
1410 @samp{throw()}, in which case the compiler will always check the
1411 return value even without this option.  In all other cases, when
1412 @code{operator new} has a non-empty exception specification, memory
1413 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1414 @samp{new (nothrow)}.
1416 @item -fconserve-space
1417 @opindex fconserve-space
1418 Put uninitialized or runtime-initialized global variables into the
1419 common segment, as C does.  This saves space in the executable at the
1420 cost of not diagnosing duplicate definitions.  If you compile with this
1421 flag and your program mysteriously crashes after @code{main()} has
1422 completed, you may have an object that is being destroyed twice because
1423 two definitions were merged.
1425 This option is no longer useful on most targets, now that support has
1426 been added for putting variables into BSS without making them common.
1428 @item -fno-const-strings
1429 @opindex fno-const-strings
1430 Give string constants type @code{char *} instead of type @code{const
1431 char *}.  By default, G++ uses type @code{const char *} as required by
1432 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1433 actually modify the value of a string constant.
1435 This option might be removed in a future release of G++.  For maximum
1436 portability, you should structure your code so that it works with
1437 string constants that have type @code{const char *}.
1439 @item -fno-elide-constructors
1440 @opindex fno-elide-constructors
1441 The C++ standard allows an implementation to omit creating a temporary
1442 which is only used to initialize another object of the same type.
1443 Specifying this option disables that optimization, and forces G++ to
1444 call the copy constructor in all cases.
1446 @item -fno-enforce-eh-specs
1447 @opindex fno-enforce-eh-specs
1448 Don't check for violation of exception specifications at runtime.  This
1449 option violates the C++ standard, but may be useful for reducing code
1450 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1451 will still optimize based on the exception specifications.
1453 @item -ffor-scope
1454 @itemx -fno-for-scope
1455 @opindex ffor-scope
1456 @opindex fno-for-scope
1457 If @option{-ffor-scope} is specified, the scope of variables declared in
1458 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1459 as specified by the C++ standard.
1460 If @option{-fno-for-scope} is specified, the scope of variables declared in
1461 a @i{for-init-statement} extends to the end of the enclosing scope,
1462 as was the case in old versions of G++, and other (traditional)
1463 implementations of C++.
1465 The default if neither flag is given to follow the standard,
1466 but to allow and give a warning for old-style code that would
1467 otherwise be invalid, or have different behavior.
1469 @item -fno-gnu-keywords
1470 @opindex fno-gnu-keywords
1471 Do not recognize @code{typeof} as a keyword, so that code can use this
1472 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1473 @option{-ansi} implies @option{-fno-gnu-keywords}.
1475 @item -fno-implicit-templates
1476 @opindex fno-implicit-templates
1477 Never emit code for non-inline templates which are instantiated
1478 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1479 @xref{Template Instantiation}, for more information.
1481 @item -fno-implicit-inline-templates
1482 @opindex fno-implicit-inline-templates
1483 Don't emit code for implicit instantiations of inline templates, either.
1484 The default is to handle inlines differently so that compiles with and
1485 without optimization will need the same set of explicit instantiations.
1487 @item -fno-implement-inlines
1488 @opindex fno-implement-inlines
1489 To save space, do not emit out-of-line copies of inline functions
1490 controlled by @samp{#pragma implementation}.  This will cause linker
1491 errors if these functions are not inlined everywhere they are called.
1493 @item -fms-extensions
1494 @opindex fms-extensions
1495 Disable pedantic warnings about constructs used in MFC, such as implicit
1496 int and getting a pointer to member function via non-standard syntax.
1498 @item -fno-nonansi-builtins
1499 @opindex fno-nonansi-builtins
1500 Disable built-in declarations of functions that are not mandated by
1501 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1502 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1504 @item -fno-operator-names
1505 @opindex fno-operator-names
1506 Do not treat the operator name keywords @code{and}, @code{bitand},
1507 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1508 synonyms as keywords.
1510 @item -fno-optional-diags
1511 @opindex fno-optional-diags
1512 Disable diagnostics that the standard says a compiler does not need to
1513 issue.  Currently, the only such diagnostic issued by G++ is the one for
1514 a name having multiple meanings within a class.
1516 @item -fpermissive
1517 @opindex fpermissive
1518 Downgrade some diagnostics about nonconformant code from errors to
1519 warnings.  Thus, using @option{-fpermissive} will allow some
1520 nonconforming code to compile.
1522 @item -frepo
1523 @opindex frepo
1524 Enable automatic template instantiation at link time.  This option also
1525 implies @option{-fno-implicit-templates}.  @xref{Template
1526 Instantiation}, for more information.
1528 @item -fno-rtti
1529 @opindex fno-rtti
1530 Disable generation of information about every class with virtual
1531 functions for use by the C++ runtime type identification features
1532 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1533 of the language, you can save some space by using this flag.  Note that
1534 exception handling uses the same information, but it will generate it as
1535 needed.
1537 @item -fstats
1538 @opindex fstats
1539 Emit statistics about front-end processing at the end of the compilation.
1540 This information is generally only useful to the G++ development team.
1542 @item -ftemplate-depth-@var{n}
1543 @opindex ftemplate-depth
1544 Set the maximum instantiation depth for template classes to @var{n}.
1545 A limit on the template instantiation depth is needed to detect
1546 endless recursions during template class instantiation.  ANSI/ISO C++
1547 conforming programs must not rely on a maximum depth greater than 17.
1549 @item -fno-threadsafe-statics
1550 @opindex fno-threadsafe-statics
1551 Do not emit the extra code to use the routines specified in the C++
1552 ABI for thread-safe initialization of local statics.  You can use this
1553 option to reduce code size slightly in code that doesn't need to be
1554 thread-safe.
1556 @item -fuse-cxa-atexit
1557 @opindex fuse-cxa-atexit
1558 Register destructors for objects with static storage duration with the
1559 @code{__cxa_atexit} function rather than the @code{atexit} function.
1560 This option is required for fully standards-compliant handling of static
1561 destructors, but will only work if your C library supports
1562 @code{__cxa_atexit}.
1564 @item -fvisibility-inlines-hidden
1565 @opindex fvisibility-inlines-hidden
1566 Causes all inlined methods to be marked with
1567 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1568 appear in the export table of a DSO and do not require a PLT indirection
1569 when used within the DSO@.  Enabling this option can have a dramatic effect
1570 on load and link times of a DSO as it massively reduces the size of the
1571 dynamic export table when the library makes heavy use of templates.  While
1572 it can cause bloating through duplication of code within each DSO where
1573 it is used, often the wastage is less than the considerable space occupied
1574 by a long symbol name in the export table which is typical when using
1575 templates and namespaces.  For even more savings, combine with the
1576 @option{-fvisibility=hidden} switch.
1578 @item -fno-weak
1579 @opindex fno-weak
1580 Do not use weak symbol support, even if it is provided by the linker.
1581 By default, G++ will use weak symbols if they are available.  This
1582 option exists only for testing, and should not be used by end-users;
1583 it will result in inferior code and has no benefits.  This option may
1584 be removed in a future release of G++.
1586 @item -nostdinc++
1587 @opindex nostdinc++
1588 Do not search for header files in the standard directories specific to
1589 C++, but do still search the other standard directories.  (This option
1590 is used when building the C++ library.)
1591 @end table
1593 In addition, these optimization, warning, and code generation options
1594 have meanings only for C++ programs:
1596 @table @gcctabopt
1597 @item -fno-default-inline
1598 @opindex fno-default-inline
1599 Do not assume @samp{inline} for functions defined inside a class scope.
1600 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1601 functions will have linkage like inline functions; they just won't be
1602 inlined by default.
1604 @item -Wabi @r{(C++ only)}
1605 @opindex Wabi
1606 Warn when G++ generates code that is probably not compatible with the
1607 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1608 all such cases, there are probably some cases that are not warned about,
1609 even though G++ is generating incompatible code.  There may also be
1610 cases where warnings are emitted even though the code that is generated
1611 will be compatible.
1613 You should rewrite your code to avoid these warnings if you are
1614 concerned about the fact that code generated by G++ may not be binary
1615 compatible with code generated by other compilers.
1617 The known incompatibilities at this point include:
1619 @itemize @bullet
1621 @item
1622 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1623 pack data into the same byte as a base class.  For example:
1625 @smallexample
1626 struct A @{ virtual void f(); int f1 : 1; @};
1627 struct B : public A @{ int f2 : 1; @};
1628 @end smallexample
1630 @noindent
1631 In this case, G++ will place @code{B::f2} into the same byte
1632 as@code{A::f1}; other compilers will not.  You can avoid this problem
1633 by explicitly padding @code{A} so that its size is a multiple of the
1634 byte size on your platform; that will cause G++ and other compilers to
1635 layout @code{B} identically.
1637 @item
1638 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1639 tail padding when laying out virtual bases.  For example:
1641 @smallexample
1642 struct A @{ virtual void f(); char c1; @};
1643 struct B @{ B(); char c2; @};
1644 struct C : public A, public virtual B @{@};
1645 @end smallexample
1647 @noindent
1648 In this case, G++ will not place @code{B} into the tail-padding for
1649 @code{A}; other compilers will.  You can avoid this problem by
1650 explicitly padding @code{A} so that its size is a multiple of its
1651 alignment (ignoring virtual base classes); that will cause G++ and other
1652 compilers to layout @code{C} identically.
1654 @item
1655 Incorrect handling of bit-fields with declared widths greater than that
1656 of their underlying types, when the bit-fields appear in a union.  For
1657 example:
1659 @smallexample
1660 union U @{ int i : 4096; @};
1661 @end smallexample
1663 @noindent
1664 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1665 union too small by the number of bits in an @code{int}.
1667 @item
1668 Empty classes can be placed at incorrect offsets.  For example:
1670 @smallexample
1671 struct A @{@};
1673 struct B @{
1674   A a;
1675   virtual void f ();
1678 struct C : public B, public A @{@};
1679 @end smallexample
1681 @noindent
1682 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1683 it should be placed at offset zero.  G++ mistakenly believes that the
1684 @code{A} data member of @code{B} is already at offset zero.
1686 @item
1687 Names of template functions whose types involve @code{typename} or
1688 template template parameters can be mangled incorrectly.
1690 @smallexample
1691 template <typename Q>
1692 void f(typename Q::X) @{@}
1694 template <template <typename> class Q>
1695 void f(typename Q<int>::X) @{@}
1696 @end smallexample
1698 @noindent
1699 Instantiations of these templates may be mangled incorrectly.
1701 @end itemize
1703 @item -Wctor-dtor-privacy @r{(C++ only)}
1704 @opindex Wctor-dtor-privacy
1705 Warn when a class seems unusable because all the constructors or
1706 destructors in that class are private, and it has neither friends nor
1707 public static member functions.
1709 @item -Wnon-virtual-dtor @r{(C++ only)}
1710 @opindex Wnon-virtual-dtor
1711 Warn when a class appears to be polymorphic, thereby requiring a virtual
1712 destructor, yet it declares a non-virtual one.
1713 This warning is enabled by @option{-Wall}.
1715 @item -Wreorder @r{(C++ only)}
1716 @opindex Wreorder
1717 @cindex reordering, warning
1718 @cindex warning for reordering of member initializers
1719 Warn when the order of member initializers given in the code does not
1720 match the order in which they must be executed.  For instance:
1722 @smallexample
1723 struct A @{
1724   int i;
1725   int j;
1726   A(): j (0), i (1) @{ @}
1728 @end smallexample
1730 The compiler will rearrange the member initializers for @samp{i}
1731 and @samp{j} to match the declaration order of the members, emitting
1732 a warning to that effect.  This warning is enabled by @option{-Wall}.
1733 @end table
1735 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1737 @table @gcctabopt
1738 @item -Weffc++ @r{(C++ only)}
1739 @opindex Weffc++
1740 Warn about violations of the following style guidelines from Scott Meyers'
1741 @cite{Effective C++} book:
1743 @itemize @bullet
1744 @item
1745 Item 11:  Define a copy constructor and an assignment operator for classes
1746 with dynamically allocated memory.
1748 @item
1749 Item 12:  Prefer initialization to assignment in constructors.
1751 @item
1752 Item 14:  Make destructors virtual in base classes.
1754 @item
1755 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1757 @item
1758 Item 23:  Don't try to return a reference when you must return an object.
1760 @end itemize
1762 Also warn about violations of the following style guidelines from
1763 Scott Meyers' @cite{More Effective C++} book:
1765 @itemize @bullet
1766 @item
1767 Item 6:  Distinguish between prefix and postfix forms of increment and
1768 decrement operators.
1770 @item
1771 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1773 @end itemize
1775 When selecting this option, be aware that the standard library
1776 headers do not obey all of these guidelines; use @samp{grep -v}
1777 to filter out those warnings.
1779 @item -Wno-deprecated @r{(C++ only)}
1780 @opindex Wno-deprecated
1781 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1783 @item -Wstrict-null-sentinel @r{(C++ only)}
1784 @opindex Wstrict-null-sentinel
1785 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1786 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1787 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1788 it is guaranteed to of the same size as a pointer.  But this use is
1789 not portable across different compilers.
1791 @item -Wno-non-template-friend @r{(C++ only)}
1792 @opindex Wno-non-template-friend
1793 Disable warnings when non-templatized friend functions are declared
1794 within a template.  Since the advent of explicit template specification
1795 support in G++, if the name of the friend is an unqualified-id (i.e.,
1796 @samp{friend foo(int)}), the C++ language specification demands that the
1797 friend declare or define an ordinary, nontemplate function.  (Section
1798 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1799 could be interpreted as a particular specialization of a templatized
1800 function.  Because this non-conforming behavior is no longer the default
1801 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1802 check existing code for potential trouble spots and is on by default.
1803 This new compiler behavior can be turned off with
1804 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1805 but disables the helpful warning.
1807 @item -Wold-style-cast @r{(C++ only)}
1808 @opindex Wold-style-cast
1809 Warn if an old-style (C-style) cast to a non-void type is used within
1810 a C++ program.  The new-style casts (@samp{dynamic_cast},
1811 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1812 less vulnerable to unintended effects and much easier to search for.
1814 @item -Woverloaded-virtual @r{(C++ only)}
1815 @opindex Woverloaded-virtual
1816 @cindex overloaded virtual fn, warning
1817 @cindex warning for overloaded virtual fn
1818 Warn when a function declaration hides virtual functions from a
1819 base class.  For example, in:
1821 @smallexample
1822 struct A @{
1823   virtual void f();
1826 struct B: public A @{
1827   void f(int);
1829 @end smallexample
1831 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1832 like:
1834 @smallexample
1835 B* b;
1836 b->f();
1837 @end smallexample
1839 will fail to compile.
1841 @item -Wno-pmf-conversions @r{(C++ only)}
1842 @opindex Wno-pmf-conversions
1843 Disable the diagnostic for converting a bound pointer to member function
1844 to a plain pointer.
1846 @item -Wsign-promo @r{(C++ only)}
1847 @opindex Wsign-promo
1848 Warn when overload resolution chooses a promotion from unsigned or
1849 enumerated type to a signed type, over a conversion to an unsigned type of
1850 the same size.  Previous versions of G++ would try to preserve
1851 unsignedness, but the standard mandates the current behavior.
1853 @smallexample
1854 struct A @{
1855   operator int ();
1856   A& operator = (int);
1859 main ()
1861   A a,b;
1862   a = b;
1864 @end smallexample
1866 In this example, G++ will synthesize a default @samp{A& operator =
1867 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1868 @end table
1870 @node Objective-C and Objective-C++ Dialect Options
1871 @section Options Controlling Objective-C and Objective-C++ Dialects
1873 @cindex compiler options, Objective-C and Objective-C++
1874 @cindex Objective-C and Objective-C++ options, command line
1875 @cindex options, Objective-C and Objective-C++
1876 (NOTE: This manual does not describe the Objective-C and Objective-C++
1877 languages themselves.  See @xref{Standards,,Language Standards
1878 Supported by GCC}, for references.)
1880 This section describes the command-line options that are only meaningful
1881 for Objective-C and Objective-C++ programs, but you can also use most of
1882 the language-independent GNU compiler options.
1883 For example, you might compile a file @code{some_class.m} like this:
1885 @smallexample
1886 gcc -g -fgnu-runtime -O -c some_class.m
1887 @end smallexample
1889 @noindent
1890 In this example, @option{-fgnu-runtime} is an option meant only for
1891 Objective-C and Objective-C++ programs; you can use the other options with
1892 any language supported by GCC@.
1894 Note that since Objective-C is an extension of the C language, Objective-C
1895 compilations may also use options specific to the C front-end (e.g.,
1896 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1897 C++-specific options (e.g., @option{-Wabi}).
1899 Here is a list of options that are @emph{only} for compiling Objective-C
1900 and Objective-C++ programs:
1902 @table @gcctabopt
1903 @item -fconstant-string-class=@var{class-name}
1904 @opindex fconstant-string-class
1905 Use @var{class-name} as the name of the class to instantiate for each
1906 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1907 class name is @code{NXConstantString} if the GNU runtime is being used, and
1908 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1909 @option{-fconstant-cfstrings} option, if also present, will override the
1910 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1911 to be laid out as constant CoreFoundation strings.
1913 @item -fgnu-runtime
1914 @opindex fgnu-runtime
1915 Generate object code compatible with the standard GNU Objective-C
1916 runtime.  This is the default for most types of systems.
1918 @item -fnext-runtime
1919 @opindex fnext-runtime
1920 Generate output compatible with the NeXT runtime.  This is the default
1921 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1922 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1923 used.
1925 @item -fno-nil-receivers
1926 @opindex fno-nil-receivers
1927 Assume that all Objective-C message dispatches (e.g.,
1928 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1929 is not @code{nil}.  This allows for more efficient entry points in the runtime
1930 to be used.  Currently, this option is only available in conjunction with
1931 the NeXT runtime on Mac OS X 10.3 and later.
1933 @item -fobjc-call-cxx-cdtors
1934 @opindex fobjc-call-cxx-cdtors
1935 For each Objective-C class, check if any of its instance variables is a
1936 C++ object with a non-trivial default constructor.  If so, synthesize a
1937 special @code{- (id) .cxx_construct} instance method that will run
1938 non-trivial default constructors on any such instance variables, in order,
1939 and then return @code{self}.  Similarly, check if any instance variable
1940 is a C++ object with a non-trivial destructor, and if so, synthesize a
1941 special @code{- (void) .cxx_destruct} method that will run
1942 all such default destructors, in reverse order.
1944 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1945 thusly generated will only operate on instance variables declared in the
1946 current Objective-C class, and not those inherited from superclasses.  It
1947 is the responsibility of the Objective-C runtime to invoke all such methods
1948 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1949 will be invoked by the runtime immediately after a new object
1950 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1951 be invoked immediately before the runtime deallocates an object instance.
1953 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1954 support for invoking the @code{- (id) .cxx_construct} and
1955 @code{- (void) .cxx_destruct} methods.
1957 @item -fobjc-direct-dispatch
1958 @opindex fobjc-direct-dispatch
1959 Allow fast jumps to the message dispatcher.  On Darwin this is
1960 accomplished via the comm page.
1962 @item -fobjc-exceptions
1963 @opindex fobjc-exceptions
1964 Enable syntactic support for structured exception handling in Objective-C,
1965 similar to what is offered by C++ and Java.  Currently, this option is only
1966 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1968 @smallexample
1969   @@try @{
1970     @dots{}
1971        @@throw expr;
1972     @dots{}
1973   @}
1974   @@catch (AnObjCClass *exc) @{
1975     @dots{}
1976       @@throw expr;
1977     @dots{}
1978       @@throw;
1979     @dots{}
1980   @}
1981   @@catch (AnotherClass *exc) @{
1982     @dots{}
1983   @}
1984   @@catch (id allOthers) @{
1985     @dots{}
1986   @}
1987   @@finally @{
1988     @dots{}
1989       @@throw expr;
1990     @dots{}
1991   @}
1992 @end smallexample
1994 The @code{@@throw} statement may appear anywhere in an Objective-C or
1995 Objective-C++ program; when used inside of a @code{@@catch} block, the
1996 @code{@@throw} may appear without an argument (as shown above), in which case
1997 the object caught by the @code{@@catch} will be rethrown.
1999 Note that only (pointers to) Objective-C objects may be thrown and
2000 caught using this scheme.  When an object is thrown, it will be caught
2001 by the nearest @code{@@catch} clause capable of handling objects of that type,
2002 analogously to how @code{catch} blocks work in C++ and Java.  A
2003 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2004 any and all Objective-C exceptions not caught by previous @code{@@catch}
2005 clauses (if any).
2007 The @code{@@finally} clause, if present, will be executed upon exit from the
2008 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2009 regardless of whether any exceptions are thrown, caught or rethrown
2010 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2011 of the @code{finally} clause in Java.
2013 There are several caveats to using the new exception mechanism:
2015 @itemize @bullet
2016 @item
2017 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2018 idioms provided by the @code{NSException} class, the new
2019 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2020 systems, due to additional functionality needed in the (NeXT) Objective-C
2021 runtime.
2023 @item
2024 As mentioned above, the new exceptions do not support handling
2025 types other than Objective-C objects.   Furthermore, when used from
2026 Objective-C++, the Objective-C exception model does not interoperate with C++
2027 exceptions at this time.  This means you cannot @code{@@throw} an exception
2028 from Objective-C and @code{catch} it in C++, or vice versa
2029 (i.e., @code{throw @dots{} @@catch}).
2030 @end itemize
2032 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2033 blocks for thread-safe execution:
2035 @smallexample
2036   @@synchronized (ObjCClass *guard) @{
2037     @dots{}
2038   @}
2039 @end smallexample
2041 Upon entering the @code{@@synchronized} block, a thread of execution shall
2042 first check whether a lock has been placed on the corresponding @code{guard}
2043 object by another thread.  If it has, the current thread shall wait until
2044 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2045 the current thread will place its own lock on it, execute the code contained in
2046 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2047 making @code{guard} available to other threads).
2049 Unlike Java, Objective-C does not allow for entire methods to be marked
2050 @code{@@synchronized}.  Note that throwing exceptions out of
2051 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2052 to be unlocked properly.
2054 @item -fobjc-gc
2055 @opindex fobjc-gc
2056 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2058 @item -freplace-objc-classes
2059 @opindex freplace-objc-classes
2060 Emit a special marker instructing @command{ld(1)} not to statically link in
2061 the resulting object file, and allow @command{dyld(1)} to load it in at
2062 run time instead.  This is used in conjunction with the Fix-and-Continue
2063 debugging mode, where the object file in question may be recompiled and
2064 dynamically reloaded in the course of program execution, without the need
2065 to restart the program itself.  Currently, Fix-and-Continue functionality
2066 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2067 and later.
2069 @item -fzero-link
2070 @opindex fzero-link
2071 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2072 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2073 compile time) with static class references that get initialized at load time,
2074 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2075 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2076 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2077 for individual class implementations to be modified during program execution.
2079 @item -gen-decls
2080 @opindex gen-decls
2081 Dump interface declarations for all classes seen in the source file to a
2082 file named @file{@var{sourcename}.decl}.
2084 @item -Wassign-intercept
2085 @opindex Wassign-intercept
2086 Warn whenever an Objective-C assignment is being intercepted by the
2087 garbage collector.
2089 @item -Wno-protocol
2090 @opindex Wno-protocol
2091 If a class is declared to implement a protocol, a warning is issued for
2092 every method in the protocol that is not implemented by the class.  The
2093 default behavior is to issue a warning for every method not explicitly
2094 implemented in the class, even if a method implementation is inherited
2095 from the superclass.  If you use the @option{-Wno-protocol} option, then
2096 methods inherited from the superclass are considered to be implemented,
2097 and no warning is issued for them.
2099 @item -Wselector
2100 @opindex Wselector
2101 Warn if multiple methods of different types for the same selector are
2102 found during compilation.  The check is performed on the list of methods
2103 in the final stage of compilation.  Additionally, a check is performed
2104 for each selector appearing in a @code{@@selector(@dots{})}
2105 expression, and a corresponding method for that selector has been found
2106 during compilation.  Because these checks scan the method table only at
2107 the end of compilation, these warnings are not produced if the final
2108 stage of compilation is not reached, for example because an error is
2109 found during compilation, or because the @option{-fsyntax-only} option is
2110 being used.
2112 @item -Wstrict-selector-match
2113 @opindex Wstrict-selector-match
2114 Warn if multiple methods with differing argument and/or return types are
2115 found for a given selector when attempting to send a message using this
2116 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2117 is off (which is the default behavior), the compiler will omit such warnings
2118 if any differences found are confined to types which share the same size
2119 and alignment.
2121 @item -Wundeclared-selector
2122 @opindex Wundeclared-selector
2123 Warn if a @code{@@selector(@dots{})} expression referring to an
2124 undeclared selector is found.  A selector is considered undeclared if no
2125 method with that name has been declared before the
2126 @code{@@selector(@dots{})} expression, either explicitly in an
2127 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2128 an @code{@@implementation} section.  This option always performs its
2129 checks as soon as a @code{@@selector(@dots{})} expression is found,
2130 while @option{-Wselector} only performs its checks in the final stage of
2131 compilation.  This also enforces the coding style convention
2132 that methods and selectors must be declared before being used.
2134 @item -print-objc-runtime-info
2135 @opindex print-objc-runtime-info
2136 Generate C header describing the largest structure that is passed by
2137 value, if any.
2139 @end table
2141 @node Language Independent Options
2142 @section Options to Control Diagnostic Messages Formatting
2143 @cindex options to control diagnostics formatting
2144 @cindex diagnostic messages
2145 @cindex message formatting
2147 Traditionally, diagnostic messages have been formatted irrespective of
2148 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2149 below can be used to control the diagnostic messages formatting
2150 algorithm, e.g.@: how many characters per line, how often source location
2151 information should be reported.  Right now, only the C++ front end can
2152 honor these options.  However it is expected, in the near future, that
2153 the remaining front ends would be able to digest them correctly.
2155 @table @gcctabopt
2156 @item -fmessage-length=@var{n}
2157 @opindex fmessage-length
2158 Try to format error messages so that they fit on lines of about @var{n}
2159 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2160 the front ends supported by GCC@.  If @var{n} is zero, then no
2161 line-wrapping will be done; each error message will appear on a single
2162 line.
2164 @opindex fdiagnostics-show-location
2165 @item -fdiagnostics-show-location=once
2166 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2167 reporter to emit @emph{once} source location information; that is, in
2168 case the message is too long to fit on a single physical line and has to
2169 be wrapped, the source location won't be emitted (as prefix) again,
2170 over and over, in subsequent continuation lines.  This is the default
2171 behavior.
2173 @item -fdiagnostics-show-location=every-line
2174 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2175 messages reporter to emit the same source location information (as
2176 prefix) for physical lines that result from the process of breaking
2177 a message which is too long to fit on a single line.
2179 @item -fdiagnostics-show-options
2180 @opindex fdiagnostics-show-options
2181 This option instructs the diagnostic machinery to add text to each
2182 diagnostic emitted, which indicates which command line option directly
2183 controls that diagnostic, when such an option is known to the
2184 diagnostic machinery.
2186 @end table
2188 @node Warning Options
2189 @section Options to Request or Suppress Warnings
2190 @cindex options to control warnings
2191 @cindex warning messages
2192 @cindex messages, warning
2193 @cindex suppressing warnings
2195 Warnings are diagnostic messages that report constructions which
2196 are not inherently erroneous but which are risky or suggest there
2197 may have been an error.
2199 You can request many specific warnings with options beginning @samp{-W},
2200 for example @option{-Wimplicit} to request warnings on implicit
2201 declarations.  Each of these specific warning options also has a
2202 negative form beginning @samp{-Wno-} to turn off warnings;
2203 for example, @option{-Wno-implicit}.  This manual lists only one of the
2204 two forms, whichever is not the default.
2206 The following options control the amount and kinds of warnings produced
2207 by GCC; for further, language-specific options also refer to
2208 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2209 Options}.
2211 @table @gcctabopt
2212 @cindex syntax checking
2213 @item -fsyntax-only
2214 @opindex fsyntax-only
2215 Check the code for syntax errors, but don't do anything beyond that.
2217 @item -pedantic
2218 @opindex pedantic
2219 Issue all the warnings demanded by strict ISO C and ISO C++;
2220 reject all programs that use forbidden extensions, and some other
2221 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2222 version of the ISO C standard specified by any @option{-std} option used.
2224 Valid ISO C and ISO C++ programs should compile properly with or without
2225 this option (though a rare few will require @option{-ansi} or a
2226 @option{-std} option specifying the required version of ISO C)@.  However,
2227 without this option, certain GNU extensions and traditional C and C++
2228 features are supported as well.  With this option, they are rejected.
2230 @option{-pedantic} does not cause warning messages for use of the
2231 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2232 warnings are also disabled in the expression that follows
2233 @code{__extension__}.  However, only system header files should use
2234 these escape routes; application programs should avoid them.
2235 @xref{Alternate Keywords}.
2237 Some users try to use @option{-pedantic} to check programs for strict ISO
2238 C conformance.  They soon find that it does not do quite what they want:
2239 it finds some non-ISO practices, but not all---only those for which
2240 ISO C @emph{requires} a diagnostic, and some others for which
2241 diagnostics have been added.
2243 A feature to report any failure to conform to ISO C might be useful in
2244 some instances, but would require considerable additional work and would
2245 be quite different from @option{-pedantic}.  We don't have plans to
2246 support such a feature in the near future.
2248 Where the standard specified with @option{-std} represents a GNU
2249 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2250 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2251 extended dialect is based.  Warnings from @option{-pedantic} are given
2252 where they are required by the base standard.  (It would not make sense
2253 for such warnings to be given only for features not in the specified GNU
2254 C dialect, since by definition the GNU dialects of C include all
2255 features the compiler supports with the given option, and there would be
2256 nothing to warn about.)
2258 @item -pedantic-errors
2259 @opindex pedantic-errors
2260 Like @option{-pedantic}, except that errors are produced rather than
2261 warnings.
2263 @item -w
2264 @opindex w
2265 Inhibit all warning messages.
2267 @item -Wno-import
2268 @opindex Wno-import
2269 Inhibit warning messages about the use of @samp{#import}.
2271 @item -Wchar-subscripts
2272 @opindex Wchar-subscripts
2273 Warn if an array subscript has type @code{char}.  This is a common cause
2274 of error, as programmers often forget that this type is signed on some
2275 machines.
2276 This warning is enabled by @option{-Wall}.
2278 @item -Wcomment
2279 @opindex Wcomment
2280 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2281 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2282 This warning is enabled by @option{-Wall}.
2284 @item -Wfatal-errors
2285 @opindex Wfatal-errors
2286 This option causes the compiler to abort compilation on the first error
2287 occurred rather than trying to keep going and printing further error
2288 messages.
2290 @item -Wformat
2291 @opindex Wformat
2292 @opindex ffreestanding
2293 @opindex fno-builtin
2294 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2295 the arguments supplied have types appropriate to the format string
2296 specified, and that the conversions specified in the format string make
2297 sense.  This includes standard functions, and others specified by format
2298 attributes (@pxref{Function Attributes}), in the @code{printf},
2299 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2300 not in the C standard) families (or other target-specific families).
2301 Which functions are checked without format attributes having been
2302 specified depends on the standard version selected, and such checks of
2303 functions without the attribute specified are disabled by
2304 @option{-ffreestanding} or @option{-fno-builtin}.
2306 The formats are checked against the format features supported by GNU
2307 libc version 2.2.  These include all ISO C90 and C99 features, as well
2308 as features from the Single Unix Specification and some BSD and GNU
2309 extensions.  Other library implementations may not support all these
2310 features; GCC does not support warning about features that go beyond a
2311 particular library's limitations.  However, if @option{-pedantic} is used
2312 with @option{-Wformat}, warnings will be given about format features not
2313 in the selected standard version (but not for @code{strfmon} formats,
2314 since those are not in any version of the C standard).  @xref{C Dialect
2315 Options,,Options Controlling C Dialect}.
2317 Since @option{-Wformat} also checks for null format arguments for
2318 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2320 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2321 aspects of format checking, the options @option{-Wformat-y2k},
2322 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2323 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2324 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2326 @item -Wformat-y2k
2327 @opindex Wformat-y2k
2328 If @option{-Wformat} is specified, also warn about @code{strftime}
2329 formats which may yield only a two-digit year.
2331 @item -Wno-format-extra-args
2332 @opindex Wno-format-extra-args
2333 If @option{-Wformat} is specified, do not warn about excess arguments to a
2334 @code{printf} or @code{scanf} format function.  The C standard specifies
2335 that such arguments are ignored.
2337 Where the unused arguments lie between used arguments that are
2338 specified with @samp{$} operand number specifications, normally
2339 warnings are still given, since the implementation could not know what
2340 type to pass to @code{va_arg} to skip the unused arguments.  However,
2341 in the case of @code{scanf} formats, this option will suppress the
2342 warning if the unused arguments are all pointers, since the Single
2343 Unix Specification says that such unused arguments are allowed.
2345 @item -Wno-format-zero-length
2346 @opindex Wno-format-zero-length
2347 If @option{-Wformat} is specified, do not warn about zero-length formats.
2348 The C standard specifies that zero-length formats are allowed.
2350 @item -Wformat-nonliteral
2351 @opindex Wformat-nonliteral
2352 If @option{-Wformat} is specified, also warn if the format string is not a
2353 string literal and so cannot be checked, unless the format function
2354 takes its format arguments as a @code{va_list}.
2356 @item -Wformat-security
2357 @opindex Wformat-security
2358 If @option{-Wformat} is specified, also warn about uses of format
2359 functions that represent possible security problems.  At present, this
2360 warns about calls to @code{printf} and @code{scanf} functions where the
2361 format string is not a string literal and there are no format arguments,
2362 as in @code{printf (foo);}.  This may be a security hole if the format
2363 string came from untrusted input and contains @samp{%n}.  (This is
2364 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2365 in future warnings may be added to @option{-Wformat-security} that are not
2366 included in @option{-Wformat-nonliteral}.)
2368 @item -Wformat=2
2369 @opindex Wformat=2
2370 Enable @option{-Wformat} plus format checks not included in
2371 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2372 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2374 @item -Wnonnull
2375 @opindex Wnonnull
2376 Warn about passing a null pointer for arguments marked as
2377 requiring a non-null value by the @code{nonnull} function attribute.
2379 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2380 can be disabled with the @option{-Wno-nonnull} option.
2382 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2383 @opindex Winit-self
2384 Warn about uninitialized variables which are initialized with themselves.
2385 Note this option can only be used with the @option{-Wuninitialized} option,
2386 which in turn only works with @option{-O1} and above.
2388 For example, GCC will warn about @code{i} being uninitialized in the
2389 following snippet only when @option{-Winit-self} has been specified:
2390 @smallexample
2391 @group
2392 int f()
2394   int i = i;
2395   return i;
2397 @end group
2398 @end smallexample
2400 @item -Wimplicit-int
2401 @opindex Wimplicit-int
2402 Warn when a declaration does not specify a type.
2403 This warning is enabled by @option{-Wall}.
2405 @item -Wimplicit-function-declaration
2406 @itemx -Werror-implicit-function-declaration
2407 @opindex Wimplicit-function-declaration
2408 @opindex Werror-implicit-function-declaration
2409 Give a warning (or error) whenever a function is used before being
2410 declared.  The form @option{-Wno-error-implicit-function-declaration}
2411 is not supported.
2412 This warning is enabled by @option{-Wall} (as a warning, not an error).
2414 @item -Wimplicit
2415 @opindex Wimplicit
2416 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2417 This warning is enabled by @option{-Wall}.
2419 @item -Wmain
2420 @opindex Wmain
2421 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2422 function with external linkage, returning int, taking either zero
2423 arguments, two, or three arguments of appropriate types.
2424 This warning is enabled by @option{-Wall}.
2426 @item -Wmissing-braces
2427 @opindex Wmissing-braces
2428 Warn if an aggregate or union initializer is not fully bracketed.  In
2429 the following example, the initializer for @samp{a} is not fully
2430 bracketed, but that for @samp{b} is fully bracketed.
2432 @smallexample
2433 int a[2][2] = @{ 0, 1, 2, 3 @};
2434 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2435 @end smallexample
2437 This warning is enabled by @option{-Wall}.
2439 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2440 @opindex Wmissing-include-dirs
2441 Warn if a user-supplied include directory does not exist.
2443 @item -Wparentheses
2444 @opindex Wparentheses
2445 Warn if parentheses are omitted in certain contexts, such
2446 as when there is an assignment in a context where a truth value
2447 is expected, or when operators are nested whose precedence people
2448 often get confused about.  Only the warning for an assignment used as
2449 a truth value is supported when compiling C++; the other warnings are
2450 only supported when compiling C@.
2452 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2453 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2454 interpretation from that of ordinary mathematical notation.
2456 Also warn about constructions where there may be confusion to which
2457 @code{if} statement an @code{else} branch belongs.  Here is an example of
2458 such a case:
2460 @smallexample
2461 @group
2463   if (a)
2464     if (b)
2465       foo ();
2466   else
2467     bar ();
2469 @end group
2470 @end smallexample
2472 In C, every @code{else} branch belongs to the innermost possible @code{if}
2473 statement, which in this example is @code{if (b)}.  This is often not
2474 what the programmer expected, as illustrated in the above example by
2475 indentation the programmer chose.  When there is the potential for this
2476 confusion, GCC will issue a warning when this flag is specified.
2477 To eliminate the warning, add explicit braces around the innermost
2478 @code{if} statement so there is no way the @code{else} could belong to
2479 the enclosing @code{if}.  The resulting code would look like this:
2481 @smallexample
2482 @group
2484   if (a)
2485     @{
2486       if (b)
2487         foo ();
2488       else
2489         bar ();
2490     @}
2492 @end group
2493 @end smallexample
2495 This warning is enabled by @option{-Wall}.
2497 @item -Wsequence-point
2498 @opindex Wsequence-point
2499 Warn about code that may have undefined semantics because of violations
2500 of sequence point rules in the C standard.
2502 The C standard defines the order in which expressions in a C program are
2503 evaluated in terms of @dfn{sequence points}, which represent a partial
2504 ordering between the execution of parts of the program: those executed
2505 before the sequence point, and those executed after it.  These occur
2506 after the evaluation of a full expression (one which is not part of a
2507 larger expression), after the evaluation of the first operand of a
2508 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2509 function is called (but after the evaluation of its arguments and the
2510 expression denoting the called function), and in certain other places.
2511 Other than as expressed by the sequence point rules, the order of
2512 evaluation of subexpressions of an expression is not specified.  All
2513 these rules describe only a partial order rather than a total order,
2514 since, for example, if two functions are called within one expression
2515 with no sequence point between them, the order in which the functions
2516 are called is not specified.  However, the standards committee have
2517 ruled that function calls do not overlap.
2519 It is not specified when between sequence points modifications to the
2520 values of objects take effect.  Programs whose behavior depends on this
2521 have undefined behavior; the C standard specifies that ``Between the
2522 previous and next sequence point an object shall have its stored value
2523 modified at most once by the evaluation of an expression.  Furthermore,
2524 the prior value shall be read only to determine the value to be
2525 stored.''.  If a program breaks these rules, the results on any
2526 particular implementation are entirely unpredictable.
2528 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2529 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2530 diagnosed by this option, and it may give an occasional false positive
2531 result, but in general it has been found fairly effective at detecting
2532 this sort of problem in programs.
2534 The present implementation of this option only works for C programs.  A
2535 future implementation may also work for C++ programs.
2537 The C standard is worded confusingly, therefore there is some debate
2538 over the precise meaning of the sequence point rules in subtle cases.
2539 Links to discussions of the problem, including proposed formal
2540 definitions, may be found on the GCC readings page, at
2541 @w{@uref{http://gcc.gnu.org/readings.html}}.
2543 This warning is enabled by @option{-Wall}.
2545 @item -Wreturn-type
2546 @opindex Wreturn-type
2547 Warn whenever a function is defined with a return-type that defaults to
2548 @code{int}.  Also warn about any @code{return} statement with no
2549 return-value in a function whose return-type is not @code{void}.
2551 For C, also warn if the return type of a function has a type qualifier
2552 such as @code{const}.  Such a type qualifier has no effect, since the
2553 value returned by a function is not an lvalue.  ISO C prohibits
2554 qualified @code{void} return types on function definitions, so such
2555 return types always receive a warning even without this option.
2557 For C++, a function without return type always produces a diagnostic
2558 message, even when @option{-Wno-return-type} is specified.  The only
2559 exceptions are @samp{main} and functions defined in system headers.
2561 This warning is enabled by @option{-Wall}.
2563 @item -Wswitch
2564 @opindex Wswitch
2565 Warn whenever a @code{switch} statement has an index of enumerated type
2566 and lacks a @code{case} for one or more of the named codes of that
2567 enumeration.  (The presence of a @code{default} label prevents this
2568 warning.)  @code{case} labels outside the enumeration range also
2569 provoke warnings when this option is used.
2570 This warning is enabled by @option{-Wall}.
2572 @item -Wswitch-default
2573 @opindex Wswitch-switch
2574 Warn whenever a @code{switch} statement does not have a @code{default}
2575 case.
2577 @item -Wswitch-enum
2578 @opindex Wswitch-enum
2579 Warn whenever a @code{switch} statement has an index of enumerated type
2580 and lacks a @code{case} for one or more of the named codes of that
2581 enumeration.  @code{case} labels outside the enumeration range also
2582 provoke warnings when this option is used.
2584 @item -Wtrigraphs
2585 @opindex Wtrigraphs
2586 Warn if any trigraphs are encountered that might change the meaning of
2587 the program (trigraphs within comments are not warned about).
2588 This warning is enabled by @option{-Wall}.
2590 @item -Wunused-function
2591 @opindex Wunused-function
2592 Warn whenever a static function is declared but not defined or a
2593 non\-inline static function is unused.
2594 This warning is enabled by @option{-Wall}.
2596 @item -Wunused-label
2597 @opindex Wunused-label
2598 Warn whenever a label is declared but not used.
2599 This warning is enabled by @option{-Wall}.
2601 To suppress this warning use the @samp{unused} attribute
2602 (@pxref{Variable Attributes}).
2604 @item -Wunused-parameter
2605 @opindex Wunused-parameter
2606 Warn whenever a function parameter is unused aside from its declaration.
2608 To suppress this warning use the @samp{unused} attribute
2609 (@pxref{Variable Attributes}).
2611 @item -Wunused-variable
2612 @opindex Wunused-variable
2613 Warn whenever a local variable or non-constant static variable is unused
2614 aside from its declaration
2615 This warning is enabled by @option{-Wall}.
2617 To suppress this warning use the @samp{unused} attribute
2618 (@pxref{Variable Attributes}).
2620 @item -Wunused-value
2621 @opindex Wunused-value
2622 Warn whenever a statement computes a result that is explicitly not used.
2623 This warning is enabled by @option{-Wall}.
2625 To suppress this warning cast the expression to @samp{void}.
2627 @item -Wunused
2628 @opindex Wunused
2629 All the above @option{-Wunused} options combined.
2631 In order to get a warning about an unused function parameter, you must
2632 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2633 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2635 @item -Wuninitialized
2636 @opindex Wuninitialized
2637 Warn if an automatic variable is used without first being initialized or
2638 if a variable may be clobbered by a @code{setjmp} call.
2640 These warnings are possible only in optimizing compilation,
2641 because they require data flow information that is computed only
2642 when optimizing.  If you don't specify @option{-O}, you simply won't
2643 get these warnings.
2645 If you want to warn about code which uses the uninitialized value of the
2646 variable in its own initializer, use the @option{-Winit-self} option.
2648 These warnings occur for individual uninitialized or clobbered
2649 elements of structure, union or array variables as well as for
2650 variables which are uninitialized or clobbered as a whole.  They do
2651 not occur for variables or elements declared @code{volatile}.  Because
2652 these warnings depend on optimization, the exact variables or elements
2653 for which there are warnings will depend on the precise optimization
2654 options and version of GCC used.
2656 Note that there may be no warning about a variable that is used only
2657 to compute a value that itself is never used, because such
2658 computations may be deleted by data flow analysis before the warnings
2659 are printed.
2661 These warnings are made optional because GCC is not smart
2662 enough to see all the reasons why the code might be correct
2663 despite appearing to have an error.  Here is one example of how
2664 this can happen:
2666 @smallexample
2667 @group
2669   int x;
2670   switch (y)
2671     @{
2672     case 1: x = 1;
2673       break;
2674     case 2: x = 4;
2675       break;
2676     case 3: x = 5;
2677     @}
2678   foo (x);
2680 @end group
2681 @end smallexample
2683 @noindent
2684 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2685 always initialized, but GCC doesn't know this.  Here is
2686 another common case:
2688 @smallexample
2690   int save_y;
2691   if (change_y) save_y = y, y = new_y;
2692   @dots{}
2693   if (change_y) y = save_y;
2695 @end smallexample
2697 @noindent
2698 This has no bug because @code{save_y} is used only if it is set.
2700 @cindex @code{longjmp} warnings
2701 This option also warns when a non-volatile automatic variable might be
2702 changed by a call to @code{longjmp}.  These warnings as well are possible
2703 only in optimizing compilation.
2705 The compiler sees only the calls to @code{setjmp}.  It cannot know
2706 where @code{longjmp} will be called; in fact, a signal handler could
2707 call it at any point in the code.  As a result, you may get a warning
2708 even when there is in fact no problem because @code{longjmp} cannot
2709 in fact be called at the place which would cause a problem.
2711 Some spurious warnings can be avoided if you declare all the functions
2712 you use that never return as @code{noreturn}.  @xref{Function
2713 Attributes}.
2715 This warning is enabled by @option{-Wall}.
2717 @item -Wunknown-pragmas
2718 @opindex Wunknown-pragmas
2719 @cindex warning for unknown pragmas
2720 @cindex unknown pragmas, warning
2721 @cindex pragmas, warning of unknown
2722 Warn when a #pragma directive is encountered which is not understood by
2723 GCC@.  If this command line option is used, warnings will even be issued
2724 for unknown pragmas in system header files.  This is not the case if
2725 the warnings were only enabled by the @option{-Wall} command line option.
2727 @item -Wno-pragmas
2728 @opindex Wno-pragmas
2729 @opindex Wpragmas
2730 Do not warn about misuses of pragmas, such as incorrect parameters,
2731 invalid syntax, or conflicts between pragmas.  See also
2732 @samp{-Wunknown-pragmas}.
2734 @item -Wstrict-aliasing
2735 @opindex Wstrict-aliasing
2736 This option is only active when @option{-fstrict-aliasing} is active.
2737 It warns about code which might break the strict aliasing rules that the
2738 compiler is using for optimization.  The warning does not catch all
2739 cases, but does attempt to catch the more common pitfalls.  It is
2740 included in @option{-Wall}.
2742 @item -Wstrict-aliasing=2
2743 @opindex Wstrict-aliasing=2
2744 This option is only active when @option{-fstrict-aliasing} is active.
2745 It warns about code which might break the strict aliasing rules that the
2746 compiler is using for optimization.  This warning catches more cases than
2747 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2748 cases that are safe.
2750 @item -Wall
2751 @opindex Wall
2752 All of the above @samp{-W} options combined.  This enables all the
2753 warnings about constructions that some users consider questionable, and
2754 that are easy to avoid (or modify to prevent the warning), even in
2755 conjunction with macros.  This also enables some language-specific
2756 warnings described in @ref{C++ Dialect Options} and
2757 @ref{Objective-C and Objective-C++ Dialect Options}.
2758 @end table
2760 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2761 Some of them warn about constructions that users generally do not
2762 consider questionable, but which occasionally you might wish to check
2763 for; others warn about constructions that are necessary or hard to avoid
2764 in some cases, and there is no simple way to modify the code to suppress
2765 the warning.
2767 @table @gcctabopt
2768 @item -Wextra
2769 @opindex W
2770 @opindex Wextra
2771 (This option used to be called @option{-W}.  The older name is still
2772 supported, but the newer name is more descriptive.)  Print extra warning
2773 messages for these events:
2775 @itemize @bullet
2776 @item
2777 A function can return either with or without a value.  (Falling
2778 off the end of the function body is considered returning without
2779 a value.)  For example, this function would evoke such a
2780 warning:
2782 @smallexample
2783 @group
2784 foo (a)
2786   if (a > 0)
2787     return a;
2789 @end group
2790 @end smallexample
2792 @item
2793 An expression-statement or the left-hand side of a comma expression
2794 contains no side effects.
2795 To suppress the warning, cast the unused expression to void.
2796 For example, an expression such as @samp{x[i,j]} will cause a warning,
2797 but @samp{x[(void)i,j]} will not.
2799 @item
2800 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2802 @item
2803 Storage-class specifiers like @code{static} are not the first things in
2804 a declaration.  According to the C Standard, this usage is obsolescent.
2806 @item
2807 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2808 arguments.
2810 @item
2811 A comparison between signed and unsigned values could produce an
2812 incorrect result when the signed value is converted to unsigned.
2813 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2815 @item
2816 An aggregate has an initializer which does not initialize all members.
2817 This warning can be independently controlled by
2818 @option{-Wmissing-field-initializers}.
2820 @item
2821 A function parameter is declared without a type specifier in K&R-style
2822 functions:
2824 @smallexample
2825 void foo(bar) @{ @}
2826 @end smallexample
2828 @item
2829 An empty body occurs in an @samp{if} or @samp{else} statement.
2831 @item
2832 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2833 @samp{>}, or @samp{>=}.
2835 @item
2836 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2838 @item
2839 Any of several floating-point events that often indicate errors, such as
2840 overflow, underflow, loss of precision, etc.
2842 @item @r{(C++ only)}
2843 An enumerator and a non-enumerator both appear in a conditional expression.
2845 @item @r{(C++ only)}
2846 A non-static reference or non-static @samp{const} member appears in a
2847 class without constructors.
2849 @item @r{(C++ only)}
2850 Ambiguous virtual bases.
2852 @item @r{(C++ only)}
2853 Subscripting an array which has been declared @samp{register}.
2855 @item @r{(C++ only)}
2856 Taking the address of a variable which has been declared @samp{register}.
2858 @item @r{(C++ only)}
2859 A base class is not initialized in a derived class' copy constructor.
2860 @end itemize
2862 @item -Wno-div-by-zero
2863 @opindex Wno-div-by-zero
2864 @opindex Wdiv-by-zero
2865 Do not warn about compile-time integer division by zero.  Floating point
2866 division by zero is not warned about, as it can be a legitimate way of
2867 obtaining infinities and NaNs.
2869 @item -Wsystem-headers
2870 @opindex Wsystem-headers
2871 @cindex warnings from system headers
2872 @cindex system headers, warnings from
2873 Print warning messages for constructs found in system header files.
2874 Warnings from system headers are normally suppressed, on the assumption
2875 that they usually do not indicate real problems and would only make the
2876 compiler output harder to read.  Using this command line option tells
2877 GCC to emit warnings from system headers as if they occurred in user
2878 code.  However, note that using @option{-Wall} in conjunction with this
2879 option will @emph{not} warn about unknown pragmas in system
2880 headers---for that, @option{-Wunknown-pragmas} must also be used.
2882 @item -Wfloat-equal
2883 @opindex Wfloat-equal
2884 Warn if floating point values are used in equality comparisons.
2886 The idea behind this is that sometimes it is convenient (for the
2887 programmer) to consider floating-point values as approximations to
2888 infinitely precise real numbers.  If you are doing this, then you need
2889 to compute (by analyzing the code, or in some other way) the maximum or
2890 likely maximum error that the computation introduces, and allow for it
2891 when performing comparisons (and when producing output, but that's a
2892 different problem).  In particular, instead of testing for equality, you
2893 would check to see whether the two values have ranges that overlap; and
2894 this is done with the relational operators, so equality comparisons are
2895 probably mistaken.
2897 @item -Wtraditional @r{(C only)}
2898 @opindex Wtraditional
2899 Warn about certain constructs that behave differently in traditional and
2900 ISO C@.  Also warn about ISO C constructs that have no traditional C
2901 equivalent, and/or problematic constructs which should be avoided.
2903 @itemize @bullet
2904 @item
2905 Macro parameters that appear within string literals in the macro body.
2906 In traditional C macro replacement takes place within string literals,
2907 but does not in ISO C@.
2909 @item
2910 In traditional C, some preprocessor directives did not exist.
2911 Traditional preprocessors would only consider a line to be a directive
2912 if the @samp{#} appeared in column 1 on the line.  Therefore
2913 @option{-Wtraditional} warns about directives that traditional C
2914 understands but would ignore because the @samp{#} does not appear as the
2915 first character on the line.  It also suggests you hide directives like
2916 @samp{#pragma} not understood by traditional C by indenting them.  Some
2917 traditional implementations would not recognize @samp{#elif}, so it
2918 suggests avoiding it altogether.
2920 @item
2921 A function-like macro that appears without arguments.
2923 @item
2924 The unary plus operator.
2926 @item
2927 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2928 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2929 constants.)  Note, these suffixes appear in macros defined in the system
2930 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2931 Use of these macros in user code might normally lead to spurious
2932 warnings, however GCC's integrated preprocessor has enough context to
2933 avoid warning in these cases.
2935 @item
2936 A function declared external in one block and then used after the end of
2937 the block.
2939 @item
2940 A @code{switch} statement has an operand of type @code{long}.
2942 @item
2943 A non-@code{static} function declaration follows a @code{static} one.
2944 This construct is not accepted by some traditional C compilers.
2946 @item
2947 The ISO type of an integer constant has a different width or
2948 signedness from its traditional type.  This warning is only issued if
2949 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2950 typically represent bit patterns, are not warned about.
2952 @item
2953 Usage of ISO string concatenation is detected.
2955 @item
2956 Initialization of automatic aggregates.
2958 @item
2959 Identifier conflicts with labels.  Traditional C lacks a separate
2960 namespace for labels.
2962 @item
2963 Initialization of unions.  If the initializer is zero, the warning is
2964 omitted.  This is done under the assumption that the zero initializer in
2965 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2966 initializer warnings and relies on default initialization to zero in the
2967 traditional C case.
2969 @item
2970 Conversions by prototypes between fixed/floating point values and vice
2971 versa.  The absence of these prototypes when compiling with traditional
2972 C would cause serious problems.  This is a subset of the possible
2973 conversion warnings, for the full set use @option{-Wconversion}.
2975 @item
2976 Use of ISO C style function definitions.  This warning intentionally is
2977 @emph{not} issued for prototype declarations or variadic functions
2978 because these ISO C features will appear in your code when using
2979 libiberty's traditional C compatibility macros, @code{PARAMS} and
2980 @code{VPARAMS}.  This warning is also bypassed for nested functions
2981 because that feature is already a GCC extension and thus not relevant to
2982 traditional C compatibility.
2983 @end itemize
2985 @item -Wdeclaration-after-statement @r{(C only)}
2986 @opindex Wdeclaration-after-statement
2987 Warn when a declaration is found after a statement in a block.  This
2988 construct, known from C++, was introduced with ISO C99 and is by default
2989 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2990 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2992 @item -Wundef
2993 @opindex Wundef
2994 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2996 @item -Wno-endif-labels
2997 @opindex Wno-endif-labels
2998 @opindex Wendif-labels
2999 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3001 @item -Wshadow
3002 @opindex Wshadow
3003 Warn whenever a local variable shadows another local variable, parameter or
3004 global variable or whenever a built-in function is shadowed.
3006 @item -Wlarger-than-@var{len}
3007 @opindex Wlarger-than
3008 Warn whenever an object of larger than @var{len} bytes is defined.
3010 @item -Wunsafe-loop-optimizations
3011 @opindex Wunsafe-loop-optimizations
3012 Warn if the loop cannot be optimized because the compiler could not
3013 assume anything on the bounds of the loop indices.  With
3014 @option{-funsafe-loop-optimizations} warn if the compiler made
3015 such assumptions.
3017 @item -Wpointer-arith
3018 @opindex Wpointer-arith
3019 Warn about anything that depends on the ``size of'' a function type or
3020 of @code{void}.  GNU C assigns these types a size of 1, for
3021 convenience in calculations with @code{void *} pointers and pointers
3022 to functions.
3024 @item -Wbad-function-cast @r{(C only)}
3025 @opindex Wbad-function-cast
3026 Warn whenever a function call is cast to a non-matching type.
3027 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3029 @item -Wc++-compat
3030 Warn about ISO C constructs that are outside of the common subset of
3031 ISO C and ISO C++, e.g.@: request for implicit conversion from
3032 @code{void *} to a pointer to non-@code{void} type.
3034 @item -Wcast-qual
3035 @opindex Wcast-qual
3036 Warn whenever a pointer is cast so as to remove a type qualifier from
3037 the target type.  For example, warn if a @code{const char *} is cast
3038 to an ordinary @code{char *}.
3040 @item -Wcast-align
3041 @opindex Wcast-align
3042 Warn whenever a pointer is cast such that the required alignment of the
3043 target is increased.  For example, warn if a @code{char *} is cast to
3044 an @code{int *} on machines where integers can only be accessed at
3045 two- or four-byte boundaries.
3047 @item -Wwrite-strings
3048 @opindex Wwrite-strings
3049 When compiling C, give string constants the type @code{const
3050 char[@var{length}]} so that
3051 copying the address of one into a non-@code{const} @code{char *}
3052 pointer will get a warning; when compiling C++, warn about the
3053 deprecated conversion from string constants to @code{char *}.
3054 These warnings will help you find at
3055 compile time code that can try to write into a string constant, but
3056 only if you have been very careful about using @code{const} in
3057 declarations and prototypes.  Otherwise, it will just be a nuisance;
3058 this is why we did not make @option{-Wall} request these warnings.
3060 @item -Wconversion
3061 @opindex Wconversion
3062 Warn if a prototype causes a type conversion that is different from what
3063 would happen to the same argument in the absence of a prototype.  This
3064 includes conversions of fixed point to floating and vice versa, and
3065 conversions changing the width or signedness of a fixed point argument
3066 except when the same as the default promotion.
3068 Also, warn if a negative integer constant expression is implicitly
3069 converted to an unsigned type.  For example, warn about the assignment
3070 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3071 casts like @code{(unsigned) -1}.
3073 @item -Wsign-compare
3074 @opindex Wsign-compare
3075 @cindex warning for comparison of signed and unsigned values
3076 @cindex comparison of signed and unsigned values, warning
3077 @cindex signed and unsigned values, comparison warning
3078 Warn when a comparison between signed and unsigned values could produce
3079 an incorrect result when the signed value is converted to unsigned.
3080 This warning is also enabled by @option{-Wextra}; to get the other warnings
3081 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3083 @item -Waggregate-return
3084 @opindex Waggregate-return
3085 Warn if any functions that return structures or unions are defined or
3086 called.  (In languages where you can return an array, this also elicits
3087 a warning.)
3089 @item -Wno-attributes
3090 @opindex Wno-attributes
3091 @opindex Wattributes
3092 Do not warn if an unexpected @code{__attribute__} is used, such as
3093 unrecognized attributes, function attributes applied to variables,
3094 etc.  This will not stop errors for incorrect use of supported
3095 attributes.
3097 @item -Wstrict-prototypes @r{(C only)}
3098 @opindex Wstrict-prototypes
3099 Warn if a function is declared or defined without specifying the
3100 argument types.  (An old-style function definition is permitted without
3101 a warning if preceded by a declaration which specifies the argument
3102 types.)
3104 @item -Wold-style-definition @r{(C only)}
3105 @opindex Wold-style-definition
3106 Warn if an old-style function definition is used.  A warning is given
3107 even if there is a previous prototype.
3109 @item -Wmissing-prototypes @r{(C only)}
3110 @opindex Wmissing-prototypes
3111 Warn if a global function is defined without a previous prototype
3112 declaration.  This warning is issued even if the definition itself
3113 provides a prototype.  The aim is to detect global functions that fail
3114 to be declared in header files.
3116 @item -Wmissing-declarations @r{(C only)}
3117 @opindex Wmissing-declarations
3118 Warn if a global function is defined without a previous declaration.
3119 Do so even if the definition itself provides a prototype.
3120 Use this option to detect global functions that are not declared in
3121 header files.
3123 @item -Wmissing-field-initializers
3124 @opindex Wmissing-field-initializers
3125 @opindex W
3126 @opindex Wextra
3127 Warn if a structure's initializer has some fields missing.  For
3128 example, the following code would cause such a warning, because
3129 @code{x.h} is implicitly zero:
3131 @smallexample
3132 struct s @{ int f, g, h; @};
3133 struct s x = @{ 3, 4 @};
3134 @end smallexample
3136 This option does not warn about designated initializers, so the following
3137 modification would not trigger a warning:
3139 @smallexample
3140 struct s @{ int f, g, h; @};
3141 struct s x = @{ .f = 3, .g = 4 @};
3142 @end smallexample
3144 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3145 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3147 @item -Wmissing-noreturn
3148 @opindex Wmissing-noreturn
3149 Warn about functions which might be candidates for attribute @code{noreturn}.
3150 Note these are only possible candidates, not absolute ones.  Care should
3151 be taken to manually verify functions actually do not ever return before
3152 adding the @code{noreturn} attribute, otherwise subtle code generation
3153 bugs could be introduced.  You will not get a warning for @code{main} in
3154 hosted C environments.
3156 @item -Wmissing-format-attribute
3157 @opindex Wmissing-format-attribute
3158 @opindex Wformat
3159 Warn about function pointers which might be candidates for @code{format}
3160 attributes.  Note these are only possible candidates, not absolute ones.
3161 GCC will guess that function pointers with @code{format} attributes that
3162 are used in assignment, initialization, parameter passing or return
3163 statements should have a corresponding @code{format} attribute in the
3164 resulting type.  I.e.@: the left-hand side of the assignment or
3165 initialization, the type of the parameter variable, or the return type
3166 of the containing function respectively should also have a @code{format}
3167 attribute to avoid the warning.
3169 GCC will also warn about function definitions which might be
3170 candidates for @code{format} attributes.  Again, these are only
3171 possible candidates.  GCC will guess that @code{format} attributes
3172 might be appropriate for any function that calls a function like
3173 @code{vprintf} or @code{vscanf}, but this might not always be the
3174 case, and some functions for which @code{format} attributes are
3175 appropriate may not be detected.
3177 @item -Wno-multichar
3178 @opindex Wno-multichar
3179 @opindex Wmultichar
3180 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3181 Usually they indicate a typo in the user's code, as they have
3182 implementation-defined values, and should not be used in portable code.
3184 @item -Wnormalized=<none|id|nfc|nfkc>
3185 @opindex Wnormalized
3186 @cindex NFC
3187 @cindex NFKC
3188 @cindex character set, input normalization
3189 In ISO C and ISO C++, two identifiers are different if they are
3190 different sequences of characters.  However, sometimes when characters
3191 outside the basic ASCII character set are used, you can have two
3192 different character sequences that look the same.  To avoid confusion,
3193 the ISO 10646 standard sets out some @dfn{normalization rules} which
3194 when applied ensure that two sequences that look the same are turned into
3195 the same sequence.  GCC can warn you if you are using identifiers which
3196 have not been normalized; this option controls that warning.
3198 There are four levels of warning that GCC supports.  The default is
3199 @option{-Wnormalized=nfc}, which warns about any identifier which is
3200 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3201 recommended form for most uses.
3203 Unfortunately, there are some characters which ISO C and ISO C++ allow
3204 in identifiers that when turned into NFC aren't allowable as
3205 identifiers.  That is, there's no way to use these symbols in portable
3206 ISO C or C++ and have all your identifiers in NFC.
3207 @option{-Wnormalized=id} suppresses the warning for these characters.
3208 It is hoped that future versions of the standards involved will correct
3209 this, which is why this option is not the default.
3211 You can switch the warning off for all characters by writing
3212 @option{-Wnormalized=none}.  You would only want to do this if you
3213 were using some other normalization scheme (like ``D''), because
3214 otherwise you can easily create bugs that are literally impossible to see.
3216 Some characters in ISO 10646 have distinct meanings but look identical
3217 in some fonts or display methodologies, especially once formatting has
3218 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3219 LETTER N'', will display just like a regular @code{n} which has been
3220 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3221 normalisation scheme to convert all these into a standard form as
3222 well, and GCC will warn if your code is not in NFKC if you use
3223 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3224 about every identifier that contains the letter O because it might be
3225 confused with the digit 0, and so is not the default, but may be
3226 useful as a local coding convention if the programming environment is
3227 unable to be fixed to display these characters distinctly.
3229 @item -Wno-deprecated-declarations
3230 @opindex Wno-deprecated-declarations
3231 Do not warn about uses of functions, variables, and types marked as
3232 deprecated by using the @code{deprecated} attribute.
3233 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3234 @pxref{Type Attributes}.)
3236 @item -Wpacked
3237 @opindex Wpacked
3238 Warn if a structure is given the packed attribute, but the packed
3239 attribute has no effect on the layout or size of the structure.
3240 Such structures may be mis-aligned for little benefit.  For
3241 instance, in this code, the variable @code{f.x} in @code{struct bar}
3242 will be misaligned even though @code{struct bar} does not itself
3243 have the packed attribute:
3245 @smallexample
3246 @group
3247 struct foo @{
3248   int x;
3249   char a, b, c, d;
3250 @} __attribute__((packed));
3251 struct bar @{
3252   char z;
3253   struct foo f;
3255 @end group
3256 @end smallexample
3258 @item -Wpadded
3259 @opindex Wpadded
3260 Warn if padding is included in a structure, either to align an element
3261 of the structure or to align the whole structure.  Sometimes when this
3262 happens it is possible to rearrange the fields of the structure to
3263 reduce the padding and so make the structure smaller.
3265 @item -Wredundant-decls
3266 @opindex Wredundant-decls
3267 Warn if anything is declared more than once in the same scope, even in
3268 cases where multiple declaration is valid and changes nothing.
3270 @item -Wnested-externs @r{(C only)}
3271 @opindex Wnested-externs
3272 Warn if an @code{extern} declaration is encountered within a function.
3274 @item -Wunreachable-code
3275 @opindex Wunreachable-code
3276 Warn if the compiler detects that code will never be executed.
3278 This option is intended to warn when the compiler detects that at
3279 least a whole line of source code will never be executed, because
3280 some condition is never satisfied or because it is after a
3281 procedure that never returns.
3283 It is possible for this option to produce a warning even though there
3284 are circumstances under which part of the affected line can be executed,
3285 so care should be taken when removing apparently-unreachable code.
3287 For instance, when a function is inlined, a warning may mean that the
3288 line is unreachable in only one inlined copy of the function.
3290 This option is not made part of @option{-Wall} because in a debugging
3291 version of a program there is often substantial code which checks
3292 correct functioning of the program and is, hopefully, unreachable
3293 because the program does work.  Another common use of unreachable
3294 code is to provide behavior which is selectable at compile-time.
3296 @item -Winline
3297 @opindex Winline
3298 Warn if a function can not be inlined and it was declared as inline.
3299 Even with this option, the compiler will not warn about failures to
3300 inline functions declared in system headers.
3302 The compiler uses a variety of heuristics to determine whether or not
3303 to inline a function.  For example, the compiler takes into account
3304 the size of the function being inlined and the amount of inlining
3305 that has already been done in the current function.  Therefore,
3306 seemingly insignificant changes in the source program can cause the
3307 warnings produced by @option{-Winline} to appear or disappear.
3309 @item -Wno-invalid-offsetof @r{(C++ only)}
3310 @opindex Wno-invalid-offsetof
3311 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3312 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3313 to a non-POD type is undefined.  In existing C++ implementations,
3314 however, @samp{offsetof} typically gives meaningful results even when
3315 applied to certain kinds of non-POD types. (Such as a simple
3316 @samp{struct} that fails to be a POD type only by virtue of having a
3317 constructor.)  This flag is for users who are aware that they are
3318 writing nonportable code and who have deliberately chosen to ignore the
3319 warning about it.
3321 The restrictions on @samp{offsetof} may be relaxed in a future version
3322 of the C++ standard.
3324 @item -Wno-int-to-pointer-cast @r{(C only)}
3325 @opindex Wno-int-to-pointer-cast
3326 Suppress warnings from casts to pointer type of an integer of a
3327 different size.
3329 @item -Wno-pointer-to-int-cast @r{(C only)}
3330 @opindex Wno-pointer-to-int-cast
3331 Suppress warnings from casts from a pointer to an integer type of a
3332 different size.
3334 @item -Winvalid-pch
3335 @opindex Winvalid-pch
3336 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3337 the search path but can't be used.
3339 @item -Wlong-long
3340 @opindex Wlong-long
3341 @opindex Wno-long-long
3342 Warn if @samp{long long} type is used.  This is default.  To inhibit
3343 the warning messages, use @option{-Wno-long-long}.  Flags
3344 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3345 only when @option{-pedantic} flag is used.
3347 @item -Wvariadic-macros
3348 @opindex Wvariadic-macros
3349 @opindex Wno-variadic-macros
3350 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3351 alternate syntax when in pedantic ISO C99 mode.  This is default.
3352 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3354 @item -Wdisabled-optimization
3355 @opindex Wdisabled-optimization
3356 Warn if a requested optimization pass is disabled.  This warning does
3357 not generally indicate that there is anything wrong with your code; it
3358 merely indicates that GCC's optimizers were unable to handle the code
3359 effectively.  Often, the problem is that your code is too big or too
3360 complex; GCC will refuse to optimize programs when the optimization
3361 itself is likely to take inordinate amounts of time.
3363 @item -Wno-pointer-sign
3364 @opindex Wno-pointer-sign
3365 Don't warn for pointer argument passing or assignment with different signedness.
3366 Only useful in the negative form since this warning is enabled by default.
3367 This option is only supported for C and Objective-C@.
3369 @item -Werror
3370 @opindex Werror
3371 Make all warnings into errors.
3373 @item -Wstack-protector
3374 This option is only active when @option{-fstack-protector} is active.  It
3375 warns about functions that will not be protected against stack smashing.
3377 @end table
3379 @node Debugging Options
3380 @section Options for Debugging Your Program or GCC
3381 @cindex options, debugging
3382 @cindex debugging information options
3384 GCC has various special options that are used for debugging
3385 either your program or GCC:
3387 @table @gcctabopt
3388 @item -g
3389 @opindex g
3390 Produce debugging information in the operating system's native format
3391 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3392 information.
3394 On most systems that use stabs format, @option{-g} enables use of extra
3395 debugging information that only GDB can use; this extra information
3396 makes debugging work better in GDB but will probably make other debuggers
3397 crash or
3398 refuse to read the program.  If you want to control for certain whether
3399 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3400 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3402 GCC allows you to use @option{-g} with
3403 @option{-O}.  The shortcuts taken by optimized code may occasionally
3404 produce surprising results: some variables you declared may not exist
3405 at all; flow of control may briefly move where you did not expect it;
3406 some statements may not be executed because they compute constant
3407 results or their values were already at hand; some statements may
3408 execute in different places because they were moved out of loops.
3410 Nevertheless it proves possible to debug optimized output.  This makes
3411 it reasonable to use the optimizer for programs that might have bugs.
3413 The following options are useful when GCC is generated with the
3414 capability for more than one debugging format.
3416 @item -ggdb
3417 @opindex ggdb
3418 Produce debugging information for use by GDB@.  This means to use the
3419 most expressive format available (DWARF 2, stabs, or the native format
3420 if neither of those are supported), including GDB extensions if at all
3421 possible.
3423 @item -gstabs
3424 @opindex gstabs
3425 Produce debugging information in stabs format (if that is supported),
3426 without GDB extensions.  This is the format used by DBX on most BSD
3427 systems.  On MIPS, Alpha and System V Release 4 systems this option
3428 produces stabs debugging output which is not understood by DBX or SDB@.
3429 On System V Release 4 systems this option requires the GNU assembler.
3431 @item -feliminate-unused-debug-symbols
3432 @opindex feliminate-unused-debug-symbols
3433 Produce debugging information in stabs format (if that is supported),
3434 for only symbols that are actually used.
3436 @item -gstabs+
3437 @opindex gstabs+
3438 Produce debugging information in stabs format (if that is supported),
3439 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3440 use of these extensions is likely to make other debuggers crash or
3441 refuse to read the program.
3443 @item -gcoff
3444 @opindex gcoff
3445 Produce debugging information in COFF format (if that is supported).
3446 This is the format used by SDB on most System V systems prior to
3447 System V Release 4.
3449 @item -gxcoff
3450 @opindex gxcoff
3451 Produce debugging information in XCOFF format (if that is supported).
3452 This is the format used by the DBX debugger on IBM RS/6000 systems.
3454 @item -gxcoff+
3455 @opindex gxcoff+
3456 Produce debugging information in XCOFF format (if that is supported),
3457 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3458 use of these extensions is likely to make other debuggers crash or
3459 refuse to read the program, and may cause assemblers other than the GNU
3460 assembler (GAS) to fail with an error.
3462 @item -gdwarf-2
3463 @opindex gdwarf-2
3464 Produce debugging information in DWARF version 2 format (if that is
3465 supported).  This is the format used by DBX on IRIX 6.  With this
3466 option, GCC uses features of DWARF version 3 when they are useful;
3467 version 3 is upward compatible with version 2, but may still cause
3468 problems for older debuggers.
3470 @item -gvms
3471 @opindex gvms
3472 Produce debugging information in VMS debug format (if that is
3473 supported).  This is the format used by DEBUG on VMS systems.
3475 @item -g@var{level}
3476 @itemx -ggdb@var{level}
3477 @itemx -gstabs@var{level}
3478 @itemx -gcoff@var{level}
3479 @itemx -gxcoff@var{level}
3480 @itemx -gvms@var{level}
3481 Request debugging information and also use @var{level} to specify how
3482 much information.  The default level is 2.
3484 Level 1 produces minimal information, enough for making backtraces in
3485 parts of the program that you don't plan to debug.  This includes
3486 descriptions of functions and external variables, but no information
3487 about local variables and no line numbers.
3489 Level 3 includes extra information, such as all the macro definitions
3490 present in the program.  Some debuggers support macro expansion when
3491 you use @option{-g3}.
3493 @option{-gdwarf-2} does not accept a concatenated debug level, because
3494 GCC used to support an option @option{-gdwarf} that meant to generate
3495 debug information in version 1 of the DWARF format (which is very
3496 different from version 2), and it would have been too confusing.  That
3497 debug format is long obsolete, but the option cannot be changed now.
3498 Instead use an additional @option{-g@var{level}} option to change the
3499 debug level for DWARF2.
3501 @item -feliminate-dwarf2-dups
3502 @opindex feliminate-dwarf2-dups
3503 Compress DWARF2 debugging information by eliminating duplicated
3504 information about each symbol.  This option only makes sense when
3505 generating DWARF2 debugging information with @option{-gdwarf-2}.
3507 @cindex @command{prof}
3508 @item -p
3509 @opindex p
3510 Generate extra code to write profile information suitable for the
3511 analysis program @command{prof}.  You must use this option when compiling
3512 the source files you want data about, and you must also use it when
3513 linking.
3515 @cindex @command{gprof}
3516 @item -pg
3517 @opindex pg
3518 Generate extra code to write profile information suitable for the
3519 analysis program @command{gprof}.  You must use this option when compiling
3520 the source files you want data about, and you must also use it when
3521 linking.
3523 @item -Q
3524 @opindex Q
3525 Makes the compiler print out each function name as it is compiled, and
3526 print some statistics about each pass when it finishes.
3528 @item -ftime-report
3529 @opindex ftime-report
3530 Makes the compiler print some statistics about the time consumed by each
3531 pass when it finishes.
3533 @item -fmem-report
3534 @opindex fmem-report
3535 Makes the compiler print some statistics about permanent memory
3536 allocation when it finishes.
3538 @item -fprofile-arcs
3539 @opindex fprofile-arcs
3540 Add code so that program flow @dfn{arcs} are instrumented.  During
3541 execution the program records how many times each branch and call is
3542 executed and how many times it is taken or returns.  When the compiled
3543 program exits it saves this data to a file called
3544 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3545 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3546 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3547 @var{auxname} is generated from the name of the output file, if
3548 explicitly specified and it is not the final executable, otherwise it is
3549 the basename of the source file.  In both cases any suffix is removed
3550 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3551 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3552 @xref{Cross-profiling}.
3554 @cindex @command{gcov}
3555 @item --coverage
3556 @opindex coverage
3558 This option is used to compile and link code instrumented for coverage
3559 analysis.  The option is a synonym for @option{-fprofile-arcs}
3560 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3561 linking).  See the documentation for those options for more details.
3563 @itemize
3565 @item
3566 Compile the source files with @option{-fprofile-arcs} plus optimization
3567 and code generation options.  For test coverage analysis, use the
3568 additional @option{-ftest-coverage} option.  You do not need to profile
3569 every source file in a program.
3571 @item
3572 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3573 (the latter implies the former).
3575 @item
3576 Run the program on a representative workload to generate the arc profile
3577 information.  This may be repeated any number of times.  You can run
3578 concurrent instances of your program, and provided that the file system
3579 supports locking, the data files will be correctly updated.  Also
3580 @code{fork} calls are detected and correctly handled (double counting
3581 will not happen).
3583 @item
3584 For profile-directed optimizations, compile the source files again with
3585 the same optimization and code generation options plus
3586 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3587 Control Optimization}).
3589 @item
3590 For test coverage analysis, use @command{gcov} to produce human readable
3591 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3592 @command{gcov} documentation for further information.
3594 @end itemize
3596 With @option{-fprofile-arcs}, for each function of your program GCC
3597 creates a program flow graph, then finds a spanning tree for the graph.
3598 Only arcs that are not on the spanning tree have to be instrumented: the
3599 compiler adds code to count the number of times that these arcs are
3600 executed.  When an arc is the only exit or only entrance to a block, the
3601 instrumentation code can be added to the block; otherwise, a new basic
3602 block must be created to hold the instrumentation code.
3604 @need 2000
3605 @item -ftest-coverage
3606 @opindex ftest-coverage
3607 Produce a notes file that the @command{gcov} code-coverage utility
3608 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3609 show program coverage.  Each source file's note file is called
3610 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3611 above for a description of @var{auxname} and instructions on how to
3612 generate test coverage data.  Coverage data will match the source files
3613 more closely, if you do not optimize.
3615 @item -d@var{letters}
3616 @item -fdump-rtl-@var{pass}
3617 @opindex d
3618 Says to make debugging dumps during compilation at times specified by
3619 @var{letters}.    This is used for debugging the RTL-based passes of the
3620 compiler.  The file names for most of the dumps are made by appending a
3621 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3622 from the name of the output file, if explicitly specified and it is not
3623 an executable, otherwise it is the basename of the source file.
3625 Most debug dumps can be enabled either passing a letter to the @option{-d}
3626 option, or with a long @option{-fdump-rtl} switch; here are the possible
3627 letters for use in @var{letters} and @var{pass}, and their meanings:
3629 @table @gcctabopt
3630 @item -dA
3631 @opindex dA
3632 Annotate the assembler output with miscellaneous debugging information.
3634 @item -db
3635 @itemx -fdump-rtl-bp
3636 @opindex db
3637 @opindex fdump-rtl-bp
3638 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3640 @item -dB
3641 @itemx -fdump-rtl-bbro
3642 @opindex dB
3643 @opindex fdump-rtl-bbro
3644 Dump after block reordering, to @file{@var{file}.30.bbro}.
3646 @item -dc
3647 @itemx -fdump-rtl-combine
3648 @opindex dc
3649 @opindex fdump-rtl-combine
3650 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3652 @item -dC
3653 @itemx -fdump-rtl-ce1
3654 @itemx -fdump-rtl-ce2
3655 @opindex dC
3656 @opindex fdump-rtl-ce1
3657 @opindex fdump-rtl-ce2
3658 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3659 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3660 and @option{-fdump-rtl-ce2} enable dumping after the second if
3661 conversion, to the file @file{@var{file}.18.ce2}.
3663 @item -dd
3664 @itemx -fdump-rtl-btl
3665 @itemx -fdump-rtl-dbr
3666 @opindex dd
3667 @opindex fdump-rtl-btl
3668 @opindex fdump-rtl-dbr
3669 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3670 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3671 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3672 scheduling, to @file{@var{file}.36.dbr}.
3674 @item -dD
3675 @opindex dD
3676 Dump all macro definitions, at the end of preprocessing, in addition to
3677 normal output.
3679 @item -dE
3680 @itemx -fdump-rtl-ce3
3681 @opindex dE
3682 @opindex fdump-rtl-ce3
3683 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3685 @item -df
3686 @itemx -fdump-rtl-cfg
3687 @itemx -fdump-rtl-life
3688 @opindex df
3689 @opindex fdump-rtl-cfg
3690 @opindex fdump-rtl-life
3691 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3692 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3693 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3694 to @file{@var{file}.16.life}.
3696 @item -dg
3697 @itemx -fdump-rtl-greg
3698 @opindex dg
3699 @opindex fdump-rtl-greg
3700 Dump after global register allocation, to @file{@var{file}.23.greg}.
3702 @item -dG
3703 @itemx -fdump-rtl-gcse
3704 @itemx -fdump-rtl-bypass
3705 @opindex dG
3706 @opindex fdump-rtl-gcse
3707 @opindex fdump-rtl-bypass
3708 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3709 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3710 enable dumping after jump bypassing and control flow optimizations, to
3711 @file{@var{file}.07.bypass}.
3713 @item -dh
3714 @itemx -fdump-rtl-eh
3715 @opindex dh
3716 @opindex fdump-rtl-eh
3717 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3719 @item -di
3720 @itemx -fdump-rtl-sibling
3721 @opindex di
3722 @opindex fdump-rtl-sibling
3723 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3725 @item -dj
3726 @itemx -fdump-rtl-jump
3727 @opindex dj
3728 @opindex fdump-rtl-jump
3729 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3731 @item -dk
3732 @itemx -fdump-rtl-stack
3733 @opindex dk
3734 @opindex fdump-rtl-stack
3735 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3737 @item -dl
3738 @itemx -fdump-rtl-lreg
3739 @opindex dl
3740 @opindex fdump-rtl-lreg
3741 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3743 @item -dL
3744 @itemx -fdump-rtl-loop
3745 @itemx -fdump-rtl-loop2
3746 @opindex dL
3747 @opindex fdump-rtl-loop
3748 @opindex fdump-rtl-loop2
3749 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3750 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3751 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3752 @file{@var{file}.13.loop2}.
3754 @item -dm
3755 @itemx -fdump-rtl-sms
3756 @opindex dm
3757 @opindex fdump-rtl-sms
3758 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3760 @item -dM
3761 @itemx -fdump-rtl-mach
3762 @opindex dM
3763 @opindex fdump-rtl-mach
3764 Dump after performing the machine dependent reorganization pass, to
3765 @file{@var{file}.35.mach}.
3767 @item -dn
3768 @itemx -fdump-rtl-rnreg
3769 @opindex dn
3770 @opindex fdump-rtl-rnreg
3771 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3773 @item -dN
3774 @itemx -fdump-rtl-regmove
3775 @opindex dN
3776 @opindex fdump-rtl-regmove
3777 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3779 @item -do
3780 @itemx -fdump-rtl-postreload
3781 @opindex do
3782 @opindex fdump-rtl-postreload
3783 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3785 @item -dr
3786 @itemx -fdump-rtl-expand
3787 @opindex dr
3788 @opindex fdump-rtl-expand
3789 Dump after RTL generation, to @file{@var{file}.00.expand}.
3791 @item -dR
3792 @itemx -fdump-rtl-sched2
3793 @opindex dR
3794 @opindex fdump-rtl-sched2
3795 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3797 @item -ds
3798 @itemx -fdump-rtl-cse
3799 @opindex ds
3800 @opindex fdump-rtl-cse
3801 Dump after CSE (including the jump optimization that sometimes follows
3802 CSE), to @file{@var{file}.04.cse}.
3804 @item -dS
3805 @itemx -fdump-rtl-sched
3806 @opindex dS
3807 @opindex fdump-rtl-sched
3808 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3810 @item -dt
3811 @itemx -fdump-rtl-cse2
3812 @opindex dt
3813 @opindex fdump-rtl-cse2
3814 Dump after the second CSE pass (including the jump optimization that
3815 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3817 @item -dT
3818 @itemx -fdump-rtl-tracer
3819 @opindex dT
3820 @opindex fdump-rtl-tracer
3821 Dump after running tracer, to @file{@var{file}.12.tracer}.
3823 @item -dV
3824 @itemx -fdump-rtl-vpt
3825 @itemx -fdump-rtl-vartrack
3826 @opindex dV
3827 @opindex fdump-rtl-vpt
3828 @opindex fdump-rtl-vartrack
3829 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3830 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3831 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3832 to @file{@var{file}.34.vartrack}.
3834 @item -dw
3835 @itemx -fdump-rtl-flow2
3836 @opindex dw
3837 @opindex fdump-rtl-flow2
3838 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3840 @item -dz
3841 @itemx -fdump-rtl-peephole2
3842 @opindex dz
3843 @opindex fdump-rtl-peephole2
3844 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3846 @item -dZ
3847 @itemx -fdump-rtl-web
3848 @opindex dZ
3849 @opindex fdump-rtl-web
3850 Dump after live range splitting, to @file{@var{file}.14.web}.
3852 @item -da
3853 @itemx -fdump-rtl-all
3854 @opindex da
3855 @opindex fdump-rtl-all
3856 Produce all the dumps listed above.
3858 @item -dH
3859 @opindex dH
3860 Produce a core dump whenever an error occurs.
3862 @item -dm
3863 @opindex dm
3864 Print statistics on memory usage, at the end of the run, to
3865 standard error.
3867 @item -dp
3868 @opindex dp
3869 Annotate the assembler output with a comment indicating which
3870 pattern and alternative was used.  The length of each instruction is
3871 also printed.
3873 @item -dP
3874 @opindex dP
3875 Dump the RTL in the assembler output as a comment before each instruction.
3876 Also turns on @option{-dp} annotation.
3878 @item -dv
3879 @opindex dv
3880 For each of the other indicated dump files (either with @option{-d} or
3881 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3882 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3884 @item -dx
3885 @opindex dx
3886 Just generate RTL for a function instead of compiling it.  Usually used
3887 with @samp{r} (@option{-fdump-rtl-expand}).
3889 @item -dy
3890 @opindex dy
3891 Dump debugging information during parsing, to standard error.
3892 @end table
3894 @item -fdump-unnumbered
3895 @opindex fdump-unnumbered
3896 When doing debugging dumps (see @option{-d} option above), suppress instruction
3897 numbers and line number note output.  This makes it more feasible to
3898 use diff on debugging dumps for compiler invocations with different
3899 options, in particular with and without @option{-g}.
3901 @item -fdump-translation-unit @r{(C++ only)}
3902 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3903 @opindex fdump-translation-unit
3904 Dump a representation of the tree structure for the entire translation
3905 unit to a file.  The file name is made by appending @file{.tu} to the
3906 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3907 controls the details of the dump as described for the
3908 @option{-fdump-tree} options.
3910 @item -fdump-class-hierarchy @r{(C++ only)}
3911 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3912 @opindex fdump-class-hierarchy
3913 Dump a representation of each class's hierarchy and virtual function
3914 table layout to a file.  The file name is made by appending @file{.class}
3915 to the source file name.  If the @samp{-@var{options}} form is used,
3916 @var{options} controls the details of the dump as described for the
3917 @option{-fdump-tree} options.
3919 @item -fdump-ipa-@var{switch}
3920 @opindex fdump-ipa
3921 Control the dumping at various stages of inter-procedural analysis
3922 language tree to a file.  The file name is generated by appending a switch
3923 specific suffix to the source file name.  The following dumps are possible:
3925 @table @samp
3926 @item all
3927 Enables all inter-procedural analysis dumps; currently the only produced
3928 dump is the @samp{cgraph} dump.
3930 @item cgraph
3931 Dumps information about call-graph optimization, unused function removal,
3932 and inlining decisions.
3933 @end table
3935 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3936 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3937 @opindex fdump-tree
3938 Control the dumping at various stages of processing the intermediate
3939 language tree to a file.  The file name is generated by appending a switch
3940 specific suffix to the source file name.  If the @samp{-@var{options}}
3941 form is used, @var{options} is a list of @samp{-} separated options that
3942 control the details of the dump.  Not all options are applicable to all
3943 dumps, those which are not meaningful will be ignored.  The following
3944 options are available
3946 @table @samp
3947 @item address
3948 Print the address of each node.  Usually this is not meaningful as it
3949 changes according to the environment and source file.  Its primary use
3950 is for tying up a dump file with a debug environment.
3951 @item slim
3952 Inhibit dumping of members of a scope or body of a function merely
3953 because that scope has been reached.  Only dump such items when they
3954 are directly reachable by some other path.  When dumping pretty-printed
3955 trees, this option inhibits dumping the bodies of control structures.
3956 @item raw
3957 Print a raw representation of the tree.  By default, trees are
3958 pretty-printed into a C-like representation.
3959 @item details
3960 Enable more detailed dumps (not honored by every dump option).
3961 @item stats
3962 Enable dumping various statistics about the pass (not honored by every dump
3963 option).
3964 @item blocks
3965 Enable showing basic block boundaries (disabled in raw dumps).
3966 @item vops
3967 Enable showing virtual operands for every statement.
3968 @item lineno
3969 Enable showing line numbers for statements.
3970 @item uid
3971 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3972 @item all
3973 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3974 @end table
3976 The following tree dumps are possible:
3977 @table @samp
3979 @item original
3980 Dump before any tree based optimization, to @file{@var{file}.original}.
3982 @item optimized
3983 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3985 @item inlined
3986 Dump after function inlining, to @file{@var{file}.inlined}.
3988 @item gimple
3989 @opindex fdump-tree-gimple
3990 Dump each function before and after the gimplification pass to a file.  The
3991 file name is made by appending @file{.gimple} to the source file name.
3993 @item cfg
3994 @opindex fdump-tree-cfg
3995 Dump the control flow graph of each function to a file.  The file name is
3996 made by appending @file{.cfg} to the source file name.
3998 @item vcg
3999 @opindex fdump-tree-vcg
4000 Dump the control flow graph of each function to a file in VCG format.  The
4001 file name is made by appending @file{.vcg} to the source file name.  Note
4002 that if the file contains more than one function, the generated file cannot
4003 be used directly by VCG@.  You will need to cut and paste each function's
4004 graph into its own separate file first.
4006 @item ch
4007 @opindex fdump-tree-ch
4008 Dump each function after copying loop headers.  The file name is made by
4009 appending @file{.ch} to the source file name.
4011 @item ssa
4012 @opindex fdump-tree-ssa
4013 Dump SSA related information to a file.  The file name is made by appending
4014 @file{.ssa} to the source file name.
4016 @item salias
4017 @opindex fdump-tree-salias
4018 Dump structure aliasing variable information to a file.  This file name
4019 is made by appending @file{.salias} to the source file name.
4021 @item alias
4022 @opindex fdump-tree-alias
4023 Dump aliasing information for each function.  The file name is made by
4024 appending @file{.alias} to the source file name.
4026 @item ccp
4027 @opindex fdump-tree-ccp
4028 Dump each function after CCP@.  The file name is made by appending
4029 @file{.ccp} to the source file name.
4031 @item storeccp
4032 @opindex fdump-tree-storeccp
4033 Dump each function after STORE-CCP.  The file name is made by appending
4034 @file{.storeccp} to the source file name.
4036 @item pre
4037 @opindex fdump-tree-pre
4038 Dump trees after partial redundancy elimination.  The file name is made
4039 by appending @file{.pre} to the source file name.
4041 @item fre
4042 @opindex fdump-tree-fre
4043 Dump trees after full redundancy elimination.  The file name is made
4044 by appending @file{.fre} to the source file name.
4046 @item copyprop
4047 @opindex fdump-tree-copyprop
4048 Dump trees after copy propagation.  The file name is made
4049 by appending @file{.copyprop} to the source file name.
4051 @item store_copyprop
4052 @opindex fdump-tree-store_copyprop
4053 Dump trees after store copy-propagation.  The file name is made
4054 by appending @file{.store_copyprop} to the source file name.
4056 @item dce
4057 @opindex fdump-tree-dce
4058 Dump each function after dead code elimination.  The file name is made by
4059 appending @file{.dce} to the source file name.
4061 @item mudflap
4062 @opindex fdump-tree-mudflap
4063 Dump each function after adding mudflap instrumentation.  The file name is
4064 made by appending @file{.mudflap} to the source file name.
4066 @item sra
4067 @opindex fdump-tree-sra
4068 Dump each function after performing scalar replacement of aggregates.  The
4069 file name is made by appending @file{.sra} to the source file name.
4071 @item sink
4072 @opindex fdump-tree-sink
4073 Dump each function after performing code sinking.  The file name is made
4074 by appending @file{.sink} to the source file name. 
4076 @item dom
4077 @opindex fdump-tree-dom
4078 Dump each function after applying dominator tree optimizations.  The file
4079 name is made by appending @file{.dom} to the source file name.
4081 @item dse
4082 @opindex fdump-tree-dse
4083 Dump each function after applying dead store elimination.  The file
4084 name is made by appending @file{.dse} to the source file name.
4086 @item phiopt
4087 @opindex fdump-tree-phiopt
4088 Dump each function after optimizing PHI nodes into straightline code.  The file
4089 name is made by appending @file{.phiopt} to the source file name.
4091 @item forwprop
4092 @opindex fdump-tree-forwprop
4093 Dump each function after forward propagating single use variables.  The file
4094 name is made by appending @file{.forwprop} to the source file name.
4096 @item copyrename
4097 @opindex fdump-tree-copyrename
4098 Dump each function after applying the copy rename optimization.  The file
4099 name is made by appending @file{.copyrename} to the source file name.
4101 @item nrv
4102 @opindex fdump-tree-nrv
4103 Dump each function after applying the named return value optimization on
4104 generic trees.  The file name is made by appending @file{.nrv} to the source
4105 file name.
4107 @item vect
4108 @opindex fdump-tree-vect
4109 Dump each function after applying vectorization of loops.  The file name is
4110 made by appending @file{.vect} to the source file name.
4112 @item vrp
4113 @opindex fdump-tree-vrp
4114 Dump each function after Value Range Propagation (VRP).  The file name
4115 is made by appending @file{.vrp} to the source file name.
4117 @item all
4118 @opindex fdump-tree-all
4119 Enable all the available tree dumps with the flags provided in this option.
4120 @end table
4122 @item -ftree-vectorizer-verbose=@var{n}
4123 @opindex ftree-vectorizer-verbose
4124 This option controls the amount of debugging output the vectorizer prints.
4125 This information is written to standard error, unless @option{-fdump-tree-all}
4126 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4127 usual dump listing file, @file{.vect}.
4129 @item -frandom-seed=@var{string}
4130 @opindex frandom-string
4131 This option provides a seed that GCC uses when it would otherwise use
4132 random numbers.  It is used to generate certain symbol names
4133 that have to be different in every compiled file.  It is also used to
4134 place unique stamps in coverage data files and the object files that
4135 produce them.  You can use the @option{-frandom-seed} option to produce
4136 reproducibly identical object files.
4138 The @var{string} should be different for every file you compile.
4140 @item -fsched-verbose=@var{n}
4141 @opindex fsched-verbose
4142 On targets that use instruction scheduling, this option controls the
4143 amount of debugging output the scheduler prints.  This information is
4144 written to standard error, unless @option{-dS} or @option{-dR} is
4145 specified, in which case it is output to the usual dump
4146 listing file, @file{.sched} or @file{.sched2} respectively.  However
4147 for @var{n} greater than nine, the output is always printed to standard
4148 error.
4150 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4151 same information as @option{-dRS}.  For @var{n} greater than one, it
4152 also output basic block probabilities, detailed ready list information
4153 and unit/insn info.  For @var{n} greater than two, it includes RTL
4154 at abort point, control-flow and regions info.  And for @var{n} over
4155 four, @option{-fsched-verbose} also includes dependence info.
4157 @item -save-temps
4158 @opindex save-temps
4159 Store the usual ``temporary'' intermediate files permanently; place them
4160 in the current directory and name them based on the source file.  Thus,
4161 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4162 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4163 preprocessed @file{foo.i} output file even though the compiler now
4164 normally uses an integrated preprocessor.
4166 When used in combination with the @option{-x} command line option,
4167 @option{-save-temps} is sensible enough to avoid over writing an
4168 input source file with the same extension as an intermediate file.
4169 The corresponding intermediate file may be obtained by renaming the
4170 source file before using @option{-save-temps}.
4172 @item -time
4173 @opindex time
4174 Report the CPU time taken by each subprocess in the compilation
4175 sequence.  For C source files, this is the compiler proper and assembler
4176 (plus the linker if linking is done).  The output looks like this:
4178 @smallexample
4179 # cc1 0.12 0.01
4180 # as 0.00 0.01
4181 @end smallexample
4183 The first number on each line is the ``user time'', that is time spent
4184 executing the program itself.  The second number is ``system time'',
4185 time spent executing operating system routines on behalf of the program.
4186 Both numbers are in seconds.
4188 @item -fvar-tracking
4189 @opindex fvar-tracking
4190 Run variable tracking pass.  It computes where variables are stored at each
4191 position in code.  Better debugging information is then generated
4192 (if the debugging information format supports this information).
4194 It is enabled by default when compiling with optimization (@option{-Os},
4195 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4196 the debug info format supports it.
4198 @item -print-file-name=@var{library}
4199 @opindex print-file-name
4200 Print the full absolute name of the library file @var{library} that
4201 would be used when linking---and don't do anything else.  With this
4202 option, GCC does not compile or link anything; it just prints the
4203 file name.
4205 @item -print-multi-directory
4206 @opindex print-multi-directory
4207 Print the directory name corresponding to the multilib selected by any
4208 other switches present in the command line.  This directory is supposed
4209 to exist in @env{GCC_EXEC_PREFIX}.
4211 @item -print-multi-lib
4212 @opindex print-multi-lib
4213 Print the mapping from multilib directory names to compiler switches
4214 that enable them.  The directory name is separated from the switches by
4215 @samp{;}, and each switch starts with an @samp{@@} instead of the
4216 @samp{-}, without spaces between multiple switches.  This is supposed to
4217 ease shell-processing.
4219 @item -print-prog-name=@var{program}
4220 @opindex print-prog-name
4221 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4223 @item -print-libgcc-file-name
4224 @opindex print-libgcc-file-name
4225 Same as @option{-print-file-name=libgcc.a}.
4227 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4228 but you do want to link with @file{libgcc.a}.  You can do
4230 @smallexample
4231 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4232 @end smallexample
4234 @item -print-search-dirs
4235 @opindex print-search-dirs
4236 Print the name of the configured installation directory and a list of
4237 program and library directories @command{gcc} will search---and don't do anything else.
4239 This is useful when @command{gcc} prints the error message
4240 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4241 To resolve this you either need to put @file{cpp0} and the other compiler
4242 components where @command{gcc} expects to find them, or you can set the environment
4243 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4244 Don't forget the trailing @samp{/}.
4245 @xref{Environment Variables}.
4247 @item -dumpmachine
4248 @opindex dumpmachine
4249 Print the compiler's target machine (for example,
4250 @samp{i686-pc-linux-gnu})---and don't do anything else.
4252 @item -dumpversion
4253 @opindex dumpversion
4254 Print the compiler version (for example, @samp{3.0})---and don't do
4255 anything else.
4257 @item -dumpspecs
4258 @opindex dumpspecs
4259 Print the compiler's built-in specs---and don't do anything else.  (This
4260 is used when GCC itself is being built.)  @xref{Spec Files}.
4262 @item -feliminate-unused-debug-types
4263 @opindex feliminate-unused-debug-types
4264 Normally, when producing DWARF2 output, GCC will emit debugging
4265 information for all types declared in a compilation
4266 unit, regardless of whether or not they are actually used
4267 in that compilation unit.  Sometimes this is useful, such as
4268 if, in the debugger, you want to cast a value to a type that is
4269 not actually used in your program (but is declared).  More often,
4270 however, this results in a significant amount of wasted space.
4271 With this option, GCC will avoid producing debug symbol output
4272 for types that are nowhere used in the source file being compiled.
4273 @end table
4275 @node Optimize Options
4276 @section Options That Control Optimization
4277 @cindex optimize options
4278 @cindex options, optimization
4280 These options control various sorts of optimizations.
4282 Without any optimization option, the compiler's goal is to reduce the
4283 cost of compilation and to make debugging produce the expected
4284 results.  Statements are independent: if you stop the program with a
4285 breakpoint between statements, you can then assign a new value to any
4286 variable or change the program counter to any other statement in the
4287 function and get exactly the results you would expect from the source
4288 code.
4290 Turning on optimization flags makes the compiler attempt to improve
4291 the performance and/or code size at the expense of compilation time
4292 and possibly the ability to debug the program.
4294 The compiler performs optimization based on the knowledge it has of
4295 the program.  Optimization levels @option{-O2} and above, in
4296 particular, enable @emph{unit-at-a-time} mode, which allows the
4297 compiler to consider information gained from later functions in
4298 the file when compiling a function.  Compiling multiple files at
4299 once to a single output file in @emph{unit-at-a-time} mode allows
4300 the compiler to use information gained from all of the files when
4301 compiling each of them.
4303 Not all optimizations are controlled directly by a flag.  Only
4304 optimizations that have a flag are listed.
4306 @table @gcctabopt
4307 @item -O
4308 @itemx -O1
4309 @opindex O
4310 @opindex O1
4311 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4312 more memory for a large function.
4314 With @option{-O}, the compiler tries to reduce code size and execution
4315 time, without performing any optimizations that take a great deal of
4316 compilation time.
4318 @option{-O} turns on the following optimization flags:
4319 @gccoptlist{-fdefer-pop @gol
4320 -fdelayed-branch @gol
4321 -fguess-branch-probability @gol
4322 -fcprop-registers @gol
4323 -floop-optimize @gol
4324 -fif-conversion @gol
4325 -fif-conversion2 @gol
4326 -ftree-ccp @gol
4327 -ftree-dce @gol
4328 -ftree-dominator-opts @gol
4329 -ftree-dse @gol
4330 -ftree-ter @gol
4331 -ftree-lrs @gol
4332 -ftree-sra @gol
4333 -ftree-copyrename @gol
4334 -ftree-fre @gol
4335 -ftree-ch @gol
4336 -fmerge-constants}
4338 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4339 where doing so does not interfere with debugging.
4341 @item -O2
4342 @opindex O2
4343 Optimize even more.  GCC performs nearly all supported optimizations
4344 that do not involve a space-speed tradeoff.  The compiler does not
4345 perform loop unrolling or function inlining when you specify @option{-O2}.
4346 As compared to @option{-O}, this option increases both compilation time
4347 and the performance of the generated code.
4349 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4350 also turns on the following optimization flags:
4351 @gccoptlist{-fthread-jumps @gol
4352 -fcrossjumping @gol
4353 -foptimize-sibling-calls @gol
4354 -fcse-follow-jumps  -fcse-skip-blocks @gol
4355 -fgcse  -fgcse-lm  @gol
4356 -fexpensive-optimizations @gol
4357 -fstrength-reduce @gol
4358 -frerun-cse-after-loop  -frerun-loop-opt @gol
4359 -fcaller-saves @gol
4360 -fpeephole2 @gol
4361 -fschedule-insns  -fschedule-insns2 @gol
4362 -fsched-interblock  -fsched-spec @gol
4363 -fregmove @gol
4364 -fstrict-aliasing @gol
4365 -fdelete-null-pointer-checks @gol
4366 -freorder-blocks  -freorder-functions @gol
4367 -funit-at-a-time @gol
4368 -falign-functions  -falign-jumps @gol
4369 -falign-loops  -falign-labels @gol
4370 -ftree-vrp @gol
4371 -ftree-pre}
4373 Please note the warning under @option{-fgcse} about
4374 invoking @option{-O2} on programs that use computed gotos.
4376 @item -O3
4377 @opindex O3
4378 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4379 @option{-O2} and also turns on the @option{-finline-functions},
4380 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4382 @item -O0
4383 @opindex O0
4384 Do not optimize.  This is the default.
4386 @item -Os
4387 @opindex Os
4388 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4389 do not typically increase code size.  It also performs further
4390 optimizations designed to reduce code size.
4392 @option{-Os} disables the following optimization flags:
4393 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4394 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4396 If you use multiple @option{-O} options, with or without level numbers,
4397 the last such option is the one that is effective.
4398 @end table
4400 Options of the form @option{-f@var{flag}} specify machine-independent
4401 flags.  Most flags have both positive and negative forms; the negative
4402 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4403 below, only one of the forms is listed---the one you typically will
4404 use.  You can figure out the other form by either removing @samp{no-}
4405 or adding it.
4407 The following options control specific optimizations.  They are either
4408 activated by @option{-O} options or are related to ones that are.  You
4409 can use the following flags in the rare cases when ``fine-tuning'' of
4410 optimizations to be performed is desired.
4412 @table @gcctabopt
4413 @item -fno-default-inline
4414 @opindex fno-default-inline
4415 Do not make member functions inline by default merely because they are
4416 defined inside the class scope (C++ only).  Otherwise, when you specify
4417 @w{@option{-O}}, member functions defined inside class scope are compiled
4418 inline by default; i.e., you don't need to add @samp{inline} in front of
4419 the member function name.
4421 @item -fno-defer-pop
4422 @opindex fno-defer-pop
4423 Always pop the arguments to each function call as soon as that function
4424 returns.  For machines which must pop arguments after a function call,
4425 the compiler normally lets arguments accumulate on the stack for several
4426 function calls and pops them all at once.
4428 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4430 @item -fforce-mem
4431 @opindex fforce-mem
4432 Force memory operands to be copied into registers before doing
4433 arithmetic on them.  This produces better code by making all memory
4434 references potential common subexpressions.  When they are not common
4435 subexpressions, instruction combination should eliminate the separate
4436 register-load. This option is now a nop and will be removed in 4.2.
4438 @item -fforce-addr
4439 @opindex fforce-addr
4440 Force memory address constants to be copied into registers before
4441 doing arithmetic on them.
4443 @item -fomit-frame-pointer
4444 @opindex fomit-frame-pointer
4445 Don't keep the frame pointer in a register for functions that
4446 don't need one.  This avoids the instructions to save, set up and
4447 restore frame pointers; it also makes an extra register available
4448 in many functions.  @strong{It also makes debugging impossible on
4449 some machines.}
4451 On some machines, such as the VAX, this flag has no effect, because
4452 the standard calling sequence automatically handles the frame pointer
4453 and nothing is saved by pretending it doesn't exist.  The
4454 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4455 whether a target machine supports this flag.  @xref{Registers,,Register
4456 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4458 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4460 @item -foptimize-sibling-calls
4461 @opindex foptimize-sibling-calls
4462 Optimize sibling and tail recursive calls.
4464 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4466 @item -fno-inline
4467 @opindex fno-inline
4468 Don't pay attention to the @code{inline} keyword.  Normally this option
4469 is used to keep the compiler from expanding any functions inline.
4470 Note that if you are not optimizing, no functions can be expanded inline.
4472 @item -finline-functions
4473 @opindex finline-functions
4474 Integrate all simple functions into their callers.  The compiler
4475 heuristically decides which functions are simple enough to be worth
4476 integrating in this way.
4478 If all calls to a given function are integrated, and the function is
4479 declared @code{static}, then the function is normally not output as
4480 assembler code in its own right.
4482 Enabled at level @option{-O3}.
4484 @item -finline-functions-called-once
4485 @opindex finline-functions-called-once
4486 Consider all @code{static} functions called once for inlining into their
4487 caller even if they are not marked @code{inline}.  If a call to a given
4488 function is integrated, then the function is not output as assembler code
4489 in its own right.
4491 Enabled if @option{-funit-at-a-time} is enabled.
4493 @item -fearly-inlining
4494 @opindex fearly-inlining
4495 Inline functions marked by @code{always_inline} and functions whose body seems
4496 smaller than the function call overhead early before doing
4497 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4498 makes profiling significantly cheaper and usually inlining faster on programs
4499 having large chains of nested wrapper functions.
4501 Enabled by default.
4503 @item -finline-limit=@var{n}
4504 @opindex finline-limit
4505 By default, GCC limits the size of functions that can be inlined.  This flag
4506 allows the control of this limit for functions that are explicitly marked as
4507 inline (i.e., marked with the inline keyword or defined within the class
4508 definition in c++).  @var{n} is the size of functions that can be inlined in
4509 number of pseudo instructions (not counting parameter handling).  The default
4510 value of @var{n} is 600.
4511 Increasing this value can result in more inlined code at
4512 the cost of compilation time and memory consumption.  Decreasing usually makes
4513 the compilation faster and less code will be inlined (which presumably
4514 means slower programs).  This option is particularly useful for programs that
4515 use inlining heavily such as those based on recursive templates with C++.
4517 Inlining is actually controlled by a number of parameters, which may be
4518 specified individually by using @option{--param @var{name}=@var{value}}.
4519 The @option{-finline-limit=@var{n}} option sets some of these parameters
4520 as follows:
4522 @table @gcctabopt
4523  @item max-inline-insns-single
4524   is set to @var{n}/2.
4525  @item max-inline-insns-auto
4526   is set to @var{n}/2.
4527  @item min-inline-insns
4528   is set to 130 or @var{n}/4, whichever is smaller.
4529  @item max-inline-insns-rtl
4530   is set to @var{n}.
4531 @end table
4533 See below for a documentation of the individual
4534 parameters controlling inlining.
4536 @emph{Note:} pseudo instruction represents, in this particular context, an
4537 abstract measurement of function's size.  In no way does it represent a count
4538 of assembly instructions and as such its exact meaning might change from one
4539 release to an another.
4541 @item -fkeep-inline-functions
4542 @opindex fkeep-inline-functions
4543 In C, emit @code{static} functions that are declared @code{inline}
4544 into the object file, even if the function has been inlined into all
4545 of its callers.  This switch does not affect functions using the
4546 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4547 inline functions into the object file.
4549 @item -fkeep-static-consts
4550 @opindex fkeep-static-consts
4551 Emit variables declared @code{static const} when optimization isn't turned
4552 on, even if the variables aren't referenced.
4554 GCC enables this option by default.  If you want to force the compiler to
4555 check if the variable was referenced, regardless of whether or not
4556 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4558 @item -fmerge-constants
4559 Attempt to merge identical constants (string constants and floating point
4560 constants) across compilation units.
4562 This option is the default for optimized compilation if the assembler and
4563 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4564 behavior.
4566 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4568 @item -fmerge-all-constants
4569 Attempt to merge identical constants and identical variables.
4571 This option implies @option{-fmerge-constants}.  In addition to
4572 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4573 arrays or initialized constant variables with integral or floating point
4574 types.  Languages like C or C++ require each non-automatic variable to
4575 have distinct location, so using this option will result in non-conforming
4576 behavior.
4578 @item -fmodulo-sched
4579 @opindex fmodulo-sched
4580 Perform swing modulo scheduling immediately before the first scheduling
4581 pass.  This pass looks at innermost loops and reorders their
4582 instructions by overlapping different iterations.
4584 @item -fno-branch-count-reg
4585 @opindex fno-branch-count-reg
4586 Do not use ``decrement and branch'' instructions on a count register,
4587 but instead generate a sequence of instructions that decrement a
4588 register, compare it against zero, then branch based upon the result.
4589 This option is only meaningful on architectures that support such
4590 instructions, which include x86, PowerPC, IA-64 and S/390.
4592 The default is @option{-fbranch-count-reg}, enabled when
4593 @option{-fstrength-reduce} is enabled.
4595 @item -fno-function-cse
4596 @opindex fno-function-cse
4597 Do not put function addresses in registers; make each instruction that
4598 calls a constant function contain the function's address explicitly.
4600 This option results in less efficient code, but some strange hacks
4601 that alter the assembler output may be confused by the optimizations
4602 performed when this option is not used.
4604 The default is @option{-ffunction-cse}
4606 @item -fno-zero-initialized-in-bss
4607 @opindex fno-zero-initialized-in-bss
4608 If the target supports a BSS section, GCC by default puts variables that
4609 are initialized to zero into BSS@.  This can save space in the resulting
4610 code.
4612 This option turns off this behavior because some programs explicitly
4613 rely on variables going to the data section.  E.g., so that the
4614 resulting executable can find the beginning of that section and/or make
4615 assumptions based on that.
4617 The default is @option{-fzero-initialized-in-bss}.
4619 @item -fbounds-check
4620 @opindex fbounds-check
4621 For front-ends that support it, generate additional code to check that
4622 indices used to access arrays are within the declared range.  This is
4623 currently only supported by the Java and Fortran front-ends, where
4624 this option defaults to true and false respectively.
4626 @item -fmudflap -fmudflapth -fmudflapir
4627 @opindex fmudflap
4628 @opindex fmudflapth
4629 @opindex fmudflapir
4630 @cindex bounds checking
4631 @cindex mudflap
4632 For front-ends that support it (C and C++), instrument all risky
4633 pointer/array dereferencing operations, some standard library
4634 string/heap functions, and some other associated constructs with
4635 range/validity tests.  Modules so instrumented should be immune to
4636 buffer overflows, invalid heap use, and some other classes of C/C++
4637 programming errors.  The instrumentation relies on a separate runtime
4638 library (@file{libmudflap}), which will be linked into a program if
4639 @option{-fmudflap} is given at link time.  Run-time behavior of the
4640 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4641 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4642 for its options.
4644 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4645 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4646 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4647 instrumentation should ignore pointer reads.  This produces less
4648 instrumentation (and therefore faster execution) and still provides
4649 some protection against outright memory corrupting writes, but allows
4650 erroneously read data to propagate within a program.
4652 @item -fstrength-reduce
4653 @opindex fstrength-reduce
4654 Perform the optimizations of loop strength reduction and
4655 elimination of iteration variables.
4657 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4659 @item -fthread-jumps
4660 @opindex fthread-jumps
4661 Perform optimizations where we check to see if a jump branches to a
4662 location where another comparison subsumed by the first is found.  If
4663 so, the first branch is redirected to either the destination of the
4664 second branch or a point immediately following it, depending on whether
4665 the condition is known to be true or false.
4667 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4669 @item -fcse-follow-jumps
4670 @opindex fcse-follow-jumps
4671 In common subexpression elimination, scan through jump instructions
4672 when the target of the jump is not reached by any other path.  For
4673 example, when CSE encounters an @code{if} statement with an
4674 @code{else} clause, CSE will follow the jump when the condition
4675 tested is false.
4677 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4679 @item -fcse-skip-blocks
4680 @opindex fcse-skip-blocks
4681 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4682 follow jumps which conditionally skip over blocks.  When CSE
4683 encounters a simple @code{if} statement with no else clause,
4684 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4685 body of the @code{if}.
4687 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4689 @item -frerun-cse-after-loop
4690 @opindex frerun-cse-after-loop
4691 Re-run common subexpression elimination after loop optimizations has been
4692 performed.
4694 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4696 @item -frerun-loop-opt
4697 @opindex frerun-loop-opt
4698 Run the loop optimizer twice.
4700 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4702 @item -fgcse
4703 @opindex fgcse
4704 Perform a global common subexpression elimination pass.
4705 This pass also performs global constant and copy propagation.
4707 @emph{Note:} When compiling a program using computed gotos, a GCC
4708 extension, you may get better runtime performance if you disable
4709 the global common subexpression elimination pass by adding
4710 @option{-fno-gcse} to the command line.
4712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4714 @item -fgcse-lm
4715 @opindex fgcse-lm
4716 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4717 attempt to move loads which are only killed by stores into themselves.  This
4718 allows a loop containing a load/store sequence to be changed to a load outside
4719 the loop, and a copy/store within the loop.
4721 Enabled by default when gcse is enabled.
4723 @item -fgcse-sm
4724 @opindex fgcse-sm
4725 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4726 global common subexpression elimination.  This pass will attempt to move
4727 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4728 loops containing a load/store sequence can be changed to a load before
4729 the loop and a store after the loop.
4731 Not enabled at any optimization level.
4733 @item -fgcse-las
4734 @opindex fgcse-las
4735 When @option{-fgcse-las} is enabled, the global common subexpression
4736 elimination pass eliminates redundant loads that come after stores to the
4737 same memory location (both partial and full redundancies).
4739 Not enabled at any optimization level.
4741 @item -fgcse-after-reload
4742 @opindex fgcse-after-reload
4743 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4744 pass is performed after reload.  The purpose of this pass is to cleanup
4745 redundant spilling.
4747 @item -floop-optimize
4748 @opindex floop-optimize
4749 Perform loop optimizations: move constant expressions out of loops, simplify
4750 exit test conditions and optionally do strength-reduction as well.
4752 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4754 @item -floop-optimize2
4755 @opindex floop-optimize2
4756 Perform loop optimizations using the new loop optimizer.  The optimizations
4757 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4758 by separate flags.
4760 @item -funsafe-loop-optimizations
4761 @opindex funsafe-loop-optimizations
4762 If given, the loop optimizer will assume that loop indices do not
4763 overflow, and that the loops with nontrivial exit condition are not
4764 infinite.  This enables a wider range of loop optimizations even if
4765 the loop optimizer itself cannot prove that these assumptions are valid.
4766 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4767 if it finds this kind of loop.
4769 @item -fcrossjumping
4770 @opindex crossjumping
4771 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4772 resulting code may or may not perform better than without cross-jumping.
4774 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4776 @item -fif-conversion
4777 @opindex if-conversion
4778 Attempt to transform conditional jumps into branch-less equivalents.  This
4779 include use of conditional moves, min, max, set flags and abs instructions, and
4780 some tricks doable by standard arithmetics.  The use of conditional execution
4781 on chips where it is available is controlled by @code{if-conversion2}.
4783 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4785 @item -fif-conversion2
4786 @opindex if-conversion2
4787 Use conditional execution (where available) to transform conditional jumps into
4788 branch-less equivalents.
4790 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4792 @item -fdelete-null-pointer-checks
4793 @opindex fdelete-null-pointer-checks
4794 Use global dataflow analysis to identify and eliminate useless checks
4795 for null pointers.  The compiler assumes that dereferencing a null
4796 pointer would have halted the program.  If a pointer is checked after
4797 it has already been dereferenced, it cannot be null.
4799 In some environments, this assumption is not true, and programs can
4800 safely dereference null pointers.  Use
4801 @option{-fno-delete-null-pointer-checks} to disable this optimization
4802 for programs which depend on that behavior.
4804 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4806 @item -fexpensive-optimizations
4807 @opindex fexpensive-optimizations
4808 Perform a number of minor optimizations that are relatively expensive.
4810 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4812 @item -foptimize-register-move
4813 @itemx -fregmove
4814 @opindex foptimize-register-move
4815 @opindex fregmove
4816 Attempt to reassign register numbers in move instructions and as
4817 operands of other simple instructions in order to maximize the amount of
4818 register tying.  This is especially helpful on machines with two-operand
4819 instructions.
4821 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4822 optimization.
4824 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4826 @item -fdelayed-branch
4827 @opindex fdelayed-branch
4828 If supported for the target machine, attempt to reorder instructions
4829 to exploit instruction slots available after delayed branch
4830 instructions.
4832 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4834 @item -fschedule-insns
4835 @opindex fschedule-insns
4836 If supported for the target machine, attempt to reorder instructions to
4837 eliminate execution stalls due to required data being unavailable.  This
4838 helps machines that have slow floating point or memory load instructions
4839 by allowing other instructions to be issued until the result of the load
4840 or floating point instruction is required.
4842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4844 @item -fschedule-insns2
4845 @opindex fschedule-insns2
4846 Similar to @option{-fschedule-insns}, but requests an additional pass of
4847 instruction scheduling after register allocation has been done.  This is
4848 especially useful on machines with a relatively small number of
4849 registers and where memory load instructions take more than one cycle.
4851 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4853 @item -fno-sched-interblock
4854 @opindex fno-sched-interblock
4855 Don't schedule instructions across basic blocks.  This is normally
4856 enabled by default when scheduling before register allocation, i.e.@:
4857 with @option{-fschedule-insns} or at @option{-O2} or higher.
4859 @item -fno-sched-spec
4860 @opindex fno-sched-spec
4861 Don't allow speculative motion of non-load instructions.  This is normally
4862 enabled by default when scheduling before register allocation, i.e.@:
4863 with @option{-fschedule-insns} or at @option{-O2} or higher.
4865 @item -fsched-spec-load
4866 @opindex fsched-spec-load
4867 Allow speculative motion of some load instructions.  This only makes
4868 sense when scheduling before register allocation, i.e.@: with
4869 @option{-fschedule-insns} or at @option{-O2} or higher.
4871 @item -fsched-spec-load-dangerous
4872 @opindex fsched-spec-load-dangerous
4873 Allow speculative motion of more load instructions.  This only makes
4874 sense when scheduling before register allocation, i.e.@: with
4875 @option{-fschedule-insns} or at @option{-O2} or higher.
4877 @item -fsched-stalled-insns=@var{n}
4878 @opindex fsched-stalled-insns
4879 Define how many insns (if any) can be moved prematurely from the queue
4880 of stalled insns into the ready list, during the second scheduling pass.
4882 @item -fsched-stalled-insns-dep=@var{n}
4883 @opindex fsched-stalled-insns-dep
4884 Define how many insn groups (cycles) will be examined for a dependency
4885 on a stalled insn that is candidate for premature removal from the queue
4886 of stalled insns.  Has an effect only during the second scheduling pass,
4887 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4889 @item -fsched2-use-superblocks
4890 @opindex fsched2-use-superblocks
4891 When scheduling after register allocation, do use superblock scheduling
4892 algorithm.  Superblock scheduling allows motion across basic block boundaries
4893 resulting on faster schedules.  This option is experimental, as not all machine
4894 descriptions used by GCC model the CPU closely enough to avoid unreliable
4895 results from the algorithm.
4897 This only makes sense when scheduling after register allocation, i.e.@: with
4898 @option{-fschedule-insns2} or at @option{-O2} or higher.
4900 @item -fsched2-use-traces
4901 @opindex fsched2-use-traces
4902 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4903 allocation and additionally perform code duplication in order to increase the
4904 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4905 trace formation.
4907 This mode should produce faster but significantly longer programs.  Also
4908 without @option{-fbranch-probabilities} the traces constructed may not
4909 match the reality and hurt the performance.  This only makes
4910 sense when scheduling after register allocation, i.e.@: with
4911 @option{-fschedule-insns2} or at @option{-O2} or higher.
4913 @item -freschedule-modulo-scheduled-loops
4914 @opindex fscheduling-in-modulo-scheduled-loops
4915 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4916 we may want to prevent the later scheduling passes from changing its schedule, we use this
4917 option to control that.
4919 @item -fcaller-saves
4920 @opindex fcaller-saves
4921 Enable values to be allocated in registers that will be clobbered by
4922 function calls, by emitting extra instructions to save and restore the
4923 registers around such calls.  Such allocation is done only when it
4924 seems to result in better code than would otherwise be produced.
4926 This option is always enabled by default on certain machines, usually
4927 those which have no call-preserved registers to use instead.
4929 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4931 @item -ftree-pre
4932 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4933 enabled by default at @option{-O2} and @option{-O3}.
4935 @item -ftree-fre
4936 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4937 between FRE and PRE is that FRE only considers expressions
4938 that are computed on all paths leading to the redundant computation.
4939 This analysis faster than PRE, though it exposes fewer redundancies.
4940 This flag is enabled by default at @option{-O} and higher.
4942 @item -ftree-copy-prop
4943 Perform copy propagation on trees.  This pass eliminates unnecessary
4944 copy operations.  This flag is enabled by default at @option{-O} and
4945 higher.
4947 @item -ftree-store-copy-prop
4948 Perform copy propagation of memory loads and stores.  This pass
4949 eliminates unnecessary copy operations in memory references
4950 (structures, global variables, arrays, etc).  This flag is enabled by
4951 default at @option{-O2} and higher.
4953 @item -ftree-salias
4954 Perform structural alias analysis on trees.  This flag
4955 is enabled by default at @option{-O} and higher.
4957 @item -ftree-sink
4958 Perform forward store motion  on trees.  This flag is
4959 enabled by default at @option{-O} and higher.
4961 @item -ftree-ccp
4962 Perform sparse conditional constant propagation (CCP) on trees.  This
4963 pass only operates on local scalar variables and is enabled by default
4964 at @option{-O} and higher.
4966 @item -ftree-store-ccp
4967 Perform sparse conditional constant propagation (CCP) on trees.  This
4968 pass operates on both local scalar variables and memory stores and
4969 loads (global variables, structures, arrays, etc).  This flag is
4970 enabled by default at @option{-O2} and higher.
4972 @item -ftree-dce
4973 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4974 default at @option{-O} and higher.
4976 @item -ftree-dominator-opts
4977 Perform a variety of simple scalar cleanups (constant/copy
4978 propagation, redundancy elimination, range propagation and expression
4979 simplification) based on a dominator tree traversal.  This also
4980 performs jump threading (to reduce jumps to jumps). This flag is
4981 enabled by default at @option{-O} and higher.
4983 @item -ftree-ch
4984 Perform loop header copying on trees.  This is beneficial since it increases
4985 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4986 is enabled by default at @option{-O} and higher.  It is not enabled
4987 for @option{-Os}, since it usually increases code size.
4989 @item -ftree-loop-optimize
4990 Perform loop optimizations on trees.  This flag is enabled by default
4991 at @option{-O} and higher.
4993 @item -ftree-loop-linear
4994 Perform linear loop transformations on tree.  This flag can improve cache
4995 performance and allow further loop optimizations to take place.
4997 @item -ftree-loop-im
4998 Perform loop invariant motion on trees.  This pass moves only invariants that
4999 would be hard to handle at RTL level (function calls, operations that expand to
5000 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5001 operands of conditions that are invariant out of the loop, so that we can use
5002 just trivial invariantness analysis in loop unswitching.  The pass also includes
5003 store motion.
5005 @item -ftree-loop-ivcanon
5006 Create a canonical counter for number of iterations in the loop for that
5007 determining number of iterations requires complicated analysis.  Later
5008 optimizations then may determine the number easily.  Useful especially
5009 in connection with unrolling.
5011 @item -fivopts
5012 Perform induction variable optimizations (strength reduction, induction
5013 variable merging and induction variable elimination) on trees.
5015 @item -ftree-sra
5016 Perform scalar replacement of aggregates.  This pass replaces structure
5017 references with scalars to prevent committing structures to memory too
5018 early.  This flag is enabled by default at @option{-O} and higher.
5020 @item -ftree-copyrename
5021 Perform copy renaming on trees.  This pass attempts to rename compiler
5022 temporaries to other variables at copy locations, usually resulting in
5023 variable names which more closely resemble the original variables.  This flag
5024 is enabled by default at @option{-O} and higher.
5026 @item -ftree-ter
5027 Perform temporary expression replacement during the SSA->normal phase.  Single
5028 use/single def temporaries are replaced at their use location with their
5029 defining expression.  This results in non-GIMPLE code, but gives the expanders
5030 much more complex trees to work on resulting in better RTL generation.  This is
5031 enabled by default at @option{-O} and higher.
5033 @item -ftree-lrs
5034 Perform live range splitting during the SSA->normal phase.  Distinct live
5035 ranges of a variable are split into unique variables, allowing for better
5036 optimization later.  This is enabled by default at @option{-O} and higher.
5038 @item -ftree-vectorize
5039 Perform loop vectorization on trees.
5041 @item -ftree-vrp
5042 Perform Value Range Propagation on trees.  This is similar to the
5043 constant propagation pass, but instead of values, ranges of values are
5044 propagated.  This allows the optimizers to remove unnecessary range
5045 checks like array bound checks and null pointer checks.  This is
5046 enabled by default at @option{-O2} and higher.  Null pointer check
5047 elimination is only done if @option{-fdelete-null-pointer-checks} is
5048 enabled.
5050 @item -ftracer
5051 @opindex ftracer
5052 Perform tail duplication to enlarge superblock size.  This transformation
5053 simplifies the control flow of the function allowing other optimizations to do
5054 better job.
5056 @item -funroll-loops
5057 @opindex funroll-loops
5058 Unroll loops whose number of iterations can be determined at compile
5059 time or upon entry to the loop.  @option{-funroll-loops} implies both
5060 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5061 option makes code larger, and may or may not make it run faster.
5063 @item -funroll-all-loops
5064 @opindex funroll-all-loops
5065 Unroll all loops, even if their number of iterations is uncertain when
5066 the loop is entered.  This usually makes programs run more slowly.
5067 @option{-funroll-all-loops} implies the same options as
5068 @option{-funroll-loops},
5070 @item -fsplit-ivs-in-unroller
5071 @opindex -fsplit-ivs-in-unroller
5072 Enables expressing of values of induction variables in later iterations
5073 of the unrolled loop using the value in the first iteration.  This breaks
5074 long dependency chains, thus improving efficiency of the scheduling passes.
5076 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5077 same effect.  However in cases the loop body is more complicated than
5078 a single basic block, this is not reliable.  It also does not work at all
5079 on some of the architectures due to restrictions in the CSE pass.
5081 This optimization is enabled by default.
5083 @item -fvariable-expansion-in-unroller
5084 @opindex -fvariable-expansion-in-unroller
5085 With this option, the compiler will create multiple copies of some
5086 local variables when unrolling a loop which can result in superior code.
5088 @item -fprefetch-loop-arrays
5089 @opindex fprefetch-loop-arrays
5090 If supported by the target machine, generate instructions to prefetch
5091 memory to improve the performance of loops that access large arrays.
5093 These options may generate better or worse code; results are highly
5094 dependent on the structure of loops within the source code.
5096 @item -fno-peephole
5097 @itemx -fno-peephole2
5098 @opindex fno-peephole
5099 @opindex fno-peephole2
5100 Disable any machine-specific peephole optimizations.  The difference
5101 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5102 are implemented in the compiler; some targets use one, some use the
5103 other, a few use both.
5105 @option{-fpeephole} is enabled by default.
5106 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5108 @item -fno-guess-branch-probability
5109 @opindex fno-guess-branch-probability
5110 Do not guess branch probabilities using heuristics.
5112 GCC will use heuristics to guess branch probabilities if they are
5113 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5114 heuristics are based on the control flow graph.  If some branch probabilities
5115 are specified by @samp{__builtin_expect}, then the heuristics will be
5116 used to guess branch probabilities for the rest of the control flow graph,
5117 taking the @samp{__builtin_expect} info into account.  The interactions
5118 between the heuristics and @samp{__builtin_expect} can be complex, and in
5119 some cases, it may be useful to disable the heuristics so that the effects
5120 of @samp{__builtin_expect} are easier to understand.
5122 The default is @option{-fguess-branch-probability} at levels
5123 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5125 @item -freorder-blocks
5126 @opindex freorder-blocks
5127 Reorder basic blocks in the compiled function in order to reduce number of
5128 taken branches and improve code locality.
5130 Enabled at levels @option{-O2}, @option{-O3}.
5132 @item -freorder-blocks-and-partition
5133 @opindex freorder-blocks-and-partition
5134 In addition to reordering basic blocks in the compiled function, in order
5135 to reduce number of taken branches, partitions hot and cold basic blocks
5136 into separate sections of the assembly and .o files, to improve
5137 paging and cache locality performance.
5139 This optimization is automatically turned off in the presence of
5140 exception handling, for linkonce sections, for functions with a user-defined
5141 section attribute and on any architecture that does not support named
5142 sections.
5144 @item -freorder-functions
5145 @opindex freorder-functions
5146 Reorder functions in the object file in order to
5147 improve code locality.  This is implemented by using special
5148 subsections @code{.text.hot} for most frequently executed functions and
5149 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5150 the linker so object file format must support named sections and linker must
5151 place them in a reasonable way.
5153 Also profile feedback must be available in to make this option effective.  See
5154 @option{-fprofile-arcs} for details.
5156 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5158 @item -fstrict-aliasing
5159 @opindex fstrict-aliasing
5160 Allows the compiler to assume the strictest aliasing rules applicable to
5161 the language being compiled.  For C (and C++), this activates
5162 optimizations based on the type of expressions.  In particular, an
5163 object of one type is assumed never to reside at the same address as an
5164 object of a different type, unless the types are almost the same.  For
5165 example, an @code{unsigned int} can alias an @code{int}, but not a
5166 @code{void*} or a @code{double}.  A character type may alias any other
5167 type.
5169 Pay special attention to code like this:
5170 @smallexample
5171 union a_union @{
5172   int i;
5173   double d;
5176 int f() @{
5177   a_union t;
5178   t.d = 3.0;
5179   return t.i;
5181 @end smallexample
5182 The practice of reading from a different union member than the one most
5183 recently written to (called ``type-punning'') is common.  Even with
5184 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5185 is accessed through the union type.  So, the code above will work as
5186 expected.  However, this code might not:
5187 @smallexample
5188 int f() @{
5189   a_union t;
5190   int* ip;
5191   t.d = 3.0;
5192   ip = &t.i;
5193   return *ip;
5195 @end smallexample
5197 Every language that wishes to perform language-specific alias analysis
5198 should define a function that computes, given an @code{tree}
5199 node, an alias set for the node.  Nodes in different alias sets are not
5200 allowed to alias.  For an example, see the C front-end function
5201 @code{c_get_alias_set}.
5203 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5205 @item -falign-functions
5206 @itemx -falign-functions=@var{n}
5207 @opindex falign-functions
5208 Align the start of functions to the next power-of-two greater than
5209 @var{n}, skipping up to @var{n} bytes.  For instance,
5210 @option{-falign-functions=32} aligns functions to the next 32-byte
5211 boundary, but @option{-falign-functions=24} would align to the next
5212 32-byte boundary only if this can be done by skipping 23 bytes or less.
5214 @option{-fno-align-functions} and @option{-falign-functions=1} are
5215 equivalent and mean that functions will not be aligned.
5217 Some assemblers only support this flag when @var{n} is a power of two;
5218 in that case, it is rounded up.
5220 If @var{n} is not specified or is zero, use a machine-dependent default.
5222 Enabled at levels @option{-O2}, @option{-O3}.
5224 @item -falign-labels
5225 @itemx -falign-labels=@var{n}
5226 @opindex falign-labels
5227 Align all branch targets to a power-of-two boundary, skipping up to
5228 @var{n} bytes like @option{-falign-functions}.  This option can easily
5229 make code slower, because it must insert dummy operations for when the
5230 branch target is reached in the usual flow of the code.
5232 @option{-fno-align-labels} and @option{-falign-labels=1} are
5233 equivalent and mean that labels will not be aligned.
5235 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5236 are greater than this value, then their values are used instead.
5238 If @var{n} is not specified or is zero, use a machine-dependent default
5239 which is very likely to be @samp{1}, meaning no alignment.
5241 Enabled at levels @option{-O2}, @option{-O3}.
5243 @item -falign-loops
5244 @itemx -falign-loops=@var{n}
5245 @opindex falign-loops
5246 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5247 like @option{-falign-functions}.  The hope is that the loop will be
5248 executed many times, which will make up for any execution of the dummy
5249 operations.
5251 @option{-fno-align-loops} and @option{-falign-loops=1} are
5252 equivalent and mean that loops will not be aligned.
5254 If @var{n} is not specified or is zero, use a machine-dependent default.
5256 Enabled at levels @option{-O2}, @option{-O3}.
5258 @item -falign-jumps
5259 @itemx -falign-jumps=@var{n}
5260 @opindex falign-jumps
5261 Align branch targets to a power-of-two boundary, for branch targets
5262 where the targets can only be reached by jumping, skipping up to @var{n}
5263 bytes like @option{-falign-functions}.  In this case, no dummy operations
5264 need be executed.
5266 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5267 equivalent and mean that loops will not be aligned.
5269 If @var{n} is not specified or is zero, use a machine-dependent default.
5271 Enabled at levels @option{-O2}, @option{-O3}.
5273 @item -funit-at-a-time
5274 @opindex funit-at-a-time
5275 Parse the whole compilation unit before starting to produce code.
5276 This allows some extra optimizations to take place but consumes
5277 more memory (in general).  There are some compatibility issues
5278 with @emph{unit-at-at-time} mode:
5279 @itemize @bullet
5280 @item
5281 enabling @emph{unit-at-a-time} mode may change the order
5282 in which functions, variables, and top-level @code{asm} statements
5283 are emitted, and will likely break code relying on some particular
5284 ordering.  The majority of such top-level @code{asm} statements,
5285 though, can be replaced by @code{section} attributes.
5287 @item
5288 @emph{unit-at-a-time} mode removes unreferenced static variables
5289 and functions.  This may result in undefined references
5290 when an @code{asm} statement refers directly to variables or functions
5291 that are otherwise unused.  In that case either the variable/function
5292 shall be listed as an operand of the @code{asm} statement operand or,
5293 in the case of top-level @code{asm} statements the attribute @code{used}
5294 shall be used on the declaration.
5296 @item
5297 Static functions now can use non-standard passing conventions that
5298 may break @code{asm} statements calling functions directly.  Again,
5299 attribute @code{used} will prevent this behavior.
5300 @end itemize
5302 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5303 but this scheme may not be supported by future releases of GCC@.
5305 Enabled at levels @option{-O2}, @option{-O3}.
5307 @item -fweb
5308 @opindex fweb
5309 Constructs webs as commonly used for register allocation purposes and assign
5310 each web individual pseudo register.  This allows the register allocation pass
5311 to operate on pseudos directly, but also strengthens several other optimization
5312 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5313 however, make debugging impossible, since variables will no longer stay in a
5314 ``home register''.
5316 Enabled by default with @option{-funroll-loops}.
5318 @item -fwhole-program
5319 @opindex fwhole-program
5320 Assume that the current compilation unit represents whole program being
5321 compiled.  All public functions and variables with the exception of @code{main}
5322 and those merged by attribute @code{externally_visible} become static functions
5323 and in a affect gets more aggressively optimized by interprocedural optimizers.
5324 While this option is equivalent to proper use of @code{static} keyword for
5325 programs consisting of single file, in combination with option
5326 @option{--combine} this flag can be used to compile most of smaller scale C
5327 programs since the functions and variables become local for the whole combined
5328 compilation unit, not for the single source file itself.
5331 @item -fno-cprop-registers
5332 @opindex fno-cprop-registers
5333 After register allocation and post-register allocation instruction splitting,
5334 we perform a copy-propagation pass to try to reduce scheduling dependencies
5335 and occasionally eliminate the copy.
5337 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5339 @item -fprofile-generate
5340 @opindex fprofile-generate
5342 Enable options usually used for instrumenting application to produce
5343 profile useful for later recompilation with profile feedback based
5344 optimization.  You must use @option{-fprofile-generate} both when
5345 compiling and when linking your program.
5347 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5349 @item -fprofile-use
5350 @opindex fprofile-use
5351 Enable profile feedback directed optimizations, and optimizations
5352 generally profitable only with profile feedback available.
5354 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5355 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5356 @code{-fno-loop-optimize}.
5358 @end table
5360 The following options control compiler behavior regarding floating
5361 point arithmetic.  These options trade off between speed and
5362 correctness.  All must be specifically enabled.
5364 @table @gcctabopt
5365 @item -ffloat-store
5366 @opindex ffloat-store
5367 Do not store floating point variables in registers, and inhibit other
5368 options that might change whether a floating point value is taken from a
5369 register or memory.
5371 @cindex floating point precision
5372 This option prevents undesirable excess precision on machines such as
5373 the 68000 where the floating registers (of the 68881) keep more
5374 precision than a @code{double} is supposed to have.  Similarly for the
5375 x86 architecture.  For most programs, the excess precision does only
5376 good, but a few programs rely on the precise definition of IEEE floating
5377 point.  Use @option{-ffloat-store} for such programs, after modifying
5378 them to store all pertinent intermediate computations into variables.
5380 @item -ffast-math
5381 @opindex ffast-math
5382 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5383 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5384 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5385 and @option{fcx-limited-range}.
5387 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5389 This option should never be turned on by any @option{-O} option since
5390 it can result in incorrect output for programs which depend on
5391 an exact implementation of IEEE or ISO rules/specifications for
5392 math functions.
5394 @item -fno-math-errno
5395 @opindex fno-math-errno
5396 Do not set ERRNO after calling math functions that are executed
5397 with a single instruction, e.g., sqrt.  A program that relies on
5398 IEEE exceptions for math error handling may want to use this flag
5399 for speed while maintaining IEEE arithmetic compatibility.
5401 This option should never be turned on by any @option{-O} option since
5402 it can result in incorrect output for programs which depend on
5403 an exact implementation of IEEE or ISO rules/specifications for
5404 math functions.
5406 The default is @option{-fmath-errno}.
5408 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5409 no reason for the compiler to consider the possibility that it might,
5410 and @option{-fno-math-errno} is the default.
5412 @item -funsafe-math-optimizations
5413 @opindex funsafe-math-optimizations
5414 Allow optimizations for floating-point arithmetic that (a) assume
5415 that arguments and results are valid and (b) may violate IEEE or
5416 ANSI standards.  When used at link-time, it may include libraries
5417 or startup files that change the default FPU control word or other
5418 similar optimizations.
5420 This option should never be turned on by any @option{-O} option since
5421 it can result in incorrect output for programs which depend on
5422 an exact implementation of IEEE or ISO rules/specifications for
5423 math functions.
5425 The default is @option{-fno-unsafe-math-optimizations}.
5427 @item -ffinite-math-only
5428 @opindex ffinite-math-only
5429 Allow optimizations for floating-point arithmetic that assume
5430 that arguments and results are not NaNs or +-Infs.
5432 This option should never be turned on by any @option{-O} option since
5433 it can result in incorrect output for programs which depend on
5434 an exact implementation of IEEE or ISO rules/specifications.
5436 The default is @option{-fno-finite-math-only}.
5438 @item -fno-trapping-math
5439 @opindex fno-trapping-math
5440 Compile code assuming that floating-point operations cannot generate
5441 user-visible traps.  These traps include division by zero, overflow,
5442 underflow, inexact result and invalid operation.  This option implies
5443 @option{-fno-signaling-nans}.  Setting this option may allow faster
5444 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5446 This option should never be turned on by any @option{-O} option since
5447 it can result in incorrect output for programs which depend on
5448 an exact implementation of IEEE or ISO rules/specifications for
5449 math functions.
5451 The default is @option{-ftrapping-math}.
5453 @item -frounding-math
5454 @opindex frounding-math
5455 Disable transformations and optimizations that assume default floating
5456 point rounding behavior.  This is round-to-zero for all floating point
5457 to integer conversions, and round-to-nearest for all other arithmetic
5458 truncations.  This option should be specified for programs that change
5459 the FP rounding mode dynamically, or that may be executed with a
5460 non-default rounding mode.  This option disables constant folding of
5461 floating point expressions at compile-time (which may be affected by
5462 rounding mode) and arithmetic transformations that are unsafe in the
5463 presence of sign-dependent rounding modes.
5465 The default is @option{-fno-rounding-math}.
5467 This option is experimental and does not currently guarantee to
5468 disable all GCC optimizations that are affected by rounding mode.
5469 Future versions of GCC may provide finer control of this setting
5470 using C99's @code{FENV_ACCESS} pragma.  This command line option
5471 will be used to specify the default state for @code{FENV_ACCESS}.
5473 @item -fsignaling-nans
5474 @opindex fsignaling-nans
5475 Compile code assuming that IEEE signaling NaNs may generate user-visible
5476 traps during floating-point operations.  Setting this option disables
5477 optimizations that may change the number of exceptions visible with
5478 signaling NaNs.  This option implies @option{-ftrapping-math}.
5480 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5481 be defined.
5483 The default is @option{-fno-signaling-nans}.
5485 This option is experimental and does not currently guarantee to
5486 disable all GCC optimizations that affect signaling NaN behavior.
5488 @item -fsingle-precision-constant
5489 @opindex fsingle-precision-constant
5490 Treat floating point constant as single precision constant instead of
5491 implicitly converting it to double precision constant.
5493 @item -fcx-limited-range
5494 @itemx -fno-cx-limited-range
5495 @opindex fcx-limited-range
5496 @opindex fno-cx-limited-range
5497 When enabled, this option states that a range reduction step is not
5498 needed when performing complex division.  The default is
5499 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5501 This option controls the default setting of the ISO C99 
5502 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5503 all languages.
5505 @end table
5507 The following options control optimizations that may improve
5508 performance, but are not enabled by any @option{-O} options.  This
5509 section includes experimental options that may produce broken code.
5511 @table @gcctabopt
5512 @item -fbranch-probabilities
5513 @opindex fbranch-probabilities
5514 After running a program compiled with @option{-fprofile-arcs}
5515 (@pxref{Debugging Options,, Options for Debugging Your Program or
5516 @command{gcc}}), you can compile it a second time using
5517 @option{-fbranch-probabilities}, to improve optimizations based on
5518 the number of times each branch was taken.  When the program
5519 compiled with @option{-fprofile-arcs} exits it saves arc execution
5520 counts to a file called @file{@var{sourcename}.gcda} for each source
5521 file  The information in this data file is very dependent on the
5522 structure of the generated code, so you must use the same source code
5523 and the same optimization options for both compilations.
5525 With @option{-fbranch-probabilities}, GCC puts a
5526 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5527 These can be used to improve optimization.  Currently, they are only
5528 used in one place: in @file{reorg.c}, instead of guessing which path a
5529 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5530 exactly determine which path is taken more often.
5532 @item -fprofile-values
5533 @opindex fprofile-values
5534 If combined with @option{-fprofile-arcs}, it adds code so that some
5535 data about values of expressions in the program is gathered.
5537 With @option{-fbranch-probabilities}, it reads back the data gathered
5538 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5539 notes to instructions for their later usage in optimizations.
5541 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5543 @item -fvpt
5544 @opindex fvpt
5545 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5546 a code to gather information about values of expressions.
5548 With @option{-fbranch-probabilities}, it reads back the data gathered
5549 and actually performs the optimizations based on them.
5550 Currently the optimizations include specialization of division operation
5551 using the knowledge about the value of the denominator.
5553 @item -frename-registers
5554 @opindex frename-registers
5555 Attempt to avoid false dependencies in scheduled code by making use
5556 of registers left over after register allocation.  This optimization
5557 will most benefit processors with lots of registers.  Depending on the
5558 debug information format adopted by the target, however, it can
5559 make debugging impossible, since variables will no longer stay in
5560 a ``home register''.
5562 Enabled by default with @option{-funroll-loops}.
5564 @item -ftracer
5565 @opindex ftracer
5566 Perform tail duplication to enlarge superblock size.  This transformation
5567 simplifies the control flow of the function allowing other optimizations to do
5568 better job.
5570 Enabled with @option{-fprofile-use}.
5572 @item -funroll-loops
5573 @opindex funroll-loops
5574 Unroll loops whose number of iterations can be determined at compile time or
5575 upon entry to the loop.  @option{-funroll-loops} implies
5576 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5577 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5578 small constant number of iterations).  This option makes code larger, and may
5579 or may not make it run faster.
5581 Enabled with @option{-fprofile-use}.
5583 @item -funroll-all-loops
5584 @opindex funroll-all-loops
5585 Unroll all loops, even if their number of iterations is uncertain when
5586 the loop is entered.  This usually makes programs run more slowly.
5587 @option{-funroll-all-loops} implies the same options as
5588 @option{-funroll-loops}.
5590 @item -fpeel-loops
5591 @opindex fpeel-loops
5592 Peels the loops for that there is enough information that they do not
5593 roll much (from profile feedback).  It also turns on complete loop peeling
5594 (i.e.@: complete removal of loops with small constant number of iterations).
5596 Enabled with @option{-fprofile-use}.
5598 @item -fmove-loop-invariants
5599 @opindex fmove-loop-invariants
5600 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5601 at level @option{-O1}
5603 @item -funswitch-loops
5604 @opindex funswitch-loops
5605 Move branches with loop invariant conditions out of the loop, with duplicates
5606 of the loop on both branches (modified according to result of the condition).
5608 @item -fprefetch-loop-arrays
5609 @opindex fprefetch-loop-arrays
5610 If supported by the target machine, generate instructions to prefetch
5611 memory to improve the performance of loops that access large arrays.
5613 Disabled at level @option{-Os}.
5615 @item -ffunction-sections
5616 @itemx -fdata-sections
5617 @opindex ffunction-sections
5618 @opindex fdata-sections
5619 Place each function or data item into its own section in the output
5620 file if the target supports arbitrary sections.  The name of the
5621 function or the name of the data item determines the section's name
5622 in the output file.
5624 Use these options on systems where the linker can perform optimizations
5625 to improve locality of reference in the instruction space.  Most systems
5626 using the ELF object format and SPARC processors running Solaris 2 have
5627 linkers with such optimizations.  AIX may have these optimizations in
5628 the future.
5630 Only use these options when there are significant benefits from doing
5631 so.  When you specify these options, the assembler and linker will
5632 create larger object and executable files and will also be slower.
5633 You will not be able to use @code{gprof} on all systems if you
5634 specify this option and you may have problems with debugging if
5635 you specify both this option and @option{-g}.
5637 @item -fbranch-target-load-optimize
5638 @opindex fbranch-target-load-optimize
5639 Perform branch target register load optimization before prologue / epilogue
5640 threading.
5641 The use of target registers can typically be exposed only during reload,
5642 thus hoisting loads out of loops and doing inter-block scheduling needs
5643 a separate optimization pass.
5645 @item -fbranch-target-load-optimize2
5646 @opindex fbranch-target-load-optimize2
5647 Perform branch target register load optimization after prologue / epilogue
5648 threading.
5650 @item -fbtr-bb-exclusive
5651 @opindex fbtr-bb-exclusive
5652 When performing branch target register load optimization, don't reuse
5653 branch target registers in within any basic block.
5655 @item -fstack-protector
5656 Emit extra code to check for buffer overflows, such as stack smashing
5657 attacks.  This is done by adding a guard variable to functions with
5658 vulnerable objects.  This includes functions that call alloca, and
5659 functions with buffers larger than 8 bytes.  The guards are initialized
5660 when a function is entered and then checked when the function exits.
5661 If a guard check fails, an error message is printed and the program exits.
5663 @item -fstack-protector-all
5664 Like @option{-fstack-protector} except that all functions are protected.
5666 @item --param @var{name}=@var{value}
5667 @opindex param
5668 In some places, GCC uses various constants to control the amount of
5669 optimization that is done.  For example, GCC will not inline functions
5670 that contain more that a certain number of instructions.  You can
5671 control some of these constants on the command-line using the
5672 @option{--param} option.
5674 The names of specific parameters, and the meaning of the values, are
5675 tied to the internals of the compiler, and are subject to change
5676 without notice in future releases.
5678 In each case, the @var{value} is an integer.  The allowable choices for
5679 @var{name} are given in the following table:
5681 @table @gcctabopt
5682 @item salias-max-implicit-fields
5683 The maximum number of fields in a variable without direct
5684 structure accesses for which structure aliasing will consider trying 
5685 to track each field.  The default is 5
5687 @item sra-max-structure-size
5688 The maximum structure size, in bytes, at which the scalar replacement
5689 of aggregates (SRA) optimization will perform block copies.  The
5690 default value, 0, implies that GCC will select the most appropriate
5691 size itself.
5693 @item sra-field-structure-ratio
5694 The threshold ratio (as a percentage) between instantiated fields and
5695 the complete structure size.  We say that if the ratio of the number
5696 of bytes in instantiated fields to the number of bytes in the complete
5697 structure exceeds this parameter, then block copies are not used.  The
5698 default is 75.
5700 @item max-crossjump-edges
5701 The maximum number of incoming edges to consider for crossjumping.
5702 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5703 the number of edges incoming to each block.  Increasing values mean
5704 more aggressive optimization, making the compile time increase with
5705 probably small improvement in executable size.
5707 @item min-crossjump-insns
5708 The minimum number of instructions which must be matched at the end
5709 of two blocks before crossjumping will be performed on them.  This
5710 value is ignored in the case where all instructions in the block being
5711 crossjumped from are matched.  The default value is 5.
5713 @item max-goto-duplication-insns
5714 The maximum number of instructions to duplicate to a block that jumps
5715 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5716 passes, GCC factors computed gotos early in the compilation process,
5717 and unfactors them as late as possible.  Only computed jumps at the
5718 end of a basic blocks with no more than max-goto-duplication-insns are
5719 unfactored.  The default value is 8.
5721 @item max-delay-slot-insn-search
5722 The maximum number of instructions to consider when looking for an
5723 instruction to fill a delay slot.  If more than this arbitrary number of
5724 instructions is searched, the time savings from filling the delay slot
5725 will be minimal so stop searching.  Increasing values mean more
5726 aggressive optimization, making the compile time increase with probably
5727 small improvement in executable run time.
5729 @item max-delay-slot-live-search
5730 When trying to fill delay slots, the maximum number of instructions to
5731 consider when searching for a block with valid live register
5732 information.  Increasing this arbitrarily chosen value means more
5733 aggressive optimization, increasing the compile time.  This parameter
5734 should be removed when the delay slot code is rewritten to maintain the
5735 control-flow graph.
5737 @item max-gcse-memory
5738 The approximate maximum amount of memory that will be allocated in
5739 order to perform the global common subexpression elimination
5740 optimization.  If more memory than specified is required, the
5741 optimization will not be done.
5743 @item max-gcse-passes
5744 The maximum number of passes of GCSE to run.  The default is 1.
5746 @item max-pending-list-length
5747 The maximum number of pending dependencies scheduling will allow
5748 before flushing the current state and starting over.  Large functions
5749 with few branches or calls can create excessively large lists which
5750 needlessly consume memory and resources.
5752 @item max-inline-insns-single
5753 Several parameters control the tree inliner used in gcc.
5754 This number sets the maximum number of instructions (counted in GCC's
5755 internal representation) in a single function that the tree inliner
5756 will consider for inlining.  This only affects functions declared
5757 inline and methods implemented in a class declaration (C++).
5758 The default value is 450.
5760 @item max-inline-insns-auto
5761 When you use @option{-finline-functions} (included in @option{-O3}),
5762 a lot of functions that would otherwise not be considered for inlining
5763 by the compiler will be investigated.  To those functions, a different
5764 (more restrictive) limit compared to functions declared inline can
5765 be applied.
5766 The default value is 90.
5768 @item large-function-insns
5769 The limit specifying really large functions.  For functions larger than this
5770 limit after inlining inlining is constrained by
5771 @option{--param large-function-growth}.  This parameter is useful primarily
5772 to avoid extreme compilation time caused by non-linear algorithms used by the
5773 backend.
5774 This parameter is ignored when @option{-funit-at-a-time} is not used.
5775 The default value is 2700.
5777 @item large-function-growth
5778 Specifies maximal growth of large function caused by inlining in percents.
5779 This parameter is ignored when @option{-funit-at-a-time} is not used.
5780 The default value is 100 which limits large function growth to 2.0 times
5781 the original size.
5783 @item inline-unit-growth
5784 Specifies maximal overall growth of the compilation unit caused by inlining.
5785 This parameter is ignored when @option{-funit-at-a-time} is not used.
5786 The default value is 50 which limits unit growth to 1.5 times the original
5787 size.
5789 @item max-inline-insns-recursive
5790 @itemx max-inline-insns-recursive-auto
5791 Specifies maximum number of instructions out-of-line copy of self recursive inline
5792 function can grow into by performing recursive inlining.
5794 For functions declared inline @option{--param max-inline-insns-recursive} is
5795 taken into acount.  For function not declared inline, recursive inlining
5796 happens only when @option{-finline-functions} (included in @option{-O3}) is
5797 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5798 default value is 450.
5800 @item max-inline-recursive-depth
5801 @itemx max-inline-recursive-depth-auto
5802 Specifies maximum recursion depth used by the recursive inlining.
5804 For functions declared inline @option{--param max-inline-recursive-depth} is
5805 taken into acount.  For function not declared inline, recursive inlining
5806 happens only when @option{-finline-functions} (included in @option{-O3}) is
5807 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5808 default value is 450.
5810 @item min-inline-recursive-probability
5811 Recursive inlining is profitable only for function having deep recursion
5812 in average and can hurt for function having little recursion depth by
5813 increasing the prologue size or complexity of function body to other
5814 optimizers.
5816 When profile feedback is available (see @option{-fprofile-generate}) the actual
5817 recursion depth can be guessed from probability that function will recurse via
5818 given call expression.  This parameter limits inlining only to call expression
5819 whose probability exceeds given threshold (in percents).  The default value is
5822 @item inline-call-cost
5823 Specify cost of call instruction relative to simple arithmetics operations
5824 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5825 functions and at the same time increases size of leaf function that is believed to
5826 reduce function size by being inlined.  In effect it increases amount of
5827 inlining for code having large abstraction penalty (many functions that just
5828 pass the arguments to other functions) and decrease inlining for code with low
5829 abstraction penalty.  The default value is 16.
5831 @item max-unrolled-insns
5832 The maximum number of instructions that a loop should have if that loop
5833 is unrolled, and if the loop is unrolled, it determines how many times
5834 the loop code is unrolled.
5836 @item max-average-unrolled-insns
5837 The maximum number of instructions biased by probabilities of their execution
5838 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5839 it determines how many times the loop code is unrolled.
5841 @item max-unroll-times
5842 The maximum number of unrollings of a single loop.
5844 @item max-peeled-insns
5845 The maximum number of instructions that a loop should have if that loop
5846 is peeled, and if the loop is peeled, it determines how many times
5847 the loop code is peeled.
5849 @item max-peel-times
5850 The maximum number of peelings of a single loop.
5852 @item max-completely-peeled-insns
5853 The maximum number of insns of a completely peeled loop.
5855 @item max-completely-peel-times
5856 The maximum number of iterations of a loop to be suitable for complete peeling.
5858 @item max-unswitch-insns
5859 The maximum number of insns of an unswitched loop.
5861 @item max-unswitch-level
5862 The maximum number of branches unswitched in a single loop.
5864 @item lim-expensive
5865 The minimum cost of an expensive expression in the loop invariant motion.
5867 @item iv-consider-all-candidates-bound
5868 Bound on number of candidates for induction variables below that
5869 all candidates are considered for each use in induction variable
5870 optimizations.  Only the most relevant candidates are considered
5871 if there are more candidates, to avoid quadratic time complexity.
5873 @item iv-max-considered-uses
5874 The induction variable optimizations give up on loops that contain more
5875 induction variable uses.
5877 @item iv-always-prune-cand-set-bound
5878 If number of candidates in the set is smaller than this value,
5879 we always try to remove unnecessary ivs from the set during its
5880 optimization when a new iv is added to the set.
5882 @item scev-max-expr-size
5883 Bound on size of expressions used in the scalar evolutions analyzer.
5884 Large expressions slow the analyzer.
5886 @item max-iterations-to-track
5888 The maximum number of iterations of a loop the brute force algorithm
5889 for analysis of # of iterations of the loop tries to evaluate.
5891 @item hot-bb-count-fraction
5892 Select fraction of the maximal count of repetitions of basic block in program
5893 given basic block needs to have to be considered hot.
5895 @item hot-bb-frequency-fraction
5896 Select fraction of the maximal frequency of executions of basic block in
5897 function given basic block needs to have to be considered hot
5899 @item tracer-dynamic-coverage
5900 @itemx tracer-dynamic-coverage-feedback
5902 This value is used to limit superblock formation once the given percentage of
5903 executed instructions is covered.  This limits unnecessary code size
5904 expansion.
5906 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5907 feedback is available.  The real profiles (as opposed to statically estimated
5908 ones) are much less balanced allowing the threshold to be larger value.
5910 @item tracer-max-code-growth
5911 Stop tail duplication once code growth has reached given percentage.  This is
5912 rather hokey argument, as most of the duplicates will be eliminated later in
5913 cross jumping, so it may be set to much higher values than is the desired code
5914 growth.
5916 @item tracer-min-branch-ratio
5918 Stop reverse growth when the reverse probability of best edge is less than this
5919 threshold (in percent).
5921 @item tracer-min-branch-ratio
5922 @itemx tracer-min-branch-ratio-feedback
5924 Stop forward growth if the best edge do have probability lower than this
5925 threshold.
5927 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5928 compilation for profile feedback and one for compilation without.  The value
5929 for compilation with profile feedback needs to be more conservative (higher) in
5930 order to make tracer effective.
5932 @item max-cse-path-length
5934 Maximum number of basic blocks on path that cse considers.  The default is 10.
5936 @item global-var-threshold
5938 Counts the number of function calls (@var{n}) and the number of
5939 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5940 single artificial variable will be created to represent all the
5941 call-clobbered variables at function call sites.  This artificial
5942 variable will then be made to alias every call-clobbered variable.
5943 (done as @code{int * size_t} on the host machine; beware overflow).
5945 @item max-aliased-vops
5947 Maximum number of virtual operands allowed to represent aliases
5948 before triggering the alias grouping heuristic.  Alias grouping
5949 reduces compile times and memory consumption needed for aliasing at
5950 the expense of precision loss in alias information.
5952 @item ggc-min-expand
5954 GCC uses a garbage collector to manage its own memory allocation.  This
5955 parameter specifies the minimum percentage by which the garbage
5956 collector's heap should be allowed to expand between collections.
5957 Tuning this may improve compilation speed; it has no effect on code
5958 generation.
5960 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5961 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5962 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5963 GCC is not able to calculate RAM on a particular platform, the lower
5964 bound of 30% is used.  Setting this parameter and
5965 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5966 every opportunity.  This is extremely slow, but can be useful for
5967 debugging.
5969 @item ggc-min-heapsize
5971 Minimum size of the garbage collector's heap before it begins bothering
5972 to collect garbage.  The first collection occurs after the heap expands
5973 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5974 tuning this may improve compilation speed, and has no effect on code
5975 generation.
5977 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5978 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5979 with a lower bound of 4096 (four megabytes) and an upper bound of
5980 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5981 particular platform, the lower bound is used.  Setting this parameter
5982 very large effectively disables garbage collection.  Setting this
5983 parameter and @option{ggc-min-expand} to zero causes a full collection
5984 to occur at every opportunity.
5986 @item max-reload-search-insns
5987 The maximum number of instruction reload should look backward for equivalent
5988 register.  Increasing values mean more aggressive optimization, making the
5989 compile time increase with probably slightly better performance.  The default
5990 value is 100.
5992 @item max-cselib-memory-location
5993 The maximum number of memory locations cselib should take into acount.
5994 Increasing values mean more aggressive optimization, making the compile time
5995 increase with probably slightly better performance.  The default value is 500.
5997 @item reorder-blocks-duplicate
5998 @itemx reorder-blocks-duplicate-feedback
6000 Used by basic block reordering pass to decide whether to use unconditional
6001 branch or duplicate the code on its destination.  Code is duplicated when its
6002 estimated size is smaller than this value multiplied by the estimated size of
6003 unconditional jump in the hot spots of the program.
6005 The @option{reorder-block-duplicate-feedback} is used only when profile
6006 feedback is available and may be set to higher values than
6007 @option{reorder-block-duplicate} since information about the hot spots is more
6008 accurate.
6010 @item max-sched-region-blocks
6011 The maximum number of blocks in a region to be considered for
6012 interblock scheduling.  The default value is 10.
6014 @item max-sched-region-insns
6015 The maximum number of insns in a region to be considered for
6016 interblock scheduling.  The default value is 100.
6018 @item min-sched-prob
6019 The minimum probability of reaching a source block for interblock
6020 speculative scheduling.  The default value is 40.
6022 @item max-last-value-rtl
6024 The maximum size measured as number of RTLs that can be recorded in an expression
6025 in combiner for a pseudo register as last known value of that register.  The default
6026 is 10000.
6028 @item integer-share-limit
6029 Small integer constants can use a shared data structure, reducing the
6030 compiler's memory usage and increasing its speed.  This sets the maximum
6031 value of a shared integer constant's.  The default value is 256.
6033 @item min-virtual-mappings
6034 Specifies the minimum number of virtual mappings in the incremental
6035 SSA updater that should be registered to trigger the virtual mappings
6036 heuristic defined by virtual-mappings-ratio.  The default value is
6037 100.
6039 @item virtual-mappings-ratio
6040 If the number of virtual mappings is virtual-mappings-ratio bigger
6041 than the number of virtual symbols to be updated, then the incremental
6042 SSA updater switches to a full update for those symbols.  The default
6043 ratio is 3.
6045 @item ssp-buffer-size
6046 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6047 protection when @option{-fstack-protection} is used.
6049 @end table
6050 @end table
6052 @node Preprocessor Options
6053 @section Options Controlling the Preprocessor
6054 @cindex preprocessor options
6055 @cindex options, preprocessor
6057 These options control the C preprocessor, which is run on each C source
6058 file before actual compilation.
6060 If you use the @option{-E} option, nothing is done except preprocessing.
6061 Some of these options make sense only together with @option{-E} because
6062 they cause the preprocessor output to be unsuitable for actual
6063 compilation.
6065 @table @gcctabopt
6066 @opindex Wp
6067 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6068 and pass @var{option} directly through to the preprocessor.  If
6069 @var{option} contains commas, it is split into multiple options at the
6070 commas.  However, many options are modified, translated or interpreted
6071 by the compiler driver before being passed to the preprocessor, and
6072 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6073 interface is undocumented and subject to change, so whenever possible
6074 you should avoid using @option{-Wp} and let the driver handle the
6075 options instead.
6077 @item -Xpreprocessor @var{option}
6078 @opindex preprocessor
6079 Pass @var{option} as an option to the preprocessor.  You can use this to
6080 supply system-specific preprocessor options which GCC does not know how to
6081 recognize.
6083 If you want to pass an option that takes an argument, you must use
6084 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6085 @end table
6087 @include cppopts.texi
6089 @node Assembler Options
6090 @section Passing Options to the Assembler
6092 @c prevent bad page break with this line
6093 You can pass options to the assembler.
6095 @table @gcctabopt
6096 @item -Wa,@var{option}
6097 @opindex Wa
6098 Pass @var{option} as an option to the assembler.  If @var{option}
6099 contains commas, it is split into multiple options at the commas.
6101 @item -Xassembler @var{option}
6102 @opindex Xassembler
6103 Pass @var{option} as an option to the assembler.  You can use this to
6104 supply system-specific assembler options which GCC does not know how to
6105 recognize.
6107 If you want to pass an option that takes an argument, you must use
6108 @option{-Xassembler} twice, once for the option and once for the argument.
6110 @end table
6112 @node Link Options
6113 @section Options for Linking
6114 @cindex link options
6115 @cindex options, linking
6117 These options come into play when the compiler links object files into
6118 an executable output file.  They are meaningless if the compiler is
6119 not doing a link step.
6121 @table @gcctabopt
6122 @cindex file names
6123 @item @var{object-file-name}
6124 A file name that does not end in a special recognized suffix is
6125 considered to name an object file or library.  (Object files are
6126 distinguished from libraries by the linker according to the file
6127 contents.)  If linking is done, these object files are used as input
6128 to the linker.
6130 @item -c
6131 @itemx -S
6132 @itemx -E
6133 @opindex c
6134 @opindex S
6135 @opindex E
6136 If any of these options is used, then the linker is not run, and
6137 object file names should not be used as arguments.  @xref{Overall
6138 Options}.
6140 @cindex Libraries
6141 @item -l@var{library}
6142 @itemx -l @var{library}
6143 @opindex l
6144 Search the library named @var{library} when linking.  (The second
6145 alternative with the library as a separate argument is only for
6146 POSIX compliance and is not recommended.)
6148 It makes a difference where in the command you write this option; the
6149 linker searches and processes libraries and object files in the order they
6150 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6151 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6152 to functions in @samp{z}, those functions may not be loaded.
6154 The linker searches a standard list of directories for the library,
6155 which is actually a file named @file{lib@var{library}.a}.  The linker
6156 then uses this file as if it had been specified precisely by name.
6158 The directories searched include several standard system directories
6159 plus any that you specify with @option{-L}.
6161 Normally the files found this way are library files---archive files
6162 whose members are object files.  The linker handles an archive file by
6163 scanning through it for members which define symbols that have so far
6164 been referenced but not defined.  But if the file that is found is an
6165 ordinary object file, it is linked in the usual fashion.  The only
6166 difference between using an @option{-l} option and specifying a file name
6167 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6168 and searches several directories.
6170 @item -lobjc
6171 @opindex lobjc
6172 You need this special case of the @option{-l} option in order to
6173 link an Objective-C or Objective-C++ program.
6175 @item -nostartfiles
6176 @opindex nostartfiles
6177 Do not use the standard system startup files when linking.
6178 The standard system libraries are used normally, unless @option{-nostdlib}
6179 or @option{-nodefaultlibs} is used.
6181 @item -nodefaultlibs
6182 @opindex nodefaultlibs
6183 Do not use the standard system libraries when linking.
6184 Only the libraries you specify will be passed to the linker.
6185 The standard startup files are used normally, unless @option{-nostartfiles}
6186 is used.  The compiler may generate calls to @code{memcmp},
6187 @code{memset}, @code{memcpy} and @code{memmove}.
6188 These entries are usually resolved by entries in
6189 libc.  These entry points should be supplied through some other
6190 mechanism when this option is specified.
6192 @item -nostdlib
6193 @opindex nostdlib
6194 Do not use the standard system startup files or libraries when linking.
6195 No startup files and only the libraries you specify will be passed to
6196 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6197 @code{memcpy} and @code{memmove}.
6198 These entries are usually resolved by entries in
6199 libc.  These entry points should be supplied through some other
6200 mechanism when this option is specified.
6202 @cindex @option{-lgcc}, use with @option{-nostdlib}
6203 @cindex @option{-nostdlib} and unresolved references
6204 @cindex unresolved references and @option{-nostdlib}
6205 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6206 @cindex @option{-nodefaultlibs} and unresolved references
6207 @cindex unresolved references and @option{-nodefaultlibs}
6208 One of the standard libraries bypassed by @option{-nostdlib} and
6209 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6210 that GCC uses to overcome shortcomings of particular machines, or special
6211 needs for some languages.
6212 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6213 Collection (GCC) Internals},
6214 for more discussion of @file{libgcc.a}.)
6215 In most cases, you need @file{libgcc.a} even when you want to avoid
6216 other standard libraries.  In other words, when you specify @option{-nostdlib}
6217 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6218 This ensures that you have no unresolved references to internal GCC
6219 library subroutines.  (For example, @samp{__main}, used to ensure C++
6220 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6221 GNU Compiler Collection (GCC) Internals}.)
6223 @item -pie
6224 @opindex pie
6225 Produce a position independent executable on targets which support it.
6226 For predictable results, you must also specify the same set of options
6227 that were used to generate code (@option{-fpie}, @option{-fPIE},
6228 or model suboptions) when you specify this option.
6230 @item -rdynamic
6231 @opindex rdynamic
6232 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6233 that support it. This instructs the linker to add all symbols, not
6234 only used ones, to the dynamic symbol table. This option is needed
6235 for some uses of @code{dlopen} or to allow obtaining backtraces
6236 from within a program.
6238 @item -s
6239 @opindex s
6240 Remove all symbol table and relocation information from the executable.
6242 @item -static
6243 @opindex static
6244 On systems that support dynamic linking, this prevents linking with the shared
6245 libraries.  On other systems, this option has no effect.
6247 @item -shared
6248 @opindex shared
6249 Produce a shared object which can then be linked with other objects to
6250 form an executable.  Not all systems support this option.  For predictable
6251 results, you must also specify the same set of options that were used to
6252 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6253 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6254 needs to build supplementary stub code for constructors to work.  On
6255 multi-libbed systems, @samp{gcc -shared} must select the correct support
6256 libraries to link against.  Failing to supply the correct flags may lead
6257 to subtle defects.  Supplying them in cases where they are not necessary
6258 is innocuous.}
6260 @item -shared-libgcc
6261 @itemx -static-libgcc
6262 @opindex shared-libgcc
6263 @opindex static-libgcc
6264 On systems that provide @file{libgcc} as a shared library, these options
6265 force the use of either the shared or static version respectively.
6266 If no shared version of @file{libgcc} was built when the compiler was
6267 configured, these options have no effect.
6269 There are several situations in which an application should use the
6270 shared @file{libgcc} instead of the static version.  The most common
6271 of these is when the application wishes to throw and catch exceptions
6272 across different shared libraries.  In that case, each of the libraries
6273 as well as the application itself should use the shared @file{libgcc}.
6275 Therefore, the G++ and GCJ drivers automatically add
6276 @option{-shared-libgcc} whenever you build a shared library or a main
6277 executable, because C++ and Java programs typically use exceptions, so
6278 this is the right thing to do.
6280 If, instead, you use the GCC driver to create shared libraries, you may
6281 find that they will not always be linked with the shared @file{libgcc}.
6282 If GCC finds, at its configuration time, that you have a non-GNU linker
6283 or a GNU linker that does not support option @option{--eh-frame-hdr},
6284 it will link the shared version of @file{libgcc} into shared libraries
6285 by default.  Otherwise, it will take advantage of the linker and optimize
6286 away the linking with the shared version of @file{libgcc}, linking with
6287 the static version of libgcc by default.  This allows exceptions to
6288 propagate through such shared libraries, without incurring relocation
6289 costs at library load time.
6291 However, if a library or main executable is supposed to throw or catch
6292 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6293 for the languages used in the program, or using the option
6294 @option{-shared-libgcc}, such that it is linked with the shared
6295 @file{libgcc}.
6297 @item -symbolic
6298 @opindex symbolic
6299 Bind references to global symbols when building a shared object.  Warn
6300 about any unresolved references (unless overridden by the link editor
6301 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6302 this option.
6304 @item -Xlinker @var{option}
6305 @opindex Xlinker
6306 Pass @var{option} as an option to the linker.  You can use this to
6307 supply system-specific linker options which GCC does not know how to
6308 recognize.
6310 If you want to pass an option that takes an argument, you must use
6311 @option{-Xlinker} twice, once for the option and once for the argument.
6312 For example, to pass @option{-assert definitions}, you must write
6313 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6314 @option{-Xlinker "-assert definitions"}, because this passes the entire
6315 string as a single argument, which is not what the linker expects.
6317 @item -Wl,@var{option}
6318 @opindex Wl
6319 Pass @var{option} as an option to the linker.  If @var{option} contains
6320 commas, it is split into multiple options at the commas.
6322 @item -u @var{symbol}
6323 @opindex u
6324 Pretend the symbol @var{symbol} is undefined, to force linking of
6325 library modules to define it.  You can use @option{-u} multiple times with
6326 different symbols to force loading of additional library modules.
6327 @end table
6329 @node Directory Options
6330 @section Options for Directory Search
6331 @cindex directory options
6332 @cindex options, directory search
6333 @cindex search path
6335 These options specify directories to search for header files, for
6336 libraries and for parts of the compiler:
6338 @table @gcctabopt
6339 @item -I@var{dir}
6340 @opindex I
6341 Add the directory @var{dir} to the head of the list of directories to be
6342 searched for header files.  This can be used to override a system header
6343 file, substituting your own version, since these directories are
6344 searched before the system header file directories.  However, you should
6345 not use this option to add directories that contain vendor-supplied
6346 system header files (use @option{-isystem} for that).  If you use more than
6347 one @option{-I} option, the directories are scanned in left-to-right
6348 order; the standard system directories come after.
6350 If a standard system include directory, or a directory specified with
6351 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6352 option will be ignored.  The directory will still be searched but as a
6353 system directory at its normal position in the system include chain.
6354 This is to ensure that GCC's procedure to fix buggy system headers and
6355 the ordering for the include_next directive are not inadvertently changed.
6356 If you really need to change the search order for system directories,
6357 use the @option{-nostdinc} and/or @option{-isystem} options.
6359 @item -iquote@var{dir}
6360 @opindex iquote
6361 Add the directory @var{dir} to the head of the list of directories to
6362 be searched for header files only for the case of @samp{#include
6363 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6364 otherwise just like @option{-I}.
6366 @item -L@var{dir}
6367 @opindex L
6368 Add directory @var{dir} to the list of directories to be searched
6369 for @option{-l}.
6371 @item -B@var{prefix}
6372 @opindex B
6373 This option specifies where to find the executables, libraries,
6374 include files, and data files of the compiler itself.
6376 The compiler driver program runs one or more of the subprograms
6377 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6378 @var{prefix} as a prefix for each program it tries to run, both with and
6379 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6381 For each subprogram to be run, the compiler driver first tries the
6382 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6383 was not specified, the driver tries two standard prefixes, which are
6384 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6385 those results in a file name that is found, the unmodified program
6386 name is searched for using the directories specified in your
6387 @env{PATH} environment variable.
6389 The compiler will check to see if the path provided by the @option{-B}
6390 refers to a directory, and if necessary it will add a directory
6391 separator character at the end of the path.
6393 @option{-B} prefixes that effectively specify directory names also apply
6394 to libraries in the linker, because the compiler translates these
6395 options into @option{-L} options for the linker.  They also apply to
6396 includes files in the preprocessor, because the compiler translates these
6397 options into @option{-isystem} options for the preprocessor.  In this case,
6398 the compiler appends @samp{include} to the prefix.
6400 The run-time support file @file{libgcc.a} can also be searched for using
6401 the @option{-B} prefix, if needed.  If it is not found there, the two
6402 standard prefixes above are tried, and that is all.  The file is left
6403 out of the link if it is not found by those means.
6405 Another way to specify a prefix much like the @option{-B} prefix is to use
6406 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6407 Variables}.
6409 As a special kludge, if the path provided by @option{-B} is
6410 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6411 9, then it will be replaced by @file{[dir/]include}.  This is to help
6412 with boot-strapping the compiler.
6414 @item -specs=@var{file}
6415 @opindex specs
6416 Process @var{file} after the compiler reads in the standard @file{specs}
6417 file, in order to override the defaults that the @file{gcc} driver
6418 program uses when determining what switches to pass to @file{cc1},
6419 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6420 @option{-specs=@var{file}} can be specified on the command line, and they
6421 are processed in order, from left to right.
6423 @item --sysroot=@var{dir}
6424 @opindex sysroot
6425 Use @var{dir} as the logical root directory for headers and libraries.
6426 For example, if the compiler would normally search for headers in
6427 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6428 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6430 If you use both this option and the @option{-isysroot} option, then
6431 the @option{--sysroot} option will apply to libraries, but the
6432 @option{-isysroot} option will apply to header files.
6434 The GNU linker (beginning with version 2.16) has the necessary support
6435 for this option.  If your linker does not support this option, the
6436 header file aspect of @option{--sysroot} will still work, but the
6437 library aspect will not.
6439 @item -I-
6440 @opindex I-
6441 This option has been deprecated.  Please use @option{-iquote} instead for
6442 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6443 Any directories you specify with @option{-I} options before the @option{-I-}
6444 option are searched only for the case of @samp{#include "@var{file}"};
6445 they are not searched for @samp{#include <@var{file}>}.
6447 If additional directories are specified with @option{-I} options after
6448 the @option{-I-}, these directories are searched for all @samp{#include}
6449 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6450 this way.)
6452 In addition, the @option{-I-} option inhibits the use of the current
6453 directory (where the current input file came from) as the first search
6454 directory for @samp{#include "@var{file}"}.  There is no way to
6455 override this effect of @option{-I-}.  With @option{-I.} you can specify
6456 searching the directory which was current when the compiler was
6457 invoked.  That is not exactly the same as what the preprocessor does
6458 by default, but it is often satisfactory.
6460 @option{-I-} does not inhibit the use of the standard system directories
6461 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6462 independent.
6463 @end table
6465 @c man end
6467 @node Spec Files
6468 @section Specifying subprocesses and the switches to pass to them
6469 @cindex Spec Files
6471 @command{gcc} is a driver program.  It performs its job by invoking a
6472 sequence of other programs to do the work of compiling, assembling and
6473 linking.  GCC interprets its command-line parameters and uses these to
6474 deduce which programs it should invoke, and which command-line options
6475 it ought to place on their command lines.  This behavior is controlled
6476 by @dfn{spec strings}.  In most cases there is one spec string for each
6477 program that GCC can invoke, but a few programs have multiple spec
6478 strings to control their behavior.  The spec strings built into GCC can
6479 be overridden by using the @option{-specs=} command-line switch to specify
6480 a spec file.
6482 @dfn{Spec files} are plaintext files that are used to construct spec
6483 strings.  They consist of a sequence of directives separated by blank
6484 lines.  The type of directive is determined by the first non-whitespace
6485 character on the line and it can be one of the following:
6487 @table @code
6488 @item %@var{command}
6489 Issues a @var{command} to the spec file processor.  The commands that can
6490 appear here are:
6492 @table @code
6493 @item %include <@var{file}>
6494 @cindex %include
6495 Search for @var{file} and insert its text at the current point in the
6496 specs file.
6498 @item %include_noerr <@var{file}>
6499 @cindex %include_noerr
6500 Just like @samp{%include}, but do not generate an error message if the include
6501 file cannot be found.
6503 @item %rename @var{old_name} @var{new_name}
6504 @cindex %rename
6505 Rename the spec string @var{old_name} to @var{new_name}.
6507 @end table
6509 @item *[@var{spec_name}]:
6510 This tells the compiler to create, override or delete the named spec
6511 string.  All lines after this directive up to the next directive or
6512 blank line are considered to be the text for the spec string.  If this
6513 results in an empty string then the spec will be deleted.  (Or, if the
6514 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6515 does not currently exist a new spec will be created.  If the spec does
6516 exist then its contents will be overridden by the text of this
6517 directive, unless the first character of that text is the @samp{+}
6518 character, in which case the text will be appended to the spec.
6520 @item [@var{suffix}]:
6521 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6522 and up to the next directive or blank line are considered to make up the
6523 spec string for the indicated suffix.  When the compiler encounters an
6524 input file with the named suffix, it will processes the spec string in
6525 order to work out how to compile that file.  For example:
6527 @smallexample
6528 .ZZ:
6529 z-compile -input %i
6530 @end smallexample
6532 This says that any input file whose name ends in @samp{.ZZ} should be
6533 passed to the program @samp{z-compile}, which should be invoked with the
6534 command-line switch @option{-input} and with the result of performing the
6535 @samp{%i} substitution.  (See below.)
6537 As an alternative to providing a spec string, the text that follows a
6538 suffix directive can be one of the following:
6540 @table @code
6541 @item @@@var{language}
6542 This says that the suffix is an alias for a known @var{language}.  This is
6543 similar to using the @option{-x} command-line switch to GCC to specify a
6544 language explicitly.  For example:
6546 @smallexample
6547 .ZZ:
6548 @@c++
6549 @end smallexample
6551 Says that .ZZ files are, in fact, C++ source files.
6553 @item #@var{name}
6554 This causes an error messages saying:
6556 @smallexample
6557 @var{name} compiler not installed on this system.
6558 @end smallexample
6559 @end table
6561 GCC already has an extensive list of suffixes built into it.
6562 This directive will add an entry to the end of the list of suffixes, but
6563 since the list is searched from the end backwards, it is effectively
6564 possible to override earlier entries using this technique.
6566 @end table
6568 GCC has the following spec strings built into it.  Spec files can
6569 override these strings or create their own.  Note that individual
6570 targets can also add their own spec strings to this list.
6572 @smallexample
6573 asm          Options to pass to the assembler
6574 asm_final    Options to pass to the assembler post-processor
6575 cpp          Options to pass to the C preprocessor
6576 cc1          Options to pass to the C compiler
6577 cc1plus      Options to pass to the C++ compiler
6578 endfile      Object files to include at the end of the link
6579 link         Options to pass to the linker
6580 lib          Libraries to include on the command line to the linker
6581 libgcc       Decides which GCC support library to pass to the linker
6582 linker       Sets the name of the linker
6583 predefines   Defines to be passed to the C preprocessor
6584 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6585              by default
6586 startfile    Object files to include at the start of the link
6587 @end smallexample
6589 Here is a small example of a spec file:
6591 @smallexample
6592 %rename lib                 old_lib
6594 *lib:
6595 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6596 @end smallexample
6598 This example renames the spec called @samp{lib} to @samp{old_lib} and
6599 then overrides the previous definition of @samp{lib} with a new one.
6600 The new definition adds in some extra command-line options before
6601 including the text of the old definition.
6603 @dfn{Spec strings} are a list of command-line options to be passed to their
6604 corresponding program.  In addition, the spec strings can contain
6605 @samp{%}-prefixed sequences to substitute variable text or to
6606 conditionally insert text into the command line.  Using these constructs
6607 it is possible to generate quite complex command lines.
6609 Here is a table of all defined @samp{%}-sequences for spec
6610 strings.  Note that spaces are not generated automatically around the
6611 results of expanding these sequences.  Therefore you can concatenate them
6612 together or combine them with constant text in a single argument.
6614 @table @code
6615 @item %%
6616 Substitute one @samp{%} into the program name or argument.
6618 @item %i
6619 Substitute the name of the input file being processed.
6621 @item %b
6622 Substitute the basename of the input file being processed.
6623 This is the substring up to (and not including) the last period
6624 and not including the directory.
6626 @item %B
6627 This is the same as @samp{%b}, but include the file suffix (text after
6628 the last period).
6630 @item %d
6631 Marks the argument containing or following the @samp{%d} as a
6632 temporary file name, so that that file will be deleted if GCC exits
6633 successfully.  Unlike @samp{%g}, this contributes no text to the
6634 argument.
6636 @item %g@var{suffix}
6637 Substitute a file name that has suffix @var{suffix} and is chosen
6638 once per compilation, and mark the argument in the same way as
6639 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6640 name is now chosen in a way that is hard to predict even when previously
6641 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6642 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6643 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6644 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6645 was simply substituted with a file name chosen once per compilation,
6646 without regard to any appended suffix (which was therefore treated
6647 just like ordinary text), making such attacks more likely to succeed.
6649 @item %u@var{suffix}
6650 Like @samp{%g}, but generates a new temporary file name even if
6651 @samp{%u@var{suffix}} was already seen.
6653 @item %U@var{suffix}
6654 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6655 new one if there is no such last file name.  In the absence of any
6656 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6657 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6658 would involve the generation of two distinct file names, one
6659 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6660 simply substituted with a file name chosen for the previous @samp{%u},
6661 without regard to any appended suffix.
6663 @item %j@var{suffix}
6664 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6665 writable, and if save-temps is off; otherwise, substitute the name
6666 of a temporary file, just like @samp{%u}.  This temporary file is not
6667 meant for communication between processes, but rather as a junk
6668 disposal mechanism.
6670 @item %|@var{suffix}
6671 @itemx %m@var{suffix}
6672 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6673 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6674 all.  These are the two most common ways to instruct a program that it
6675 should read from standard input or write to standard output.  If you
6676 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6677 construct: see for example @file{f/lang-specs.h}.
6679 @item %.@var{SUFFIX}
6680 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6681 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6682 terminated by the next space or %.
6684 @item %w
6685 Marks the argument containing or following the @samp{%w} as the
6686 designated output file of this compilation.  This puts the argument
6687 into the sequence of arguments that @samp{%o} will substitute later.
6689 @item %o
6690 Substitutes the names of all the output files, with spaces
6691 automatically placed around them.  You should write spaces
6692 around the @samp{%o} as well or the results are undefined.
6693 @samp{%o} is for use in the specs for running the linker.
6694 Input files whose names have no recognized suffix are not compiled
6695 at all, but they are included among the output files, so they will
6696 be linked.
6698 @item %O
6699 Substitutes the suffix for object files.  Note that this is
6700 handled specially when it immediately follows @samp{%g, %u, or %U},
6701 because of the need for those to form complete file names.  The
6702 handling is such that @samp{%O} is treated exactly as if it had already
6703 been substituted, except that @samp{%g, %u, and %U} do not currently
6704 support additional @var{suffix} characters following @samp{%O} as they would
6705 following, for example, @samp{.o}.
6707 @item %p
6708 Substitutes the standard macro predefinitions for the
6709 current target machine.  Use this when running @code{cpp}.
6711 @item %P
6712 Like @samp{%p}, but puts @samp{__} before and after the name of each
6713 predefined macro, except for macros that start with @samp{__} or with
6714 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6717 @item %I
6718 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6719 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6720 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6721 as necessary.
6723 @item %s
6724 Current argument is the name of a library or startup file of some sort.
6725 Search for that file in a standard list of directories and substitute
6726 the full name found.
6728 @item %e@var{str}
6729 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6730 Use this when inconsistent options are detected.
6732 @item %(@var{name})
6733 Substitute the contents of spec string @var{name} at this point.
6735 @item %[@var{name}]
6736 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6738 @item %x@{@var{option}@}
6739 Accumulate an option for @samp{%X}.
6741 @item %X
6742 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6743 spec string.
6745 @item %Y
6746 Output the accumulated assembler options specified by @option{-Wa}.
6748 @item %Z
6749 Output the accumulated preprocessor options specified by @option{-Wp}.
6751 @item %a
6752 Process the @code{asm} spec.  This is used to compute the
6753 switches to be passed to the assembler.
6755 @item %A
6756 Process the @code{asm_final} spec.  This is a spec string for
6757 passing switches to an assembler post-processor, if such a program is
6758 needed.
6760 @item %l
6761 Process the @code{link} spec.  This is the spec for computing the
6762 command line passed to the linker.  Typically it will make use of the
6763 @samp{%L %G %S %D and %E} sequences.
6765 @item %D
6766 Dump out a @option{-L} option for each directory that GCC believes might
6767 contain startup files.  If the target supports multilibs then the
6768 current multilib directory will be prepended to each of these paths.
6770 @item %L
6771 Process the @code{lib} spec.  This is a spec string for deciding which
6772 libraries should be included on the command line to the linker.
6774 @item %G
6775 Process the @code{libgcc} spec.  This is a spec string for deciding
6776 which GCC support library should be included on the command line to the linker.
6778 @item %S
6779 Process the @code{startfile} spec.  This is a spec for deciding which
6780 object files should be the first ones passed to the linker.  Typically
6781 this might be a file named @file{crt0.o}.
6783 @item %E
6784 Process the @code{endfile} spec.  This is a spec string that specifies
6785 the last object files that will be passed to the linker.
6787 @item %C
6788 Process the @code{cpp} spec.  This is used to construct the arguments
6789 to be passed to the C preprocessor.
6791 @item %1
6792 Process the @code{cc1} spec.  This is used to construct the options to be
6793 passed to the actual C compiler (@samp{cc1}).
6795 @item %2
6796 Process the @code{cc1plus} spec.  This is used to construct the options to be
6797 passed to the actual C++ compiler (@samp{cc1plus}).
6799 @item %*
6800 Substitute the variable part of a matched option.  See below.
6801 Note that each comma in the substituted string is replaced by
6802 a single space.
6804 @item %<@code{S}
6805 Remove all occurrences of @code{-S} from the command line.  Note---this
6806 command is position dependent.  @samp{%} commands in the spec string
6807 before this one will see @code{-S}, @samp{%} commands in the spec string
6808 after this one will not.
6810 @item %:@var{function}(@var{args})
6811 Call the named function @var{function}, passing it @var{args}.
6812 @var{args} is first processed as a nested spec string, then split
6813 into an argument vector in the usual fashion.  The function returns
6814 a string which is processed as if it had appeared literally as part
6815 of the current spec.
6817 The following built-in spec functions are provided:
6819 @table @code
6820 @item @code{if-exists}
6821 The @code{if-exists} spec function takes one argument, an absolute
6822 pathname to a file.  If the file exists, @code{if-exists} returns the
6823 pathname.  Here is a small example of its usage:
6825 @smallexample
6826 *startfile:
6827 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6828 @end smallexample
6830 @item @code{if-exists-else}
6831 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6832 spec function, except that it takes two arguments.  The first argument is
6833 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6834 returns the pathname.  If it does not exist, it returns the second argument.
6835 This way, @code{if-exists-else} can be used to select one file or another,
6836 based on the existence of the first.  Here is a small example of its usage:
6838 @smallexample
6839 *startfile:
6840 crt0%O%s %:if-exists(crti%O%s) \
6841 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6842 @end smallexample
6844 @item @code{replace-outfile}
6845 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6846 first argument in the outfiles array and replaces it with the second argument.  Here
6847 is a small example of its usage:
6849 @smallexample
6850 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6851 @end smallexample
6853 @end table
6855 @item %@{@code{S}@}
6856 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6857 If that switch was not specified, this substitutes nothing.  Note that
6858 the leading dash is omitted when specifying this option, and it is
6859 automatically inserted if the substitution is performed.  Thus the spec
6860 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6861 and would output the command line option @option{-foo}.
6863 @item %W@{@code{S}@}
6864 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6865 deleted on failure.
6867 @item %@{@code{S}*@}
6868 Substitutes all the switches specified to GCC whose names start
6869 with @code{-S}, but which also take an argument.  This is used for
6870 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6871 GCC considers @option{-o foo} as being
6872 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6873 text, including the space.  Thus two arguments would be generated.
6875 @item %@{@code{S}*&@code{T}*@}
6876 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6877 (the order of @code{S} and @code{T} in the spec is not significant).
6878 There can be any number of ampersand-separated variables; for each the
6879 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6881 @item %@{@code{S}:@code{X}@}
6882 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6884 @item %@{!@code{S}:@code{X}@}
6885 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6887 @item %@{@code{S}*:@code{X}@}
6888 Substitutes @code{X} if one or more switches whose names start with
6889 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6890 once, no matter how many such switches appeared.  However, if @code{%*}
6891 appears somewhere in @code{X}, then @code{X} will be substituted once
6892 for each matching switch, with the @code{%*} replaced by the part of
6893 that switch that matched the @code{*}.
6895 @item %@{.@code{S}:@code{X}@}
6896 Substitutes @code{X}, if processing a file with suffix @code{S}.
6898 @item %@{!.@code{S}:@code{X}@}
6899 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6901 @item %@{@code{S}|@code{P}:@code{X}@}
6902 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6903 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6904 although they have a stronger binding than the @samp{|}.  If @code{%*}
6905 appears in @code{X}, all of the alternatives must be starred, and only
6906 the first matching alternative is substituted.
6908 For example, a spec string like this:
6910 @smallexample
6911 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6912 @end smallexample
6914 will output the following command-line options from the following input
6915 command-line options:
6917 @smallexample
6918 fred.c        -foo -baz
6919 jim.d         -bar -boggle
6920 -d fred.c     -foo -baz -boggle
6921 -d jim.d      -bar -baz -boggle
6922 @end smallexample
6924 @item %@{S:X; T:Y; :D@}
6926 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6927 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6928 be as many clauses as you need.  This may be combined with @code{.},
6929 @code{!}, @code{|}, and @code{*} as needed.
6932 @end table
6934 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6935 construct may contain other nested @samp{%} constructs or spaces, or
6936 even newlines.  They are processed as usual, as described above.
6937 Trailing white space in @code{X} is ignored.  White space may also
6938 appear anywhere on the left side of the colon in these constructs,
6939 except between @code{.} or @code{*} and the corresponding word.
6941 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6942 handled specifically in these constructs.  If another value of
6943 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6944 @option{-W} switch is found later in the command line, the earlier
6945 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6946 just one letter, which passes all matching options.
6948 The character @samp{|} at the beginning of the predicate text is used to
6949 indicate that a command should be piped to the following command, but
6950 only if @option{-pipe} is specified.
6952 It is built into GCC which switches take arguments and which do not.
6953 (You might think it would be useful to generalize this to allow each
6954 compiler's spec to say which switches take arguments.  But this cannot
6955 be done in a consistent fashion.  GCC cannot even decide which input
6956 files have been specified without knowing which switches take arguments,
6957 and it must know which input files to compile in order to tell which
6958 compilers to run).
6960 GCC also knows implicitly that arguments starting in @option{-l} are to be
6961 treated as compiler output files, and passed to the linker in their
6962 proper position among the other output files.
6964 @c man begin OPTIONS
6966 @node Target Options
6967 @section Specifying Target Machine and Compiler Version
6968 @cindex target options
6969 @cindex cross compiling
6970 @cindex specifying machine version
6971 @cindex specifying compiler version and target machine
6972 @cindex compiler version, specifying
6973 @cindex target machine, specifying
6975 The usual way to run GCC is to run the executable called @file{gcc}, or
6976 @file{<machine>-gcc} when cross-compiling, or
6977 @file{<machine>-gcc-<version>} to run a version other than the one that
6978 was installed last.  Sometimes this is inconvenient, so GCC provides
6979 options that will switch to another cross-compiler or version.
6981 @table @gcctabopt
6982 @item -b @var{machine}
6983 @opindex b
6984 The argument @var{machine} specifies the target machine for compilation.
6986 The value to use for @var{machine} is the same as was specified as the
6987 machine type when configuring GCC as a cross-compiler.  For
6988 example, if a cross-compiler was configured with @samp{configure
6989 arm-elf}, meaning to compile for an arm processor with elf binaries,
6990 then you would specify @option{-b arm-elf} to run that cross compiler.
6991 Because there are other options beginning with @option{-b}, the
6992 configuration must contain a hyphen. 
6994 @item -V @var{version}
6995 @opindex V
6996 The argument @var{version} specifies which version of GCC to run.
6997 This is useful when multiple versions are installed.  For example,
6998 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
6999 @end table
7001 The @option{-V} and @option{-b} options work by running the
7002 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7003 use them if you can just run that directly.
7005 @node Submodel Options
7006 @section Hardware Models and Configurations
7007 @cindex submodel options
7008 @cindex specifying hardware config
7009 @cindex hardware models and configurations, specifying
7010 @cindex machine dependent options
7012 Earlier we discussed the standard option @option{-b} which chooses among
7013 different installed compilers for completely different target
7014 machines, such as VAX vs.@: 68000 vs.@: 80386.
7016 In addition, each of these target machine types can have its own
7017 special options, starting with @samp{-m}, to choose among various
7018 hardware models or configurations---for example, 68010 vs 68020,
7019 floating coprocessor or none.  A single installed version of the
7020 compiler can compile for any model or configuration, according to the
7021 options specified.
7023 Some configurations of the compiler also support additional special
7024 options, usually for compatibility with other compilers on the same
7025 platform.
7027 @c This list is ordered alphanumerically by subsection name.
7028 @c It should be the same order and spelling as these options are listed
7029 @c in Machine Dependent Options
7031 @menu
7032 * ARC Options::
7033 * ARM Options::
7034 * AVR Options::
7035 * Blackfin Options::
7036 * CRIS Options::
7037 * CRX Options::
7038 * Darwin Options::
7039 * DEC Alpha Options::
7040 * DEC Alpha/VMS Options::
7041 * FRV Options::
7042 * H8/300 Options::
7043 * HPPA Options::
7044 * i386 and x86-64 Options::
7045 * IA-64 Options::
7046 * M32C Options::
7047 * M32R/D Options::
7048 * M680x0 Options::
7049 * M68hc1x Options::
7050 * MCore Options::
7051 * MIPS Options::
7052 * MMIX Options::
7053 * MN10300 Options::
7054 * MS1 Options::
7055 * PDP-11 Options::
7056 * PowerPC Options::
7057 * RS/6000 and PowerPC Options::
7058 * S/390 and zSeries Options::
7059 * SH Options::
7060 * SPARC Options::
7061 * System V Options::
7062 * TMS320C3x/C4x Options::
7063 * V850 Options::
7064 * VAX Options::
7065 * x86-64 Options::
7066 * Xstormy16 Options::
7067 * Xtensa Options::
7068 * zSeries Options::
7069 @end menu
7071 @node ARC Options
7072 @subsection ARC Options
7073 @cindex ARC Options
7075 These options are defined for ARC implementations:
7077 @table @gcctabopt
7078 @item -EL
7079 @opindex EL
7080 Compile code for little endian mode.  This is the default.
7082 @item -EB
7083 @opindex EB
7084 Compile code for big endian mode.
7086 @item -mmangle-cpu
7087 @opindex mmangle-cpu
7088 Prepend the name of the cpu to all public symbol names.
7089 In multiple-processor systems, there are many ARC variants with different
7090 instruction and register set characteristics.  This flag prevents code
7091 compiled for one cpu to be linked with code compiled for another.
7092 No facility exists for handling variants that are ``almost identical''.
7093 This is an all or nothing option.
7095 @item -mcpu=@var{cpu}
7096 @opindex mcpu
7097 Compile code for ARC variant @var{cpu}.
7098 Which variants are supported depend on the configuration.
7099 All variants support @option{-mcpu=base}, this is the default.
7101 @item -mtext=@var{text-section}
7102 @itemx -mdata=@var{data-section}
7103 @itemx -mrodata=@var{readonly-data-section}
7104 @opindex mtext
7105 @opindex mdata
7106 @opindex mrodata
7107 Put functions, data, and readonly data in @var{text-section},
7108 @var{data-section}, and @var{readonly-data-section} respectively
7109 by default.  This can be overridden with the @code{section} attribute.
7110 @xref{Variable Attributes}.
7112 @end table
7114 @node ARM Options
7115 @subsection ARM Options
7116 @cindex ARM options
7118 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7119 architectures:
7121 @table @gcctabopt
7122 @item -mabi=@var{name}
7123 @opindex mabi
7124 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7125 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7127 @item -mapcs-frame
7128 @opindex mapcs-frame
7129 Generate a stack frame that is compliant with the ARM Procedure Call
7130 Standard for all functions, even if this is not strictly necessary for
7131 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7132 with this option will cause the stack frames not to be generated for
7133 leaf functions.  The default is @option{-mno-apcs-frame}.
7135 @item -mapcs
7136 @opindex mapcs
7137 This is a synonym for @option{-mapcs-frame}.
7139 @ignore
7140 @c not currently implemented
7141 @item -mapcs-stack-check
7142 @opindex mapcs-stack-check
7143 Generate code to check the amount of stack space available upon entry to
7144 every function (that actually uses some stack space).  If there is
7145 insufficient space available then either the function
7146 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7147 called, depending upon the amount of stack space required.  The run time
7148 system is required to provide these functions.  The default is
7149 @option{-mno-apcs-stack-check}, since this produces smaller code.
7151 @c not currently implemented
7152 @item -mapcs-float
7153 @opindex mapcs-float
7154 Pass floating point arguments using the float point registers.  This is
7155 one of the variants of the APCS@.  This option is recommended if the
7156 target hardware has a floating point unit or if a lot of floating point
7157 arithmetic is going to be performed by the code.  The default is
7158 @option{-mno-apcs-float}, since integer only code is slightly increased in
7159 size if @option{-mapcs-float} is used.
7161 @c not currently implemented
7162 @item -mapcs-reentrant
7163 @opindex mapcs-reentrant
7164 Generate reentrant, position independent code.  The default is
7165 @option{-mno-apcs-reentrant}.
7166 @end ignore
7168 @item -mthumb-interwork
7169 @opindex mthumb-interwork
7170 Generate code which supports calling between the ARM and Thumb
7171 instruction sets.  Without this option the two instruction sets cannot
7172 be reliably used inside one program.  The default is
7173 @option{-mno-thumb-interwork}, since slightly larger code is generated
7174 when @option{-mthumb-interwork} is specified.
7176 @item -mno-sched-prolog
7177 @opindex mno-sched-prolog
7178 Prevent the reordering of instructions in the function prolog, or the
7179 merging of those instruction with the instructions in the function's
7180 body.  This means that all functions will start with a recognizable set
7181 of instructions (or in fact one of a choice from a small set of
7182 different function prologues), and this information can be used to
7183 locate the start if functions inside an executable piece of code.  The
7184 default is @option{-msched-prolog}.
7186 @item -mhard-float
7187 @opindex mhard-float
7188 Generate output containing floating point instructions.  This is the
7189 default.
7191 @item -msoft-float
7192 @opindex msoft-float
7193 Generate output containing library calls for floating point.
7194 @strong{Warning:} the requisite libraries are not available for all ARM
7195 targets.  Normally the facilities of the machine's usual C compiler are
7196 used, but this cannot be done directly in cross-compilation.  You must make
7197 your own arrangements to provide suitable library functions for
7198 cross-compilation.
7200 @option{-msoft-float} changes the calling convention in the output file;
7201 therefore, it is only useful if you compile @emph{all} of a program with
7202 this option.  In particular, you need to compile @file{libgcc.a}, the
7203 library that comes with GCC, with @option{-msoft-float} in order for
7204 this to work.
7206 @item -mfloat-abi=@var{name}
7207 @opindex mfloat-abi
7208 Specifies which ABI to use for floating point values.  Permissible values
7209 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7211 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7212 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7213 of floating point instructions, but still uses the soft-float calling
7214 conventions.
7216 @item -mlittle-endian
7217 @opindex mlittle-endian
7218 Generate code for a processor running in little-endian mode.  This is
7219 the default for all standard configurations.
7221 @item -mbig-endian
7222 @opindex mbig-endian
7223 Generate code for a processor running in big-endian mode; the default is
7224 to compile code for a little-endian processor.
7226 @item -mwords-little-endian
7227 @opindex mwords-little-endian
7228 This option only applies when generating code for big-endian processors.
7229 Generate code for a little-endian word order but a big-endian byte
7230 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7231 option should only be used if you require compatibility with code for
7232 big-endian ARM processors generated by versions of the compiler prior to
7233 2.8.
7235 @item -mcpu=@var{name}
7236 @opindex mcpu
7237 This specifies the name of the target ARM processor.  GCC uses this name
7238 to determine what kind of instructions it can emit when generating
7239 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7240 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7241 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7242 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7243 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7244 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7245 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7246 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7247 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7248 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7249 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7250 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7251 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7252 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7253 @samp{ep9312}.
7255 @itemx -mtune=@var{name}
7256 @opindex mtune
7257 This option is very similar to the @option{-mcpu=} option, except that
7258 instead of specifying the actual target processor type, and hence
7259 restricting which instructions can be used, it specifies that GCC should
7260 tune the performance of the code as if the target were of the type
7261 specified in this option, but still choosing the instructions that it
7262 will generate based on the cpu specified by a @option{-mcpu=} option.
7263 For some ARM implementations better performance can be obtained by using
7264 this option.
7266 @item -march=@var{name}
7267 @opindex march
7268 This specifies the name of the target ARM architecture.  GCC uses this
7269 name to determine what kind of instructions it can emit when generating
7270 assembly code.  This option can be used in conjunction with or instead
7271 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7272 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7273 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7274 @samp{iwmmxt}, @samp{ep9312}.
7276 @item -mfpu=@var{name}
7277 @itemx -mfpe=@var{number}
7278 @itemx -mfp=@var{number}
7279 @opindex mfpu
7280 @opindex mfpe
7281 @opindex mfp
7282 This specifies what floating point hardware (or hardware emulation) is
7283 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7284 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7285 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7286 with older versions of GCC@.
7288 If @option{-msoft-float} is specified this specifies the format of
7289 floating point values.
7291 @item -mstructure-size-boundary=@var{n}
7292 @opindex mstructure-size-boundary
7293 The size of all structures and unions will be rounded up to a multiple
7294 of the number of bits set by this option.  Permissible values are 8, 32
7295 and 64.  The default value varies for different toolchains.  For the COFF
7296 targeted toolchain the default value is 8.  A value of 64 is only allowed
7297 if the underlying ABI supports it.
7299 Specifying the larger number can produce faster, more efficient code, but
7300 can also increase the size of the program.  Different values are potentially
7301 incompatible.  Code compiled with one value cannot necessarily expect to
7302 work with code or libraries compiled with another value, if they exchange
7303 information using structures or unions.
7305 @item -mabort-on-noreturn
7306 @opindex mabort-on-noreturn
7307 Generate a call to the function @code{abort} at the end of a
7308 @code{noreturn} function.  It will be executed if the function tries to
7309 return.
7311 @item -mlong-calls
7312 @itemx -mno-long-calls
7313 @opindex mlong-calls
7314 @opindex mno-long-calls
7315 Tells the compiler to perform function calls by first loading the
7316 address of the function into a register and then performing a subroutine
7317 call on this register.  This switch is needed if the target function
7318 will lie outside of the 64 megabyte addressing range of the offset based
7319 version of subroutine call instruction.
7321 Even if this switch is enabled, not all function calls will be turned
7322 into long calls.  The heuristic is that static functions, functions
7323 which have the @samp{short-call} attribute, functions that are inside
7324 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7325 definitions have already been compiled within the current compilation
7326 unit, will not be turned into long calls.  The exception to this rule is
7327 that weak function definitions, functions with the @samp{long-call}
7328 attribute or the @samp{section} attribute, and functions that are within
7329 the scope of a @samp{#pragma long_calls} directive, will always be
7330 turned into long calls.
7332 This feature is not enabled by default.  Specifying
7333 @option{-mno-long-calls} will restore the default behavior, as will
7334 placing the function calls within the scope of a @samp{#pragma
7335 long_calls_off} directive.  Note these switches have no effect on how
7336 the compiler generates code to handle function calls via function
7337 pointers.
7339 @item -mnop-fun-dllimport
7340 @opindex mnop-fun-dllimport
7341 Disable support for the @code{dllimport} attribute.
7343 @item -msingle-pic-base
7344 @opindex msingle-pic-base
7345 Treat the register used for PIC addressing as read-only, rather than
7346 loading it in the prologue for each function.  The run-time system is
7347 responsible for initializing this register with an appropriate value
7348 before execution begins.
7350 @item -mpic-register=@var{reg}
7351 @opindex mpic-register
7352 Specify the register to be used for PIC addressing.  The default is R10
7353 unless stack-checking is enabled, when R9 is used.
7355 @item -mcirrus-fix-invalid-insns
7356 @opindex mcirrus-fix-invalid-insns
7357 @opindex mno-cirrus-fix-invalid-insns
7358 Insert NOPs into the instruction stream to in order to work around
7359 problems with invalid Maverick instruction combinations.  This option
7360 is only valid if the @option{-mcpu=ep9312} option has been used to
7361 enable generation of instructions for the Cirrus Maverick floating
7362 point co-processor.  This option is not enabled by default, since the
7363 problem is only present in older Maverick implementations.  The default
7364 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7365 switch.
7367 @item -mpoke-function-name
7368 @opindex mpoke-function-name
7369 Write the name of each function into the text section, directly
7370 preceding the function prologue.  The generated code is similar to this:
7372 @smallexample
7373      t0
7374          .ascii "arm_poke_function_name", 0
7375          .align
7376      t1
7377          .word 0xff000000 + (t1 - t0)
7378      arm_poke_function_name
7379          mov     ip, sp
7380          stmfd   sp!, @{fp, ip, lr, pc@}
7381          sub     fp, ip, #4
7382 @end smallexample
7384 When performing a stack backtrace, code can inspect the value of
7385 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7386 location @code{pc - 12} and the top 8 bits are set, then we know that
7387 there is a function name embedded immediately preceding this location
7388 and has length @code{((pc[-3]) & 0xff000000)}.
7390 @item -mthumb
7391 @opindex mthumb
7392 Generate code for the 16-bit Thumb instruction set.  The default is to
7393 use the 32-bit ARM instruction set.
7395 @item -mtpcs-frame
7396 @opindex mtpcs-frame
7397 Generate a stack frame that is compliant with the Thumb Procedure Call
7398 Standard for all non-leaf functions.  (A leaf function is one that does
7399 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7401 @item -mtpcs-leaf-frame
7402 @opindex mtpcs-leaf-frame
7403 Generate a stack frame that is compliant with the Thumb Procedure Call
7404 Standard for all leaf functions.  (A leaf function is one that does
7405 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7407 @item -mcallee-super-interworking
7408 @opindex mcallee-super-interworking
7409 Gives all externally visible functions in the file being compiled an ARM
7410 instruction set header which switches to Thumb mode before executing the
7411 rest of the function.  This allows these functions to be called from
7412 non-interworking code.
7414 @item -mcaller-super-interworking
7415 @opindex mcaller-super-interworking
7416 Allows calls via function pointers (including virtual functions) to
7417 execute correctly regardless of whether the target code has been
7418 compiled for interworking or not.  There is a small overhead in the cost
7419 of executing a function pointer if this option is enabled.
7421 @end table
7423 @node AVR Options
7424 @subsection AVR Options
7425 @cindex AVR Options
7427 These options are defined for AVR implementations:
7429 @table @gcctabopt
7430 @item -mmcu=@var{mcu}
7431 @opindex mmcu
7432 Specify ATMEL AVR instruction set or MCU type.
7434 Instruction set avr1 is for the minimal AVR core, not supported by the C
7435 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7436 attiny11, attiny12, attiny15, attiny28).
7438 Instruction set avr2 (default) is for the classic AVR core with up to
7439 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7440 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7441 at90c8534, at90s8535).
7443 Instruction set avr3 is for the classic AVR core with up to 128K program
7444 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7446 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7447 memory space (MCU types: atmega8, atmega83, atmega85).
7449 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7450 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7451 atmega64, atmega128, at43usb355, at94k).
7453 @item -msize
7454 @opindex msize
7455 Output instruction sizes to the asm file.
7457 @item -minit-stack=@var{N}
7458 @opindex minit-stack
7459 Specify the initial stack address, which may be a symbol or numeric value,
7460 @samp{__stack} is the default.
7462 @item -mno-interrupts
7463 @opindex mno-interrupts
7464 Generated code is not compatible with hardware interrupts.
7465 Code size will be smaller.
7467 @item -mcall-prologues
7468 @opindex mcall-prologues
7469 Functions prologues/epilogues expanded as call to appropriate
7470 subroutines.  Code size will be smaller.
7472 @item -mno-tablejump
7473 @opindex mno-tablejump
7474 Do not generate tablejump insns which sometimes increase code size.
7476 @item -mtiny-stack
7477 @opindex mtiny-stack
7478 Change only the low 8 bits of the stack pointer.
7480 @item -mint8
7481 @opindex mint8
7482 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7483 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7484 and long long will be 4 bytes.  Please note that this option does not
7485 comply to the C standards, but it will provide you with smaller code
7486 size.
7487 @end table
7489 @node Blackfin Options
7490 @subsection Blackfin Options
7491 @cindex Blackfin Options
7493 @table @gcctabopt
7494 @item -momit-leaf-frame-pointer
7495 @opindex momit-leaf-frame-pointer
7496 Don't keep the frame pointer in a register for leaf functions.  This
7497 avoids the instructions to save, set up and restore frame pointers and
7498 makes an extra register available in leaf functions.  The option
7499 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7500 which might make debugging harder.
7502 @item -mspecld-anomaly
7503 @opindex mspecld-anomaly
7504 When enabled, the compiler will ensure that the generated code does not
7505 contain speculative loads after jump instructions.  This option is enabled
7506 by default.
7508 @item -mno-specld-anomaly
7509 @opindex mno-specld-anomaly
7510 Don't generate extra code to prevent speculative loads from occurring.
7512 @item -mcsync-anomaly
7513 @opindex mcsync-anomaly
7514 When enabled, the compiler will ensure that the generated code does not
7515 contain CSYNC or SSYNC instructions too soon after conditional branches.
7516 This option is enabled by default.
7518 @item -mno-csync-anomaly
7519 @opindex mno-csync-anomaly
7520 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7521 occurring too soon after a conditional branch.
7523 @item -mlow-64k
7524 @opindex mlow-64k
7525 When enabled, the compiler is free to take advantage of the knowledge that
7526 the entire program fits into the low 64k of memory.
7528 @item -mno-low-64k
7529 @opindex mno-low-64k
7530 Assume that the program is arbitrarily large.  This is the default.
7532 @item -mid-shared-library
7533 @opindex mid-shared-library
7534 Generate code that supports shared libraries via the library ID method.
7535 This allows for execute in place and shared libraries in an environment
7536 without virtual memory management.  This option implies @option{-fPIC}.
7538 @item -mno-id-shared-library
7539 @opindex mno-id-shared-library
7540 Generate code that doesn't assume ID based shared libraries are being used.
7541 This is the default.
7543 @item -mshared-library-id=n
7544 @opindex mshared-library-id
7545 Specified the identification number of the ID based shared library being
7546 compiled.  Specifying a value of 0 will generate more compact code, specifying
7547 other values will force the allocation of that number to the current
7548 library but is no more space or time efficient than omitting this option.
7550 @item -mlong-calls
7551 @itemx -mno-long-calls
7552 @opindex mlong-calls
7553 @opindex mno-long-calls
7554 Tells the compiler to perform function calls by first loading the
7555 address of the function into a register and then performing a subroutine
7556 call on this register.  This switch is needed if the target function
7557 will lie outside of the 24 bit addressing range of the offset based
7558 version of subroutine call instruction.
7560 This feature is not enabled by default.  Specifying
7561 @option{-mno-long-calls} will restore the default behavior.  Note these
7562 switches have no effect on how the compiler generates code to handle
7563 function calls via function pointers.
7564 @end table
7566 @node CRIS Options
7567 @subsection CRIS Options
7568 @cindex CRIS Options
7570 These options are defined specifically for the CRIS ports.
7572 @table @gcctabopt
7573 @item -march=@var{architecture-type}
7574 @itemx -mcpu=@var{architecture-type}
7575 @opindex march
7576 @opindex mcpu
7577 Generate code for the specified architecture.  The choices for
7578 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7579 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7580 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7581 @samp{v10}.
7583 @item -mtune=@var{architecture-type}
7584 @opindex mtune
7585 Tune to @var{architecture-type} everything applicable about the generated
7586 code, except for the ABI and the set of available instructions.  The
7587 choices for @var{architecture-type} are the same as for
7588 @option{-march=@var{architecture-type}}.
7590 @item -mmax-stack-frame=@var{n}
7591 @opindex mmax-stack-frame
7592 Warn when the stack frame of a function exceeds @var{n} bytes.
7594 @item -melinux-stacksize=@var{n}
7595 @opindex melinux-stacksize
7596 Only available with the @samp{cris-axis-aout} target.  Arranges for
7597 indications in the program to the kernel loader that the stack of the
7598 program should be set to @var{n} bytes.
7600 @item -metrax4
7601 @itemx -metrax100
7602 @opindex metrax4
7603 @opindex metrax100
7604 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7605 @option{-march=v3} and @option{-march=v8} respectively.
7607 @item -mmul-bug-workaround
7608 @itemx -mno-mul-bug-workaround
7609 @opindex mmul-bug-workaround
7610 @opindex mno-mul-bug-workaround
7611 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7612 models where it applies.  This option is active by default.
7614 @item -mpdebug
7615 @opindex mpdebug
7616 Enable CRIS-specific verbose debug-related information in the assembly
7617 code.  This option also has the effect to turn off the @samp{#NO_APP}
7618 formatted-code indicator to the assembler at the beginning of the
7619 assembly file.
7621 @item -mcc-init
7622 @opindex mcc-init
7623 Do not use condition-code results from previous instruction; always emit
7624 compare and test instructions before use of condition codes.
7626 @item -mno-side-effects
7627 @opindex mno-side-effects
7628 Do not emit instructions with side-effects in addressing modes other than
7629 post-increment.
7631 @item -mstack-align
7632 @itemx -mno-stack-align
7633 @itemx -mdata-align
7634 @itemx -mno-data-align
7635 @itemx -mconst-align
7636 @itemx -mno-const-align
7637 @opindex mstack-align
7638 @opindex mno-stack-align
7639 @opindex mdata-align
7640 @opindex mno-data-align
7641 @opindex mconst-align
7642 @opindex mno-const-align
7643 These options (no-options) arranges (eliminate arrangements) for the
7644 stack-frame, individual data and constants to be aligned for the maximum
7645 single data access size for the chosen CPU model.  The default is to
7646 arrange for 32-bit alignment.  ABI details such as structure layout are
7647 not affected by these options.
7649 @item -m32-bit
7650 @itemx -m16-bit
7651 @itemx -m8-bit
7652 @opindex m32-bit
7653 @opindex m16-bit
7654 @opindex m8-bit
7655 Similar to the stack- data- and const-align options above, these options
7656 arrange for stack-frame, writable data and constants to all be 32-bit,
7657 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7659 @item -mno-prologue-epilogue
7660 @itemx -mprologue-epilogue
7661 @opindex mno-prologue-epilogue
7662 @opindex mprologue-epilogue
7663 With @option{-mno-prologue-epilogue}, the normal function prologue and
7664 epilogue that sets up the stack-frame are omitted and no return
7665 instructions or return sequences are generated in the code.  Use this
7666 option only together with visual inspection of the compiled code: no
7667 warnings or errors are generated when call-saved registers must be saved,
7668 or storage for local variable needs to be allocated.
7670 @item -mno-gotplt
7671 @itemx -mgotplt
7672 @opindex mno-gotplt
7673 @opindex mgotplt
7674 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7675 instruction sequences that load addresses for functions from the PLT part
7676 of the GOT rather than (traditional on other architectures) calls to the
7677 PLT@.  The default is @option{-mgotplt}.
7679 @item -maout
7680 @opindex maout
7681 Legacy no-op option only recognized with the cris-axis-aout target.
7683 @item -melf
7684 @opindex melf
7685 Legacy no-op option only recognized with the cris-axis-elf and
7686 cris-axis-linux-gnu targets.
7688 @item -melinux
7689 @opindex melinux
7690 Only recognized with the cris-axis-aout target, where it selects a
7691 GNU/linux-like multilib, include files and instruction set for
7692 @option{-march=v8}.
7694 @item -mlinux
7695 @opindex mlinux
7696 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7698 @item -sim
7699 @opindex sim
7700 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7701 to link with input-output functions from a simulator library.  Code,
7702 initialized data and zero-initialized data are allocated consecutively.
7704 @item -sim2
7705 @opindex sim2
7706 Like @option{-sim}, but pass linker options to locate initialized data at
7707 0x40000000 and zero-initialized data at 0x80000000.
7708 @end table
7710 @node CRX Options
7711 @subsection CRX Options
7712 @cindex CRX Options
7714 These options are defined specifically for the CRX ports.
7716 @table @gcctabopt
7718 @item -mmac
7719 @opindex mmac
7720 Enable the use of multiply-accumulate instructions. Disabled by default.
7722 @item -mpush-args
7723 @opindex mpush-args
7724 Push instructions will be used to pass outgoing arguments when functions
7725 are called. Enabled by default.
7726 @end table
7728 @node Darwin Options
7729 @subsection Darwin Options
7730 @cindex Darwin options
7732 These options are defined for all architectures running the Darwin operating
7733 system.
7735 FSF GCC on Darwin does not create ``fat'' object files; it will create
7736 an object file for the single architecture that it was built to
7737 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7738 @option{-arch} options are used; it does so by running the compiler or
7739 linker multiple times and joining the results together with
7740 @file{lipo}.
7742 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7743 @samp{i686}) is determined by the flags that specify the ISA
7744 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7745 @option{-force_cpusubtype_ALL} option can be used to override this.
7747 The Darwin tools vary in their behavior when presented with an ISA
7748 mismatch.  The assembler, @file{as}, will only permit instructions to
7749 be used that are valid for the subtype of the file it is generating,
7750 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7751 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7752 and print an error if asked to create a shared library with a less
7753 restrictive subtype than its input files (for instance, trying to put
7754 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7755 for executables, @file{ld}, will quietly give the executable the most
7756 restrictive subtype of any of its input files.
7758 @table @gcctabopt
7759 @item -F@var{dir}
7760 @opindex F
7761 Add the framework directory @var{dir} to the head of the list of
7762 directories to be searched for header files.  These directories are
7763 interleaved with those specified by @option{-I} options and are
7764 scanned in a left-to-right order.
7766 A framework directory is a directory with frameworks in it.  A
7767 framework is a directory with a @samp{"Headers"} and/or
7768 @samp{"PrivateHeaders"} directory contained directly in it that ends
7769 in @samp{".framework"}.  The name of a framework is the name of this
7770 directory excluding the @samp{".framework"}.  Headers associated with
7771 the framework are found in one of those two directories, with
7772 @samp{"Headers"} being searched first.  A subframework is a framework
7773 directory that is in a framework's @samp{"Frameworks"} directory.
7774 Includes of subframework headers can only appear in a header of a
7775 framework that contains the subframework, or in a sibling subframework
7776 header.  Two subframeworks are siblings if they occur in the same
7777 framework.  A subframework should not have the same name as a
7778 framework, a warning will be issued if this is violated.  Currently a
7779 subframework cannot have subframeworks, in the future, the mechanism
7780 may be extended to support this.  The standard frameworks can be found
7781 in @samp{"/System/Library/Frameworks"} and
7782 @samp{"/Library/Frameworks"}.  An example include looks like
7783 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7784 the name of the framework and header.h is found in the
7785 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7787 @item -gused
7788 @opindex -gused
7789 Emit debugging information for symbols that are used.  For STABS
7790 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7791 This is by default ON@.
7793 @item -gfull
7794 @opindex -gfull
7795 Emit debugging information for all symbols and types.
7797 @item -mmacosx-version-min=@var{version}
7798 The earliest version of MacOS X that this executable will run on
7799 is @var{version}.  Typical values of @var{version} include @code{10.1},
7800 @code{10.2}, and @code{10.3.9}.
7802 The default for this option is to make choices that seem to be most
7803 useful.  
7805 @item -mone-byte-bool
7806 @opindex -mone-byte-bool
7807 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7808 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7809 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7810 option has no effect on x86.
7812 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7813 to generate code that is not binary compatible with code generated
7814 without that switch.  Using this switch may require recompiling all
7815 other modules in a program, including system libraries.  Use this
7816 switch to conform to a non-default data model.
7818 @item -mfix-and-continue
7819 @itemx -ffix-and-continue
7820 @itemx -findirect-data
7821 @opindex mfix-and-continue
7822 @opindex ffix-and-continue
7823 @opindex findirect-data
7824 Generate code suitable for fast turn around development.  Needed to
7825 enable gdb to dynamically load @code{.o} files into already running
7826 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7827 are provided for backwards compatibility.
7829 @item -all_load
7830 @opindex all_load
7831 Loads all members of static archive libraries.
7832 See man ld(1) for more information.
7834 @item -arch_errors_fatal
7835 @opindex arch_errors_fatal
7836 Cause the errors having to do with files that have the wrong architecture
7837 to be fatal.
7839 @item -bind_at_load
7840 @opindex bind_at_load
7841 Causes the output file to be marked such that the dynamic linker will
7842 bind all undefined references when the file is loaded or launched.
7844 @item -bundle
7845 @opindex bundle
7846 Produce a Mach-o bundle format file.
7847 See man ld(1) for more information.
7849 @item -bundle_loader @var{executable}
7850 @opindex bundle_loader
7851 This option specifies the @var{executable} that will be loading the build
7852 output file being linked.  See man ld(1) for more information.
7854 @item -dynamiclib
7855 @opindex -dynamiclib
7856 When passed this option, GCC will produce a dynamic library instead of
7857 an executable when linking, using the Darwin @file{libtool} command.
7859 @item -force_cpusubtype_ALL
7860 @opindex -force_cpusubtype_ALL
7861 This causes GCC's output file to have the @var{ALL} subtype, instead of
7862 one controlled by the @option{-mcpu} or @option{-march} option.
7864 @item -allowable_client  @var{client_name}
7865 @itemx -client_name
7866 @itemx -compatibility_version
7867 @itemx -current_version
7868 @itemx -dead_strip
7869 @itemx -dependency-file
7870 @itemx -dylib_file
7871 @itemx -dylinker_install_name
7872 @itemx -dynamic
7873 @itemx -exported_symbols_list
7874 @itemx -filelist
7875 @itemx -flat_namespace
7876 @itemx -force_flat_namespace
7877 @itemx -headerpad_max_install_names
7878 @itemx -image_base
7879 @itemx -init
7880 @itemx -install_name
7881 @itemx -keep_private_externs
7882 @itemx -multi_module
7883 @itemx -multiply_defined
7884 @itemx -multiply_defined_unused
7885 @itemx -noall_load
7886 @itemx -no_dead_strip_inits_and_terms
7887 @itemx -nofixprebinding
7888 @itemx -nomultidefs
7889 @itemx -noprebind
7890 @itemx -noseglinkedit
7891 @itemx -pagezero_size
7892 @itemx -prebind
7893 @itemx -prebind_all_twolevel_modules
7894 @itemx -private_bundle
7895 @itemx -read_only_relocs
7896 @itemx -sectalign
7897 @itemx -sectobjectsymbols
7898 @itemx -whyload
7899 @itemx -seg1addr
7900 @itemx -sectcreate
7901 @itemx -sectobjectsymbols
7902 @itemx -sectorder
7903 @itemx -segaddr
7904 @itemx -segs_read_only_addr
7905 @itemx -segs_read_write_addr
7906 @itemx -seg_addr_table
7907 @itemx -seg_addr_table_filename
7908 @itemx -seglinkedit
7909 @itemx -segprot
7910 @itemx -segs_read_only_addr
7911 @itemx -segs_read_write_addr
7912 @itemx -single_module
7913 @itemx -static
7914 @itemx -sub_library
7915 @itemx -sub_umbrella
7916 @itemx -twolevel_namespace
7917 @itemx -umbrella
7918 @itemx -undefined
7919 @itemx -unexported_symbols_list
7920 @itemx -weak_reference_mismatches
7921 @itemx -whatsloaded
7923 @opindex allowable_client
7924 @opindex client_name
7925 @opindex compatibility_version
7926 @opindex current_version
7927 @opindex dead_strip
7928 @opindex dependency-file
7929 @opindex dylib_file
7930 @opindex dylinker_install_name
7931 @opindex dynamic
7932 @opindex exported_symbols_list
7933 @opindex filelist
7934 @opindex flat_namespace
7935 @opindex force_flat_namespace
7936 @opindex headerpad_max_install_names
7937 @opindex image_base
7938 @opindex init
7939 @opindex install_name
7940 @opindex keep_private_externs
7941 @opindex multi_module
7942 @opindex multiply_defined
7943 @opindex multiply_defined_unused
7944 @opindex noall_load
7945 @opindex no_dead_strip_inits_and_terms
7946 @opindex nofixprebinding
7947 @opindex nomultidefs
7948 @opindex noprebind
7949 @opindex noseglinkedit
7950 @opindex pagezero_size
7951 @opindex prebind
7952 @opindex prebind_all_twolevel_modules
7953 @opindex private_bundle
7954 @opindex read_only_relocs
7955 @opindex sectalign
7956 @opindex sectobjectsymbols
7957 @opindex whyload
7958 @opindex seg1addr
7959 @opindex sectcreate
7960 @opindex sectobjectsymbols
7961 @opindex sectorder
7962 @opindex segaddr
7963 @opindex segs_read_only_addr
7964 @opindex segs_read_write_addr
7965 @opindex seg_addr_table
7966 @opindex seg_addr_table_filename
7967 @opindex seglinkedit
7968 @opindex segprot
7969 @opindex segs_read_only_addr
7970 @opindex segs_read_write_addr
7971 @opindex single_module
7972 @opindex static
7973 @opindex sub_library
7974 @opindex sub_umbrella
7975 @opindex twolevel_namespace
7976 @opindex umbrella
7977 @opindex undefined
7978 @opindex unexported_symbols_list
7979 @opindex weak_reference_mismatches
7980 @opindex whatsloaded
7982 These options are passed to the Darwin linker.  The Darwin linker man page
7983 describes them in detail.
7984 @end table
7986 @node DEC Alpha Options
7987 @subsection DEC Alpha Options
7989 These @samp{-m} options are defined for the DEC Alpha implementations:
7991 @table @gcctabopt
7992 @item -mno-soft-float
7993 @itemx -msoft-float
7994 @opindex mno-soft-float
7995 @opindex msoft-float
7996 Use (do not use) the hardware floating-point instructions for
7997 floating-point operations.  When @option{-msoft-float} is specified,
7998 functions in @file{libgcc.a} will be used to perform floating-point
7999 operations.  Unless they are replaced by routines that emulate the
8000 floating-point operations, or compiled in such a way as to call such
8001 emulations routines, these routines will issue floating-point
8002 operations.   If you are compiling for an Alpha without floating-point
8003 operations, you must ensure that the library is built so as not to call
8004 them.
8006 Note that Alpha implementations without floating-point operations are
8007 required to have floating-point registers.
8009 @item -mfp-reg
8010 @itemx -mno-fp-regs
8011 @opindex mfp-reg
8012 @opindex mno-fp-regs
8013 Generate code that uses (does not use) the floating-point register set.
8014 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8015 register set is not used, floating point operands are passed in integer
8016 registers as if they were integers and floating-point results are passed
8017 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8018 so any function with a floating-point argument or return value called by code
8019 compiled with @option{-mno-fp-regs} must also be compiled with that
8020 option.
8022 A typical use of this option is building a kernel that does not use,
8023 and hence need not save and restore, any floating-point registers.
8025 @item -mieee
8026 @opindex mieee
8027 The Alpha architecture implements floating-point hardware optimized for
8028 maximum performance.  It is mostly compliant with the IEEE floating
8029 point standard.  However, for full compliance, software assistance is
8030 required.  This option generates code fully IEEE compliant code
8031 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8032 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8033 defined during compilation.  The resulting code is less efficient but is
8034 able to correctly support denormalized numbers and exceptional IEEE
8035 values such as not-a-number and plus/minus infinity.  Other Alpha
8036 compilers call this option @option{-ieee_with_no_inexact}.
8038 @item -mieee-with-inexact
8039 @opindex mieee-with-inexact
8040 This is like @option{-mieee} except the generated code also maintains
8041 the IEEE @var{inexact-flag}.  Turning on this option causes the
8042 generated code to implement fully-compliant IEEE math.  In addition to
8043 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8044 macro.  On some Alpha implementations the resulting code may execute
8045 significantly slower than the code generated by default.  Since there is
8046 very little code that depends on the @var{inexact-flag}, you should
8047 normally not specify this option.  Other Alpha compilers call this
8048 option @option{-ieee_with_inexact}.
8050 @item -mfp-trap-mode=@var{trap-mode}
8051 @opindex mfp-trap-mode
8052 This option controls what floating-point related traps are enabled.
8053 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8054 The trap mode can be set to one of four values:
8056 @table @samp
8057 @item n
8058 This is the default (normal) setting.  The only traps that are enabled
8059 are the ones that cannot be disabled in software (e.g., division by zero
8060 trap).
8062 @item u
8063 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8064 as well.
8066 @item su
8067 Like @samp{su}, but the instructions are marked to be safe for software
8068 completion (see Alpha architecture manual for details).
8070 @item sui
8071 Like @samp{su}, but inexact traps are enabled as well.
8072 @end table
8074 @item -mfp-rounding-mode=@var{rounding-mode}
8075 @opindex mfp-rounding-mode
8076 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8077 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8080 @table @samp
8081 @item n
8082 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8083 the nearest machine number or towards the even machine number in case
8084 of a tie.
8086 @item m
8087 Round towards minus infinity.
8089 @item c
8090 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8092 @item d
8093 Dynamic rounding mode.  A field in the floating point control register
8094 (@var{fpcr}, see Alpha architecture reference manual) controls the
8095 rounding mode in effect.  The C library initializes this register for
8096 rounding towards plus infinity.  Thus, unless your program modifies the
8097 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8098 @end table
8100 @item -mtrap-precision=@var{trap-precision}
8101 @opindex mtrap-precision
8102 In the Alpha architecture, floating point traps are imprecise.  This
8103 means without software assistance it is impossible to recover from a
8104 floating trap and program execution normally needs to be terminated.
8105 GCC can generate code that can assist operating system trap handlers
8106 in determining the exact location that caused a floating point trap.
8107 Depending on the requirements of an application, different levels of
8108 precisions can be selected:
8110 @table @samp
8111 @item p
8112 Program precision.  This option is the default and means a trap handler
8113 can only identify which program caused a floating point exception.
8115 @item f
8116 Function precision.  The trap handler can determine the function that
8117 caused a floating point exception.
8119 @item i
8120 Instruction precision.  The trap handler can determine the exact
8121 instruction that caused a floating point exception.
8122 @end table
8124 Other Alpha compilers provide the equivalent options called
8125 @option{-scope_safe} and @option{-resumption_safe}.
8127 @item -mieee-conformant
8128 @opindex mieee-conformant
8129 This option marks the generated code as IEEE conformant.  You must not
8130 use this option unless you also specify @option{-mtrap-precision=i} and either
8131 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8132 is to emit the line @samp{.eflag 48} in the function prologue of the
8133 generated assembly file.  Under DEC Unix, this has the effect that
8134 IEEE-conformant math library routines will be linked in.
8136 @item -mbuild-constants
8137 @opindex mbuild-constants
8138 Normally GCC examines a 32- or 64-bit integer constant to
8139 see if it can construct it from smaller constants in two or three
8140 instructions.  If it cannot, it will output the constant as a literal and
8141 generate code to load it from the data segment at runtime.
8143 Use this option to require GCC to construct @emph{all} integer constants
8144 using code, even if it takes more instructions (the maximum is six).
8146 You would typically use this option to build a shared library dynamic
8147 loader.  Itself a shared library, it must relocate itself in memory
8148 before it can find the variables and constants in its own data segment.
8150 @item -malpha-as
8151 @itemx -mgas
8152 @opindex malpha-as
8153 @opindex mgas
8154 Select whether to generate code to be assembled by the vendor-supplied
8155 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8157 @item -mbwx
8158 @itemx -mno-bwx
8159 @itemx -mcix
8160 @itemx -mno-cix
8161 @itemx -mfix
8162 @itemx -mno-fix
8163 @itemx -mmax
8164 @itemx -mno-max
8165 @opindex mbwx
8166 @opindex mno-bwx
8167 @opindex mcix
8168 @opindex mno-cix
8169 @opindex mfix
8170 @opindex mno-fix
8171 @opindex mmax
8172 @opindex mno-max
8173 Indicate whether GCC should generate code to use the optional BWX,
8174 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8175 sets supported by the CPU type specified via @option{-mcpu=} option or that
8176 of the CPU on which GCC was built if none was specified.
8178 @item -mfloat-vax
8179 @itemx -mfloat-ieee
8180 @opindex mfloat-vax
8181 @opindex mfloat-ieee
8182 Generate code that uses (does not use) VAX F and G floating point
8183 arithmetic instead of IEEE single and double precision.
8185 @item -mexplicit-relocs
8186 @itemx -mno-explicit-relocs
8187 @opindex mexplicit-relocs
8188 @opindex mno-explicit-relocs
8189 Older Alpha assemblers provided no way to generate symbol relocations
8190 except via assembler macros.  Use of these macros does not allow
8191 optimal instruction scheduling.  GNU binutils as of version 2.12
8192 supports a new syntax that allows the compiler to explicitly mark
8193 which relocations should apply to which instructions.  This option
8194 is mostly useful for debugging, as GCC detects the capabilities of
8195 the assembler when it is built and sets the default accordingly.
8197 @item -msmall-data
8198 @itemx -mlarge-data
8199 @opindex msmall-data
8200 @opindex mlarge-data
8201 When @option{-mexplicit-relocs} is in effect, static data is
8202 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8203 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8204 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8205 16-bit relocations off of the @code{$gp} register.  This limits the
8206 size of the small data area to 64KB, but allows the variables to be
8207 directly accessed via a single instruction.
8209 The default is @option{-mlarge-data}.  With this option the data area
8210 is limited to just below 2GB@.  Programs that require more than 2GB of
8211 data must use @code{malloc} or @code{mmap} to allocate the data in the
8212 heap instead of in the program's data segment.
8214 When generating code for shared libraries, @option{-fpic} implies
8215 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8217 @item -msmall-text
8218 @itemx -mlarge-text
8219 @opindex msmall-text
8220 @opindex mlarge-text
8221 When @option{-msmall-text} is used, the compiler assumes that the
8222 code of the entire program (or shared library) fits in 4MB, and is
8223 thus reachable with a branch instruction.  When @option{-msmall-data}
8224 is used, the compiler can assume that all local symbols share the
8225 same @code{$gp} value, and thus reduce the number of instructions
8226 required for a function call from 4 to 1.
8228 The default is @option{-mlarge-text}.
8230 @item -mcpu=@var{cpu_type}
8231 @opindex mcpu
8232 Set the instruction set and instruction scheduling parameters for
8233 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8234 style name or the corresponding chip number.  GCC supports scheduling
8235 parameters for the EV4, EV5 and EV6 family of processors and will
8236 choose the default values for the instruction set from the processor
8237 you specify.  If you do not specify a processor type, GCC will default
8238 to the processor on which the compiler was built.
8240 Supported values for @var{cpu_type} are
8242 @table @samp
8243 @item ev4
8244 @itemx ev45
8245 @itemx 21064
8246 Schedules as an EV4 and has no instruction set extensions.
8248 @item ev5
8249 @itemx 21164
8250 Schedules as an EV5 and has no instruction set extensions.
8252 @item ev56
8253 @itemx 21164a
8254 Schedules as an EV5 and supports the BWX extension.
8256 @item pca56
8257 @itemx 21164pc
8258 @itemx 21164PC
8259 Schedules as an EV5 and supports the BWX and MAX extensions.
8261 @item ev6
8262 @itemx 21264
8263 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8265 @item ev67
8266 @itemx 21264a
8267 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8268 @end table
8270 @item -mtune=@var{cpu_type}
8271 @opindex mtune
8272 Set only the instruction scheduling parameters for machine type
8273 @var{cpu_type}.  The instruction set is not changed.
8275 @item -mmemory-latency=@var{time}
8276 @opindex mmemory-latency
8277 Sets the latency the scheduler should assume for typical memory
8278 references as seen by the application.  This number is highly
8279 dependent on the memory access patterns used by the application
8280 and the size of the external cache on the machine.
8282 Valid options for @var{time} are
8284 @table @samp
8285 @item @var{number}
8286 A decimal number representing clock cycles.
8288 @item L1
8289 @itemx L2
8290 @itemx L3
8291 @itemx main
8292 The compiler contains estimates of the number of clock cycles for
8293 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8294 (also called Dcache, Scache, and Bcache), as well as to main memory.
8295 Note that L3 is only valid for EV5.
8297 @end table
8298 @end table
8300 @node DEC Alpha/VMS Options
8301 @subsection DEC Alpha/VMS Options
8303 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8305 @table @gcctabopt
8306 @item -mvms-return-codes
8307 @opindex mvms-return-codes
8308 Return VMS condition codes from main.  The default is to return POSIX
8309 style condition (e.g.@ error) codes.
8310 @end table
8312 @node FRV Options
8313 @subsection FRV Options
8314 @cindex FRV Options
8316 @table @gcctabopt
8317 @item -mgpr-32
8318 @opindex mgpr-32
8320 Only use the first 32 general purpose registers.
8322 @item -mgpr-64
8323 @opindex mgpr-64
8325 Use all 64 general purpose registers.
8327 @item -mfpr-32
8328 @opindex mfpr-32
8330 Use only the first 32 floating point registers.
8332 @item -mfpr-64
8333 @opindex mfpr-64
8335 Use all 64 floating point registers
8337 @item -mhard-float
8338 @opindex mhard-float
8340 Use hardware instructions for floating point operations.
8342 @item -msoft-float
8343 @opindex msoft-float
8345 Use library routines for floating point operations.
8347 @item -malloc-cc
8348 @opindex malloc-cc
8350 Dynamically allocate condition code registers.
8352 @item -mfixed-cc
8353 @opindex mfixed-cc
8355 Do not try to dynamically allocate condition code registers, only
8356 use @code{icc0} and @code{fcc0}.
8358 @item -mdword
8359 @opindex mdword
8361 Change ABI to use double word insns.
8363 @item -mno-dword
8364 @opindex mno-dword
8366 Do not use double word instructions.
8368 @item -mdouble
8369 @opindex mdouble
8371 Use floating point double instructions.
8373 @item -mno-double
8374 @opindex mno-double
8376 Do not use floating point double instructions.
8378 @item -mmedia
8379 @opindex mmedia
8381 Use media instructions.
8383 @item -mno-media
8384 @opindex mno-media
8386 Do not use media instructions.
8388 @item -mmuladd
8389 @opindex mmuladd
8391 Use multiply and add/subtract instructions.
8393 @item -mno-muladd
8394 @opindex mno-muladd
8396 Do not use multiply and add/subtract instructions.
8398 @item -mfdpic
8399 @opindex mfdpic
8401 Select the FDPIC ABI, that uses function descriptors to represent
8402 pointers to functions.  Without any PIC/PIE-related options, it
8403 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8404 assumes GOT entries and small data are within a 12-bit range from the
8405 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8406 are computed with 32 bits.
8408 @item -minline-plt
8409 @opindex minline-plt
8411 Enable inlining of PLT entries in function calls to functions that are
8412 not known to bind locally.  It has no effect without @option{-mfdpic}.
8413 It's enabled by default if optimizing for speed and compiling for
8414 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8415 optimization option such as @option{-O3} or above is present in the
8416 command line.
8418 @item -mTLS
8419 @opindex TLS
8421 Assume a large TLS segment when generating thread-local code.
8423 @item -mtls
8424 @opindex tls
8426 Do not assume a large TLS segment when generating thread-local code.
8428 @item -mgprel-ro
8429 @opindex mgprel-ro
8431 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8432 that is known to be in read-only sections.  It's enabled by default,
8433 except for @option{-fpic} or @option{-fpie}: even though it may help
8434 make the global offset table smaller, it trades 1 instruction for 4.
8435 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8436 one of which may be shared by multiple symbols, and it avoids the need
8437 for a GOT entry for the referenced symbol, so it's more likely to be a
8438 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8440 @item -multilib-library-pic
8441 @opindex multilib-library-pic
8443 Link with the (library, not FD) pic libraries.  It's implied by
8444 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8445 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8446 it explicitly.
8448 @item -mlinked-fp
8449 @opindex mlinked-fp
8451 Follow the EABI requirement of always creating a frame pointer whenever
8452 a stack frame is allocated.  This option is enabled by default and can
8453 be disabled with @option{-mno-linked-fp}.
8455 @item -mlong-calls
8456 @opindex mlong-calls
8458 Use indirect addressing to call functions outside the current
8459 compilation unit.  This allows the functions to be placed anywhere
8460 within the 32-bit address space.
8462 @item -malign-labels
8463 @opindex malign-labels
8465 Try to align labels to an 8-byte boundary by inserting nops into the
8466 previous packet.  This option only has an effect when VLIW packing
8467 is enabled.  It doesn't create new packets; it merely adds nops to
8468 existing ones.
8470 @item -mlibrary-pic
8471 @opindex mlibrary-pic
8473 Generate position-independent EABI code.
8475 @item -macc-4
8476 @opindex macc-4
8478 Use only the first four media accumulator registers.
8480 @item -macc-8
8481 @opindex macc-8
8483 Use all eight media accumulator registers.
8485 @item -mpack
8486 @opindex mpack
8488 Pack VLIW instructions.
8490 @item -mno-pack
8491 @opindex mno-pack
8493 Do not pack VLIW instructions.
8495 @item -mno-eflags
8496 @opindex mno-eflags
8498 Do not mark ABI switches in e_flags.
8500 @item -mcond-move
8501 @opindex mcond-move
8503 Enable the use of conditional-move instructions (default).
8505 This switch is mainly for debugging the compiler and will likely be removed
8506 in a future version.
8508 @item -mno-cond-move
8509 @opindex mno-cond-move
8511 Disable the use of conditional-move instructions.
8513 This switch is mainly for debugging the compiler and will likely be removed
8514 in a future version.
8516 @item -mscc
8517 @opindex mscc
8519 Enable the use of conditional set instructions (default).
8521 This switch is mainly for debugging the compiler and will likely be removed
8522 in a future version.
8524 @item -mno-scc
8525 @opindex mno-scc
8527 Disable the use of conditional set instructions.
8529 This switch is mainly for debugging the compiler and will likely be removed
8530 in a future version.
8532 @item -mcond-exec
8533 @opindex mcond-exec
8535 Enable the use of conditional execution (default).
8537 This switch is mainly for debugging the compiler and will likely be removed
8538 in a future version.
8540 @item -mno-cond-exec
8541 @opindex mno-cond-exec
8543 Disable the use of conditional execution.
8545 This switch is mainly for debugging the compiler and will likely be removed
8546 in a future version.
8548 @item -mvliw-branch
8549 @opindex mvliw-branch
8551 Run a pass to pack branches into VLIW instructions (default).
8553 This switch is mainly for debugging the compiler and will likely be removed
8554 in a future version.
8556 @item -mno-vliw-branch
8557 @opindex mno-vliw-branch
8559 Do not run a pass to pack branches into VLIW instructions.
8561 This switch is mainly for debugging the compiler and will likely be removed
8562 in a future version.
8564 @item -mmulti-cond-exec
8565 @opindex mmulti-cond-exec
8567 Enable optimization of @code{&&} and @code{||} in conditional execution
8568 (default).
8570 This switch is mainly for debugging the compiler and will likely be removed
8571 in a future version.
8573 @item -mno-multi-cond-exec
8574 @opindex mno-multi-cond-exec
8576 Disable optimization of @code{&&} and @code{||} in conditional execution.
8578 This switch is mainly for debugging the compiler and will likely be removed
8579 in a future version.
8581 @item -mnested-cond-exec
8582 @opindex mnested-cond-exec
8584 Enable nested conditional execution optimizations (default).
8586 This switch is mainly for debugging the compiler and will likely be removed
8587 in a future version.
8589 @item -mno-nested-cond-exec
8590 @opindex mno-nested-cond-exec
8592 Disable nested conditional execution optimizations.
8594 This switch is mainly for debugging the compiler and will likely be removed
8595 in a future version.
8597 @item -moptimize-membar
8598 @opindex moptimize-membar
8600 This switch removes redundant @code{membar} instructions from the
8601 compiler generated code.  It is enabled by default.
8603 @item -mno-optimize-membar
8604 @opindex mno-optimize-membar
8606 This switch disables the automatic removal of redundant @code{membar}
8607 instructions from the generated code.
8609 @item -mtomcat-stats
8610 @opindex mtomcat-stats
8612 Cause gas to print out tomcat statistics.
8614 @item -mcpu=@var{cpu}
8615 @opindex mcpu
8617 Select the processor type for which to generate code.  Possible values are
8618 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8619 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8621 @end table
8623 @node H8/300 Options
8624 @subsection H8/300 Options
8626 These @samp{-m} options are defined for the H8/300 implementations:
8628 @table @gcctabopt
8629 @item -mrelax
8630 @opindex mrelax
8631 Shorten some address references at link time, when possible; uses the
8632 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8633 ld, Using ld}, for a fuller description.
8635 @item -mh
8636 @opindex mh
8637 Generate code for the H8/300H@.
8639 @item -ms
8640 @opindex ms
8641 Generate code for the H8S@.
8643 @item -mn
8644 @opindex mn
8645 Generate code for the H8S and H8/300H in the normal mode.  This switch
8646 must be used either with @option{-mh} or @option{-ms}.
8648 @item -ms2600
8649 @opindex ms2600
8650 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8652 @item -mint32
8653 @opindex mint32
8654 Make @code{int} data 32 bits by default.
8656 @item -malign-300
8657 @opindex malign-300
8658 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8659 The default for the H8/300H and H8S is to align longs and floats on 4
8660 byte boundaries.
8661 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8662 This option has no effect on the H8/300.
8663 @end table
8665 @node HPPA Options
8666 @subsection HPPA Options
8667 @cindex HPPA Options
8669 These @samp{-m} options are defined for the HPPA family of computers:
8671 @table @gcctabopt
8672 @item -march=@var{architecture-type}
8673 @opindex march
8674 Generate code for the specified architecture.  The choices for
8675 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8676 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8677 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8678 architecture option for your machine.  Code compiled for lower numbered
8679 architectures will run on higher numbered architectures, but not the
8680 other way around.
8682 @item -mpa-risc-1-0
8683 @itemx -mpa-risc-1-1
8684 @itemx -mpa-risc-2-0
8685 @opindex mpa-risc-1-0
8686 @opindex mpa-risc-1-1
8687 @opindex mpa-risc-2-0
8688 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8690 @item -mbig-switch
8691 @opindex mbig-switch
8692 Generate code suitable for big switch tables.  Use this option only if
8693 the assembler/linker complain about out of range branches within a switch
8694 table.
8696 @item -mjump-in-delay
8697 @opindex mjump-in-delay
8698 Fill delay slots of function calls with unconditional jump instructions
8699 by modifying the return pointer for the function call to be the target
8700 of the conditional jump.
8702 @item -mdisable-fpregs
8703 @opindex mdisable-fpregs
8704 Prevent floating point registers from being used in any manner.  This is
8705 necessary for compiling kernels which perform lazy context switching of
8706 floating point registers.  If you use this option and attempt to perform
8707 floating point operations, the compiler will abort.
8709 @item -mdisable-indexing
8710 @opindex mdisable-indexing
8711 Prevent the compiler from using indexing address modes.  This avoids some
8712 rather obscure problems when compiling MIG generated code under MACH@.
8714 @item -mno-space-regs
8715 @opindex mno-space-regs
8716 Generate code that assumes the target has no space registers.  This allows
8717 GCC to generate faster indirect calls and use unscaled index address modes.
8719 Such code is suitable for level 0 PA systems and kernels.
8721 @item -mfast-indirect-calls
8722 @opindex mfast-indirect-calls
8723 Generate code that assumes calls never cross space boundaries.  This
8724 allows GCC to emit code which performs faster indirect calls.
8726 This option will not work in the presence of shared libraries or nested
8727 functions.
8729 @item -mfixed-range=@var{register-range}
8730 @opindex mfixed-range
8731 Generate code treating the given register range as fixed registers.
8732 A fixed register is one that the register allocator can not use.  This is
8733 useful when compiling kernel code.  A register range is specified as
8734 two registers separated by a dash.  Multiple register ranges can be
8735 specified separated by a comma.
8737 @item -mlong-load-store
8738 @opindex mlong-load-store
8739 Generate 3-instruction load and store sequences as sometimes required by
8740 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8741 the HP compilers.
8743 @item -mportable-runtime
8744 @opindex mportable-runtime
8745 Use the portable calling conventions proposed by HP for ELF systems.
8747 @item -mgas
8748 @opindex mgas
8749 Enable the use of assembler directives only GAS understands.
8751 @item -mschedule=@var{cpu-type}
8752 @opindex mschedule
8753 Schedule code according to the constraints for the machine type
8754 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8755 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8756 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8757 proper scheduling option for your machine.  The default scheduling is
8758 @samp{8000}.
8760 @item -mlinker-opt
8761 @opindex mlinker-opt
8762 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8763 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8764 linkers in which they give bogus error messages when linking some programs.
8766 @item -msoft-float
8767 @opindex msoft-float
8768 Generate output containing library calls for floating point.
8769 @strong{Warning:} the requisite libraries are not available for all HPPA
8770 targets.  Normally the facilities of the machine's usual C compiler are
8771 used, but this cannot be done directly in cross-compilation.  You must make
8772 your own arrangements to provide suitable library functions for
8773 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8774 does provide software floating point support.
8776 @option{-msoft-float} changes the calling convention in the output file;
8777 therefore, it is only useful if you compile @emph{all} of a program with
8778 this option.  In particular, you need to compile @file{libgcc.a}, the
8779 library that comes with GCC, with @option{-msoft-float} in order for
8780 this to work.
8782 @item -msio
8783 @opindex msio
8784 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8785 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8786 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8787 options are available under HP-UX and HI-UX@.
8789 @item -mgnu-ld
8790 @opindex gnu-ld
8791 Use GNU ld specific options.  This passes @option{-shared} to ld when
8792 building a shared library.  It is the default when GCC is configured,
8793 explicitly or implicitly, with the GNU linker.  This option does not
8794 have any affect on which ld is called, it only changes what parameters
8795 are passed to that ld.  The ld that is called is determined by the
8796 @option{--with-ld} configure option, GCC's program search path, and
8797 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8798 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8799 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8801 @item -mhp-ld
8802 @opindex hp-ld
8803 Use HP ld specific options.  This passes @option{-b} to ld when building
8804 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8805 links.  It is the default when GCC is configured, explicitly or
8806 implicitly, with the HP linker.  This option does not have any affect on
8807 which ld is called, it only changes what parameters are passed to that
8808 ld.  The ld that is called is determined by the @option{--with-ld}
8809 configure option, GCC's program search path, and finally by the user's
8810 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8811 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8812 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8814 @item -mlong-calls
8815 @opindex mno-long-calls
8816 Generate code that uses long call sequences.  This ensures that a call
8817 is always able to reach linker generated stubs.  The default is to generate
8818 long calls only when the distance from the call site to the beginning
8819 of the function or translation unit, as the case may be, exceeds a
8820 predefined limit set by the branch type being used.  The limits for
8821 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8822 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8823 240,000 bytes.
8825 Distances are measured from the beginning of functions when using the
8826 @option{-ffunction-sections} option, or when using the @option{-mgas}
8827 and @option{-mno-portable-runtime} options together under HP-UX with
8828 the SOM linker.
8830 It is normally not desirable to use this option as it will degrade
8831 performance.  However, it may be useful in large applications,
8832 particularly when partial linking is used to build the application.
8834 The types of long calls used depends on the capabilities of the
8835 assembler and linker, and the type of code being generated.  The
8836 impact on systems that support long absolute calls, and long pic
8837 symbol-difference or pc-relative calls should be relatively small.
8838 However, an indirect call is used on 32-bit ELF systems in pic code
8839 and it is quite long.
8841 @item -munix=@var{unix-std}
8842 @opindex march
8843 Generate compiler predefines and select a startfile for the specified
8844 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8845 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8846 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8847 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8848 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8849 and later.
8851 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8852 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8853 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8854 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8855 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8856 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8858 It is @emph{important} to note that this option changes the interfaces
8859 for various library routines.  It also affects the operational behavior
8860 of the C library.  Thus, @emph{extreme} care is needed in using this
8861 option.
8863 Library code that is intended to operate with more than one UNIX
8864 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8865 as appropriate.  Most GNU software doesn't provide this capability.
8867 @item -nolibdld
8868 @opindex nolibdld
8869 Suppress the generation of link options to search libdld.sl when the
8870 @option{-static} option is specified on HP-UX 10 and later.
8872 @item -static
8873 @opindex static
8874 The HP-UX implementation of setlocale in libc has a dependency on
8875 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8876 when the @option{-static} option is specified, special link options
8877 are needed to resolve this dependency.
8879 On HP-UX 10 and later, the GCC driver adds the necessary options to
8880 link with libdld.sl when the @option{-static} option is specified.
8881 This causes the resulting binary to be dynamic.  On the 64-bit port,
8882 the linkers generate dynamic binaries by default in any case.  The
8883 @option{-nolibdld} option can be used to prevent the GCC driver from
8884 adding these link options.
8886 @item -threads
8887 @opindex threads
8888 Add support for multithreading with the @dfn{dce thread} library
8889 under HP-UX@.  This option sets flags for both the preprocessor and
8890 linker.
8891 @end table
8893 @node i386 and x86-64 Options
8894 @subsection Intel 386 and AMD x86-64 Options
8895 @cindex i386 Options
8896 @cindex x86-64 Options
8897 @cindex Intel 386 Options
8898 @cindex AMD x86-64 Options
8900 These @samp{-m} options are defined for the i386 and x86-64 family of
8901 computers:
8903 @table @gcctabopt
8904 @item -mtune=@var{cpu-type}
8905 @opindex mtune
8906 Tune to @var{cpu-type} everything applicable about the generated code, except
8907 for the ABI and the set of available instructions.  The choices for
8908 @var{cpu-type} are:
8909 @table @emph
8910 @item i386
8911 Original Intel's i386 CPU@.
8912 @item i486
8913 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8914 @item i586, pentium
8915 Intel Pentium CPU with no MMX support.
8916 @item pentium-mmx
8917 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8918 @item i686, pentiumpro
8919 Intel PentiumPro CPU@.
8920 @item pentium2
8921 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8922 @item pentium3, pentium3m
8923 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8924 support.
8925 @item pentium-m
8926 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8927 support.  Used by Centrino notebooks.
8928 @item pentium4, pentium4m
8929 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8930 @item prescott
8931 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8932 set support.
8933 @item nocona
8934 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8935 SSE2 and SSE3 instruction set support.
8936 @item k6
8937 AMD K6 CPU with MMX instruction set support.
8938 @item k6-2, k6-3
8939 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8940 @item athlon, athlon-tbird
8941 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8942 support.
8943 @item athlon-4, athlon-xp, athlon-mp
8944 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8945 instruction set support.
8946 @item k8, opteron, athlon64, athlon-fx
8947 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8948 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8949 @item winchip-c6
8950 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8951 set support.
8952 @item winchip2
8953 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8954 instruction set support.
8955 @item c3
8956 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8957 implemented for this chip.)
8958 @item c3-2
8959 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8960 implemented for this chip.)
8961 @end table
8963 While picking a specific @var{cpu-type} will schedule things appropriately
8964 for that particular chip, the compiler will not generate any code that
8965 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8966 being used.
8968 @item -march=@var{cpu-type}
8969 @opindex march
8970 Generate instructions for the machine type @var{cpu-type}.  The choices
8971 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8972 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8974 @item -mcpu=@var{cpu-type}
8975 @opindex mcpu
8976 A deprecated synonym for @option{-mtune}.
8978 @item -m386
8979 @itemx -m486
8980 @itemx -mpentium
8981 @itemx -mpentiumpro
8982 @opindex m386
8983 @opindex m486
8984 @opindex mpentium
8985 @opindex mpentiumpro
8986 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8987 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8988 These synonyms are deprecated.
8990 @item -mfpmath=@var{unit}
8991 @opindex march
8992 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8993 for @var{unit} are:
8995 @table @samp
8996 @item 387
8997 Use the standard 387 floating point coprocessor present majority of chips and
8998 emulated otherwise.  Code compiled with this option will run almost everywhere.
8999 The temporary results are computed in 80bit precision instead of precision
9000 specified by the type resulting in slightly different results compared to most
9001 of other chips.  See @option{-ffloat-store} for more detailed description.
9003 This is the default choice for i386 compiler.
9005 @item sse
9006 Use scalar floating point instructions present in the SSE instruction set.
9007 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9008 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9009 instruction set supports only single precision arithmetics, thus the double and
9010 extended precision arithmetics is still done using 387.  Later version, present
9011 only in Pentium4 and the future AMD x86-64 chips supports double precision
9012 arithmetics too.
9014 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9015 or @option{-msse2} switches to enable SSE extensions and make this option
9016 effective.  For the x86-64 compiler, these extensions are enabled by default.
9018 The resulting code should be considerably faster in the majority of cases and avoid
9019 the numerical instability problems of 387 code, but may break some existing
9020 code that expects temporaries to be 80bit.
9022 This is the default choice for the x86-64 compiler.
9024 @item sse,387
9025 Attempt to utilize both instruction sets at once.  This effectively double the
9026 amount of available registers and on chips with separate execution units for
9027 387 and SSE the execution resources too.  Use this option with care, as it is
9028 still experimental, because the GCC register allocator does not model separate
9029 functional units well resulting in instable performance.
9030 @end table
9032 @item -masm=@var{dialect}
9033 @opindex masm=@var{dialect}
9034 Output asm instructions using selected @var{dialect}.  Supported choices are
9035 @samp{intel} or @samp{att} (the default one).
9037 @item -mieee-fp
9038 @itemx -mno-ieee-fp
9039 @opindex mieee-fp
9040 @opindex mno-ieee-fp
9041 Control whether or not the compiler uses IEEE floating point
9042 comparisons.  These handle correctly the case where the result of a
9043 comparison is unordered.
9045 @item -msoft-float
9046 @opindex msoft-float
9047 Generate output containing library calls for floating point.
9048 @strong{Warning:} the requisite libraries are not part of GCC@.
9049 Normally the facilities of the machine's usual C compiler are used, but
9050 this can't be done directly in cross-compilation.  You must make your
9051 own arrangements to provide suitable library functions for
9052 cross-compilation.
9054 On machines where a function returns floating point results in the 80387
9055 register stack, some floating point opcodes may be emitted even if
9056 @option{-msoft-float} is used.
9058 @item -mno-fp-ret-in-387
9059 @opindex mno-fp-ret-in-387
9060 Do not use the FPU registers for return values of functions.
9062 The usual calling convention has functions return values of types
9063 @code{float} and @code{double} in an FPU register, even if there
9064 is no FPU@.  The idea is that the operating system should emulate
9065 an FPU@.
9067 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9068 in ordinary CPU registers instead.
9070 @item -mno-fancy-math-387
9071 @opindex mno-fancy-math-387
9072 Some 387 emulators do not support the @code{sin}, @code{cos} and
9073 @code{sqrt} instructions for the 387.  Specify this option to avoid
9074 generating those instructions.  This option is the default on FreeBSD,
9075 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9076 indicates that the target cpu will always have an FPU and so the
9077 instruction will not need emulation.  As of revision 2.6.1, these
9078 instructions are not generated unless you also use the
9079 @option{-funsafe-math-optimizations} switch.
9081 @item -malign-double
9082 @itemx -mno-align-double
9083 @opindex malign-double
9084 @opindex mno-align-double
9085 Control whether GCC aligns @code{double}, @code{long double}, and
9086 @code{long long} variables on a two word boundary or a one word
9087 boundary.  Aligning @code{double} variables on a two word boundary will
9088 produce code that runs somewhat faster on a @samp{Pentium} at the
9089 expense of more memory.
9091 @strong{Warning:} if you use the @option{-malign-double} switch,
9092 structures containing the above types will be aligned differently than
9093 the published application binary interface specifications for the 386
9094 and will not be binary compatible with structures in code compiled
9095 without that switch.
9097 @item -m96bit-long-double
9098 @itemx -m128bit-long-double
9099 @opindex m96bit-long-double
9100 @opindex m128bit-long-double
9101 These switches control the size of @code{long double} type.  The i386
9102 application binary interface specifies the size to be 96 bits,
9103 so @option{-m96bit-long-double} is the default in 32 bit mode.
9105 Modern architectures (Pentium and newer) would prefer @code{long double}
9106 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9107 conforming to the ABI, this would not be possible.  So specifying a
9108 @option{-m128bit-long-double} will align @code{long double}
9109 to a 16 byte boundary by padding the @code{long double} with an additional
9110 32 bit zero.
9112 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9113 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9115 Notice that neither of these options enable any extra precision over the x87
9116 standard of 80 bits for a @code{long double}.
9118 @strong{Warning:} if you override the default value for your target ABI, the
9119 structures and arrays containing @code{long double} variables will change
9120 their size as well as function calling convention for function taking
9121 @code{long double} will be modified.  Hence they will not be binary
9122 compatible with arrays or structures in code compiled without that switch.
9124 @item -mmlarge-data-threshold=@var{number}
9125 @opindex mlarge-data-threshold=@var{number}
9126 When @option{-mcmodel=medium} is specified, the data greater than
9127 @var{threshold} are placed in large data section.  This value must be the
9128 same across all object linked into the binary and defaults to 65535.
9130 @item -msvr3-shlib
9131 @itemx -mno-svr3-shlib
9132 @opindex msvr3-shlib
9133 @opindex mno-svr3-shlib
9134 Control whether GCC places uninitialized local variables into the
9135 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9136 into @code{bss}.  These options are meaningful only on System V Release 3.
9138 @item -mrtd
9139 @opindex mrtd
9140 Use a different function-calling convention, in which functions that
9141 take a fixed number of arguments return with the @code{ret} @var{num}
9142 instruction, which pops their arguments while returning.  This saves one
9143 instruction in the caller since there is no need to pop the arguments
9144 there.
9146 You can specify that an individual function is called with this calling
9147 sequence with the function attribute @samp{stdcall}.  You can also
9148 override the @option{-mrtd} option by using the function attribute
9149 @samp{cdecl}.  @xref{Function Attributes}.
9151 @strong{Warning:} this calling convention is incompatible with the one
9152 normally used on Unix, so you cannot use it if you need to call
9153 libraries compiled with the Unix compiler.
9155 Also, you must provide function prototypes for all functions that
9156 take variable numbers of arguments (including @code{printf});
9157 otherwise incorrect code will be generated for calls to those
9158 functions.
9160 In addition, seriously incorrect code will result if you call a
9161 function with too many arguments.  (Normally, extra arguments are
9162 harmlessly ignored.)
9164 @item -mregparm=@var{num}
9165 @opindex mregparm
9166 Control how many registers are used to pass integer arguments.  By
9167 default, no registers are used to pass arguments, and at most 3
9168 registers can be used.  You can control this behavior for a specific
9169 function by using the function attribute @samp{regparm}.
9170 @xref{Function Attributes}.
9172 @strong{Warning:} if you use this switch, and
9173 @var{num} is nonzero, then you must build all modules with the same
9174 value, including any libraries.  This includes the system libraries and
9175 startup modules.
9177 @item -msseregparm
9178 @opindex msseregparm
9179 Use SSE register passing conventions for float and double arguments
9180 and return values.  You can control this behavior for a specific
9181 function by using the function attribute @samp{sseregparm}.
9182 @xref{Function Attributes}.
9184 @strong{Warning:} if you use this switch then you must build all
9185 modules with the same value, including any libraries.  This includes
9186 the system libraries and startup modules.
9188 @item -mpreferred-stack-boundary=@var{num}
9189 @opindex mpreferred-stack-boundary
9190 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9191 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9192 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9193 size (@option{-Os}), in which case the default is the minimum correct
9194 alignment (4 bytes for x86, and 8 bytes for x86-64).
9196 On Pentium and PentiumPro, @code{double} and @code{long double} values
9197 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9198 suffer significant run time performance penalties.  On Pentium III, the
9199 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9200 penalties if it is not 16 byte aligned.
9202 To ensure proper alignment of this values on the stack, the stack boundary
9203 must be as aligned as that required by any value stored on the stack.
9204 Further, every function must be generated such that it keeps the stack
9205 aligned.  Thus calling a function compiled with a higher preferred
9206 stack boundary from a function compiled with a lower preferred stack
9207 boundary will most likely misalign the stack.  It is recommended that
9208 libraries that use callbacks always use the default setting.
9210 This extra alignment does consume extra stack space, and generally
9211 increases code size.  Code that is sensitive to stack space usage, such
9212 as embedded systems and operating system kernels, may want to reduce the
9213 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9215 @item -mmmx
9216 @itemx -mno-mmx
9217 @item -msse
9218 @itemx -mno-sse
9219 @item -msse2
9220 @itemx -mno-sse2
9221 @item -msse3
9222 @itemx -mno-sse3
9223 @item -m3dnow
9224 @itemx -mno-3dnow
9225 @opindex mmmx
9226 @opindex mno-mmx
9227 @opindex msse
9228 @opindex mno-sse
9229 @opindex m3dnow
9230 @opindex mno-3dnow
9231 These switches enable or disable the use of built-in functions that allow
9232 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9233 instruction set.
9235 @xref{X86 Built-in Functions}, for details of the functions enabled
9236 and disabled by these switches.
9238 To have SSE/SSE2 instructions generated automatically from floating-point
9239 code, see @option{-mfpmath=sse}.
9241 @item -mpush-args
9242 @itemx -mno-push-args
9243 @opindex mpush-args
9244 @opindex mno-push-args
9245 Use PUSH operations to store outgoing parameters.  This method is shorter
9246 and usually equally fast as method using SUB/MOV operations and is enabled
9247 by default.  In some cases disabling it may improve performance because of
9248 improved scheduling and reduced dependencies.
9250 @item -maccumulate-outgoing-args
9251 @opindex maccumulate-outgoing-args
9252 If enabled, the maximum amount of space required for outgoing arguments will be
9253 computed in the function prologue.  This is faster on most modern CPUs
9254 because of reduced dependencies, improved scheduling and reduced stack usage
9255 when preferred stack boundary is not equal to 2.  The drawback is a notable
9256 increase in code size.  This switch implies @option{-mno-push-args}.
9258 @item -mthreads
9259 @opindex mthreads
9260 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9261 on thread-safe exception handling must compile and link all code with the
9262 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9263 @option{-D_MT}; when linking, it links in a special thread helper library
9264 @option{-lmingwthrd} which cleans up per thread exception handling data.
9266 @item -mno-align-stringops
9267 @opindex mno-align-stringops
9268 Do not align destination of inlined string operations.  This switch reduces
9269 code size and improves performance in case the destination is already aligned,
9270 but GCC doesn't know about it.
9272 @item -minline-all-stringops
9273 @opindex minline-all-stringops
9274 By default GCC inlines string operations only when destination is known to be
9275 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9276 size, but may improve performance of code that depends on fast memcpy, strlen
9277 and memset for short lengths.
9279 @item -momit-leaf-frame-pointer
9280 @opindex momit-leaf-frame-pointer
9281 Don't keep the frame pointer in a register for leaf functions.  This
9282 avoids the instructions to save, set up and restore frame pointers and
9283 makes an extra register available in leaf functions.  The option
9284 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9285 which might make debugging harder.
9287 @item -mtls-direct-seg-refs
9288 @itemx -mno-tls-direct-seg-refs
9289 @opindex mtls-direct-seg-refs
9290 Controls whether TLS variables may be accessed with offsets from the
9291 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9292 or whether the thread base pointer must be added.  Whether or not this
9293 is legal depends on the operating system, and whether it maps the
9294 segment to cover the entire TLS area.
9296 For systems that use GNU libc, the default is on.
9297 @end table
9299 These @samp{-m} switches are supported in addition to the above
9300 on AMD x86-64 processors in 64-bit environments.
9302 @table @gcctabopt
9303 @item -m32
9304 @itemx -m64
9305 @opindex m32
9306 @opindex m64
9307 Generate code for a 32-bit or 64-bit environment.
9308 The 32-bit environment sets int, long and pointer to 32 bits and
9309 generates code that runs on any i386 system.
9310 The 64-bit environment sets int to 32 bits and long and pointer
9311 to 64 bits and generates code for AMD's x86-64 architecture.
9313 @item -mno-red-zone
9314 @opindex no-red-zone
9315 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9316 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9317 stack pointer that will not be modified by signal or interrupt handlers
9318 and therefore can be used for temporary data without adjusting the stack
9319 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9321 @item -mcmodel=small
9322 @opindex mcmodel=small
9323 Generate code for the small code model: the program and its symbols must
9324 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9325 Programs can be statically or dynamically linked.  This is the default
9326 code model.
9328 @item -mcmodel=kernel
9329 @opindex mcmodel=kernel
9330 Generate code for the kernel code model.  The kernel runs in the
9331 negative 2 GB of the address space.
9332 This model has to be used for Linux kernel code.
9334 @item -mcmodel=medium
9335 @opindex mcmodel=medium
9336 Generate code for the medium model: The program is linked in the lower 2
9337 GB of the address space but symbols can be located anywhere in the
9338 address space.  Programs can be statically or dynamically linked, but
9339 building of shared libraries are not supported with the medium model.
9341 @item -mcmodel=large
9342 @opindex mcmodel=large
9343 Generate code for the large model: This model makes no assumptions
9344 about addresses and sizes of sections.  Currently GCC does not implement
9345 this model.
9346 @end table
9348 @node IA-64 Options
9349 @subsection IA-64 Options
9350 @cindex IA-64 Options
9352 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9354 @table @gcctabopt
9355 @item -mbig-endian
9356 @opindex mbig-endian
9357 Generate code for a big endian target.  This is the default for HP-UX@.
9359 @item -mlittle-endian
9360 @opindex mlittle-endian
9361 Generate code for a little endian target.  This is the default for AIX5
9362 and GNU/Linux.
9364 @item -mgnu-as
9365 @itemx -mno-gnu-as
9366 @opindex mgnu-as
9367 @opindex mno-gnu-as
9368 Generate (or don't) code for the GNU assembler.  This is the default.
9369 @c Also, this is the default if the configure option @option{--with-gnu-as}
9370 @c is used.
9372 @item -mgnu-ld
9373 @itemx -mno-gnu-ld
9374 @opindex mgnu-ld
9375 @opindex mno-gnu-ld
9376 Generate (or don't) code for the GNU linker.  This is the default.
9377 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9378 @c is used.
9380 @item -mno-pic
9381 @opindex mno-pic
9382 Generate code that does not use a global pointer register.  The result
9383 is not position independent code, and violates the IA-64 ABI@.
9385 @item -mvolatile-asm-stop
9386 @itemx -mno-volatile-asm-stop
9387 @opindex mvolatile-asm-stop
9388 @opindex mno-volatile-asm-stop
9389 Generate (or don't) a stop bit immediately before and after volatile asm
9390 statements.
9392 @item -mregister-names
9393 @itemx -mno-register-names
9394 @opindex mregister-names
9395 @opindex mno-register-names
9396 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9397 the stacked registers.  This may make assembler output more readable.
9399 @item -mno-sdata
9400 @itemx -msdata
9401 @opindex mno-sdata
9402 @opindex msdata
9403 Disable (or enable) optimizations that use the small data section.  This may
9404 be useful for working around optimizer bugs.
9406 @item -mconstant-gp
9407 @opindex mconstant-gp
9408 Generate code that uses a single constant global pointer value.  This is
9409 useful when compiling kernel code.
9411 @item -mauto-pic
9412 @opindex mauto-pic
9413 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9414 This is useful when compiling firmware code.
9416 @item -minline-float-divide-min-latency
9417 @opindex minline-float-divide-min-latency
9418 Generate code for inline divides of floating point values
9419 using the minimum latency algorithm.
9421 @item -minline-float-divide-max-throughput
9422 @opindex minline-float-divide-max-throughput
9423 Generate code for inline divides of floating point values
9424 using the maximum throughput algorithm.
9426 @item -minline-int-divide-min-latency
9427 @opindex minline-int-divide-min-latency
9428 Generate code for inline divides of integer values
9429 using the minimum latency algorithm.
9431 @item -minline-int-divide-max-throughput
9432 @opindex minline-int-divide-max-throughput
9433 Generate code for inline divides of integer values
9434 using the maximum throughput algorithm.
9436 @item -minline-sqrt-min-latency
9437 @opindex minline-sqrt-min-latency
9438 Generate code for inline square roots
9439 using the minimum latency algorithm.
9441 @item -minline-sqrt-max-throughput
9442 @opindex minline-sqrt-max-throughput
9443 Generate code for inline square roots
9444 using the maximum throughput algorithm.
9446 @item -mno-dwarf2-asm
9447 @itemx -mdwarf2-asm
9448 @opindex mno-dwarf2-asm
9449 @opindex mdwarf2-asm
9450 Don't (or do) generate assembler code for the DWARF2 line number debugging
9451 info.  This may be useful when not using the GNU assembler.
9453 @item -mearly-stop-bits
9454 @itemx -mno-early-stop-bits
9455 @opindex mearly-stop-bits
9456 @opindex mno-early-stop-bits
9457 Allow stop bits to be placed earlier than immediately preceding the
9458 instruction that triggered the stop bit.  This can improve instruction
9459 scheduling, but does not always do so.
9461 @item -mfixed-range=@var{register-range}
9462 @opindex mfixed-range
9463 Generate code treating the given register range as fixed registers.
9464 A fixed register is one that the register allocator can not use.  This is
9465 useful when compiling kernel code.  A register range is specified as
9466 two registers separated by a dash.  Multiple register ranges can be
9467 specified separated by a comma.
9469 @item -mtls-size=@var{tls-size}
9470 @opindex mtls-size
9471 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9474 @item -mtune-arch=@var{cpu-type}
9475 @opindex mtune-arch
9476 Tune the instruction scheduling for a particular CPU, Valid values are
9477 itanium, itanium1, merced, itanium2, and mckinley.
9479 @item -mt
9480 @itemx -pthread
9481 @opindex mt
9482 @opindex pthread
9483 Add support for multithreading using the POSIX threads library.  This
9484 option sets flags for both the preprocessor and linker.  It does
9485 not affect the thread safety of object code produced by the compiler or
9486 that of libraries supplied with it.  These are HP-UX specific flags.
9488 @item -milp32
9489 @itemx -mlp64
9490 @opindex milp32
9491 @opindex mlp64
9492 Generate code for a 32-bit or 64-bit environment.
9493 The 32-bit environment sets int, long and pointer to 32 bits.
9494 The 64-bit environment sets int to 32 bits and long and pointer
9495 to 64 bits.  These are HP-UX specific flags.
9497 @end table
9499 @node M32C Options
9500 @subsection M32C Options
9501 @cindex M32C options
9503 @table @gcctabopt
9504 @item -mcpu=@var{name}
9505 @opindex mcpu=
9506 Select the CPU for which code is generated.  @var{name} may be one of
9507 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9508 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9509 the M32C/80 series.
9511 @item -msim
9512 @opindex msim
9513 Specifies that the program will be run on the simulator.  This causes
9514 an alternate runtime library to be linked in which supports, for
9515 example, file I/O.  You must not use this option when generating
9516 programs that will run on real hardware; you must provide your own
9517 runtime library for whatever I/O functions are needed.
9519 @item -memregs=@var{number}
9520 @opindex memregs=
9521 Specifies the number of memory-based pseudo-registers GCC will use
9522 during code generation.  These pseudo-registers will be used like real
9523 registers, so there is a tradeoff between GCC's ability to fit the
9524 code into available registers, and the performance penalty of using
9525 memory instead of registers.  Note that all modules in a program must
9526 be compiled with the same value for this option.  Because of that, you
9527 must not use this option with the default runtime libraries gcc
9528 builds.
9530 @end table
9532 @node M32R/D Options
9533 @subsection M32R/D Options
9534 @cindex M32R/D options
9536 These @option{-m} options are defined for Renesas M32R/D architectures:
9538 @table @gcctabopt
9539 @item -m32r2
9540 @opindex m32r2
9541 Generate code for the M32R/2@.
9543 @item -m32rx
9544 @opindex m32rx
9545 Generate code for the M32R/X@.
9547 @item -m32r
9548 @opindex m32r
9549 Generate code for the M32R@.  This is the default.
9551 @item -mmodel=small
9552 @opindex mmodel=small
9553 Assume all objects live in the lower 16MB of memory (so that their addresses
9554 can be loaded with the @code{ld24} instruction), and assume all subroutines
9555 are reachable with the @code{bl} instruction.
9556 This is the default.
9558 The addressability of a particular object can be set with the
9559 @code{model} attribute.
9561 @item -mmodel=medium
9562 @opindex mmodel=medium
9563 Assume objects may be anywhere in the 32-bit address space (the compiler
9564 will generate @code{seth/add3} instructions to load their addresses), and
9565 assume all subroutines are reachable with the @code{bl} instruction.
9567 @item -mmodel=large
9568 @opindex mmodel=large
9569 Assume objects may be anywhere in the 32-bit address space (the compiler
9570 will generate @code{seth/add3} instructions to load their addresses), and
9571 assume subroutines may not be reachable with the @code{bl} instruction
9572 (the compiler will generate the much slower @code{seth/add3/jl}
9573 instruction sequence).
9575 @item -msdata=none
9576 @opindex msdata=none
9577 Disable use of the small data area.  Variables will be put into
9578 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9579 @code{section} attribute has been specified).
9580 This is the default.
9582 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9583 Objects may be explicitly put in the small data area with the
9584 @code{section} attribute using one of these sections.
9586 @item -msdata=sdata
9587 @opindex msdata=sdata
9588 Put small global and static data in the small data area, but do not
9589 generate special code to reference them.
9591 @item -msdata=use
9592 @opindex msdata=use
9593 Put small global and static data in the small data area, and generate
9594 special instructions to reference them.
9596 @item -G @var{num}
9597 @opindex G
9598 @cindex smaller data references
9599 Put global and static objects less than or equal to @var{num} bytes
9600 into the small data or bss sections instead of the normal data or bss
9601 sections.  The default value of @var{num} is 8.
9602 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9603 for this option to have any effect.
9605 All modules should be compiled with the same @option{-G @var{num}} value.
9606 Compiling with different values of @var{num} may or may not work; if it
9607 doesn't the linker will give an error message---incorrect code will not be
9608 generated.
9610 @item -mdebug
9611 @opindex mdebug
9612 Makes the M32R specific code in the compiler display some statistics
9613 that might help in debugging programs.
9615 @item -malign-loops
9616 @opindex malign-loops
9617 Align all loops to a 32-byte boundary.
9619 @item -mno-align-loops
9620 @opindex mno-align-loops
9621 Do not enforce a 32-byte alignment for loops.  This is the default.
9623 @item -missue-rate=@var{number}
9624 @opindex missue-rate=@var{number}
9625 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9626 or 2.
9628 @item -mbranch-cost=@var{number}
9629 @opindex mbranch-cost=@var{number}
9630 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9631 preferred over conditional code, if it is 2, then the opposite will
9632 apply.
9634 @item -mflush-trap=@var{number}
9635 @opindex mflush-trap=@var{number}
9636 Specifies the trap number to use to flush the cache.  The default is
9637 12.  Valid numbers are between 0 and 15 inclusive.
9639 @item -mno-flush-trap
9640 @opindex mno-flush-trap
9641 Specifies that the cache cannot be flushed by using a trap.
9643 @item -mflush-func=@var{name}
9644 @opindex mflush-func=@var{name}
9645 Specifies the name of the operating system function to call to flush
9646 the cache.  The default is @emph{_flush_cache}, but a function call
9647 will only be used if a trap is not available.
9649 @item -mno-flush-func
9650 @opindex mno-flush-func
9651 Indicates that there is no OS function for flushing the cache.
9653 @end table
9655 @node M680x0 Options
9656 @subsection M680x0 Options
9657 @cindex M680x0 options
9659 These are the @samp{-m} options defined for the 68000 series.  The default
9660 values for these options depends on which style of 68000 was selected when
9661 the compiler was configured; the defaults for the most common choices are
9662 given below.
9664 @table @gcctabopt
9665 @item -m68000
9666 @itemx -mc68000
9667 @opindex m68000
9668 @opindex mc68000
9669 Generate output for a 68000.  This is the default
9670 when the compiler is configured for 68000-based systems.
9672 Use this option for microcontrollers with a 68000 or EC000 core,
9673 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9675 @item -m68020
9676 @itemx -mc68020
9677 @opindex m68020
9678 @opindex mc68020
9679 Generate output for a 68020.  This is the default
9680 when the compiler is configured for 68020-based systems.
9682 @item -m68881
9683 @opindex m68881
9684 Generate output containing 68881 instructions for floating point.
9685 This is the default for most 68020 systems unless @option{--nfp} was
9686 specified when the compiler was configured.
9688 @item -m68030
9689 @opindex m68030
9690 Generate output for a 68030.  This is the default when the compiler is
9691 configured for 68030-based systems.
9693 @item -m68040
9694 @opindex m68040
9695 Generate output for a 68040.  This is the default when the compiler is
9696 configured for 68040-based systems.
9698 This option inhibits the use of 68881/68882 instructions that have to be
9699 emulated by software on the 68040.  Use this option if your 68040 does not
9700 have code to emulate those instructions.
9702 @item -m68060
9703 @opindex m68060
9704 Generate output for a 68060.  This is the default when the compiler is
9705 configured for 68060-based systems.
9707 This option inhibits the use of 68020 and 68881/68882 instructions that
9708 have to be emulated by software on the 68060.  Use this option if your 68060
9709 does not have code to emulate those instructions.
9711 @item -mcpu32
9712 @opindex mcpu32
9713 Generate output for a CPU32.  This is the default
9714 when the compiler is configured for CPU32-based systems.
9716 Use this option for microcontrollers with a
9717 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9718 68336, 68340, 68341, 68349 and 68360.
9720 @item -m5200
9721 @opindex m5200
9722 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9723 when the compiler is configured for 520X-based systems.
9725 Use this option for microcontroller with a 5200 core, including
9726 the MCF5202, MCF5203, MCF5204 and MCF5202.
9729 @item -m68020-40
9730 @opindex m68020-40
9731 Generate output for a 68040, without using any of the new instructions.
9732 This results in code which can run relatively efficiently on either a
9733 68020/68881 or a 68030 or a 68040.  The generated code does use the
9734 68881 instructions that are emulated on the 68040.
9736 @item -m68020-60
9737 @opindex m68020-60
9738 Generate output for a 68060, without using any of the new instructions.
9739 This results in code which can run relatively efficiently on either a
9740 68020/68881 or a 68030 or a 68040.  The generated code does use the
9741 68881 instructions that are emulated on the 68060.
9743 @item -msoft-float
9744 @opindex msoft-float
9745 Generate output containing library calls for floating point.
9746 @strong{Warning:} the requisite libraries are not available for all m68k
9747 targets.  Normally the facilities of the machine's usual C compiler are
9748 used, but this can't be done directly in cross-compilation.  You must
9749 make your own arrangements to provide suitable library functions for
9750 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9751 @samp{m68k-*-coff} do provide software floating point support.
9753 @item -mshort
9754 @opindex mshort
9755 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9756 Additionally, parameters passed on the stack are also aligned to a
9757 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9759 @item -mnobitfield
9760 @opindex mnobitfield
9761 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9762 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9764 @item -mbitfield
9765 @opindex mbitfield
9766 Do use the bit-field instructions.  The @option{-m68020} option implies
9767 @option{-mbitfield}.  This is the default if you use a configuration
9768 designed for a 68020.
9770 @item -mrtd
9771 @opindex mrtd
9772 Use a different function-calling convention, in which functions
9773 that take a fixed number of arguments return with the @code{rtd}
9774 instruction, which pops their arguments while returning.  This
9775 saves one instruction in the caller since there is no need to pop
9776 the arguments there.
9778 This calling convention is incompatible with the one normally
9779 used on Unix, so you cannot use it if you need to call libraries
9780 compiled with the Unix compiler.
9782 Also, you must provide function prototypes for all functions that
9783 take variable numbers of arguments (including @code{printf});
9784 otherwise incorrect code will be generated for calls to those
9785 functions.
9787 In addition, seriously incorrect code will result if you call a
9788 function with too many arguments.  (Normally, extra arguments are
9789 harmlessly ignored.)
9791 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9792 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9794 @item -malign-int
9795 @itemx -mno-align-int
9796 @opindex malign-int
9797 @opindex mno-align-int
9798 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9799 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9800 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9801 Aligning variables on 32-bit boundaries produces code that runs somewhat
9802 faster on processors with 32-bit busses at the expense of more memory.
9804 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9805 align structures containing the above types  differently than
9806 most published application binary interface specifications for the m68k.
9808 @item -mpcrel
9809 @opindex mpcrel
9810 Use the pc-relative addressing mode of the 68000 directly, instead of
9811 using a global offset table.  At present, this option implies @option{-fpic},
9812 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9813 not presently supported with @option{-mpcrel}, though this could be supported for
9814 68020 and higher processors.
9816 @item -mno-strict-align
9817 @itemx -mstrict-align
9818 @opindex mno-strict-align
9819 @opindex mstrict-align
9820 Do not (do) assume that unaligned memory references will be handled by
9821 the system.
9823 @item -msep-data
9824 Generate code that allows the data segment to be located in a different
9825 area of memory from the text segment.  This allows for execute in place in
9826 an environment without virtual memory management.  This option implies
9827 @option{-fPIC}.
9829 @item -mno-sep-data
9830 Generate code that assumes that the data segment follows the text segment.
9831 This is the default.
9833 @item -mid-shared-library
9834 Generate code that supports shared libraries via the library ID method.
9835 This allows for execute in place and shared libraries in an environment
9836 without virtual memory management.  This option implies @option{-fPIC}.
9838 @item -mno-id-shared-library
9839 Generate code that doesn't assume ID based shared libraries are being used.
9840 This is the default.
9842 @item -mshared-library-id=n
9843 Specified the identification number of the ID based shared library being
9844 compiled.  Specifying a value of 0 will generate more compact code, specifying
9845 other values will force the allocation of that number to the current
9846 library but is no more space or time efficient than omitting this option.
9848 @end table
9850 @node M68hc1x Options
9851 @subsection M68hc1x Options
9852 @cindex M68hc1x options
9854 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9855 microcontrollers.  The default values for these options depends on
9856 which style of microcontroller was selected when the compiler was configured;
9857 the defaults for the most common choices are given below.
9859 @table @gcctabopt
9860 @item -m6811
9861 @itemx -m68hc11
9862 @opindex m6811
9863 @opindex m68hc11
9864 Generate output for a 68HC11.  This is the default
9865 when the compiler is configured for 68HC11-based systems.
9867 @item -m6812
9868 @itemx -m68hc12
9869 @opindex m6812
9870 @opindex m68hc12
9871 Generate output for a 68HC12.  This is the default
9872 when the compiler is configured for 68HC12-based systems.
9874 @item -m68S12
9875 @itemx -m68hcs12
9876 @opindex m68S12
9877 @opindex m68hcs12
9878 Generate output for a 68HCS12.
9880 @item -mauto-incdec
9881 @opindex mauto-incdec
9882 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9883 addressing modes.
9885 @item -minmax
9886 @itemx -nominmax
9887 @opindex minmax
9888 @opindex mnominmax
9889 Enable the use of 68HC12 min and max instructions.
9891 @item -mlong-calls
9892 @itemx -mno-long-calls
9893 @opindex mlong-calls
9894 @opindex mno-long-calls
9895 Treat all calls as being far away (near).  If calls are assumed to be
9896 far away, the compiler will use the @code{call} instruction to
9897 call a function and the @code{rtc} instruction for returning.
9899 @item -mshort
9900 @opindex mshort
9901 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9903 @item -msoft-reg-count=@var{count}
9904 @opindex msoft-reg-count
9905 Specify the number of pseudo-soft registers which are used for the
9906 code generation.  The maximum number is 32.  Using more pseudo-soft
9907 register may or may not result in better code depending on the program.
9908 The default is 4 for 68HC11 and 2 for 68HC12.
9910 @end table
9912 @node MCore Options
9913 @subsection MCore Options
9914 @cindex MCore options
9916 These are the @samp{-m} options defined for the Motorola M*Core
9917 processors.
9919 @table @gcctabopt
9921 @item -mhardlit
9922 @itemx -mno-hardlit
9923 @opindex mhardlit
9924 @opindex mno-hardlit
9925 Inline constants into the code stream if it can be done in two
9926 instructions or less.
9928 @item -mdiv
9929 @itemx -mno-div
9930 @opindex mdiv
9931 @opindex mno-div
9932 Use the divide instruction.  (Enabled by default).
9934 @item -mrelax-immediate
9935 @itemx -mno-relax-immediate
9936 @opindex mrelax-immediate
9937 @opindex mno-relax-immediate
9938 Allow arbitrary sized immediates in bit operations.
9940 @item -mwide-bitfields
9941 @itemx -mno-wide-bitfields
9942 @opindex mwide-bitfields
9943 @opindex mno-wide-bitfields
9944 Always treat bit-fields as int-sized.
9946 @item -m4byte-functions
9947 @itemx -mno-4byte-functions
9948 @opindex m4byte-functions
9949 @opindex mno-4byte-functions
9950 Force all functions to be aligned to a four byte boundary.
9952 @item -mcallgraph-data
9953 @itemx -mno-callgraph-data
9954 @opindex mcallgraph-data
9955 @opindex mno-callgraph-data
9956 Emit callgraph information.
9958 @item -mslow-bytes
9959 @itemx -mno-slow-bytes
9960 @opindex mslow-bytes
9961 @opindex mno-slow-bytes
9962 Prefer word access when reading byte quantities.
9964 @item -mlittle-endian
9965 @itemx -mbig-endian
9966 @opindex mlittle-endian
9967 @opindex mbig-endian
9968 Generate code for a little endian target.
9970 @item -m210
9971 @itemx -m340
9972 @opindex m210
9973 @opindex m340
9974 Generate code for the 210 processor.
9975 @end table
9977 @node MIPS Options
9978 @subsection MIPS Options
9979 @cindex MIPS options
9981 @table @gcctabopt
9983 @item -EB
9984 @opindex EB
9985 Generate big-endian code.
9987 @item -EL
9988 @opindex EL
9989 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9990 configurations.
9992 @item -march=@var{arch}
9993 @opindex march
9994 Generate code that will run on @var{arch}, which can be the name of a
9995 generic MIPS ISA, or the name of a particular processor.
9996 The ISA names are:
9997 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9998 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9999 The processor names are:
10000 @samp{4kc}, @samp{4km}, @samp{4kp},
10001 @samp{5kc}, @samp{5kf},
10002 @samp{20kc},
10003 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10004 @samp{m4k},
10005 @samp{orion},
10006 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10007 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10008 @samp{rm7000}, @samp{rm9000},
10009 @samp{sb1},
10010 @samp{sr71000},
10011 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10012 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10013 The special value @samp{from-abi} selects the
10014 most compatible architecture for the selected ABI (that is,
10015 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10017 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10018 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10019 @samp{vr} may be written @samp{r}.
10021 GCC defines two macros based on the value of this option.  The first
10022 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10023 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10024 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10025 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10026 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10028 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10029 above.  In other words, it will have the full prefix and will not
10030 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10031 the macro names the resolved architecture (either @samp{"mips1"} or
10032 @samp{"mips3"}).  It names the default architecture when no
10033 @option{-march} option is given.
10035 @item -mtune=@var{arch}
10036 @opindex mtune
10037 Optimize for @var{arch}.  Among other things, this option controls
10038 the way instructions are scheduled, and the perceived cost of arithmetic
10039 operations.  The list of @var{arch} values is the same as for
10040 @option{-march}.
10042 When this option is not used, GCC will optimize for the processor
10043 specified by @option{-march}.  By using @option{-march} and
10044 @option{-mtune} together, it is possible to generate code that will
10045 run on a family of processors, but optimize the code for one
10046 particular member of that family.
10048 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10049 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10050 @samp{-march} ones described above.
10052 @item -mips1
10053 @opindex mips1
10054 Equivalent to @samp{-march=mips1}.
10056 @item -mips2
10057 @opindex mips2
10058 Equivalent to @samp{-march=mips2}.
10060 @item -mips3
10061 @opindex mips3
10062 Equivalent to @samp{-march=mips3}.
10064 @item -mips4
10065 @opindex mips4
10066 Equivalent to @samp{-march=mips4}.
10068 @item -mips32
10069 @opindex mips32
10070 Equivalent to @samp{-march=mips32}.
10072 @item -mips32r2
10073 @opindex mips32r2
10074 Equivalent to @samp{-march=mips32r2}.
10076 @item -mips64
10077 @opindex mips64
10078 Equivalent to @samp{-march=mips64}.
10080 @item -mips16
10081 @itemx -mno-mips16
10082 @opindex mips16
10083 @opindex mno-mips16
10084 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10085 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10087 @item -mabi=32
10088 @itemx -mabi=o64
10089 @itemx -mabi=n32
10090 @itemx -mabi=64
10091 @itemx -mabi=eabi
10092 @opindex mabi=32
10093 @opindex mabi=o64
10094 @opindex mabi=n32
10095 @opindex mabi=64
10096 @opindex mabi=eabi
10097 Generate code for the given ABI@.
10099 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10100 generates 64-bit code when you select a 64-bit architecture, but you
10101 can use @option{-mgp32} to get 32-bit code instead.
10103 For information about the O64 ABI, see
10104 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10106 @item -mabicalls
10107 @itemx -mno-abicalls
10108 @opindex mabicalls
10109 @opindex mno-abicalls
10110 Generate (do not generate) SVR4-style position-independent code.
10111 @option{-mabicalls} is the default for SVR4-based systems.
10113 @item -mxgot
10114 @itemx -mno-xgot
10115 @opindex mxgot
10116 @opindex mno-xgot
10117 Lift (do not lift) the usual restrictions on the size of the global
10118 offset table.
10120 GCC normally uses a single instruction to load values from the GOT@.
10121 While this is relatively efficient, it will only work if the GOT
10122 is smaller than about 64k.  Anything larger will cause the linker
10123 to report an error such as:
10125 @cindex relocation truncated to fit (MIPS)
10126 @smallexample
10127 relocation truncated to fit: R_MIPS_GOT16 foobar
10128 @end smallexample
10130 If this happens, you should recompile your code with @option{-mxgot}.
10131 It should then work with very large GOTs, although it will also be
10132 less efficient, since it will take three instructions to fetch the
10133 value of a global symbol.
10135 Note that some linkers can create multiple GOTs.  If you have such a
10136 linker, you should only need to use @option{-mxgot} when a single object
10137 file accesses more than 64k's worth of GOT entries.  Very few do.
10139 These options have no effect unless GCC is generating position
10140 independent code.
10142 @item -mgp32
10143 @opindex mgp32
10144 Assume that general-purpose registers are 32 bits wide.
10146 @item -mgp64
10147 @opindex mgp64
10148 Assume that general-purpose registers are 64 bits wide.
10150 @item -mfp32
10151 @opindex mfp32
10152 Assume that floating-point registers are 32 bits wide.
10154 @item -mfp64
10155 @opindex mfp64
10156 Assume that floating-point registers are 64 bits wide.
10158 @item -mhard-float
10159 @opindex mhard-float
10160 Use floating-point coprocessor instructions.
10162 @item -msoft-float
10163 @opindex msoft-float
10164 Do not use floating-point coprocessor instructions.  Implement
10165 floating-point calculations using library calls instead.
10167 @item -msingle-float
10168 @opindex msingle-float
10169 Assume that the floating-point coprocessor only supports single-precision
10170 operations.
10172 @itemx -mdouble-float
10173 @opindex mdouble-float
10174 Assume that the floating-point coprocessor supports double-precision
10175 operations.  This is the default.
10177 @itemx -mdsp
10178 @itemx -mno-dsp
10179 @opindex mdsp
10180 @opindex mno-dsp
10181 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10183 @itemx -mpaired-single
10184 @itemx -mno-paired-single
10185 @opindex mpaired-single
10186 @opindex mno-paired-single
10187 Use (do not use) paired-single floating-point instructions.
10188 @xref{MIPS Paired-Single Support}.  This option can only be used
10189 when generating 64-bit code and requires hardware floating-point
10190 support to be enabled.
10192 @itemx -mips3d
10193 @itemx -mno-mips3d
10194 @opindex mips3d
10195 @opindex mno-mips3d
10196 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10197 The option @option{-mips3d} implies @option{-mpaired-single}.
10199 @item -mlong64
10200 @opindex mlong64
10201 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10202 an explanation of the default and the way that the pointer size is
10203 determined.
10205 @item -mlong32
10206 @opindex mlong32
10207 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10209 The default size of @code{int}s, @code{long}s and pointers depends on
10210 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10211 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10212 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10213 or the same size as integer registers, whichever is smaller.
10215 @item -msym32
10216 @itemx -mno-sym32
10217 @opindex msym32
10218 @opindex mno-sym32
10219 Assume (do not assume) that all symbols have 32-bit values, regardless
10220 of the selected ABI@.  This option is useful in combination with
10221 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10222 to generate shorter and faster references to symbolic addresses.
10224 @item -G @var{num}
10225 @opindex G
10226 @cindex smaller data references (MIPS)
10227 @cindex gp-relative references (MIPS)
10228 Put global and static items less than or equal to @var{num} bytes into
10229 the small data or bss section instead of the normal data or bss section.
10230 This allows the data to be accessed using a single instruction.
10232 All modules should be compiled with the same @option{-G @var{num}}
10233 value.
10235 @item -membedded-data
10236 @itemx -mno-embedded-data
10237 @opindex membedded-data
10238 @opindex mno-embedded-data
10239 Allocate variables to the read-only data section first if possible, then
10240 next in the small data section if possible, otherwise in data.  This gives
10241 slightly slower code than the default, but reduces the amount of RAM required
10242 when executing, and thus may be preferred for some embedded systems.
10244 @item -muninit-const-in-rodata
10245 @itemx -mno-uninit-const-in-rodata
10246 @opindex muninit-const-in-rodata
10247 @opindex mno-uninit-const-in-rodata
10248 Put uninitialized @code{const} variables in the read-only data section.
10249 This option is only meaningful in conjunction with @option{-membedded-data}.
10251 @item -msplit-addresses
10252 @itemx -mno-split-addresses
10253 @opindex msplit-addresses
10254 @opindex mno-split-addresses
10255 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10256 relocation operators.  This option has been superseded by
10257 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10259 @item -mexplicit-relocs
10260 @itemx -mno-explicit-relocs
10261 @opindex mexplicit-relocs
10262 @opindex mno-explicit-relocs
10263 Use (do not use) assembler relocation operators when dealing with symbolic
10264 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10265 is to use assembler macros instead.
10267 @option{-mexplicit-relocs} is the default if GCC was configured
10268 to use an assembler that supports relocation operators.
10270 @item -mcheck-zero-division
10271 @itemx -mno-check-zero-division
10272 @opindex mcheck-zero-division
10273 @opindex mno-check-zero-division
10274 Trap (do not trap) on integer division by zero.  The default is
10275 @option{-mcheck-zero-division}.
10277 @item -mdivide-traps
10278 @itemx -mdivide-breaks
10279 @opindex mdivide-traps
10280 @opindex mdivide-breaks
10281 MIPS systems check for division by zero by generating either a
10282 conditional trap or a break instruction.  Using traps results in
10283 smaller code, but is only supported on MIPS II and later.  Also, some
10284 versions of the Linux kernel have a bug that prevents trap from
10285 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10286 allow conditional traps on architectures that support them and
10287 @option{-mdivide-breaks} to force the use of breaks.
10289 The default is usually @option{-mdivide-traps}, but this can be
10290 overridden at configure time using @option{--with-divide=breaks}.
10291 Divide-by-zero checks can be completely disabled using
10292 @option{-mno-check-zero-division}.
10294 @item -mmemcpy
10295 @itemx -mno-memcpy
10296 @opindex mmemcpy
10297 @opindex mno-memcpy
10298 Force (do not force) the use of @code{memcpy()} for non-trivial block
10299 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10300 most constant-sized copies.
10302 @item -mlong-calls
10303 @itemx -mno-long-calls
10304 @opindex mlong-calls
10305 @opindex mno-long-calls
10306 Disable (do not disable) use of the @code{jal} instruction.  Calling
10307 functions using @code{jal} is more efficient but requires the caller
10308 and callee to be in the same 256 megabyte segment.
10310 This option has no effect on abicalls code.  The default is
10311 @option{-mno-long-calls}.
10313 @item -mmad
10314 @itemx -mno-mad
10315 @opindex mmad
10316 @opindex mno-mad
10317 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10318 instructions, as provided by the R4650 ISA@.
10320 @item -mfused-madd
10321 @itemx -mno-fused-madd
10322 @opindex mfused-madd
10323 @opindex mno-fused-madd
10324 Enable (disable) use of the floating point multiply-accumulate
10325 instructions, when they are available.  The default is
10326 @option{-mfused-madd}.
10328 When multiply-accumulate instructions are used, the intermediate
10329 product is calculated to infinite precision and is not subject to
10330 the FCSR Flush to Zero bit.  This may be undesirable in some
10331 circumstances.
10333 @item -nocpp
10334 @opindex nocpp
10335 Tell the MIPS assembler to not run its preprocessor over user
10336 assembler files (with a @samp{.s} suffix) when assembling them.
10338 @item -mfix-r4000
10339 @itemx -mno-fix-r4000
10340 @opindex mfix-r4000
10341 @opindex mno-fix-r4000
10342 Work around certain R4000 CPU errata:
10343 @itemize @minus
10344 @item
10345 A double-word or a variable shift may give an incorrect result if executed
10346 immediately after starting an integer division.
10347 @item
10348 A double-word or a variable shift may give an incorrect result if executed
10349 while an integer multiplication is in progress.
10350 @item
10351 An integer division may give an incorrect result if started in a delay slot
10352 of a taken branch or a jump.
10353 @end itemize
10355 @item -mfix-r4400
10356 @itemx -mno-fix-r4400
10357 @opindex mfix-r4400
10358 @opindex mno-fix-r4400
10359 Work around certain R4400 CPU errata:
10360 @itemize @minus
10361 @item
10362 A double-word or a variable shift may give an incorrect result if executed
10363 immediately after starting an integer division.
10364 @end itemize
10366 @item -mfix-vr4120
10367 @itemx -mno-fix-vr4120
10368 @opindex mfix-vr4120
10369 Work around certain VR4120 errata:
10370 @itemize @minus
10371 @item
10372 @code{dmultu} does not always produce the correct result.
10373 @item
10374 @code{div} and @code{ddiv} do not always produce the correct result if one
10375 of the operands is negative.
10376 @end itemize
10377 The workarounds for the division errata rely on special functions in
10378 @file{libgcc.a}.  At present, these functions are only provided by
10379 the @code{mips64vr*-elf} configurations.
10381 Other VR4120 errata require a nop to be inserted between certain pairs of
10382 instructions.  These errata are handled by the assembler, not by GCC itself.
10384 @item -mfix-vr4130
10385 @opindex mfix-vr4130
10386 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10387 workarounds are implemented by the assembler rather than by GCC,
10388 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10389 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10390 instructions are available instead.
10392 @item -mfix-sb1
10393 @itemx -mno-fix-sb1
10394 @opindex mfix-sb1
10395 Work around certain SB-1 CPU core errata.
10396 (This flag currently works around the SB-1 revision 2
10397 ``F1'' and ``F2'' floating point errata.)
10399 @item -mflush-func=@var{func}
10400 @itemx -mno-flush-func
10401 @opindex mflush-func
10402 Specifies the function to call to flush the I and D caches, or to not
10403 call any such function.  If called, the function must take the same
10404 arguments as the common @code{_flush_func()}, that is, the address of the
10405 memory range for which the cache is being flushed, the size of the
10406 memory range, and the number 3 (to flush both caches).  The default
10407 depends on the target GCC was configured for, but commonly is either
10408 @samp{_flush_func} or @samp{__cpu_flush}.
10410 @item -mbranch-likely
10411 @itemx -mno-branch-likely
10412 @opindex mbranch-likely
10413 @opindex mno-branch-likely
10414 Enable or disable use of Branch Likely instructions, regardless of the
10415 default for the selected architecture.  By default, Branch Likely
10416 instructions may be generated if they are supported by the selected
10417 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10418 and processors which implement those architectures; for those, Branch
10419 Likely instructions will not be generated by default because the MIPS32
10420 and MIPS64 architectures specifically deprecate their use.
10422 @item -mfp-exceptions
10423 @itemx -mno-fp-exceptions
10424 @opindex mfp-exceptions
10425 Specifies whether FP exceptions are enabled.  This affects how we schedule
10426 FP instructions for some processors.  The default is that FP exceptions are
10427 enabled.
10429 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10430 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10431 FP pipe.
10433 @item -mvr4130-align
10434 @itemx -mno-vr4130-align
10435 @opindex mvr4130-align
10436 The VR4130 pipeline is two-way superscalar, but can only issue two
10437 instructions together if the first one is 8-byte aligned.  When this
10438 option is enabled, GCC will align pairs of instructions that it
10439 thinks should execute in parallel.
10441 This option only has an effect when optimizing for the VR4130.
10442 It normally makes code faster, but at the expense of making it bigger.
10443 It is enabled by default at optimization level @option{-O3}.
10444 @end table
10446 @node MMIX Options
10447 @subsection MMIX Options
10448 @cindex MMIX Options
10450 These options are defined for the MMIX:
10452 @table @gcctabopt
10453 @item -mlibfuncs
10454 @itemx -mno-libfuncs
10455 @opindex mlibfuncs
10456 @opindex mno-libfuncs
10457 Specify that intrinsic library functions are being compiled, passing all
10458 values in registers, no matter the size.
10460 @item -mepsilon
10461 @itemx -mno-epsilon
10462 @opindex mepsilon
10463 @opindex mno-epsilon
10464 Generate floating-point comparison instructions that compare with respect
10465 to the @code{rE} epsilon register.
10467 @item -mabi=mmixware
10468 @itemx -mabi=gnu
10469 @opindex mabi-mmixware
10470 @opindex mabi=gnu
10471 Generate code that passes function parameters and return values that (in
10472 the called function) are seen as registers @code{$0} and up, as opposed to
10473 the GNU ABI which uses global registers @code{$231} and up.
10475 @item -mzero-extend
10476 @itemx -mno-zero-extend
10477 @opindex mzero-extend
10478 @opindex mno-zero-extend
10479 When reading data from memory in sizes shorter than 64 bits, use (do not
10480 use) zero-extending load instructions by default, rather than
10481 sign-extending ones.
10483 @item -mknuthdiv
10484 @itemx -mno-knuthdiv
10485 @opindex mknuthdiv
10486 @opindex mno-knuthdiv
10487 Make the result of a division yielding a remainder have the same sign as
10488 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10489 remainder follows the sign of the dividend.  Both methods are
10490 arithmetically valid, the latter being almost exclusively used.
10492 @item -mtoplevel-symbols
10493 @itemx -mno-toplevel-symbols
10494 @opindex mtoplevel-symbols
10495 @opindex mno-toplevel-symbols
10496 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10497 code can be used with the @code{PREFIX} assembly directive.
10499 @item -melf
10500 @opindex melf
10501 Generate an executable in the ELF format, rather than the default
10502 @samp{mmo} format used by the @command{mmix} simulator.
10504 @item -mbranch-predict
10505 @itemx -mno-branch-predict
10506 @opindex mbranch-predict
10507 @opindex mno-branch-predict
10508 Use (do not use) the probable-branch instructions, when static branch
10509 prediction indicates a probable branch.
10511 @item -mbase-addresses
10512 @itemx -mno-base-addresses
10513 @opindex mbase-addresses
10514 @opindex mno-base-addresses
10515 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10516 base address automatically generates a request (handled by the assembler
10517 and the linker) for a constant to be set up in a global register.  The
10518 register is used for one or more base address requests within the range 0
10519 to 255 from the value held in the register.  The generally leads to short
10520 and fast code, but the number of different data items that can be
10521 addressed is limited.  This means that a program that uses lots of static
10522 data may require @option{-mno-base-addresses}.
10524 @item -msingle-exit
10525 @itemx -mno-single-exit
10526 @opindex msingle-exit
10527 @opindex mno-single-exit
10528 Force (do not force) generated code to have a single exit point in each
10529 function.
10530 @end table
10532 @node MN10300 Options
10533 @subsection MN10300 Options
10534 @cindex MN10300 options
10536 These @option{-m} options are defined for Matsushita MN10300 architectures:
10538 @table @gcctabopt
10539 @item -mmult-bug
10540 @opindex mmult-bug
10541 Generate code to avoid bugs in the multiply instructions for the MN10300
10542 processors.  This is the default.
10544 @item -mno-mult-bug
10545 @opindex mno-mult-bug
10546 Do not generate code to avoid bugs in the multiply instructions for the
10547 MN10300 processors.
10549 @item -mam33
10550 @opindex mam33
10551 Generate code which uses features specific to the AM33 processor.
10553 @item -mno-am33
10554 @opindex mno-am33
10555 Do not generate code which uses features specific to the AM33 processor.  This
10556 is the default.
10558 @item -mno-crt0
10559 @opindex mno-crt0
10560 Do not link in the C run-time initialization object file.
10562 @item -mrelax
10563 @opindex mrelax
10564 Indicate to the linker that it should perform a relaxation optimization pass
10565 to shorten branches, calls and absolute memory addresses.  This option only
10566 has an effect when used on the command line for the final link step.
10568 This option makes symbolic debugging impossible.
10569 @end table
10571 @node MS1 Options
10572 @subsection MS1 Options
10573 @cindex MS1 options
10575 These @option{-m} options are defined for Morpho MS1 architectures:
10577 @table @gcctabopt
10579 @item -march=@var{cpu-type}
10580 @opindex march
10581 Generate code that will run on @var{cpu-type}, which is the name of a system
10582 representing a certain processor type.  Possible values for
10583 @var{cpu-type} are @samp{MS1-64-001}, @samp{MS1-16-002}, and
10584 @samp{MS1-16-003}.
10586 When this option is not used, the default is @option{-march=MS1-16-003}.
10588 @item -mmul
10589 @opindex mmul
10590 Generate multiply instructions.
10592 @item -mno-mul
10593 @opindex mno-mul
10594 Do not generate multiply instructions.
10596 @item -mbacc
10597 @opindex mbacc
10598 Use byte loads and stores when generating code.
10600 @item -mno-bacc
10601 @opindex mno-bacc
10602 Do not use byte loads and stores when generating code.
10604 @item -msim
10605 @opindex msim
10606 Use simulator runtime
10608 @item -mno-crt0
10609 @opindex mno-crt0
10610 Do not link in the C run-time initialization object file
10611 @file{crti.o}.  Other run-time initialization and termination files
10612 such as @file{startup.o} and @file{exit.o} are still included on the
10613 linker command line.
10615 @end table
10617 @node PDP-11 Options
10618 @subsection PDP-11 Options
10619 @cindex PDP-11 Options
10621 These options are defined for the PDP-11:
10623 @table @gcctabopt
10624 @item -mfpu
10625 @opindex mfpu
10626 Use hardware FPP floating point.  This is the default.  (FIS floating
10627 point on the PDP-11/40 is not supported.)
10629 @item -msoft-float
10630 @opindex msoft-float
10631 Do not use hardware floating point.
10633 @item -mac0
10634 @opindex mac0
10635 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10637 @item -mno-ac0
10638 @opindex mno-ac0
10639 Return floating-point results in memory.  This is the default.
10641 @item -m40
10642 @opindex m40
10643 Generate code for a PDP-11/40.
10645 @item -m45
10646 @opindex m45
10647 Generate code for a PDP-11/45.  This is the default.
10649 @item -m10
10650 @opindex m10
10651 Generate code for a PDP-11/10.
10653 @item -mbcopy-builtin
10654 @opindex bcopy-builtin
10655 Use inline @code{movmemhi} patterns for copying memory.  This is the
10656 default.
10658 @item -mbcopy
10659 @opindex mbcopy
10660 Do not use inline @code{movmemhi} patterns for copying memory.
10662 @item -mint16
10663 @itemx -mno-int32
10664 @opindex mint16
10665 @opindex mno-int32
10666 Use 16-bit @code{int}.  This is the default.
10668 @item -mint32
10669 @itemx -mno-int16
10670 @opindex mint32
10671 @opindex mno-int16
10672 Use 32-bit @code{int}.
10674 @item -mfloat64
10675 @itemx -mno-float32
10676 @opindex mfloat64
10677 @opindex mno-float32
10678 Use 64-bit @code{float}.  This is the default.
10680 @item -mfloat32
10681 @itemx -mno-float64
10682 @opindex mfloat32
10683 @opindex mno-float64
10684 Use 32-bit @code{float}.
10686 @item -mabshi
10687 @opindex mabshi
10688 Use @code{abshi2} pattern.  This is the default.
10690 @item -mno-abshi
10691 @opindex mno-abshi
10692 Do not use @code{abshi2} pattern.
10694 @item -mbranch-expensive
10695 @opindex mbranch-expensive
10696 Pretend that branches are expensive.  This is for experimenting with
10697 code generation only.
10699 @item -mbranch-cheap
10700 @opindex mbranch-cheap
10701 Do not pretend that branches are expensive.  This is the default.
10703 @item -msplit
10704 @opindex msplit
10705 Generate code for a system with split I&D@.
10707 @item -mno-split
10708 @opindex mno-split
10709 Generate code for a system without split I&D@.  This is the default.
10711 @item -munix-asm
10712 @opindex munix-asm
10713 Use Unix assembler syntax.  This is the default when configured for
10714 @samp{pdp11-*-bsd}.
10716 @item -mdec-asm
10717 @opindex mdec-asm
10718 Use DEC assembler syntax.  This is the default when configured for any
10719 PDP-11 target other than @samp{pdp11-*-bsd}.
10720 @end table
10722 @node PowerPC Options
10723 @subsection PowerPC Options
10724 @cindex PowerPC options
10726 These are listed under @xref{RS/6000 and PowerPC Options}.
10728 @node RS/6000 and PowerPC Options
10729 @subsection IBM RS/6000 and PowerPC Options
10730 @cindex RS/6000 and PowerPC Options
10731 @cindex IBM RS/6000 and PowerPC Options
10733 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10734 @table @gcctabopt
10735 @item -mpower
10736 @itemx -mno-power
10737 @itemx -mpower2
10738 @itemx -mno-power2
10739 @itemx -mpowerpc
10740 @itemx -mno-powerpc
10741 @itemx -mpowerpc-gpopt
10742 @itemx -mno-powerpc-gpopt
10743 @itemx -mpowerpc-gfxopt
10744 @itemx -mno-powerpc-gfxopt
10745 @itemx -mpowerpc64
10746 @itemx -mno-powerpc64
10747 @opindex mpower
10748 @opindex mno-power
10749 @opindex mpower2
10750 @opindex mno-power2
10751 @opindex mpowerpc
10752 @opindex mno-powerpc
10753 @opindex mpowerpc-gpopt
10754 @opindex mno-powerpc-gpopt
10755 @opindex mpowerpc-gfxopt
10756 @opindex mno-powerpc-gfxopt
10757 @opindex mpowerpc64
10758 @opindex mno-powerpc64
10759 GCC supports two related instruction set architectures for the
10760 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10761 instructions supported by the @samp{rios} chip set used in the original
10762 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10763 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10764 the IBM 4xx microprocessors.
10766 Neither architecture is a subset of the other.  However there is a
10767 large common subset of instructions supported by both.  An MQ
10768 register is included in processors supporting the POWER architecture.
10770 You use these options to specify which instructions are available on the
10771 processor you are using.  The default value of these options is
10772 determined when configuring GCC@.  Specifying the
10773 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10774 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10775 rather than the options listed above.
10777 The @option{-mpower} option allows GCC to generate instructions that
10778 are found only in the POWER architecture and to use the MQ register.
10779 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10780 to generate instructions that are present in the POWER2 architecture but
10781 not the original POWER architecture.
10783 The @option{-mpowerpc} option allows GCC to generate instructions that
10784 are found only in the 32-bit subset of the PowerPC architecture.
10785 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10786 GCC to use the optional PowerPC architecture instructions in the
10787 General Purpose group, including floating-point square root.  Specifying
10788 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10789 use the optional PowerPC architecture instructions in the Graphics
10790 group, including floating-point select.
10792 The @option{-mpowerpc64} option allows GCC to generate the additional
10793 64-bit instructions that are found in the full PowerPC64 architecture
10794 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10795 @option{-mno-powerpc64}.
10797 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10798 will use only the instructions in the common subset of both
10799 architectures plus some special AIX common-mode calls, and will not use
10800 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10801 permits GCC to use any instruction from either architecture and to
10802 allow use of the MQ register; specify this for the Motorola MPC601.
10804 @item -mnew-mnemonics
10805 @itemx -mold-mnemonics
10806 @opindex mnew-mnemonics
10807 @opindex mold-mnemonics
10808 Select which mnemonics to use in the generated assembler code.  With
10809 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10810 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10811 assembler mnemonics defined for the POWER architecture.  Instructions
10812 defined in only one architecture have only one mnemonic; GCC uses that
10813 mnemonic irrespective of which of these options is specified.
10815 GCC defaults to the mnemonics appropriate for the architecture in
10816 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10817 value of these option.  Unless you are building a cross-compiler, you
10818 should normally not specify either @option{-mnew-mnemonics} or
10819 @option{-mold-mnemonics}, but should instead accept the default.
10821 @item -mcpu=@var{cpu_type}
10822 @opindex mcpu
10823 Set architecture type, register usage, choice of mnemonics, and
10824 instruction scheduling parameters for machine type @var{cpu_type}.
10825 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10826 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10827 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10828 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10829 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10830 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10831 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10832 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10833 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10835 @option{-mcpu=common} selects a completely generic processor.  Code
10836 generated under this option will run on any POWER or PowerPC processor.
10837 GCC will use only the instructions in the common subset of both
10838 architectures, and will not use the MQ register.  GCC assumes a generic
10839 processor model for scheduling purposes.
10841 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10842 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10843 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10844 types, with an appropriate, generic processor model assumed for
10845 scheduling purposes.
10847 The other options specify a specific processor.  Code generated under
10848 those options will run best on that processor, and may not run at all on
10849 others.
10851 The @option{-mcpu} options automatically enable or disable the
10852 following options: @option{-maltivec}, @option{-mhard-float},
10853 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10854 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10855 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10856 @option{-mstring}.  The particular options set for any particular CPU
10857 will vary between compiler versions, depending on what setting seems
10858 to produce optimal code for that CPU; it doesn't necessarily reflect
10859 the actual hardware's capabilities.  If you wish to set an individual
10860 option to a particular value, you may specify it after the
10861 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10863 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10864 not enabled or disabled by the @option{-mcpu} option at present, since
10865 AIX does not have full support for these options.  You may still
10866 enable or disable them individually if you're sure it'll work in your
10867 environment.
10869 @item -mtune=@var{cpu_type}
10870 @opindex mtune
10871 Set the instruction scheduling parameters for machine type
10872 @var{cpu_type}, but do not set the architecture type, register usage, or
10873 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10874 values for @var{cpu_type} are used for @option{-mtune} as for
10875 @option{-mcpu}.  If both are specified, the code generated will use the
10876 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10877 scheduling parameters set by @option{-mtune}.
10879 @item -mswdiv
10880 @itemx -mno-swdiv
10881 @opindex mswdiv
10882 @opindex mno-swdiv
10883 Generate code to compute division as reciprocal estimate and iterative
10884 refinement, creating opportunities for increased throughput.  This
10885 feature requires: optional PowerPC Graphics instruction set for single
10886 precision and FRE instruction for double precision, assuming divides
10887 cannot generate user-visible traps, and the domain values not include
10888 Infinities, denormals or zero denominator.
10890 @item -maltivec
10891 @itemx -mno-altivec
10892 @opindex maltivec
10893 @opindex mno-altivec
10894 Generate code that uses (does not use) AltiVec instructions, and also
10895 enable the use of built-in functions that allow more direct access to
10896 the AltiVec instruction set.  You may also need to set
10897 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10898 enhancements.
10900 @item -mvrsave
10901 @item -mno-vrsave
10902 @opindex mvrsave
10903 @opindex mno-vrsave
10904 Generate VRSAVE instructions when generating AltiVec code.
10906 @item -mabi=spe
10907 @opindex mabi=spe
10908 Extend the current ABI with SPE ABI extensions.  This does not change
10909 the default ABI, instead it adds the SPE ABI extensions to the current
10910 ABI@.
10912 @item -mabi=no-spe
10913 @opindex mabi=no-spe
10914 Disable Booke SPE ABI extensions for the current ABI@.
10916 @item -msecure-plt
10917 @opindex msecure-plt
10918 Generate code that allows ld and ld.so to build executables and shared
10919 libraries with non-exec .plt and .got sections.  This is a PowerPC
10920 32-bit SYSV ABI option.
10922 @item -mbss-plt
10923 @opindex mbss-plt
10924 Generate code that uses a BSS .plt section that ld.so fills in, and
10925 requires .plt and .got sections that are both writable and executable.
10926 This is a PowerPC 32-bit SYSV ABI option.
10928 @item -misel
10929 @itemx -mno-isel
10930 @opindex misel
10931 @opindex mno-isel
10932 This switch enables or disables the generation of ISEL instructions.
10934 @item -misel=@var{yes/no}
10935 This switch has been deprecated.  Use @option{-misel} and
10936 @option{-mno-isel} instead.
10938 @item -mspe
10939 @itemx -mno-isel
10940 @opindex mspe
10941 @opindex mno-spe
10942 This switch enables or disables the generation of SPE simd
10943 instructions.
10945 @item -mspe=@var{yes/no}
10946 This option has been deprecated.  Use @option{-mspe} and
10947 @option{-mno-spe} instead.
10949 @item -mfloat-gprs=@var{yes/single/double/no}
10950 @itemx -mfloat-gprs
10951 @opindex mfloat-gprs
10952 This switch enables or disables the generation of floating point
10953 operations on the general purpose registers for architectures that
10954 support it.
10956 The argument @var{yes} or @var{single} enables the use of
10957 single-precision floating point operations.
10959 The argument @var{double} enables the use of single and
10960 double-precision floating point operations.
10962 The argument @var{no} disables floating point operations on the
10963 general purpose registers.
10965 This option is currently only available on the MPC854x.
10967 @item -m32
10968 @itemx -m64
10969 @opindex m32
10970 @opindex m64
10971 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10972 targets (including GNU/Linux).  The 32-bit environment sets int, long
10973 and pointer to 32 bits and generates code that runs on any PowerPC
10974 variant.  The 64-bit environment sets int to 32 bits and long and
10975 pointer to 64 bits, and generates code for PowerPC64, as for
10976 @option{-mpowerpc64}.
10978 @item -mfull-toc
10979 @itemx -mno-fp-in-toc
10980 @itemx -mno-sum-in-toc
10981 @itemx -mminimal-toc
10982 @opindex mfull-toc
10983 @opindex mno-fp-in-toc
10984 @opindex mno-sum-in-toc
10985 @opindex mminimal-toc
10986 Modify generation of the TOC (Table Of Contents), which is created for
10987 every executable file.  The @option{-mfull-toc} option is selected by
10988 default.  In that case, GCC will allocate at least one TOC entry for
10989 each unique non-automatic variable reference in your program.  GCC
10990 will also place floating-point constants in the TOC@.  However, only
10991 16,384 entries are available in the TOC@.
10993 If you receive a linker error message that saying you have overflowed
10994 the available TOC space, you can reduce the amount of TOC space used
10995 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10996 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10997 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10998 generate code to calculate the sum of an address and a constant at
10999 run-time instead of putting that sum into the TOC@.  You may specify one
11000 or both of these options.  Each causes GCC to produce very slightly
11001 slower and larger code at the expense of conserving TOC space.
11003 If you still run out of space in the TOC even when you specify both of
11004 these options, specify @option{-mminimal-toc} instead.  This option causes
11005 GCC to make only one TOC entry for every file.  When you specify this
11006 option, GCC will produce code that is slower and larger but which
11007 uses extremely little TOC space.  You may wish to use this option
11008 only on files that contain less frequently executed code.
11010 @item -maix64
11011 @itemx -maix32
11012 @opindex maix64
11013 @opindex maix32
11014 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11015 @code{long} type, and the infrastructure needed to support them.
11016 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11017 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11018 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11020 @item -mxl-compat
11021 @itemx -mno-xl-compat
11022 @opindex mxl-compat
11023 @opindex mno-xl-compat
11024 Produce code that conforms more closely to IBM XLC semantics when using
11025 AIX-compatible ABI.  Pass floating-point arguments to prototyped
11026 functions beyond the register save area (RSA) on the stack in addition
11027 to argument FPRs.  Do not assume that most significant double in 128
11028 bit long double value is properly rounded when comparing values.
11030 The AIX calling convention was extended but not initially documented to
11031 handle an obscure K&R C case of calling a function that takes the
11032 address of its arguments with fewer arguments than declared.  AIX XL
11033 compilers access floating point arguments which do not fit in the
11034 RSA from the stack when a subroutine is compiled without
11035 optimization.  Because always storing floating-point arguments on the
11036 stack is inefficient and rarely needed, this option is not enabled by
11037 default and only is necessary when calling subroutines compiled by AIX
11038 XL compilers without optimization.
11040 @item -mpe
11041 @opindex mpe
11042 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11043 application written to use message passing with special startup code to
11044 enable the application to run.  The system must have PE installed in the
11045 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11046 must be overridden with the @option{-specs=} option to specify the
11047 appropriate directory location.  The Parallel Environment does not
11048 support threads, so the @option{-mpe} option and the @option{-pthread}
11049 option are incompatible.
11051 @item -malign-natural
11052 @itemx -malign-power
11053 @opindex malign-natural
11054 @opindex malign-power
11055 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11056 @option{-malign-natural} overrides the ABI-defined alignment of larger
11057 types, such as floating-point doubles, on their natural size-based boundary.
11058 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11059 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11061 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11062 is not supported.
11064 @item -msoft-float
11065 @itemx -mhard-float
11066 @opindex msoft-float
11067 @opindex mhard-float
11068 Generate code that does not use (uses) the floating-point register set.
11069 Software floating point emulation is provided if you use the
11070 @option{-msoft-float} option, and pass the option to GCC when linking.
11072 @item -mmultiple
11073 @itemx -mno-multiple
11074 @opindex mmultiple
11075 @opindex mno-multiple
11076 Generate code that uses (does not use) the load multiple word
11077 instructions and the store multiple word instructions.  These
11078 instructions are generated by default on POWER systems, and not
11079 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11080 endian PowerPC systems, since those instructions do not work when the
11081 processor is in little endian mode.  The exceptions are PPC740 and
11082 PPC750 which permit the instructions usage in little endian mode.
11084 @item -mstring
11085 @itemx -mno-string
11086 @opindex mstring
11087 @opindex mno-string
11088 Generate code that uses (does not use) the load string instructions
11089 and the store string word instructions to save multiple registers and
11090 do small block moves.  These instructions are generated by default on
11091 POWER systems, and not generated on PowerPC systems.  Do not use
11092 @option{-mstring} on little endian PowerPC systems, since those
11093 instructions do not work when the processor is in little endian mode.
11094 The exceptions are PPC740 and PPC750 which permit the instructions
11095 usage in little endian mode.
11097 @item -mupdate
11098 @itemx -mno-update
11099 @opindex mupdate
11100 @opindex mno-update
11101 Generate code that uses (does not use) the load or store instructions
11102 that update the base register to the address of the calculated memory
11103 location.  These instructions are generated by default.  If you use
11104 @option{-mno-update}, there is a small window between the time that the
11105 stack pointer is updated and the address of the previous frame is
11106 stored, which means code that walks the stack frame across interrupts or
11107 signals may get corrupted data.
11109 @item -mfused-madd
11110 @itemx -mno-fused-madd
11111 @opindex mfused-madd
11112 @opindex mno-fused-madd
11113 Generate code that uses (does not use) the floating point multiply and
11114 accumulate instructions.  These instructions are generated by default if
11115 hardware floating is used.
11117 @item -mno-bit-align
11118 @itemx -mbit-align
11119 @opindex mno-bit-align
11120 @opindex mbit-align
11121 On System V.4 and embedded PowerPC systems do not (do) force structures
11122 and unions that contain bit-fields to be aligned to the base type of the
11123 bit-field.
11125 For example, by default a structure containing nothing but 8
11126 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11127 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11128 the structure would be aligned to a 1 byte boundary and be one byte in
11129 size.
11131 @item -mno-strict-align
11132 @itemx -mstrict-align
11133 @opindex mno-strict-align
11134 @opindex mstrict-align
11135 On System V.4 and embedded PowerPC systems do not (do) assume that
11136 unaligned memory references will be handled by the system.
11138 @item -mrelocatable
11139 @itemx -mno-relocatable
11140 @opindex mrelocatable
11141 @opindex mno-relocatable
11142 On embedded PowerPC systems generate code that allows (does not allow)
11143 the program to be relocated to a different address at runtime.  If you
11144 use @option{-mrelocatable} on any module, all objects linked together must
11145 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11147 @item -mrelocatable-lib
11148 @itemx -mno-relocatable-lib
11149 @opindex mrelocatable-lib
11150 @opindex mno-relocatable-lib
11151 On embedded PowerPC systems generate code that allows (does not allow)
11152 the program to be relocated to a different address at runtime.  Modules
11153 compiled with @option{-mrelocatable-lib} can be linked with either modules
11154 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11155 with modules compiled with the @option{-mrelocatable} options.
11157 @item -mno-toc
11158 @itemx -mtoc
11159 @opindex mno-toc
11160 @opindex mtoc
11161 On System V.4 and embedded PowerPC systems do not (do) assume that
11162 register 2 contains a pointer to a global area pointing to the addresses
11163 used in the program.
11165 @item -mlittle
11166 @itemx -mlittle-endian
11167 @opindex mlittle
11168 @opindex mlittle-endian
11169 On System V.4 and embedded PowerPC systems compile code for the
11170 processor in little endian mode.  The @option{-mlittle-endian} option is
11171 the same as @option{-mlittle}.
11173 @item -mbig
11174 @itemx -mbig-endian
11175 @opindex mbig
11176 @opindex mbig-endian
11177 On System V.4 and embedded PowerPC systems compile code for the
11178 processor in big endian mode.  The @option{-mbig-endian} option is
11179 the same as @option{-mbig}.
11181 @item -mdynamic-no-pic
11182 @opindex mdynamic-no-pic
11183 On Darwin and Mac OS X systems, compile code so that it is not
11184 relocatable, but that its external references are relocatable.  The
11185 resulting code is suitable for applications, but not shared
11186 libraries.
11188 @item -mprioritize-restricted-insns=@var{priority}
11189 @opindex mprioritize-restricted-insns
11190 This option controls the priority that is assigned to
11191 dispatch-slot restricted instructions during the second scheduling
11192 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11193 @var{no/highest/second-highest} priority to dispatch slot restricted
11194 instructions.
11196 @item -msched-costly-dep=@var{dependence_type}
11197 @opindex msched-costly-dep
11198 This option controls which dependences are considered costly
11199 by the target during instruction scheduling.  The argument
11200 @var{dependence_type} takes one of the following values:
11201 @var{no}: no dependence is costly,
11202 @var{all}: all dependences are costly,
11203 @var{true_store_to_load}: a true dependence from store to load is costly,
11204 @var{store_to_load}: any dependence from store to load is costly,
11205 @var{number}: any dependence which latency >= @var{number} is costly.
11207 @item -minsert-sched-nops=@var{scheme}
11208 @opindex minsert-sched-nops
11209 This option controls which nop insertion scheme will be used during
11210 the second scheduling pass.  The argument @var{scheme} takes one of the
11211 following values:
11212 @var{no}: Don't insert nops.
11213 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11214 according to the scheduler's grouping.
11215 @var{regroup_exact}: Insert nops to force costly dependent insns into
11216 separate groups.  Insert exactly as many nops as needed to force an insn
11217 to a new group, according to the estimated processor grouping.
11218 @var{number}: Insert nops to force costly dependent insns into
11219 separate groups.  Insert @var{number} nops to force an insn to a new group.
11221 @item -mcall-sysv
11222 @opindex mcall-sysv
11223 On System V.4 and embedded PowerPC systems compile code using calling
11224 conventions that adheres to the March 1995 draft of the System V
11225 Application Binary Interface, PowerPC processor supplement.  This is the
11226 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11228 @item -mcall-sysv-eabi
11229 @opindex mcall-sysv-eabi
11230 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11232 @item -mcall-sysv-noeabi
11233 @opindex mcall-sysv-noeabi
11234 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11236 @item -mcall-solaris
11237 @opindex mcall-solaris
11238 On System V.4 and embedded PowerPC systems compile code for the Solaris
11239 operating system.
11241 @item -mcall-linux
11242 @opindex mcall-linux
11243 On System V.4 and embedded PowerPC systems compile code for the
11244 Linux-based GNU system.
11246 @item -mcall-gnu
11247 @opindex mcall-gnu
11248 On System V.4 and embedded PowerPC systems compile code for the
11249 Hurd-based GNU system.
11251 @item -mcall-netbsd
11252 @opindex mcall-netbsd
11253 On System V.4 and embedded PowerPC systems compile code for the
11254 NetBSD operating system.
11256 @item -maix-struct-return
11257 @opindex maix-struct-return
11258 Return all structures in memory (as specified by the AIX ABI)@.
11260 @item -msvr4-struct-return
11261 @opindex msvr4-struct-return
11262 Return structures smaller than 8 bytes in registers (as specified by the
11263 SVR4 ABI)@.
11265 @item -mabi=@var{abi-type}
11266 @opindex mabi
11267 Extend the current ABI with a particular extension, or remove such extension.
11268 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11269 @var{no-spe}@.
11271 @item -mprototype
11272 @itemx -mno-prototype
11273 @opindex mprototype
11274 @opindex mno-prototype
11275 On System V.4 and embedded PowerPC systems assume that all calls to
11276 variable argument functions are properly prototyped.  Otherwise, the
11277 compiler must insert an instruction before every non prototyped call to
11278 set or clear bit 6 of the condition code register (@var{CR}) to
11279 indicate whether floating point values were passed in the floating point
11280 registers in case the function takes a variable arguments.  With
11281 @option{-mprototype}, only calls to prototyped variable argument functions
11282 will set or clear the bit.
11284 @item -msim
11285 @opindex msim
11286 On embedded PowerPC systems, assume that the startup module is called
11287 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11288 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11289 configurations.
11291 @item -mmvme
11292 @opindex mmvme
11293 On embedded PowerPC systems, assume that the startup module is called
11294 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11295 @file{libc.a}.
11297 @item -mads
11298 @opindex mads
11299 On embedded PowerPC systems, assume that the startup module is called
11300 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11301 @file{libc.a}.
11303 @item -myellowknife
11304 @opindex myellowknife
11305 On embedded PowerPC systems, assume that the startup module is called
11306 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11307 @file{libc.a}.
11309 @item -mvxworks
11310 @opindex mvxworks
11311 On System V.4 and embedded PowerPC systems, specify that you are
11312 compiling for a VxWorks system.
11314 @item -mwindiss
11315 @opindex mwindiss
11316 Specify that you are compiling for the WindISS simulation environment.
11318 @item -memb
11319 @opindex memb
11320 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11321 header to indicate that @samp{eabi} extended relocations are used.
11323 @item -meabi
11324 @itemx -mno-eabi
11325 @opindex meabi
11326 @opindex mno-eabi
11327 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11328 Embedded Applications Binary Interface (eabi) which is a set of
11329 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11330 means that the stack is aligned to an 8 byte boundary, a function
11331 @code{__eabi} is called to from @code{main} to set up the eabi
11332 environment, and the @option{-msdata} option can use both @code{r2} and
11333 @code{r13} to point to two separate small data areas.  Selecting
11334 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11335 do not call an initialization function from @code{main}, and the
11336 @option{-msdata} option will only use @code{r13} to point to a single
11337 small data area.  The @option{-meabi} option is on by default if you
11338 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11340 @item -msdata=eabi
11341 @opindex msdata=eabi
11342 On System V.4 and embedded PowerPC systems, put small initialized
11343 @code{const} global and static data in the @samp{.sdata2} section, which
11344 is pointed to by register @code{r2}.  Put small initialized
11345 non-@code{const} global and static data in the @samp{.sdata} section,
11346 which is pointed to by register @code{r13}.  Put small uninitialized
11347 global and static data in the @samp{.sbss} section, which is adjacent to
11348 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11349 incompatible with the @option{-mrelocatable} option.  The
11350 @option{-msdata=eabi} option also sets the @option{-memb} option.
11352 @item -msdata=sysv
11353 @opindex msdata=sysv
11354 On System V.4 and embedded PowerPC systems, put small global and static
11355 data in the @samp{.sdata} section, which is pointed to by register
11356 @code{r13}.  Put small uninitialized global and static data in the
11357 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11358 The @option{-msdata=sysv} option is incompatible with the
11359 @option{-mrelocatable} option.
11361 @item -msdata=default
11362 @itemx -msdata
11363 @opindex msdata=default
11364 @opindex msdata
11365 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11366 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11367 same as @option{-msdata=sysv}.
11369 @item -msdata-data
11370 @opindex msdata-data
11371 On System V.4 and embedded PowerPC systems, put small global and static
11372 data in the @samp{.sdata} section.  Put small uninitialized global and
11373 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11374 to address small data however.  This is the default behavior unless
11375 other @option{-msdata} options are used.
11377 @item -msdata=none
11378 @itemx -mno-sdata
11379 @opindex msdata=none
11380 @opindex mno-sdata
11381 On embedded PowerPC systems, put all initialized global and static data
11382 in the @samp{.data} section, and all uninitialized data in the
11383 @samp{.bss} section.
11385 @item -G @var{num}
11386 @opindex G
11387 @cindex smaller data references (PowerPC)
11388 @cindex .sdata/.sdata2 references (PowerPC)
11389 On embedded PowerPC systems, put global and static items less than or
11390 equal to @var{num} bytes into the small data or bss sections instead of
11391 the normal data or bss section.  By default, @var{num} is 8.  The
11392 @option{-G @var{num}} switch is also passed to the linker.
11393 All modules should be compiled with the same @option{-G @var{num}} value.
11395 @item -mregnames
11396 @itemx -mno-regnames
11397 @opindex mregnames
11398 @opindex mno-regnames
11399 On System V.4 and embedded PowerPC systems do (do not) emit register
11400 names in the assembly language output using symbolic forms.
11402 @item -mlongcall
11403 @itemx -mno-longcall
11404 @opindex mlongcall
11405 @opindex mno-longcall
11406 Default to making all function calls indirectly, using a register, so
11407 that functions which reside further than 32 megabytes (33,554,432
11408 bytes) from the current location can be called.  This setting can be
11409 overridden by the @code{shortcall} function attribute, or by
11410 @code{#pragma longcall(0)}.
11412 Some linkers are capable of detecting out-of-range calls and generating
11413 glue code on the fly.  On these systems, long calls are unnecessary and
11414 generate slower code.  As of this writing, the AIX linker can do this,
11415 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11416 to the GNU linker for 32-bit PowerPC systems as well.
11418 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11419 callee, L42'', plus a ``branch island'' (glue code).  The two target
11420 addresses represent the callee and the ``branch island''.  The
11421 Darwin/PPC linker will prefer the first address and generate a ``bl
11422 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11423 otherwise, the linker will generate ``bl L42'' to call the ``branch
11424 island''.  The ``branch island'' is appended to the body of the
11425 calling function; it computes the full 32-bit address of the callee
11426 and jumps to it.
11428 On Mach-O (Darwin) systems, this option directs the compiler emit to
11429 the glue for every direct call, and the Darwin linker decides whether
11430 to use or discard it.
11432 In the future, we may cause GCC to ignore all longcall specifications
11433 when the linker is known to generate glue.
11435 @item -pthread
11436 @opindex pthread
11437 Adds support for multithreading with the @dfn{pthreads} library.
11438 This option sets flags for both the preprocessor and linker.
11440 @end table
11442 @node S/390 and zSeries Options
11443 @subsection S/390 and zSeries Options
11444 @cindex S/390 and zSeries Options
11446 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11448 @table @gcctabopt
11449 @item -mhard-float
11450 @itemx -msoft-float
11451 @opindex mhard-float
11452 @opindex msoft-float
11453 Use (do not use) the hardware floating-point instructions and registers
11454 for floating-point operations.  When @option{-msoft-float} is specified,
11455 functions in @file{libgcc.a} will be used to perform floating-point
11456 operations.  When @option{-mhard-float} is specified, the compiler
11457 generates IEEE floating-point instructions.  This is the default.
11459 @item -mbackchain
11460 @itemx -mno-backchain
11461 @opindex mbackchain
11462 @opindex mno-backchain
11463 Store (do not store) the address of the caller's frame as backchain pointer
11464 into the callee's stack frame.
11465 A backchain may be needed to allow debugging using tools that do not understand
11466 DWARF-2 call frame information.
11467 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11468 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11469 the backchain is placed into the topmost word of the 96/160 byte register
11470 save area.
11472 In general, code compiled with @option{-mbackchain} is call-compatible with
11473 code compiled with @option{-mmo-backchain}; however, use of the backchain
11474 for debugging purposes usually requires that the whole binary is built with
11475 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11476 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11477 to build a linux kernel use @option{-msoft-float}.
11479 The default is to not maintain the backchain.
11481 @item -mpacked-stack
11482 @item -mno-packed-stack
11483 @opindex mpacked-stack
11484 @opindex mno-packed-stack
11485 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11486 specified, the compiler uses the all fields of the 96/160 byte register save
11487 area only for their default purpose; unused fields still take up stack space.
11488 When @option{-mpacked-stack} is specified, register save slots are densely
11489 packed at the top of the register save area; unused space is reused for other
11490 purposes, allowing for more efficient use of the available stack space.
11491 However, when @option{-mbackchain} is also in effect, the topmost word of
11492 the save area is always used to store the backchain, and the return address
11493 register is always saved two words below the backchain.
11495 As long as the stack frame backchain is not used, code generated with
11496 @option{-mpacked-stack} is call-compatible with code generated with
11497 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11498 S/390 or zSeries generated code that uses the stack frame backchain at run
11499 time, not just for debugging purposes.  Such code is not call-compatible
11500 with code compiled with @option{-mpacked-stack}.  Also, note that the
11501 combination of @option{-mbackchain},
11502 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11503 to build a linux kernel use @option{-msoft-float}.
11505 The default is to not use the packed stack layout.
11507 @item -msmall-exec
11508 @itemx -mno-small-exec
11509 @opindex msmall-exec
11510 @opindex mno-small-exec
11511 Generate (or do not generate) code using the @code{bras} instruction
11512 to do subroutine calls.
11513 This only works reliably if the total executable size does not
11514 exceed 64k.  The default is to use the @code{basr} instruction instead,
11515 which does not have this limitation.
11517 @item -m64
11518 @itemx -m31
11519 @opindex m64
11520 @opindex m31
11521 When @option{-m31} is specified, generate code compliant to the
11522 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11523 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11524 particular to generate 64-bit instructions.  For the @samp{s390}
11525 targets, the default is @option{-m31}, while the @samp{s390x}
11526 targets default to @option{-m64}.
11528 @item -mzarch
11529 @itemx -mesa
11530 @opindex mzarch
11531 @opindex mesa
11532 When @option{-mzarch} is specified, generate code using the
11533 instructions available on z/Architecture.
11534 When @option{-mesa} is specified, generate code using the
11535 instructions available on ESA/390.  Note that @option{-mesa} is
11536 not possible with @option{-m64}.
11537 When generating code compliant to the GNU/Linux for S/390 ABI,
11538 the default is @option{-mesa}.  When generating code compliant
11539 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11541 @item -mmvcle
11542 @itemx -mno-mvcle
11543 @opindex mmvcle
11544 @opindex mno-mvcle
11545 Generate (or do not generate) code using the @code{mvcle} instruction
11546 to perform block moves.  When @option{-mno-mvcle} is specified,
11547 use a @code{mvc} loop instead.  This is the default unless optimizing for
11548 size.
11550 @item -mdebug
11551 @itemx -mno-debug
11552 @opindex mdebug
11553 @opindex mno-debug
11554 Print (or do not print) additional debug information when compiling.
11555 The default is to not print debug information.
11557 @item -march=@var{cpu-type}
11558 @opindex march
11559 Generate code that will run on @var{cpu-type}, which is the name of a system
11560 representing a certain processor type.  Possible values for
11561 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11562 When generating code using the instructions available on z/Architecture,
11563 the default is @option{-march=z900}.  Otherwise, the default is
11564 @option{-march=g5}.
11566 @item -mtune=@var{cpu-type}
11567 @opindex mtune
11568 Tune to @var{cpu-type} everything applicable about the generated code,
11569 except for the ABI and the set of available instructions.
11570 The list of @var{cpu-type} values is the same as for @option{-march}.
11571 The default is the value used for @option{-march}.
11573 @item -mtpf-trace
11574 @itemx -mno-tpf-trace
11575 @opindex mtpf-trace
11576 @opindex mno-tpf-trace
11577 Generate code that adds (does not add) in TPF OS specific branches to trace
11578 routines in the operating system.  This option is off by default, even
11579 when compiling for the TPF OS@.
11581 @item -mfused-madd
11582 @itemx -mno-fused-madd
11583 @opindex mfused-madd
11584 @opindex mno-fused-madd
11585 Generate code that uses (does not use) the floating point multiply and
11586 accumulate instructions.  These instructions are generated by default if
11587 hardware floating point is used.
11589 @item -mwarn-framesize=@var{framesize}
11590 @opindex mwarn-framesize
11591 Emit a warning if the current function exceeds the given frame size.  Because
11592 this is a compile time check it doesn't need to be a real problem when the program
11593 runs.  It is intended to identify functions which most probably cause
11594 a stack overflow.  It is useful to be used in an environment with limited stack
11595 size e.g.@: the linux kernel.
11597 @item -mwarn-dynamicstack
11598 @opindex mwarn-dynamicstack
11599 Emit a warning if the function calls alloca or uses dynamically
11600 sized arrays.  This is generally a bad idea with a limited stack size.
11602 @item -mstack-guard=@var{stack-guard}
11603 @item -mstack-size=@var{stack-size}
11604 @opindex mstack-guard
11605 @opindex mstack-size
11606 These arguments always have to be used in conjunction.  If they are present the s390
11607 back end emits additional instructions in the function prologue which trigger a trap
11608 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11609 (remember that the stack on s390 grows downward).  These options are intended to
11610 be used to help debugging stack overflow problems.  The additionally emitted code
11611 cause only little overhead and hence can also be used in production like systems
11612 without greater performance degradation.  The given values have to be exact
11613 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11614 In order to be efficient the extra code makes the assumption that the stack starts
11615 at an address aligned to the value given by @var{stack-size}.
11616 @end table
11618 @node SH Options
11619 @subsection SH Options
11621 These @samp{-m} options are defined for the SH implementations:
11623 @table @gcctabopt
11624 @item -m1
11625 @opindex m1
11626 Generate code for the SH1.
11628 @item -m2
11629 @opindex m2
11630 Generate code for the SH2.
11632 @item -m2e
11633 Generate code for the SH2e.
11635 @item -m3
11636 @opindex m3
11637 Generate code for the SH3.
11639 @item -m3e
11640 @opindex m3e
11641 Generate code for the SH3e.
11643 @item -m4-nofpu
11644 @opindex m4-nofpu
11645 Generate code for the SH4 without a floating-point unit.
11647 @item -m4-single-only
11648 @opindex m4-single-only
11649 Generate code for the SH4 with a floating-point unit that only
11650 supports single-precision arithmetic.
11652 @item -m4-single
11653 @opindex m4-single
11654 Generate code for the SH4 assuming the floating-point unit is in
11655 single-precision mode by default.
11657 @item -m4
11658 @opindex m4
11659 Generate code for the SH4.
11661 @item -m4a-nofpu
11662 @opindex m4a-nofpu
11663 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11664 floating-point unit is not used.
11666 @item -m4a-single-only
11667 @opindex m4a-single-only
11668 Generate code for the SH4a, in such a way that no double-precision
11669 floating point operations are used.
11671 @item -m4a-single
11672 @opindex m4a-single
11673 Generate code for the SH4a assuming the floating-point unit is in
11674 single-precision mode by default.
11676 @item -m4a
11677 @opindex m4a
11678 Generate code for the SH4a.
11680 @item -m4al
11681 @opindex m4al
11682 Same as @option{-m4a-nofpu}, except that it implicitly passes
11683 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11684 instructions at the moment.
11686 @item -mb
11687 @opindex mb
11688 Compile code for the processor in big endian mode.
11690 @item -ml
11691 @opindex ml
11692 Compile code for the processor in little endian mode.
11694 @item -mdalign
11695 @opindex mdalign
11696 Align doubles at 64-bit boundaries.  Note that this changes the calling
11697 conventions, and thus some functions from the standard C library will
11698 not work unless you recompile it first with @option{-mdalign}.
11700 @item -mrelax
11701 @opindex mrelax
11702 Shorten some address references at link time, when possible; uses the
11703 linker option @option{-relax}.
11705 @item -mbigtable
11706 @opindex mbigtable
11707 Use 32-bit offsets in @code{switch} tables.  The default is to use
11708 16-bit offsets.
11710 @item -mfmovd
11711 @opindex mfmovd
11712 Enable the use of the instruction @code{fmovd}.
11714 @item -mhitachi
11715 @opindex mhitachi
11716 Comply with the calling conventions defined by Renesas.
11718 @item -mrenesas
11719 @opindex mhitachi
11720 Comply with the calling conventions defined by Renesas.
11722 @item -mno-renesas
11723 @opindex mhitachi
11724 Comply with the calling conventions defined for GCC before the Renesas
11725 conventions were available.  This option is the default for all
11726 targets of the SH toolchain except for @samp{sh-symbianelf}.
11728 @item -mnomacsave
11729 @opindex mnomacsave
11730 Mark the @code{MAC} register as call-clobbered, even if
11731 @option{-mhitachi} is given.
11733 @item -mieee
11734 @opindex mieee
11735 Increase IEEE-compliance of floating-point code.
11736 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11737 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11738 comparisons of NANs / infinities incurs extra overhead in every
11739 floating point comparison, therefore the default is set to
11740 @option{-ffinite-math-only}.
11742 @item -misize
11743 @opindex misize
11744 Dump instruction size and location in the assembly code.
11746 @item -mpadstruct
11747 @opindex mpadstruct
11748 This option is deprecated.  It pads structures to multiple of 4 bytes,
11749 which is incompatible with the SH ABI@.
11751 @item -mspace
11752 @opindex mspace
11753 Optimize for space instead of speed.  Implied by @option{-Os}.
11755 @item -mprefergot
11756 @opindex mprefergot
11757 When generating position-independent code, emit function calls using
11758 the Global Offset Table instead of the Procedure Linkage Table.
11760 @item -musermode
11761 @opindex musermode
11762 Generate a library function call to invalidate instruction cache
11763 entries, after fixing up a trampoline.  This library function call
11764 doesn't assume it can write to the whole memory address space.  This
11765 is the default when the target is @code{sh-*-linux*}.
11767 @item -multcost=@var{number}
11768 @opindex multcost=@var{number}
11769 Set the cost to assume for a multiply insn.
11771 @item -mdiv=@var{strategy}
11772 @opindex mdiv=@var{strategy}
11773 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11774 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11775 inv:call2, inv:fp .
11776 "fp" performs the operation in floating point.  This has a very high latency,
11777 but needs only a few instructions, so it might be a good choice if
11778 your code has enough easily exploitable ILP to allow the compiler to
11779 schedule the floating point instructions together with other instructions.
11780 Division by zero causes a floating point exception.
11781 "inv" uses integer operations to calculate the inverse of the divisor,
11782 and then multiplies the dividend with the inverse.  This strategy allows
11783 cse and hoisting of the inverse calculation.  Division by zero calculates
11784 an unspecified result, but does not trap.
11785 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11786 have been found, or if the entire operation has been hoisted to the same
11787 place, the last stages of the inverse calculation are intertwined with the
11788 final multiply to reduce the overall latency, at the expense of using a few
11789 more instructions, and thus offering fewer scheduling opportunities with
11790 other code.
11791 "call" calls a library function that usually implements the inv:minlat
11792 strategy.
11793 This gives high code density for m5-*media-nofpu compilations.
11794 "call2" uses a different entry point of the same library function, where it
11795 assumes that a pointer to a lookup table has already been set up, which
11796 exposes the pointer load to cse / code hoisting optimizations.
11797 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11798 code generation, but if the code stays unoptimized, revert to the "call",
11799 "call2", or "fp" strategies, respectively.  Note that the
11800 potentially-trapping side effect of division by zero is carried by a
11801 separate instruction, so it is possible that all the integer instructions
11802 are hoisted out, but the marker for the side effect stays where it is.
11803 A recombination to fp operations or a call is not possible in that case.
11804 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11805 that the inverse calculation was nor separated from the multiply, they speed
11806 up division where the dividend fits into 20 bits (plus sign where applicable),
11807 by inserting a test to skip a number of operations in this case; this test
11808 slows down the case of larger dividends.  inv20u assumes the case of a such
11809 a small dividend to be unlikely, and inv20l assumes it to be likely.
11811 @item -mdivsi3_libfunc=@var{name}
11812 @opindex mdivsi3_libfunc=@var{name}
11813 Set the name of the library function used for 32 bit signed division to
11814 @var{name}.  This only affect the name used in the call and inv:call
11815 division strategies, and the compiler will still expect the same
11816 sets of input/output/clobbered registers as if this option was not present.
11818 @item -madjust-unroll
11819 @opindex madjust-unroll
11820 Throttle unrolling to avoid thrashing target registers.
11821 This option only has an effect if the gcc code base supports the
11822 TARGET_ADJUST_UNROLL_MAX target hook.
11824 @item -mindexed-addressing
11825 @opindex mindexed-addressing
11826 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11827 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11828 semantics for the indexed addressing mode.  The architecture allows the
11829 implementation of processors with 64 bit MMU, which the OS could use to
11830 get 32 bit addressing, but since no current hardware implementation supports
11831 this or any other way to make the indexed addressing mode safe to use in
11832 the 32 bit ABI, the default is -mno-indexed-addressing.
11834 @item -mgettrcost=@var{number}
11835 @opindex mgettrcost=@var{number}
11836 Set the cost assumed for the gettr instruction to @var{number}.
11837 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11839 @item -mpt-fixed
11840 @opindex mpt-fixed
11841 Assume pt* instructions won't trap.  This will generally generate better
11842 scheduled code, but is unsafe on current hardware.  The current architecture
11843 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11844 This has the unintentional effect of making it unsafe to schedule ptabs /
11845 ptrel before a branch, or hoist it out of a loop.  For example,
11846 __do_global_ctors, a part of libgcc that runs constructors at program
11847 startup, calls functions in a list which is delimited by -1.  With the
11848 -mpt-fixed option, the ptabs will be done before testing against -1.
11849 That means that all the constructors will be run a bit quicker, but when
11850 the loop comes to the end of the list, the program crashes because ptabs
11851 loads -1 into a target register.  Since this option is unsafe for any
11852 hardware implementing the current architecture specification, the default
11853 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11854 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11855 this deters register allocation using target registers for storing
11856 ordinary integers.
11858 @item -minvalid-symbols
11859 @opindex minvalid-symbols
11860 Assume symbols might be invalid.  Ordinary function symbols generated by
11861 the compiler will always be valid to load with movi/shori/ptabs or
11862 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11863 to generate symbols that will cause ptabs / ptrel to trap.
11864 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11865 It will then prevent cross-basic-block cse, hoisting and most scheduling
11866 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11867 @end table
11869 @node SPARC Options
11870 @subsection SPARC Options
11871 @cindex SPARC options
11873 These @samp{-m} options are supported on the SPARC:
11875 @table @gcctabopt
11876 @item -mno-app-regs
11877 @itemx -mapp-regs
11878 @opindex mno-app-regs
11879 @opindex mapp-regs
11880 Specify @option{-mapp-regs} to generate output using the global registers
11881 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11882 is the default.
11884 To be fully SVR4 ABI compliant at the cost of some performance loss,
11885 specify @option{-mno-app-regs}.  You should compile libraries and system
11886 software with this option.
11888 @item -mfpu
11889 @itemx -mhard-float
11890 @opindex mfpu
11891 @opindex mhard-float
11892 Generate output containing floating point instructions.  This is the
11893 default.
11895 @item -mno-fpu
11896 @itemx -msoft-float
11897 @opindex mno-fpu
11898 @opindex msoft-float
11899 Generate output containing library calls for floating point.
11900 @strong{Warning:} the requisite libraries are not available for all SPARC
11901 targets.  Normally the facilities of the machine's usual C compiler are
11902 used, but this cannot be done directly in cross-compilation.  You must make
11903 your own arrangements to provide suitable library functions for
11904 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11905 @samp{sparclite-*-*} do provide software floating point support.
11907 @option{-msoft-float} changes the calling convention in the output file;
11908 therefore, it is only useful if you compile @emph{all} of a program with
11909 this option.  In particular, you need to compile @file{libgcc.a}, the
11910 library that comes with GCC, with @option{-msoft-float} in order for
11911 this to work.
11913 @item -mhard-quad-float
11914 @opindex mhard-quad-float
11915 Generate output containing quad-word (long double) floating point
11916 instructions.
11918 @item -msoft-quad-float
11919 @opindex msoft-quad-float
11920 Generate output containing library calls for quad-word (long double)
11921 floating point instructions.  The functions called are those specified
11922 in the SPARC ABI@.  This is the default.
11924 As of this writing, there are no SPARC implementations that have hardware
11925 support for the quad-word floating point instructions.  They all invoke
11926 a trap handler for one of these instructions, and then the trap handler
11927 emulates the effect of the instruction.  Because of the trap handler overhead,
11928 this is much slower than calling the ABI library routines.  Thus the
11929 @option{-msoft-quad-float} option is the default.
11931 @item -mno-unaligned-doubles
11932 @itemx -munaligned-doubles
11933 @opindex mno-unaligned-doubles
11934 @opindex munaligned-doubles
11935 Assume that doubles have 8 byte alignment.  This is the default.
11937 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11938 alignment only if they are contained in another type, or if they have an
11939 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11940 Specifying this option avoids some rare compatibility problems with code
11941 generated by other compilers.  It is not the default because it results
11942 in a performance loss, especially for floating point code.
11944 @item -mno-faster-structs
11945 @itemx -mfaster-structs
11946 @opindex mno-faster-structs
11947 @opindex mfaster-structs
11948 With @option{-mfaster-structs}, the compiler assumes that structures
11949 should have 8 byte alignment.  This enables the use of pairs of
11950 @code{ldd} and @code{std} instructions for copies in structure
11951 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11952 However, the use of this changed alignment directly violates the SPARC
11953 ABI@.  Thus, it's intended only for use on targets where the developer
11954 acknowledges that their resulting code will not be directly in line with
11955 the rules of the ABI@.
11957 @item -mimpure-text
11958 @opindex mimpure-text
11959 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11960 the compiler to not pass @option{-z text} to the linker when linking a
11961 shared object.  Using this option, you can link position-dependent
11962 code into a shared object.
11964 @option{-mimpure-text} suppresses the ``relocations remain against
11965 allocatable but non-writable sections'' linker error message.
11966 However, the necessary relocations will trigger copy-on-write, and the
11967 shared object is not actually shared across processes.  Instead of
11968 using @option{-mimpure-text}, you should compile all source code with
11969 @option{-fpic} or @option{-fPIC}.
11971 This option is only available on SunOS and Solaris.
11973 @item -mcpu=@var{cpu_type}
11974 @opindex mcpu
11975 Set the instruction set, register set, and instruction scheduling parameters
11976 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11977 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11978 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11979 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11980 @samp{ultrasparc3}.
11982 Default instruction scheduling parameters are used for values that select
11983 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11984 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11986 Here is a list of each supported architecture and their supported
11987 implementations.
11989 @smallexample
11990     v7:             cypress
11991     v8:             supersparc, hypersparc
11992     sparclite:      f930, f934, sparclite86x
11993     sparclet:       tsc701
11994     v9:             ultrasparc, ultrasparc3
11995 @end smallexample
11997 By default (unless configured otherwise), GCC generates code for the V7
11998 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11999 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12000 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12001 SPARCStation 1, 2, IPX etc.
12003 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12004 architecture.  The only difference from V7 code is that the compiler emits
12005 the integer multiply and integer divide instructions which exist in SPARC-V8
12006 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12007 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12008 2000 series.
12010 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12011 the SPARC architecture.  This adds the integer multiply, integer divide step
12012 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12013 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12014 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12015 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12016 MB86934 chip, which is the more recent SPARClite with FPU@.
12018 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12019 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12020 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12021 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12022 optimizes it for the TEMIC SPARClet chip.
12024 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12025 architecture.  This adds 64-bit integer and floating-point move instructions,
12026 3 additional floating-point condition code registers and conditional move
12027 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12028 optimizes it for the Sun UltraSPARC I/II chips.  With
12029 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12030 Sun UltraSPARC III chip.
12032 @item -mtune=@var{cpu_type}
12033 @opindex mtune
12034 Set the instruction scheduling parameters for machine type
12035 @var{cpu_type}, but do not set the instruction set or register set that the
12036 option @option{-mcpu=@var{cpu_type}} would.
12038 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12039 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12040 that select a particular cpu implementation.  Those are @samp{cypress},
12041 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12042 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12043 @samp{ultrasparc3}.
12045 @item -mv8plus
12046 @itemx -mno-v8plus
12047 @opindex mv8plus
12048 @opindex mno-v8plus
12049 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12050 difference from the V8 ABI is that the global and out registers are
12051 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12052 mode for all SPARC-V9 processors.
12054 @item -mvis
12055 @itemx -mno-vis
12056 @opindex mvis
12057 @opindex mno-vis
12058 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12059 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12060 @end table
12062 These @samp{-m} options are supported in addition to the above
12063 on SPARC-V9 processors in 64-bit environments:
12065 @table @gcctabopt
12066 @item -mlittle-endian
12067 @opindex mlittle-endian
12068 Generate code for a processor running in little-endian mode.  It is only
12069 available for a few configurations and most notably not on Solaris and Linux.
12071 @item -m32
12072 @itemx -m64
12073 @opindex m32
12074 @opindex m64
12075 Generate code for a 32-bit or 64-bit environment.
12076 The 32-bit environment sets int, long and pointer to 32 bits.
12077 The 64-bit environment sets int to 32 bits and long and pointer
12078 to 64 bits.
12080 @item -mcmodel=medlow
12081 @opindex mcmodel=medlow
12082 Generate code for the Medium/Low code model: 64-bit addresses, programs
12083 must be linked in the low 32 bits of memory.  Programs can be statically
12084 or dynamically linked.
12086 @item -mcmodel=medmid
12087 @opindex mcmodel=medmid
12088 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12089 must be linked in the low 44 bits of memory, the text and data segments must
12090 be less than 2GB in size and the data segment must be located within 2GB of
12091 the text segment.
12093 @item -mcmodel=medany
12094 @opindex mcmodel=medany
12095 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12096 may be linked anywhere in memory, the text and data segments must be less
12097 than 2GB in size and the data segment must be located within 2GB of the
12098 text segment.
12100 @item -mcmodel=embmedany
12101 @opindex mcmodel=embmedany
12102 Generate code for the Medium/Anywhere code model for embedded systems:
12103 64-bit addresses, the text and data segments must be less than 2GB in
12104 size, both starting anywhere in memory (determined at link time).  The
12105 global register %g4 points to the base of the data segment.  Programs
12106 are statically linked and PIC is not supported.
12108 @item -mstack-bias
12109 @itemx -mno-stack-bias
12110 @opindex mstack-bias
12111 @opindex mno-stack-bias
12112 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12113 frame pointer if present, are offset by @minus{}2047 which must be added back
12114 when making stack frame references.  This is the default in 64-bit mode.
12115 Otherwise, assume no such offset is present.
12116 @end table
12118 These switches are supported in addition to the above on Solaris:
12120 @table @gcctabopt
12121 @item -threads
12122 @opindex threads
12123 Add support for multithreading using the Solaris threads library.  This
12124 option sets flags for both the preprocessor and linker.  This option does
12125 not affect the thread safety of object code produced by the compiler or
12126 that of libraries supplied with it.
12128 @item -pthreads
12129 @opindex pthreads
12130 Add support for multithreading using the POSIX threads library.  This
12131 option sets flags for both the preprocessor and linker.  This option does
12132 not affect the thread safety of object code produced  by the compiler or
12133 that of libraries supplied with it.
12134 @end table
12136 @node System V Options
12137 @subsection Options for System V
12139 These additional options are available on System V Release 4 for
12140 compatibility with other compilers on those systems:
12142 @table @gcctabopt
12143 @item -G
12144 @opindex G
12145 Create a shared object.
12146 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12148 @item -Qy
12149 @opindex Qy
12150 Identify the versions of each tool used by the compiler, in a
12151 @code{.ident} assembler directive in the output.
12153 @item -Qn
12154 @opindex Qn
12155 Refrain from adding @code{.ident} directives to the output file (this is
12156 the default).
12158 @item -YP,@var{dirs}
12159 @opindex YP
12160 Search the directories @var{dirs}, and no others, for libraries
12161 specified with @option{-l}.
12163 @item -Ym,@var{dir}
12164 @opindex Ym
12165 Look in the directory @var{dir} to find the M4 preprocessor.
12166 The assembler uses this option.
12167 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12168 @c the generic assembler that comes with Solaris takes just -Ym.
12169 @end table
12171 @node TMS320C3x/C4x Options
12172 @subsection TMS320C3x/C4x Options
12173 @cindex TMS320C3x/C4x Options
12175 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12177 @table @gcctabopt
12179 @item -mcpu=@var{cpu_type}
12180 @opindex mcpu
12181 Set the instruction set, register set, and instruction scheduling
12182 parameters for machine type @var{cpu_type}.  Supported values for
12183 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12184 @samp{c44}.  The default is @samp{c40} to generate code for the
12185 TMS320C40.
12187 @item -mbig-memory
12188 @itemx -mbig
12189 @itemx -msmall-memory
12190 @itemx -msmall
12191 @opindex mbig-memory
12192 @opindex mbig
12193 @opindex msmall-memory
12194 @opindex msmall
12195 Generates code for the big or small memory model.  The small memory
12196 model assumed that all data fits into one 64K word page.  At run-time
12197 the data page (DP) register must be set to point to the 64K page
12198 containing the .bss and .data program sections.  The big memory model is
12199 the default and requires reloading of the DP register for every direct
12200 memory access.
12202 @item -mbk
12203 @itemx -mno-bk
12204 @opindex mbk
12205 @opindex mno-bk
12206 Allow (disallow) allocation of general integer operands into the block
12207 count register BK@.
12209 @item -mdb
12210 @itemx -mno-db
12211 @opindex mdb
12212 @opindex mno-db
12213 Enable (disable) generation of code using decrement and branch,
12214 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12215 on the safe side, this is disabled for the C3x, since the maximum
12216 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12217 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12218 that it can utilize the decrement and branch instruction, but will give
12219 up if there is more than one memory reference in the loop.  Thus a loop
12220 where the loop counter is decremented can generate slightly more
12221 efficient code, in cases where the RPTB instruction cannot be utilized.
12223 @item -mdp-isr-reload
12224 @itemx -mparanoid
12225 @opindex mdp-isr-reload
12226 @opindex mparanoid
12227 Force the DP register to be saved on entry to an interrupt service
12228 routine (ISR), reloaded to point to the data section, and restored on
12229 exit from the ISR@.  This should not be required unless someone has
12230 violated the small memory model by modifying the DP register, say within
12231 an object library.
12233 @item -mmpyi
12234 @itemx -mno-mpyi
12235 @opindex mmpyi
12236 @opindex mno-mpyi
12237 For the C3x use the 24-bit MPYI instruction for integer multiplies
12238 instead of a library call to guarantee 32-bit results.  Note that if one
12239 of the operands is a constant, then the multiplication will be performed
12240 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12241 then squaring operations are performed inline instead of a library call.
12243 @item -mfast-fix
12244 @itemx -mno-fast-fix
12245 @opindex mfast-fix
12246 @opindex mno-fast-fix
12247 The C3x/C4x FIX instruction to convert a floating point value to an
12248 integer value chooses the nearest integer less than or equal to the
12249 floating point value rather than to the nearest integer.  Thus if the
12250 floating point number is negative, the result will be incorrectly
12251 truncated an additional code is necessary to detect and correct this
12252 case.  This option can be used to disable generation of the additional
12253 code required to correct the result.
12255 @item -mrptb
12256 @itemx -mno-rptb
12257 @opindex mrptb
12258 @opindex mno-rptb
12259 Enable (disable) generation of repeat block sequences using the RPTB
12260 instruction for zero overhead looping.  The RPTB construct is only used
12261 for innermost loops that do not call functions or jump across the loop
12262 boundaries.  There is no advantage having nested RPTB loops due to the
12263 overhead required to save and restore the RC, RS, and RE registers.
12264 This is enabled by default with @option{-O2}.
12266 @item -mrpts=@var{count}
12267 @itemx -mno-rpts
12268 @opindex mrpts
12269 @opindex mno-rpts
12270 Enable (disable) the use of the single instruction repeat instruction
12271 RPTS@.  If a repeat block contains a single instruction, and the loop
12272 count can be guaranteed to be less than the value @var{count}, GCC will
12273 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12274 then a RPTS will be emitted even if the loop count cannot be determined
12275 at compile time.  Note that the repeated instruction following RPTS does
12276 not have to be reloaded from memory each iteration, thus freeing up the
12277 CPU buses for operands.  However, since interrupts are blocked by this
12278 instruction, it is disabled by default.
12280 @item -mloop-unsigned
12281 @itemx -mno-loop-unsigned
12282 @opindex mloop-unsigned
12283 @opindex mno-loop-unsigned
12284 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12285 is @math{2^{31} + 1} since these instructions test if the iteration count is
12286 negative to terminate the loop.  If the iteration count is unsigned
12287 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12288 exceeded.  This switch allows an unsigned iteration count.
12290 @item -mti
12291 @opindex mti
12292 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12293 with.  This also enforces compatibility with the API employed by the TI
12294 C3x C compiler.  For example, long doubles are passed as structures
12295 rather than in floating point registers.
12297 @item -mregparm
12298 @itemx -mmemparm
12299 @opindex mregparm
12300 @opindex mmemparm
12301 Generate code that uses registers (stack) for passing arguments to functions.
12302 By default, arguments are passed in registers where possible rather
12303 than by pushing arguments on to the stack.
12305 @item -mparallel-insns
12306 @itemx -mno-parallel-insns
12307 @opindex mparallel-insns
12308 @opindex mno-parallel-insns
12309 Allow the generation of parallel instructions.  This is enabled by
12310 default with @option{-O2}.
12312 @item -mparallel-mpy
12313 @itemx -mno-parallel-mpy
12314 @opindex mparallel-mpy
12315 @opindex mno-parallel-mpy
12316 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12317 provided @option{-mparallel-insns} is also specified.  These instructions have
12318 tight register constraints which can pessimize the code generation
12319 of large functions.
12321 @end table
12323 @node V850 Options
12324 @subsection V850 Options
12325 @cindex V850 Options
12327 These @samp{-m} options are defined for V850 implementations:
12329 @table @gcctabopt
12330 @item -mlong-calls
12331 @itemx -mno-long-calls
12332 @opindex mlong-calls
12333 @opindex mno-long-calls
12334 Treat all calls as being far away (near).  If calls are assumed to be
12335 far away, the compiler will always load the functions address up into a
12336 register, and call indirect through the pointer.
12338 @item -mno-ep
12339 @itemx -mep
12340 @opindex mno-ep
12341 @opindex mep
12342 Do not optimize (do optimize) basic blocks that use the same index
12343 pointer 4 or more times to copy pointer into the @code{ep} register, and
12344 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12345 option is on by default if you optimize.
12347 @item -mno-prolog-function
12348 @itemx -mprolog-function
12349 @opindex mno-prolog-function
12350 @opindex mprolog-function
12351 Do not use (do use) external functions to save and restore registers
12352 at the prologue and epilogue of a function.  The external functions
12353 are slower, but use less code space if more than one function saves
12354 the same number of registers.  The @option{-mprolog-function} option
12355 is on by default if you optimize.
12357 @item -mspace
12358 @opindex mspace
12359 Try to make the code as small as possible.  At present, this just turns
12360 on the @option{-mep} and @option{-mprolog-function} options.
12362 @item -mtda=@var{n}
12363 @opindex mtda
12364 Put static or global variables whose size is @var{n} bytes or less into
12365 the tiny data area that register @code{ep} points to.  The tiny data
12366 area can hold up to 256 bytes in total (128 bytes for byte references).
12368 @item -msda=@var{n}
12369 @opindex msda
12370 Put static or global variables whose size is @var{n} bytes or less into
12371 the small data area that register @code{gp} points to.  The small data
12372 area can hold up to 64 kilobytes.
12374 @item -mzda=@var{n}
12375 @opindex mzda
12376 Put static or global variables whose size is @var{n} bytes or less into
12377 the first 32 kilobytes of memory.
12379 @item -mv850
12380 @opindex mv850
12381 Specify that the target processor is the V850.
12383 @item -mbig-switch
12384 @opindex mbig-switch
12385 Generate code suitable for big switch tables.  Use this option only if
12386 the assembler/linker complain about out of range branches within a switch
12387 table.
12389 @item -mapp-regs
12390 @opindex mapp-regs
12391 This option will cause r2 and r5 to be used in the code generated by
12392 the compiler.  This setting is the default.
12394 @item -mno-app-regs
12395 @opindex mno-app-regs
12396 This option will cause r2 and r5 to be treated as fixed registers.
12398 @item -mv850e1
12399 @opindex mv850e1
12400 Specify that the target processor is the V850E1.  The preprocessor
12401 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12402 this option is used.
12404 @item -mv850e
12405 @opindex mv850e
12406 Specify that the target processor is the V850E@.  The preprocessor
12407 constant @samp{__v850e__} will be defined if this option is used.
12409 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12410 are defined then a default target processor will be chosen and the
12411 relevant @samp{__v850*__} preprocessor constant will be defined.
12413 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12414 defined, regardless of which processor variant is the target.
12416 @item -mdisable-callt
12417 @opindex mdisable-callt
12418 This option will suppress generation of the CALLT instruction for the
12419 v850e and v850e1 flavors of the v850 architecture.  The default is
12420 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12422 @end table
12424 @node VAX Options
12425 @subsection VAX Options
12426 @cindex VAX options
12428 These @samp{-m} options are defined for the VAX:
12430 @table @gcctabopt
12431 @item -munix
12432 @opindex munix
12433 Do not output certain jump instructions (@code{aobleq} and so on)
12434 that the Unix assembler for the VAX cannot handle across long
12435 ranges.
12437 @item -mgnu
12438 @opindex mgnu
12439 Do output those jump instructions, on the assumption that you
12440 will assemble with the GNU assembler.
12442 @item -mg
12443 @opindex mg
12444 Output code for g-format floating point numbers instead of d-format.
12445 @end table
12447 @node x86-64 Options
12448 @subsection x86-64 Options
12449 @cindex x86-64 options
12451 These are listed under @xref{i386 and x86-64 Options}.
12453 @node Xstormy16 Options
12454 @subsection Xstormy16 Options
12455 @cindex Xstormy16 Options
12457 These options are defined for Xstormy16:
12459 @table @gcctabopt
12460 @item -msim
12461 @opindex msim
12462 Choose startup files and linker script suitable for the simulator.
12463 @end table
12465 @node Xtensa Options
12466 @subsection Xtensa Options
12467 @cindex Xtensa Options
12469 These options are supported for Xtensa targets:
12471 @table @gcctabopt
12472 @item -mconst16
12473 @itemx -mno-const16
12474 @opindex mconst16
12475 @opindex mno-const16
12476 Enable or disable use of @code{CONST16} instructions for loading
12477 constant values.  The @code{CONST16} instruction is currently not a
12478 standard option from Tensilica.  When enabled, @code{CONST16}
12479 instructions are always used in place of the standard @code{L32R}
12480 instructions.  The use of @code{CONST16} is enabled by default only if
12481 the @code{L32R} instruction is not available.
12483 @item -mfused-madd
12484 @itemx -mno-fused-madd
12485 @opindex mfused-madd
12486 @opindex mno-fused-madd
12487 Enable or disable use of fused multiply/add and multiply/subtract
12488 instructions in the floating-point option.  This has no effect if the
12489 floating-point option is not also enabled.  Disabling fused multiply/add
12490 and multiply/subtract instructions forces the compiler to use separate
12491 instructions for the multiply and add/subtract operations.  This may be
12492 desirable in some cases where strict IEEE 754-compliant results are
12493 required: the fused multiply add/subtract instructions do not round the
12494 intermediate result, thereby producing results with @emph{more} bits of
12495 precision than specified by the IEEE standard.  Disabling fused multiply
12496 add/subtract instructions also ensures that the program output is not
12497 sensitive to the compiler's ability to combine multiply and add/subtract
12498 operations.
12500 @item -mtext-section-literals
12501 @itemx -mno-text-section-literals
12502 @opindex mtext-section-literals
12503 @opindex mno-text-section-literals
12504 Control the treatment of literal pools.  The default is
12505 @option{-mno-text-section-literals}, which places literals in a separate
12506 section in the output file.  This allows the literal pool to be placed
12507 in a data RAM/ROM, and it also allows the linker to combine literal
12508 pools from separate object files to remove redundant literals and
12509 improve code size.  With @option{-mtext-section-literals}, the literals
12510 are interspersed in the text section in order to keep them as close as
12511 possible to their references.  This may be necessary for large assembly
12512 files.
12514 @item -mtarget-align
12515 @itemx -mno-target-align
12516 @opindex mtarget-align
12517 @opindex mno-target-align
12518 When this option is enabled, GCC instructs the assembler to
12519 automatically align instructions to reduce branch penalties at the
12520 expense of some code density.  The assembler attempts to widen density
12521 instructions to align branch targets and the instructions following call
12522 instructions.  If there are not enough preceding safe density
12523 instructions to align a target, no widening will be performed.  The
12524 default is @option{-mtarget-align}.  These options do not affect the
12525 treatment of auto-aligned instructions like @code{LOOP}, which the
12526 assembler will always align, either by widening density instructions or
12527 by inserting no-op instructions.
12529 @item -mlongcalls
12530 @itemx -mno-longcalls
12531 @opindex mlongcalls
12532 @opindex mno-longcalls
12533 When this option is enabled, GCC instructs the assembler to translate
12534 direct calls to indirect calls unless it can determine that the target
12535 of a direct call is in the range allowed by the call instruction.  This
12536 translation typically occurs for calls to functions in other source
12537 files.  Specifically, the assembler translates a direct @code{CALL}
12538 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12539 The default is @option{-mno-longcalls}.  This option should be used in
12540 programs where the call target can potentially be out of range.  This
12541 option is implemented in the assembler, not the compiler, so the
12542 assembly code generated by GCC will still show direct call
12543 instructions---look at the disassembled object code to see the actual
12544 instructions.  Note that the assembler will use an indirect call for
12545 every cross-file call, not just those that really will be out of range.
12546 @end table
12548 @node zSeries Options
12549 @subsection zSeries Options
12550 @cindex zSeries options
12552 These are listed under @xref{S/390 and zSeries Options}.
12554 @node Code Gen Options
12555 @section Options for Code Generation Conventions
12556 @cindex code generation conventions
12557 @cindex options, code generation
12558 @cindex run-time options
12560 These machine-independent options control the interface conventions
12561 used in code generation.
12563 Most of them have both positive and negative forms; the negative form
12564 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12565 one of the forms is listed---the one which is not the default.  You
12566 can figure out the other form by either removing @samp{no-} or adding
12569 @table @gcctabopt
12570 @item -fbounds-check
12571 @opindex fbounds-check
12572 For front-ends that support it, generate additional code to check that
12573 indices used to access arrays are within the declared range.  This is
12574 currently only supported by the Java and Fortran 77 front-ends, where
12575 this option defaults to true and false respectively.
12577 @item -ftrapv
12578 @opindex ftrapv
12579 This option generates traps for signed overflow on addition, subtraction,
12580 multiplication operations.
12582 @item -fwrapv
12583 @opindex fwrapv
12584 This option instructs the compiler to assume that signed arithmetic
12585 overflow of addition, subtraction and multiplication wraps around
12586 using twos-complement representation.  This flag enables some optimizations
12587 and disables other.  This option is enabled by default for the Java
12588 front-end, as required by the Java language specification.
12590 @item -fexceptions
12591 @opindex fexceptions
12592 Enable exception handling.  Generates extra code needed to propagate
12593 exceptions.  For some targets, this implies GCC will generate frame
12594 unwind information for all functions, which can produce significant data
12595 size overhead, although it does not affect execution.  If you do not
12596 specify this option, GCC will enable it by default for languages like
12597 C++ which normally require exception handling, and disable it for
12598 languages like C that do not normally require it.  However, you may need
12599 to enable this option when compiling C code that needs to interoperate
12600 properly with exception handlers written in C++.  You may also wish to
12601 disable this option if you are compiling older C++ programs that don't
12602 use exception handling.
12604 @item -fnon-call-exceptions
12605 @opindex fnon-call-exceptions
12606 Generate code that allows trapping instructions to throw exceptions.
12607 Note that this requires platform-specific runtime support that does
12608 not exist everywhere.  Moreover, it only allows @emph{trapping}
12609 instructions to throw exceptions, i.e.@: memory references or floating
12610 point instructions.  It does not allow exceptions to be thrown from
12611 arbitrary signal handlers such as @code{SIGALRM}.
12613 @item -funwind-tables
12614 @opindex funwind-tables
12615 Similar to @option{-fexceptions}, except that it will just generate any needed
12616 static data, but will not affect the generated code in any other way.
12617 You will normally not enable this option; instead, a language processor
12618 that needs this handling would enable it on your behalf.
12620 @item -fasynchronous-unwind-tables
12621 @opindex fasynchronous-unwind-tables
12622 Generate unwind table in dwarf2 format, if supported by target machine.  The
12623 table is exact at each instruction boundary, so it can be used for stack
12624 unwinding from asynchronous events (such as debugger or garbage collector).
12626 @item -fpcc-struct-return
12627 @opindex fpcc-struct-return
12628 Return ``short'' @code{struct} and @code{union} values in memory like
12629 longer ones, rather than in registers.  This convention is less
12630 efficient, but it has the advantage of allowing intercallability between
12631 GCC-compiled files and files compiled with other compilers, particularly
12632 the Portable C Compiler (pcc).
12634 The precise convention for returning structures in memory depends
12635 on the target configuration macros.
12637 Short structures and unions are those whose size and alignment match
12638 that of some integer type.
12640 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12641 switch is not binary compatible with code compiled with the
12642 @option{-freg-struct-return} switch.
12643 Use it to conform to a non-default application binary interface.
12645 @item -freg-struct-return
12646 @opindex freg-struct-return
12647 Return @code{struct} and @code{union} values in registers when possible.
12648 This is more efficient for small structures than
12649 @option{-fpcc-struct-return}.
12651 If you specify neither @option{-fpcc-struct-return} nor
12652 @option{-freg-struct-return}, GCC defaults to whichever convention is
12653 standard for the target.  If there is no standard convention, GCC
12654 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12655 the principal compiler.  In those cases, we can choose the standard, and
12656 we chose the more efficient register return alternative.
12658 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12659 switch is not binary compatible with code compiled with the
12660 @option{-fpcc-struct-return} switch.
12661 Use it to conform to a non-default application binary interface.
12663 @item -fshort-enums
12664 @opindex fshort-enums
12665 Allocate to an @code{enum} type only as many bytes as it needs for the
12666 declared range of possible values.  Specifically, the @code{enum} type
12667 will be equivalent to the smallest integer type which has enough room.
12669 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12670 code that is not binary compatible with code generated without that switch.
12671 Use it to conform to a non-default application binary interface.
12673 @item -fshort-double
12674 @opindex fshort-double
12675 Use the same size for @code{double} as for @code{float}.
12677 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12678 code that is not binary compatible with code generated without that switch.
12679 Use it to conform to a non-default application binary interface.
12681 @item -fshort-wchar
12682 @opindex fshort-wchar
12683 Override the underlying type for @samp{wchar_t} to be @samp{short
12684 unsigned int} instead of the default for the target.  This option is
12685 useful for building programs to run under WINE@.
12687 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12688 code that is not binary compatible with code generated without that switch.
12689 Use it to conform to a non-default application binary interface.
12691 @item -fshared-data
12692 @opindex fshared-data
12693 Requests that the data and non-@code{const} variables of this
12694 compilation be shared data rather than private data.  The distinction
12695 makes sense only on certain operating systems, where shared data is
12696 shared between processes running the same program, while private data
12697 exists in one copy per process.
12699 @item -fno-common
12700 @opindex fno-common
12701 In C, allocate even uninitialized global variables in the data section of the
12702 object file, rather than generating them as common blocks.  This has the
12703 effect that if the same variable is declared (without @code{extern}) in
12704 two different compilations, you will get an error when you link them.
12705 The only reason this might be useful is if you wish to verify that the
12706 program will work on other systems which always work this way.
12708 @item -fno-ident
12709 @opindex fno-ident
12710 Ignore the @samp{#ident} directive.
12712 @item -finhibit-size-directive
12713 @opindex finhibit-size-directive
12714 Don't output a @code{.size} assembler directive, or anything else that
12715 would cause trouble if the function is split in the middle, and the
12716 two halves are placed at locations far apart in memory.  This option is
12717 used when compiling @file{crtstuff.c}; you should not need to use it
12718 for anything else.
12720 @item -fverbose-asm
12721 @opindex fverbose-asm
12722 Put extra commentary information in the generated assembly code to
12723 make it more readable.  This option is generally only of use to those
12724 who actually need to read the generated assembly code (perhaps while
12725 debugging the compiler itself).
12727 @option{-fno-verbose-asm}, the default, causes the
12728 extra information to be omitted and is useful when comparing two assembler
12729 files.
12731 @item -fpic
12732 @opindex fpic
12733 @cindex global offset table
12734 @cindex PIC
12735 Generate position-independent code (PIC) suitable for use in a shared
12736 library, if supported for the target machine.  Such code accesses all
12737 constant addresses through a global offset table (GOT)@.  The dynamic
12738 loader resolves the GOT entries when the program starts (the dynamic
12739 loader is not part of GCC; it is part of the operating system).  If
12740 the GOT size for the linked executable exceeds a machine-specific
12741 maximum size, you get an error message from the linker indicating that
12742 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12743 instead.  (These maximums are 8k on the SPARC and 32k
12744 on the m68k and RS/6000.  The 386 has no such limit.)
12746 Position-independent code requires special support, and therefore works
12747 only on certain machines.  For the 386, GCC supports PIC for System V
12748 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12749 position-independent.
12751 @item -fPIC
12752 @opindex fPIC
12753 If supported for the target machine, emit position-independent code,
12754 suitable for dynamic linking and avoiding any limit on the size of the
12755 global offset table.  This option makes a difference on the m68k,
12756 PowerPC and SPARC@.
12758 Position-independent code requires special support, and therefore works
12759 only on certain machines.
12761 @item -fpie
12762 @itemx -fPIE
12763 @opindex fpie
12764 @opindex fPIE
12765 These options are similar to @option{-fpic} and @option{-fPIC}, but
12766 generated position independent code can be only linked into executables.
12767 Usually these options are used when @option{-pie} GCC option will be
12768 used during linking.
12770 @item -fno-jump-tables
12771 @opindex fno-jump-tables
12772 Do not use jump tables for switch statements even where it would be
12773 more efficient than other code generation strategies.  This option is
12774 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12775 building code which forms part of a dynamic linker and cannot
12776 reference the address of a jump table.  On some targets, jump tables
12777 do not require a GOT and this option is not needed.
12779 @item -ffixed-@var{reg}
12780 @opindex ffixed
12781 Treat the register named @var{reg} as a fixed register; generated code
12782 should never refer to it (except perhaps as a stack pointer, frame
12783 pointer or in some other fixed role).
12785 @var{reg} must be the name of a register.  The register names accepted
12786 are machine-specific and are defined in the @code{REGISTER_NAMES}
12787 macro in the machine description macro file.
12789 This flag does not have a negative form, because it specifies a
12790 three-way choice.
12792 @item -fcall-used-@var{reg}
12793 @opindex fcall-used
12794 Treat the register named @var{reg} as an allocable register that is
12795 clobbered by function calls.  It may be allocated for temporaries or
12796 variables that do not live across a call.  Functions compiled this way
12797 will not save and restore the register @var{reg}.
12799 It is an error to used this flag with the frame pointer or stack pointer.
12800 Use of this flag for other registers that have fixed pervasive roles in
12801 the machine's execution model will produce disastrous results.
12803 This flag does not have a negative form, because it specifies a
12804 three-way choice.
12806 @item -fcall-saved-@var{reg}
12807 @opindex fcall-saved
12808 Treat the register named @var{reg} as an allocable register saved by
12809 functions.  It may be allocated even for temporaries or variables that
12810 live across a call.  Functions compiled this way will save and restore
12811 the register @var{reg} if they use it.
12813 It is an error to used this flag with the frame pointer or stack pointer.
12814 Use of this flag for other registers that have fixed pervasive roles in
12815 the machine's execution model will produce disastrous results.
12817 A different sort of disaster will result from the use of this flag for
12818 a register in which function values may be returned.
12820 This flag does not have a negative form, because it specifies a
12821 three-way choice.
12823 @item -fpack-struct[=@var{n}]
12824 @opindex fpack-struct
12825 Without a value specified, pack all structure members together without
12826 holes.  When a value is specified (which must be a small power of two), pack
12827 structure members according to this value, representing the maximum
12828 alignment (that is, objects with default alignment requirements larger than
12829 this will be output potentially unaligned at the next fitting location.
12831 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12832 code that is not binary compatible with code generated without that switch.
12833 Additionally, it makes the code suboptimal.
12834 Use it to conform to a non-default application binary interface.
12836 @item -finstrument-functions
12837 @opindex finstrument-functions
12838 Generate instrumentation calls for entry and exit to functions.  Just
12839 after function entry and just before function exit, the following
12840 profiling functions will be called with the address of the current
12841 function and its call site.  (On some platforms,
12842 @code{__builtin_return_address} does not work beyond the current
12843 function, so the call site information may not be available to the
12844 profiling functions otherwise.)
12846 @smallexample
12847 void __cyg_profile_func_enter (void *this_fn,
12848                                void *call_site);
12849 void __cyg_profile_func_exit  (void *this_fn,
12850                                void *call_site);
12851 @end smallexample
12853 The first argument is the address of the start of the current function,
12854 which may be looked up exactly in the symbol table.
12856 This instrumentation is also done for functions expanded inline in other
12857 functions.  The profiling calls will indicate where, conceptually, the
12858 inline function is entered and exited.  This means that addressable
12859 versions of such functions must be available.  If all your uses of a
12860 function are expanded inline, this may mean an additional expansion of
12861 code size.  If you use @samp{extern inline} in your C code, an
12862 addressable version of such functions must be provided.  (This is
12863 normally the case anyways, but if you get lucky and the optimizer always
12864 expands the functions inline, you might have gotten away without
12865 providing static copies.)
12867 A function may be given the attribute @code{no_instrument_function}, in
12868 which case this instrumentation will not be done.  This can be used, for
12869 example, for the profiling functions listed above, high-priority
12870 interrupt routines, and any functions from which the profiling functions
12871 cannot safely be called (perhaps signal handlers, if the profiling
12872 routines generate output or allocate memory).
12874 @item -fstack-check
12875 @opindex fstack-check
12876 Generate code to verify that you do not go beyond the boundary of the
12877 stack.  You should specify this flag if you are running in an
12878 environment with multiple threads, but only rarely need to specify it in
12879 a single-threaded environment since stack overflow is automatically
12880 detected on nearly all systems if there is only one stack.
12882 Note that this switch does not actually cause checking to be done; the
12883 operating system must do that.  The switch causes generation of code
12884 to ensure that the operating system sees the stack being extended.
12886 @item -fstack-limit-register=@var{reg}
12887 @itemx -fstack-limit-symbol=@var{sym}
12888 @itemx -fno-stack-limit
12889 @opindex fstack-limit-register
12890 @opindex fstack-limit-symbol
12891 @opindex fno-stack-limit
12892 Generate code to ensure that the stack does not grow beyond a certain value,
12893 either the value of a register or the address of a symbol.  If the stack
12894 would grow beyond the value, a signal is raised.  For most targets,
12895 the signal is raised before the stack overruns the boundary, so
12896 it is possible to catch the signal without taking special precautions.
12898 For instance, if the stack starts at absolute address @samp{0x80000000}
12899 and grows downwards, you can use the flags
12900 @option{-fstack-limit-symbol=__stack_limit} and
12901 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12902 of 128KB@.  Note that this may only work with the GNU linker.
12904 @cindex aliasing of parameters
12905 @cindex parameters, aliased
12906 @item -fargument-alias
12907 @itemx -fargument-noalias
12908 @itemx -fargument-noalias-global
12909 @opindex fargument-alias
12910 @opindex fargument-noalias
12911 @opindex fargument-noalias-global
12912 Specify the possible relationships among parameters and between
12913 parameters and global data.
12915 @option{-fargument-alias} specifies that arguments (parameters) may
12916 alias each other and may alias global storage.@*
12917 @option{-fargument-noalias} specifies that arguments do not alias
12918 each other, but may alias global storage.@*
12919 @option{-fargument-noalias-global} specifies that arguments do not
12920 alias each other and do not alias global storage.
12922 Each language will automatically use whatever option is required by
12923 the language standard.  You should not need to use these options yourself.
12925 @item -fleading-underscore
12926 @opindex fleading-underscore
12927 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12928 change the way C symbols are represented in the object file.  One use
12929 is to help link with legacy assembly code.
12931 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12932 generate code that is not binary compatible with code generated without that
12933 switch.  Use it to conform to a non-default application binary interface.
12934 Not all targets provide complete support for this switch.
12936 @item -ftls-model=@var{model}
12937 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12938 The @var{model} argument should be one of @code{global-dynamic},
12939 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12941 The default without @option{-fpic} is @code{initial-exec}; with
12942 @option{-fpic} the default is @code{global-dynamic}.
12944 @item -fvisibility=@var{default|internal|hidden|protected}
12945 @opindex fvisibility
12946 Set the default ELF image symbol visibility to the specified option---all
12947 symbols will be marked with this unless overridden within the code.
12948 Using this feature can very substantially improve linking and
12949 load times of shared object libraries, produce more optimized
12950 code, provide near-perfect API export and prevent symbol clashes.
12951 It is @strong{strongly} recommended that you use this in any shared objects
12952 you distribute.
12954 Despite the nomenclature, @code{default} always means public ie;
12955 available to be linked against from outside the shared object.
12956 @code{protected} and @code{internal} are pretty useless in real-world
12957 usage so the only other commonly used option will be @code{hidden}.
12958 The default if @option{-fvisibility} isn't specified is
12959 @code{default}, i.e., make every
12960 symbol public---this causes the same behavior as previous versions of
12961 GCC@.
12963 A good explanation of the benefits offered by ensuring ELF
12964 symbols have the correct visibility is given by ``How To Write
12965 Shared Libraries'' by Ulrich Drepper (which can be found at
12966 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12967 solution made possible by this option to marking things hidden when
12968 the default is public is to make the default hidden and mark things
12969 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12970 and @code{__attribute__ ((visibility("default")))} instead of
12971 @code{__declspec(dllexport)} you get almost identical semantics with
12972 identical syntax.  This is a great boon to those working with
12973 cross-platform projects.
12975 For those adding visibility support to existing code, you may find
12976 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12977 the declarations you wish to set visibility for with (for example)
12978 @samp{#pragma GCC visibility push(hidden)} and
12979 @samp{#pragma GCC visibility pop}.
12980 Bear in mind that symbol visibility should be viewed @strong{as
12981 part of the API interface contract} and thus all new code should
12982 always specify visibility when it is not the default ie; declarations
12983 only for use within the local DSO should @strong{always} be marked explicitly
12984 as hidden as so to avoid PLT indirection overheads---making this
12985 abundantly clear also aids readability and self-documentation of the code.
12986 Note that due to ISO C++ specification requirements, operator new and
12987 operator delete must always be of default visibility.
12989 An overview of these techniques, their benefits and how to use them
12990 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12992 @end table
12994 @c man end
12996 @node Environment Variables
12997 @section Environment Variables Affecting GCC
12998 @cindex environment variables
13000 @c man begin ENVIRONMENT
13001 This section describes several environment variables that affect how GCC
13002 operates.  Some of them work by specifying directories or prefixes to use
13003 when searching for various kinds of files.  Some are used to specify other
13004 aspects of the compilation environment.
13006 Note that you can also specify places to search using options such as
13007 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13008 take precedence over places specified using environment variables, which
13009 in turn take precedence over those specified by the configuration of GCC@.
13010 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13011 GNU Compiler Collection (GCC) Internals}.
13013 @table @env
13014 @item LANG
13015 @itemx LC_CTYPE
13016 @c @itemx LC_COLLATE
13017 @itemx LC_MESSAGES
13018 @c @itemx LC_MONETARY
13019 @c @itemx LC_NUMERIC
13020 @c @itemx LC_TIME
13021 @itemx LC_ALL
13022 @findex LANG
13023 @findex LC_CTYPE
13024 @c @findex LC_COLLATE
13025 @findex LC_MESSAGES
13026 @c @findex LC_MONETARY
13027 @c @findex LC_NUMERIC
13028 @c @findex LC_TIME
13029 @findex LC_ALL
13030 @cindex locale
13031 These environment variables control the way that GCC uses
13032 localization information that allow GCC to work with different
13033 national conventions.  GCC inspects the locale categories
13034 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13035 so.  These locale categories can be set to any value supported by your
13036 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13037 Kingdom encoded in UTF-8.
13039 The @env{LC_CTYPE} environment variable specifies character
13040 classification.  GCC uses it to determine the character boundaries in
13041 a string; this is needed for some multibyte encodings that contain quote
13042 and escape characters that would otherwise be interpreted as a string
13043 end or escape.
13045 The @env{LC_MESSAGES} environment variable specifies the language to
13046 use in diagnostic messages.
13048 If the @env{LC_ALL} environment variable is set, it overrides the value
13049 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13050 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13051 environment variable.  If none of these variables are set, GCC
13052 defaults to traditional C English behavior.
13054 @item TMPDIR
13055 @findex TMPDIR
13056 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13057 files.  GCC uses temporary files to hold the output of one stage of
13058 compilation which is to be used as input to the next stage: for example,
13059 the output of the preprocessor, which is the input to the compiler
13060 proper.
13062 @item GCC_EXEC_PREFIX
13063 @findex GCC_EXEC_PREFIX
13064 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13065 names of the subprograms executed by the compiler.  No slash is added
13066 when this prefix is combined with the name of a subprogram, but you can
13067 specify a prefix that ends with a slash if you wish.
13069 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13070 an appropriate prefix to use based on the pathname it was invoked with.
13072 If GCC cannot find the subprogram using the specified prefix, it
13073 tries looking in the usual places for the subprogram.
13075 The default value of @env{GCC_EXEC_PREFIX} is
13076 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13077 of @code{prefix} when you ran the @file{configure} script.
13079 Other prefixes specified with @option{-B} take precedence over this prefix.
13081 This prefix is also used for finding files such as @file{crt0.o} that are
13082 used for linking.
13084 In addition, the prefix is used in an unusual way in finding the
13085 directories to search for header files.  For each of the standard
13086 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13087 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13088 replacing that beginning with the specified prefix to produce an
13089 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13090 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13091 These alternate directories are searched first; the standard directories
13092 come next.
13094 @item COMPILER_PATH
13095 @findex COMPILER_PATH
13096 The value of @env{COMPILER_PATH} is a colon-separated list of
13097 directories, much like @env{PATH}.  GCC tries the directories thus
13098 specified when searching for subprograms, if it can't find the
13099 subprograms using @env{GCC_EXEC_PREFIX}.
13101 @item LIBRARY_PATH
13102 @findex LIBRARY_PATH
13103 The value of @env{LIBRARY_PATH} is a colon-separated list of
13104 directories, much like @env{PATH}.  When configured as a native compiler,
13105 GCC tries the directories thus specified when searching for special
13106 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13107 using GCC also uses these directories when searching for ordinary
13108 libraries for the @option{-l} option (but directories specified with
13109 @option{-L} come first).
13111 @item LANG
13112 @findex LANG
13113 @cindex locale definition
13114 This variable is used to pass locale information to the compiler.  One way in
13115 which this information is used is to determine the character set to be used
13116 when character literals, string literals and comments are parsed in C and C++.
13117 When the compiler is configured to allow multibyte characters,
13118 the following values for @env{LANG} are recognized:
13120 @table @samp
13121 @item C-JIS
13122 Recognize JIS characters.
13123 @item C-SJIS
13124 Recognize SJIS characters.
13125 @item C-EUCJP
13126 Recognize EUCJP characters.
13127 @end table
13129 If @env{LANG} is not defined, or if it has some other value, then the
13130 compiler will use mblen and mbtowc as defined by the default locale to
13131 recognize and translate multibyte characters.
13132 @end table
13134 @noindent
13135 Some additional environments variables affect the behavior of the
13136 preprocessor.
13138 @include cppenv.texi
13140 @c man end
13142 @node Precompiled Headers
13143 @section Using Precompiled Headers
13144 @cindex precompiled headers
13145 @cindex speed of compilation
13147 Often large projects have many header files that are included in every
13148 source file.  The time the compiler takes to process these header files
13149 over and over again can account for nearly all of the time required to
13150 build the project.  To make builds faster, GCC allows users to
13151 `precompile' a header file; then, if builds can use the precompiled
13152 header file they will be much faster.
13154 To create a precompiled header file, simply compile it as you would any
13155 other file, if necessary using the @option{-x} option to make the driver
13156 treat it as a C or C++ header file.  You will probably want to use a
13157 tool like @command{make} to keep the precompiled header up-to-date when
13158 the headers it contains change.
13160 A precompiled header file will be searched for when @code{#include} is
13161 seen in the compilation.  As it searches for the included file
13162 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13163 compiler looks for a precompiled header in each directory just before it
13164 looks for the include file in that directory.  The name searched for is
13165 the name specified in the @code{#include} with @samp{.gch} appended.  If
13166 the precompiled header file can't be used, it is ignored.
13168 For instance, if you have @code{#include "all.h"}, and you have
13169 @file{all.h.gch} in the same directory as @file{all.h}, then the
13170 precompiled header file will be used if possible, and the original
13171 header will be used otherwise.
13173 Alternatively, you might decide to put the precompiled header file in a
13174 directory and use @option{-I} to ensure that directory is searched
13175 before (or instead of) the directory containing the original header.
13176 Then, if you want to check that the precompiled header file is always
13177 used, you can put a file of the same name as the original header in this
13178 directory containing an @code{#error} command.
13180 This also works with @option{-include}.  So yet another way to use
13181 precompiled headers, good for projects not designed with precompiled
13182 header files in mind, is to simply take most of the header files used by
13183 a project, include them from another header file, precompile that header
13184 file, and @option{-include} the precompiled header.  If the header files
13185 have guards against multiple inclusion, they will be skipped because
13186 they've already been included (in the precompiled header).
13188 If you need to precompile the same header file for different
13189 languages, targets, or compiler options, you can instead make a
13190 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13191 header in the directory, perhaps using @option{-o}.  It doesn't matter
13192 what you call the files in the directory, every precompiled header in
13193 the directory will be considered.  The first precompiled header
13194 encountered in the directory that is valid for this compilation will
13195 be used; they're searched in no particular order.
13197 There are many other possibilities, limited only by your imagination,
13198 good sense, and the constraints of your build system.
13200 A precompiled header file can be used only when these conditions apply:
13202 @itemize
13203 @item
13204 Only one precompiled header can be used in a particular compilation.
13206 @item
13207 A precompiled header can't be used once the first C token is seen.  You
13208 can have preprocessor directives before a precompiled header; you can
13209 even include a precompiled header from inside another header, so long as
13210 there are no C tokens before the @code{#include}.
13212 @item
13213 The precompiled header file must be produced for the same language as
13214 the current compilation.  You can't use a C precompiled header for a C++
13215 compilation.
13217 @item
13218 The precompiled header file must have been produced by the same compiler
13219 binary as the current compilation is using.
13221 @item
13222 Any macros defined before the precompiled header is included must
13223 either be defined in the same way as when the precompiled header was
13224 generated, or must not affect the precompiled header, which usually
13225 means that they don't appear in the precompiled header at all.
13227 The @option{-D} option is one way to define a macro before a
13228 precompiled header is included; using a @code{#define} can also do it.
13229 There are also some options that define macros implicitly, like
13230 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13231 defined this way.
13233 @item If debugging information is output when using the precompiled
13234 header, using @option{-g} or similar, the same kind of debugging information
13235 must have been output when building the precompiled header.  However,
13236 a precompiled header built using @option{-g} can be used in a compilation
13237 when no debugging information is being output.
13239 @item The same @option{-m} options must generally be used when building
13240 and using the precompiled header.  @xref{Submodel Options},
13241 for any cases where this rule is relaxed.
13243 @item Each of the following options must be the same when building and using
13244 the precompiled header:
13246 @gccoptlist{-fexceptions -funit-at-a-time}
13248 @item
13249 Some other command-line options starting with @option{-f},
13250 @option{-p}, or @option{-O} must be defined in the same way as when
13251 the precompiled header was generated.  At present, it's not clear
13252 which options are safe to change and which are not; the safest choice
13253 is to use exactly the same options when generating and using the
13254 precompiled header.  The following are known to be safe:
13256 @gccoptlist{-fmessage-length= -fpreprocessed
13257 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13258 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13259 -pedantic-errors}
13261 @end itemize
13263 For all of these except the last, the compiler will automatically
13264 ignore the precompiled header if the conditions aren't met.  If you
13265 find an option combination that doesn't work and doesn't cause the
13266 precompiled header to be ignored, please consider filing a bug report,
13267 see @ref{Bugs}.
13269 If you do use differing options when generating and using the
13270 precompiled header, the actual behavior will be a mixture of the
13271 behavior for the options.  For instance, if you use @option{-g} to
13272 generate the precompiled header but not when using it, you may or may
13273 not get debugging information for routines in the precompiled header.
13275 @node Running Protoize
13276 @section Running Protoize
13278 The program @code{protoize} is an optional part of GCC@.  You can use
13279 it to add prototypes to a program, thus converting the program to ISO
13280 C in one respect.  The companion program @code{unprotoize} does the
13281 reverse: it removes argument types from any prototypes that are found.
13283 When you run these programs, you must specify a set of source files as
13284 command line arguments.  The conversion programs start out by compiling
13285 these files to see what functions they define.  The information gathered
13286 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13288 After scanning comes actual conversion.  The specified files are all
13289 eligible to be converted; any files they include (whether sources or
13290 just headers) are eligible as well.
13292 But not all the eligible files are converted.  By default,
13293 @code{protoize} and @code{unprotoize} convert only source and header
13294 files in the current directory.  You can specify additional directories
13295 whose files should be converted with the @option{-d @var{directory}}
13296 option.  You can also specify particular files to exclude with the
13297 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13298 directory name matches one of the specified directory names, and its
13299 name within the directory has not been excluded.
13301 Basic conversion with @code{protoize} consists of rewriting most
13302 function definitions and function declarations to specify the types of
13303 the arguments.  The only ones not rewritten are those for varargs
13304 functions.
13306 @code{protoize} optionally inserts prototype declarations at the
13307 beginning of the source file, to make them available for any calls that
13308 precede the function's definition.  Or it can insert prototype
13309 declarations with block scope in the blocks where undeclared functions
13310 are called.
13312 Basic conversion with @code{unprotoize} consists of rewriting most
13313 function declarations to remove any argument types, and rewriting
13314 function definitions to the old-style pre-ISO form.
13316 Both conversion programs print a warning for any function declaration or
13317 definition that they can't convert.  You can suppress these warnings
13318 with @option{-q}.
13320 The output from @code{protoize} or @code{unprotoize} replaces the
13321 original source file.  The original file is renamed to a name ending
13322 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13323 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13324 for DOS) file already exists, then the source file is simply discarded.
13326 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13327 scan the program and collect information about the functions it uses.
13328 So neither of these programs will work until GCC is installed.
13330 Here is a table of the options you can use with @code{protoize} and
13331 @code{unprotoize}.  Each option works with both programs unless
13332 otherwise stated.
13334 @table @code
13335 @item -B @var{directory}
13336 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13337 usual directory (normally @file{/usr/local/lib}).  This file contains
13338 prototype information about standard system functions.  This option
13339 applies only to @code{protoize}.
13341 @item -c @var{compilation-options}
13342 Use @var{compilation-options} as the options when running @command{gcc} to
13343 produce the @samp{.X} files.  The special option @option{-aux-info} is
13344 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13346 Note that the compilation options must be given as a single argument to
13347 @code{protoize} or @code{unprotoize}.  If you want to specify several
13348 @command{gcc} options, you must quote the entire set of compilation options
13349 to make them a single word in the shell.
13351 There are certain @command{gcc} arguments that you cannot use, because they
13352 would produce the wrong kind of output.  These include @option{-g},
13353 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13354 the @var{compilation-options}, they are ignored.
13356 @item -C
13357 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13358 systems) instead of @samp{.c}.  This is convenient if you are converting
13359 a C program to C++.  This option applies only to @code{protoize}.
13361 @item -g
13362 Add explicit global declarations.  This means inserting explicit
13363 declarations at the beginning of each source file for each function
13364 that is called in the file and was not declared.  These declarations
13365 precede the first function definition that contains a call to an
13366 undeclared function.  This option applies only to @code{protoize}.
13368 @item -i @var{string}
13369 Indent old-style parameter declarations with the string @var{string}.
13370 This option applies only to @code{protoize}.
13372 @code{unprotoize} converts prototyped function definitions to old-style
13373 function definitions, where the arguments are declared between the
13374 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13375 uses five spaces as the indentation.  If you want to indent with just
13376 one space instead, use @option{-i " "}.
13378 @item -k
13379 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13380 is finished.
13382 @item -l
13383 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13384 a prototype declaration for each function in each block which calls the
13385 function without any declaration.  This option applies only to
13386 @code{protoize}.
13388 @item -n
13389 Make no real changes.  This mode just prints information about the conversions
13390 that would have been done without @option{-n}.
13392 @item -N
13393 Make no @samp{.save} files.  The original files are simply deleted.
13394 Use this option with caution.
13396 @item -p @var{program}
13397 Use the program @var{program} as the compiler.  Normally, the name
13398 @file{gcc} is used.
13400 @item -q
13401 Work quietly.  Most warnings are suppressed.
13403 @item -v
13404 Print the version number, just like @option{-v} for @command{gcc}.
13405 @end table
13407 If you need special compiler options to compile one of your program's
13408 source files, then you should generate that file's @samp{.X} file
13409 specially, by running @command{gcc} on that source file with the
13410 appropriate options and the option @option{-aux-info}.  Then run
13411 @code{protoize} on the entire set of files.  @code{protoize} will use
13412 the existing @samp{.X} file because it is newer than the source file.
13413 For example:
13415 @smallexample
13416 gcc -Dfoo=bar file1.c -aux-info file1.X
13417 protoize *.c
13418 @end smallexample
13420 @noindent
13421 You need to include the special files along with the rest in the
13422 @code{protoize} command, even though their @samp{.X} files already
13423 exist, because otherwise they won't get converted.
13425 @xref{Protoize Caveats}, for more information on how to use
13426 @code{protoize} successfully.