delete some extraneous characters accidentally included in last change.
[gcc/gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on 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
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
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}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
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}
170
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 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
186 -Wnon-virtual-dtor  -Wreorder @gol
187 -Weffc++  -Wno-deprecated @gol
188 -Wno-non-template-friend  -Wold-style-cast @gol
189 -Woverloaded-virtual  -Wno-pmf-conversions @gol
190 -Wsign-promo  -Wsynth}
191
192 @item Objective-C Language Options
193 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
194 @gccoptlist{
195 -fconstant-string-class=@var{class-name} @gol
196 -fgnu-runtime  -fnext-runtime @gol
197 -fno-nil-receivers @gol
198 -fobjc-exceptions @gol
199 -freplace-objc-classes @gol
200 -fzero-link @gol
201 -gen-decls @gol
202 -Wno-protocol  -Wselector -Wundeclared-selector}
203
204 @item Language Independent Options
205 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
206 @gccoptlist{-fmessage-length=@var{n}  @gol
207 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
208
209 @item Warning Options
210 @xref{Warning Options,,Options to Request or Suppress Warnings}.
211 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
212 -w  -Wextra  -Wall  -Waggregate-return @gol
213 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
214 -Wconversion  -Wno-deprecated-declarations @gol
215 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
216 -Werror  -Werror-implicit-function-declaration @gol
217 -Wfloat-equal  -Wformat  -Wformat=2 @gol
218 -Wno-format-extra-args -Wformat-nonliteral @gol
219 -Wformat-security  -Wformat-y2k @gol
220 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
221 -Wimport  -Wno-import  -Winit-self  -Winline @gol
222 -Wno-invalid-offsetof  -Winvalid-pch @gol
223 -Wlarger-than-@var{len}  -Wlong-long @gol
224 -Wmain  -Wmissing-braces @gol
225 -Wmissing-format-attribute  -Wmissing-noreturn @gol
226 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
227 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
228 -Wreturn-type  -Wsequence-point  -Wshadow @gol
229 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
230 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
231 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
232 -Wunknown-pragmas  -Wunreachable-code @gol
233 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
234 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
235 -Wvariadic-macros}
236
237 @item C-only Warning Options
238 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
239 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
240 -Wstrict-prototypes  -Wtraditional @gol
241 -Wdeclaration-after-statement}
242
243 @item Debugging Options
244 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
245 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
246 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
247 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
248 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
249 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
250 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
251 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
252 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
253 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
254 -ftest-coverage  -ftime-report -fvar-tracking @gol
255 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
256 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
257 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
258 -print-multi-directory  -print-multi-lib @gol
259 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
260 -save-temps  -time}
261
262 @item Optimization Options
263 @xref{Optimize Options,,Options that Control Optimization}.
264 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
265 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
266 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
267 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
268 -fcaller-saves  -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -floop-optimize @gol
274 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations  -ffinite-math-only @gol
282 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -fprofile-generate -fprofile-use @gol
286 -freduce-all-givs  -fregmove  -frename-registers @gol
287 -freorder-blocks  -freorder-functions @gol
288 -frerun-cse-after-loop  -frerun-loop-opt @gol
289 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
290 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
291 -fsched-spec-load-dangerous  @gol
292 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
293 -fsched2-use-superblocks @gol
294 -fsched2-use-traces  -fsignaling-nans @gol
295 -fsingle-precision-constant  @gol
296 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
297 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
298 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
299 --param @var{name}=@var{value}
300 -O  -O0  -O1  -O2  -O3  -Os}
301
302 @item Preprocessor Options
303 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
304 @gccoptlist{-A@var{question}=@var{answer} @gol
305 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
306 -C  -dD  -dI  -dM  -dN @gol
307 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
308 -idirafter @var{dir} @gol
309 -include @var{file}  -imacros @var{file} @gol
310 -iprefix @var{file}  -iwithprefix @var{dir} @gol
311 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
312 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
313 -P  -fworking-directory  -remap @gol
314 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
315 -Xpreprocessor @var{option}}
316
317 @item Assembler Option
318 @xref{Assembler Options,,Passing Options to the Assembler}.
319 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
320
321 @item Linker Options
322 @xref{Link Options,,Options for Linking}.
323 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
324 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
325 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
326 -Wl,@var{option}  -Xlinker @var{option} @gol
327 -u @var{symbol}}
328
329 @item Directory Options
330 @xref{Directory Options,,Options for Directory Search}.
331 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
332
333 @item Target Options
334 @c I wrote this xref this way to avoid overfull hbox. -- rms
335 @xref{Target Options}.
336 @gccoptlist{-V @var{version}  -b @var{machine}}
337
338 @item Machine Dependent Options
339 @xref{Submodel Options,,Hardware Models and Configurations}.
340
341 @emph{M680x0 Options}
342 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
343 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
344 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
345 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
346 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
347
348 @emph{M68hc1x Options}
349 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
350 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
351 -msoft-reg-count=@var{count}}
352
353 @emph{VAX Options}
354 @gccoptlist{-mg  -mgnu  -munix}
355
356 @emph{SPARC Options}
357 @gccoptlist{-mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32  -m64  -mapp-regs  -mno-app-regs @gol
361 -mfaster-structs  -mno-faster-structs @gol
362 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
363 -mhard-quad-float  -msoft-quad-float @gol
364 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
365 -mstack-bias  -mno-stack-bias @gol
366 -munaligned-doubles  -mno-unaligned-doubles @gol
367 -mv8plus  -mno-v8plus  -mvis  -mno-vis}
368
369 @emph{ARM Options}
370 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
371 -mapcs-26  -mapcs-32 @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -malignment-traps  -mno-alignment-traps @gol
378 -mfloat-abi=@var{name}  soft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mabort-on-noreturn @gol
383 -mlong-calls  -mno-long-calls @gol
384 -msingle-pic-base  -mno-single-pic-base @gol
385 -mpic-register=@var{reg} @gol
386 -mnop-fun-dllimport @gol
387 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
388 -mpoke-function-name @gol
389 -mthumb  -marm @gol
390 -mtpcs-frame  -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking  -mcallee-super-interworking}
392
393 @emph{MN10300 Options}
394 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
395 -mam33  -mno-am33 @gol
396 -mam33-2  -mno-am33-2 @gol
397 -mno-crt0  -mrelax}
398
399 @emph{M32R/D Options}
400 @gccoptlist{-m32r2 -m32rx -m32r @gol
401 -mdebug @gol
402 -malign-loops -mno-align-loops @gol
403 -missue-rate=@var{number} @gol
404 -mbranch-cost=@var{number} @gol
405 -mmodel=@var{code-size-model-type} @gol
406 -msdata=@var{sdata-type} @gol
407 -mno-flush-func -mflush-func=@var{name} @gol
408 -mno-flush-trap -mflush-trap=@var{number} @gol
409 -G @var{num}}
410
411 @emph{RS/6000 and PowerPC Options}
412 @gccoptlist{-mcpu=@var{cpu-type} @gol
413 -mtune=@var{cpu-type} @gol
414 -mpower  -mno-power  -mpower2  -mno-power2 @gol
415 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
416 -maltivec  -mno-altivec @gol
417 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
418 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
419 -mnew-mnemonics  -mold-mnemonics @gol
420 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
421 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
422 -malign-power  -malign-natural @gol
423 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
424 -mstring  -mno-string  -mupdate  -mno-update @gol
425 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
426 -mstrict-align  -mno-strict-align  -mrelocatable @gol
427 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
428 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
429 -mdynamic-no-pic @gol
430 -mprioritize-restricted-insns=@var{priority} @gol
431 -msched-costly-dep=@var{dependence_type} @gol
432 -minsert-sched-nops=@var{scheme} @gol
433 -mcall-sysv  -mcall-netbsd @gol
434 -maix-struct-return  -msvr4-struct-return @gol
435 -mabi=altivec  -mabi=no-altivec @gol
436 -mabi=spe  -mabi=no-spe @gol
437 -misel=yes  -misel=no @gol
438 -mspe=yes  -mspe=no @gol
439 -mfloat-gprs=yes  -mfloat-gprs=no @gol
440 -mprototype  -mno-prototype @gol
441 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
442 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
443
444 @emph{Darwin Options}
445 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
446 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
447 -client_name  -compatibility_version  -current_version @gol
448 -dependency-file  -dylib_file  -dylinker_install_name @gol
449 -dynamic  -dynamiclib  -exported_symbols_list @gol
450 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
451 -force_flat_namespace  -headerpad_max_install_names @gol
452 -image_base  -init  -install_name  -keep_private_externs @gol
453 -multi_module  -multiply_defined  -multiply_defined_unused @gol
454 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
455 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
456 -private_bundle  -read_only_relocs  -sectalign @gol
457 -sectobjectsymbols  -whyload  -seg1addr @gol
458 -sectcreate  -sectobjectsymbols  -sectorder @gol
459 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
460 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
461 -single_module  -static  -sub_library  -sub_umbrella @gol
462 -twolevel_namespace  -umbrella  -undefined @gol
463 -unexported_symbols_list  -weak_reference_mismatches @gol
464 -whatsloaded}
465
466 @emph{MIPS Options}
467 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
468 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
469 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
470 -mxgot  -mno-xgot  -membedded-pic  -mno-embedded-pic @gol
471 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
472 -msingle-float  -mdouble-float  -mint64  -mlong64  -mlong32 @gol
473 -G@var{num}  -membedded-data  -mno-embedded-data @gol
474 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
475 -msplit-addresses  -mno-split-addresses  @gol
476 -mexplicit-relocs  -mno-explicit-relocs  @gol
477 -mrnames  -mno-rnames @gol
478 -mcheck-zero-division  -mno-check-zero-division @gol
479 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
480 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
481 -mfix-r4000  -mno-fix-r4000  -mfix-sb1  -mno-fix-sb1 @gol
482 -mflush-func=@var{func}  -mno-flush-func @gol
483 -mbranch-likely  -mno-branch-likely}
484
485 @emph{i386 and x86-64 Options}
486 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
487 -mfpmath=@var{unit} @gol
488 -masm=@var{dialect}  -mno-fancy-math-387 @gol
489 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
490 -mno-wide-multiply  -mrtd  -malign-double @gol
491 -mpreferred-stack-boundary=@var{num} @gol
492 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
493 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
494 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
495 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
496 -mno-red-zone -mno-tls-direct-seg-refs @gol
497 -mcmodel=@var{code-model} @gol
498 -m32  -m64}
499
500 @emph{HPPA Options}
501 @gccoptlist{-march=@var{architecture-type} @gol
502 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
503 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
504 -mjump-in-delay -mlinker-opt -mlong-calls @gol
505 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
506 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
507 -mno-jump-in-delay  -mno-long-load-store @gol
508 -mno-portable-runtime  -mno-soft-float @gol
509 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
510 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
511 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
512 -nolibdld  -static  -threads}
513
514 @emph{DEC Alpha Options}
515 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
516 -mieee  -mieee-with-inexact  -mieee-conformant @gol
517 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
518 -mtrap-precision=@var{mode}  -mbuild-constants @gol
519 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
520 -mbwx  -mmax  -mfix  -mcix @gol
521 -mfloat-vax  -mfloat-ieee @gol
522 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
523 -msmall-text  -mlarge-text @gol
524 -mmemory-latency=@var{time}}
525
526 @emph{DEC Alpha/VMS Options}
527 @gccoptlist{-mvms-return-codes}
528
529 @emph{H8/300 Options}
530 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
531
532 @emph{SH Options}
533 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
534 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
535 -m5-64media  -m5-64media-nofpu @gol
536 -m5-32media  -m5-32media-nofpu @gol
537 -m5-compact  -m5-compact-nofpu @gol
538 -mb  -ml  -mdalign  -mrelax @gol
539 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
540 -mieee  -misize  -mpadstruct  -mspace @gol
541 -mprefergot  -musermode}
542
543 @emph{System V Options}
544 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
545
546 @emph{ARC Options}
547 @gccoptlist{-EB  -EL @gol
548 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
549 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
550
551 @emph{TMS320C3x/C4x Options}
552 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
553 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
554 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
555 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
556
557 @emph{V850 Options}
558 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
559 -mprolog-function  -mno-prolog-function  -mspace @gol
560 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
561 -mapp-regs  -mno-app-regs @gol
562 -mdisable-callt  -mno-disable-callt @gol
563 -mv850e1 @gol
564 -mv850e @gol
565 -mv850  -mbig-switch}
566
567 @emph{NS32K Options}
568 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
569 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
570 -mregparam  -mnoregparam  -msb  -mnosb @gol
571 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
572
573 @emph{AVR Options}
574 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
575 -mcall-prologues  -mno-tablejump  -mtiny-stack}
576
577 @emph{MCore Options}
578 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
579 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
580 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
581 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
582 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
583
584 @emph{MMIX Options}
585 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
586 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
587 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
588 -mno-base-addresses  -msingle-exit  -mno-single-exit}
589
590 @emph{IA-64 Options}
591 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
592 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
593 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
594 -minline-float-divide-max-throughput @gol
595 -minline-int-divide-min-latency @gol
596 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
597 -mfixed-range=@var{register-range}}
598
599 @emph{S/390 and zSeries Options}
600 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
601 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
602 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
603 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
604
605 @emph{CRIS Options}
606 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
607 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
608 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
609 -mstack-align  -mdata-align  -mconst-align @gol
610 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
611 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
612 -mmul-bug-workaround  -mno-mul-bug-workaround}
613
614 @emph{PDP-11 Options}
615 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
616 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
617 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
618 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
619 -mbranch-expensive  -mbranch-cheap @gol
620 -msplit  -mno-split  -munix-asm  -mdec-asm}
621
622 @emph{Xstormy16 Options}
623 @gccoptlist{-msim}
624
625 @emph{Xtensa Options}
626 @gccoptlist{-mconst16 -mno-const16 @gol
627 -mfused-madd  -mno-fused-madd @gol
628 -mtext-section-literals  -mno-text-section-literals @gol
629 -mtarget-align  -mno-target-align @gol
630 -mlongcalls  -mno-longcalls}
631
632 @emph{FRV Options}
633 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
634 -mhard-float  -msoft-float @gol
635 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
636 -mdouble  -mno-double @gol
637 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
638 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic -mlinked-fp @gol
639 -mlibrary-pic  -macc-4 -macc-8 @gol
640 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
641 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
642 -mvliw-branch  -mno-vliw-branch @gol
643 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
644 -mno-nested-cond-exec  -mtomcat-stats @gol
645 -mcpu=@var{cpu}}
646
647 @item Code Generation Options
648 @xref{Code Gen Options,,Options for Code Generation Conventions}.
649 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
650 -ffixed-@var{reg}  -fexceptions @gol
651 -fnon-call-exceptions  -funwind-tables @gol
652 -fasynchronous-unwind-tables @gol
653 -finhibit-size-directive  -finstrument-functions @gol
654 -fno-common  -fno-ident @gol
655 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
656 -freg-struct-return  -fshared-data  -fshort-enums @gol
657 -fshort-double  -fshort-wchar @gol
658 -fverbose-asm  -fpack-struct  -fstack-check @gol
659 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
660 -fargument-alias  -fargument-noalias @gol
661 -fargument-noalias-global  -fleading-underscore @gol
662 -ftls-model=@var{model} @gol
663 -ftrapv  -fwrapv  -fbounds-check}
664 @end table
665
666 @menu
667 * Overall Options::     Controlling the kind of output:
668                         an executable, object files, assembler files,
669                         or preprocessed source.
670 * C Dialect Options::   Controlling the variant of C language compiled.
671 * C++ Dialect Options:: Variations on C++.
672 * Objective-C Dialect Options:: Variations on Objective-C.
673 * Language Independent Options:: Controlling how diagnostics should be
674                         formatted.
675 * Warning Options::     How picky should the compiler be?
676 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
677 * Optimize Options::    How much optimization?
678 * Preprocessor Options:: Controlling header files and macro definitions.
679                          Also, getting dependency information for Make.
680 * Assembler Options::   Passing options to the assembler.
681 * Link Options::        Specifying libraries and so on.
682 * Directory Options::   Where to find header files and libraries.
683                         Where to find the compiler executable files.
684 * Spec Files::          How to pass switches to sub-processes.
685 * Target Options::      Running a cross-compiler, or an old version of GCC.
686 @end menu
687
688 @node Overall Options
689 @section Options Controlling the Kind of Output
690
691 Compilation can involve up to four stages: preprocessing, compilation
692 proper, assembly and linking, always in that order.  GCC is capable of
693 preprocessing and compiling several files either into several
694 assembler input files, or into one assembler input file; then each
695 assembler input file produces an object file, and linking combines all
696 the object files (those newly compiled, and those specified as input)
697 into an executable file.
698
699 @cindex file name suffix
700 For any given input file, the file name suffix determines what kind of
701 compilation is done:
702
703 @table @gcctabopt
704 @item @var{file}.c
705 C source code which must be preprocessed.
706
707 @item @var{file}.i
708 C source code which should not be preprocessed.
709
710 @item @var{file}.ii
711 C++ source code which should not be preprocessed.
712
713 @item @var{file}.m
714 Objective-C source code.  Note that you must link with the library
715 @file{libobjc.a} to make an Objective-C program work.
716
717 @item @var{file}.mi
718 Objective-C source code which should not be preprocessed.
719
720 @item @var{file}.h
721 C or C++ header file to be turned into a precompiled header.
722
723 @item @var{file}.cc
724 @itemx @var{file}.cp
725 @itemx @var{file}.cxx
726 @itemx @var{file}.cpp
727 @itemx @var{file}.CPP
728 @itemx @var{file}.c++
729 @itemx @var{file}.C
730 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
731 the last two letters must both be literally @samp{x}.  Likewise,
732 @samp{.C} refers to a literal capital C@.
733
734 @item @var{file}.hh
735 @itemx @var{file}.H
736 C++ header file to be turned into a precompiled header.
737
738 @item @var{file}.f
739 @itemx @var{file}.for
740 @itemx @var{file}.FOR
741 Fortran source code which should not be preprocessed.
742
743 @item @var{file}.F
744 @itemx @var{file}.fpp
745 @itemx @var{file}.FPP
746 Fortran source code which must be preprocessed (with the traditional
747 preprocessor).
748
749 @item @var{file}.r
750 Fortran source code which must be preprocessed with a RATFOR
751 preprocessor (not included with GCC)@.
752
753 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
754 Using and Porting GNU Fortran}, for more details of the handling of
755 Fortran input files.
756
757 @c FIXME: Descriptions of Java file types.
758 @c @var{file}.java
759 @c @var{file}.class
760 @c @var{file}.zip
761 @c @var{file}.jar
762
763 @item @var{file}.ads
764 Ada source code file which contains a library unit declaration (a
765 declaration of a package, subprogram, or generic, or a generic
766 instantiation), or a library unit renaming declaration (a package,
767 generic, or subprogram renaming declaration).  Such files are also
768 called @dfn{specs}.
769
770 @itemx @var{file}.adb
771 Ada source code file containing a library unit body (a subprogram or
772 package body).  Such files are also called @dfn{bodies}.
773
774 @c GCC also knows about some suffixes for languages not yet included:
775 @c Pascal:
776 @c @var{file}.p
777 @c @var{file}.pas
778
779 @item @var{file}.s
780 Assembler code.
781
782 @item @var{file}.S
783 Assembler code which must be preprocessed.
784
785 @item @var{other}
786 An object file to be fed straight into linking.
787 Any file name with no recognized suffix is treated this way.
788 @end table
789
790 @opindex x
791 You can specify the input language explicitly with the @option{-x} option:
792
793 @table @gcctabopt
794 @item -x @var{language}
795 Specify explicitly the @var{language} for the following input files
796 (rather than letting the compiler choose a default based on the file
797 name suffix).  This option applies to all following input files until
798 the next @option{-x} option.  Possible values for @var{language} are:
799 @smallexample
800 c  c-header  cpp-output
801 c++  c++-header  c++-cpp-output
802 objective-c  objective-c-header  objc-cpp-output
803 assembler  assembler-with-cpp
804 ada
805 f77  f77-cpp-input  ratfor
806 java
807 treelang
808 @end smallexample
809
810 @item -x none
811 Turn off any specification of a language, so that subsequent files are
812 handled according to their file name suffixes (as they are if @option{-x}
813 has not been used at all).
814
815 @item -pass-exit-codes
816 @opindex pass-exit-codes
817 Normally the @command{gcc} program will exit with the code of 1 if any
818 phase of the compiler returns a non-success return code.  If you specify
819 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
820 numerically highest error produced by any phase that returned an error
821 indication.
822 @end table
823
824 If you only want some of the stages of compilation, you can use
825 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
826 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
827 @command{gcc} is to stop.  Note that some combinations (for example,
828 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
829
830 @table @gcctabopt
831 @item -c
832 @opindex c
833 Compile or assemble the source files, but do not link.  The linking
834 stage simply is not done.  The ultimate output is in the form of an
835 object file for each source file.
836
837 By default, the object file name for a source file is made by replacing
838 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
839
840 Unrecognized input files, not requiring compilation or assembly, are
841 ignored.
842
843 @item -S
844 @opindex S
845 Stop after the stage of compilation proper; do not assemble.  The output
846 is in the form of an assembler code file for each non-assembler input
847 file specified.
848
849 By default, the assembler file name for a source file is made by
850 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
851
852 Input files that don't require compilation are ignored.
853
854 @item -E
855 @opindex E
856 Stop after the preprocessing stage; do not run the compiler proper.  The
857 output is in the form of preprocessed source code, which is sent to the
858 standard output.
859
860 Input files which don't require preprocessing are ignored.
861
862 @cindex output file option
863 @item -o @var{file}
864 @opindex o
865 Place output in file @var{file}.  This applies regardless to whatever
866 sort of output is being produced, whether it be an executable file,
867 an object file, an assembler file or preprocessed C code.
868
869 If you specify @option{-o} when compiling more than one input file, or
870 you are producing an executable file as output, all the source files
871 on the command line will be compiled at once.
872
873 If @option{-o} is not specified, the default is to put an executable file
874 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
875 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
876 all preprocessed C source on standard output.
877
878 @item -v
879 @opindex v
880 Print (on standard error output) the commands executed to run the stages
881 of compilation.  Also print the version number of the compiler driver
882 program and of the preprocessor and the compiler proper.
883
884 @item -###
885 @opindex ###
886 Like @option{-v} except the commands are not executed and all command
887 arguments are quoted.  This is useful for shell scripts to capture the
888 driver-generated command lines.
889
890 @item -pipe
891 @opindex pipe
892 Use pipes rather than temporary files for communication between the
893 various stages of compilation.  This fails to work on some systems where
894 the assembler is unable to read from a pipe; but the GNU assembler has
895 no trouble.
896
897 @item --help
898 @opindex help
899 Print (on the standard output) a description of the command line options
900 understood by @command{gcc}.  If the @option{-v} option is also specified
901 then @option{--help} will also be passed on to the various processes
902 invoked by @command{gcc}, so that they can display the command line options
903 they accept.  If the @option{-Wextra} option is also specified then command
904 line options which have no documentation associated with them will also
905 be displayed.
906
907 @item --target-help
908 @opindex target-help
909 Print (on the standard output) a description of target specific command
910 line options for each tool.
911
912 @item --version
913 @opindex version
914 Display the version number and copyrights of the invoked GCC.
915 @end table
916
917 @node Invoking G++
918 @section Compiling C++ Programs
919
920 @cindex suffixes for C++ source
921 @cindex C++ source file suffixes
922 C++ source files conventionally use one of the suffixes @samp{.C},
923 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
924 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
925 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
926 files with these names and compiles them as C++ programs even if you
927 call the compiler the same way as for compiling C programs (usually
928 with the name @command{gcc}).
929
930 @findex g++
931 @findex c++
932 However, C++ programs often require class libraries as well as a
933 compiler that understands the C++ language---and under some
934 circumstances, you might want to compile programs or header files from
935 standard input, or otherwise without a suffix that flags them as C++
936 programs.  You might also like to precompile a C header file with a
937 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
938 program that calls GCC with the default language set to C++, and
939 automatically specifies linking against the C++ library.  On many
940 systems, @command{g++} is also installed with the name @command{c++}.
941
942 @cindex invoking @command{g++}
943 When you compile C++ programs, you may specify many of the same
944 command-line options that you use for compiling programs in any
945 language; or command-line options meaningful for C and related
946 languages; or options that are meaningful only for C++ programs.
947 @xref{C Dialect Options,,Options Controlling C Dialect}, for
948 explanations of options for languages related to C@.
949 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
950 explanations of options that are meaningful only for C++ programs.
951
952 @node C Dialect Options
953 @section Options Controlling C Dialect
954 @cindex dialect options
955 @cindex language dialect options
956 @cindex options, dialect
957
958 The following options control the dialect of C (or languages derived
959 from C, such as C++ and Objective-C) that the compiler accepts:
960
961 @table @gcctabopt
962 @cindex ANSI support
963 @cindex ISO support
964 @item -ansi
965 @opindex ansi
966 In C mode, support all ISO C90 programs.  In C++ mode,
967 remove GNU extensions that conflict with ISO C++.
968
969 This turns off certain features of GCC that are incompatible with ISO
970 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
971 such as the @code{asm} and @code{typeof} keywords, and
972 predefined macros such as @code{unix} and @code{vax} that identify the
973 type of system you are using.  It also enables the undesirable and
974 rarely used ISO trigraph feature.  For the C compiler,
975 it disables recognition of C++ style @samp{//} comments as well as
976 the @code{inline} keyword.
977
978 The alternate keywords @code{__asm__}, @code{__extension__},
979 @code{__inline__} and @code{__typeof__} continue to work despite
980 @option{-ansi}.  You would not want to use them in an ISO C program, of
981 course, but it is useful to put them in header files that might be included
982 in compilations done with @option{-ansi}.  Alternate predefined macros
983 such as @code{__unix__} and @code{__vax__} are also available, with or
984 without @option{-ansi}.
985
986 The @option{-ansi} option does not cause non-ISO programs to be
987 rejected gratuitously.  For that, @option{-pedantic} is required in
988 addition to @option{-ansi}.  @xref{Warning Options}.
989
990 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
991 option is used.  Some header files may notice this macro and refrain
992 from declaring certain functions or defining certain macros that the
993 ISO standard doesn't call for; this is to avoid interfering with any
994 programs that might use these names for other things.
995
996 Functions which would normally be built in but do not have semantics
997 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
998 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
999 built-in functions provided by GCC}, for details of the functions
1000 affected.
1001
1002 @item -std=
1003 @opindex std
1004 Determine the language standard.  This option is currently only
1005 supported when compiling C or C++.  A value for this option must be
1006 provided; possible values are
1007
1008 @table @samp
1009 @item c89
1010 @itemx iso9899:1990
1011 ISO C90 (same as @option{-ansi}).
1012
1013 @item iso9899:199409
1014 ISO C90 as modified in amendment 1.
1015
1016 @item c99
1017 @itemx c9x
1018 @itemx iso9899:1999
1019 @itemx iso9899:199x
1020 ISO C99.  Note that this standard is not yet fully supported; see
1021 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1022 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1023
1024 @item gnu89
1025 Default, ISO C90 plus GNU extensions (including some C99 features).
1026
1027 @item gnu99
1028 @itemx gnu9x
1029 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1030 this will become the default.  The name @samp{gnu9x} is deprecated.
1031
1032 @item c++98
1033 The 1998 ISO C++ standard plus amendments.
1034
1035 @item gnu++98
1036 The same as @option{-std=c++98} plus GNU extensions.  This is the
1037 default for C++ code.
1038 @end table
1039
1040 Even when this option is not specified, you can still use some of the
1041 features of newer standards in so far as they do not conflict with
1042 previous C standards.  For example, you may use @code{__restrict__} even
1043 when @option{-std=c99} is not specified.
1044
1045 The @option{-std} options specifying some version of ISO C have the same
1046 effects as @option{-ansi}, except that features that were not in ISO C90
1047 but are in the specified version (for example, @samp{//} comments and
1048 the @code{inline} keyword in ISO C99) are not disabled.
1049
1050 @xref{Standards,,Language Standards Supported by GCC}, for details of
1051 these standard versions.
1052
1053 @item -aux-info @var{filename}
1054 @opindex aux-info
1055 Output to the given filename prototyped declarations for all functions
1056 declared and/or defined in a translation unit, including those in header
1057 files.  This option is silently ignored in any language other than C@.
1058
1059 Besides declarations, the file indicates, in comments, the origin of
1060 each declaration (source file and line), whether the declaration was
1061 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1062 @samp{O} for old, respectively, in the first character after the line
1063 number and the colon), and whether it came from a declaration or a
1064 definition (@samp{C} or @samp{F}, respectively, in the following
1065 character).  In the case of function definitions, a K&R-style list of
1066 arguments followed by their declarations is also provided, inside
1067 comments, after the declaration.
1068
1069 @item -fno-asm
1070 @opindex fno-asm
1071 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1072 keyword, so that code can use these words as identifiers.  You can use
1073 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1074 instead.  @option{-ansi} implies @option{-fno-asm}.
1075
1076 In C++, this switch only affects the @code{typeof} keyword, since
1077 @code{asm} and @code{inline} are standard keywords.  You may want to
1078 use the @option{-fno-gnu-keywords} flag instead, which has the same
1079 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1080 switch only affects the @code{asm} and @code{typeof} keywords, since
1081 @code{inline} is a standard keyword in ISO C99.
1082
1083 @item -fno-builtin
1084 @itemx -fno-builtin-@var{function}
1085 @opindex fno-builtin
1086 @cindex built-in functions
1087 Don't recognize built-in functions that do not begin with
1088 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1089 functions provided by GCC}, for details of the functions affected,
1090 including those which are not built-in functions when @option{-ansi} or
1091 @option{-std} options for strict ISO C conformance are used because they
1092 do not have an ISO standard meaning.
1093
1094 GCC normally generates special code to handle certain built-in functions
1095 more efficiently; for instance, calls to @code{alloca} may become single
1096 instructions that adjust the stack directly, and calls to @code{memcpy}
1097 may become inline copy loops.  The resulting code is often both smaller
1098 and faster, but since the function calls no longer appear as such, you
1099 cannot set a breakpoint on those calls, nor can you change the behavior
1100 of the functions by linking with a different library.
1101
1102 With the @option{-fno-builtin-@var{function}} option
1103 only the built-in function @var{function} is
1104 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1105 function is named this is not built-in in this version of GCC, this
1106 option is ignored.  There is no corresponding
1107 @option{-fbuiltin-@var{function}} option; if you wish to enable
1108 built-in functions selectively when using @option{-fno-builtin} or
1109 @option{-ffreestanding}, you may define macros such as:
1110
1111 @smallexample
1112 #define abs(n)          __builtin_abs ((n))
1113 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1114 @end smallexample
1115
1116 @item -fhosted
1117 @opindex fhosted
1118 @cindex hosted environment
1119
1120 Assert that compilation takes place in a hosted environment.  This implies
1121 @option{-fbuiltin}.  A hosted environment is one in which the
1122 entire standard library is available, and in which @code{main} has a return
1123 type of @code{int}.  Examples are nearly everything except a kernel.
1124 This is equivalent to @option{-fno-freestanding}.
1125
1126 @item -ffreestanding
1127 @opindex ffreestanding
1128 @cindex hosted environment
1129
1130 Assert that compilation takes place in a freestanding environment.  This
1131 implies @option{-fno-builtin}.  A freestanding environment
1132 is one in which the standard library may not exist, and program startup may
1133 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1134 This is equivalent to @option{-fno-hosted}.
1135
1136 @xref{Standards,,Language Standards Supported by GCC}, for details of
1137 freestanding and hosted environments.
1138
1139 @item -fms-extensions
1140 @opindex fms-extensions
1141 Accept some non-standard constructs used in Microsoft header files.
1142
1143 @item -trigraphs
1144 @opindex trigraphs
1145 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1146 options for strict ISO C conformance) implies @option{-trigraphs}.
1147
1148 @item -no-integrated-cpp
1149 @opindex no-integrated-cpp
1150 Performs a compilation in two passes: preprocessing and compiling.  This
1151 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1152 @option{-B} option. The user supplied compilation step can then add in
1153 an additional preprocessing step after normal preprocessing but before
1154 compiling. The default is to use the integrated cpp (internal cpp)
1155
1156 The semantics of this option will change if "cc1", "cc1plus", and
1157 "cc1obj" are merged.
1158
1159 @cindex traditional C language
1160 @cindex C language, traditional
1161 @item -traditional
1162 @itemx -traditional-cpp
1163 @opindex traditional-cpp
1164 @opindex traditional
1165 Formerly, these options caused GCC to attempt to emulate a pre-standard
1166 C compiler.  They are now only supported with the @option{-E} switch.
1167 The preprocessor continues to support a pre-standard mode.  See the GNU
1168 CPP manual for details.
1169
1170 @item -fcond-mismatch
1171 @opindex fcond-mismatch
1172 Allow conditional expressions with mismatched types in the second and
1173 third arguments.  The value of such an expression is void.  This option
1174 is not supported for C++.
1175
1176 @item -funsigned-char
1177 @opindex funsigned-char
1178 Let the type @code{char} be unsigned, like @code{unsigned char}.
1179
1180 Each kind of machine has a default for what @code{char} should
1181 be.  It is either like @code{unsigned char} by default or like
1182 @code{signed char} by default.
1183
1184 Ideally, a portable program should always use @code{signed char} or
1185 @code{unsigned char} when it depends on the signedness of an object.
1186 But many programs have been written to use plain @code{char} and
1187 expect it to be signed, or expect it to be unsigned, depending on the
1188 machines they were written for.  This option, and its inverse, let you
1189 make such a program work with the opposite default.
1190
1191 The type @code{char} is always a distinct type from each of
1192 @code{signed char} or @code{unsigned char}, even though its behavior
1193 is always just like one of those two.
1194
1195 @item -fsigned-char
1196 @opindex fsigned-char
1197 Let the type @code{char} be signed, like @code{signed char}.
1198
1199 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1200 the negative form of @option{-funsigned-char}.  Likewise, the option
1201 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1202
1203 @item -fsigned-bitfields
1204 @itemx -funsigned-bitfields
1205 @itemx -fno-signed-bitfields
1206 @itemx -fno-unsigned-bitfields
1207 @opindex fsigned-bitfields
1208 @opindex funsigned-bitfields
1209 @opindex fno-signed-bitfields
1210 @opindex fno-unsigned-bitfields
1211 These options control whether a bit-field is signed or unsigned, when the
1212 declaration does not use either @code{signed} or @code{unsigned}.  By
1213 default, such a bit-field is signed, because this is consistent: the
1214 basic integer types such as @code{int} are signed types.
1215 @end table
1216
1217 @node C++ Dialect Options
1218 @section Options Controlling C++ Dialect
1219
1220 @cindex compiler options, C++
1221 @cindex C++ options, command line
1222 @cindex options, C++
1223 This section describes the command-line options that are only meaningful
1224 for C++ programs; but you can also use most of the GNU compiler options
1225 regardless of what language your program is in.  For example, you
1226 might compile a file @code{firstClass.C} like this:
1227
1228 @smallexample
1229 g++ -g -frepo -O -c firstClass.C
1230 @end smallexample
1231
1232 @noindent
1233 In this example, only @option{-frepo} is an option meant
1234 only for C++ programs; you can use the other options with any
1235 language supported by GCC@.
1236
1237 Here is a list of options that are @emph{only} for compiling C++ programs:
1238
1239 @table @gcctabopt
1240
1241 @item -fabi-version=@var{n}
1242 @opindex fabi-version
1243 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1244 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1245 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1246 the version that conforms most closely to the C++ ABI specification.
1247 Therefore, the ABI obtained using version 0 will change as ABI bugs
1248 are fixed.
1249
1250 The default is version 2.
1251
1252 @item -fno-access-control
1253 @opindex fno-access-control
1254 Turn off all access checking.  This switch is mainly useful for working
1255 around bugs in the access control code.
1256
1257 @item -fcheck-new
1258 @opindex fcheck-new
1259 Check that the pointer returned by @code{operator new} is non-null
1260 before attempting to modify the storage allocated.  This check is
1261 normally unnecessary because the C++ standard specifies that
1262 @code{operator new} will only return @code{0} if it is declared
1263 @samp{throw()}, in which case the compiler will always check the
1264 return value even without this option.  In all other cases, when
1265 @code{operator new} has a non-empty exception specification, memory
1266 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1267 @samp{new (nothrow)}.
1268
1269 @item -fconserve-space
1270 @opindex fconserve-space
1271 Put uninitialized or runtime-initialized global variables into the
1272 common segment, as C does.  This saves space in the executable at the
1273 cost of not diagnosing duplicate definitions.  If you compile with this
1274 flag and your program mysteriously crashes after @code{main()} has
1275 completed, you may have an object that is being destroyed twice because
1276 two definitions were merged.
1277
1278 This option is no longer useful on most targets, now that support has
1279 been added for putting variables into BSS without making them common.
1280
1281 @item -fno-const-strings
1282 @opindex fno-const-strings
1283 Give string constants type @code{char *} instead of type @code{const
1284 char *}.  By default, G++ uses type @code{const char *} as required by
1285 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1286 actually modify the value of a string constant.
1287
1288 This option might be removed in a future release of G++.  For maximum
1289 portability, you should structure your code so that it works with
1290 string constants that have type @code{const char *}.
1291
1292 @item -fno-elide-constructors
1293 @opindex fno-elide-constructors
1294 The C++ standard allows an implementation to omit creating a temporary
1295 which is only used to initialize another object of the same type.
1296 Specifying this option disables that optimization, and forces G++ to
1297 call the copy constructor in all cases.
1298
1299 @item -fno-enforce-eh-specs
1300 @opindex fno-enforce-eh-specs
1301 Don't check for violation of exception specifications at runtime.  This
1302 option violates the C++ standard, but may be useful for reducing code
1303 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1304 will still optimize based on the exception specifications.
1305
1306 @item -ffor-scope
1307 @itemx -fno-for-scope
1308 @opindex ffor-scope
1309 @opindex fno-for-scope
1310 If @option{-ffor-scope} is specified, the scope of variables declared in
1311 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1312 as specified by the C++ standard.
1313 If @option{-fno-for-scope} is specified, the scope of variables declared in
1314 a @i{for-init-statement} extends to the end of the enclosing scope,
1315 as was the case in old versions of G++, and other (traditional)
1316 implementations of C++.
1317
1318 The default if neither flag is given to follow the standard,
1319 but to allow and give a warning for old-style code that would
1320 otherwise be invalid, or have different behavior.
1321
1322 @item -fno-gnu-keywords
1323 @opindex fno-gnu-keywords
1324 Do not recognize @code{typeof} as a keyword, so that code can use this
1325 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1326 @option{-ansi} implies @option{-fno-gnu-keywords}.
1327
1328 @item -fno-implicit-templates
1329 @opindex fno-implicit-templates
1330 Never emit code for non-inline templates which are instantiated
1331 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1332 @xref{Template Instantiation}, for more information.
1333
1334 @item -fno-implicit-inline-templates
1335 @opindex fno-implicit-inline-templates
1336 Don't emit code for implicit instantiations of inline templates, either.
1337 The default is to handle inlines differently so that compiles with and
1338 without optimization will need the same set of explicit instantiations.
1339
1340 @item -fno-implement-inlines
1341 @opindex fno-implement-inlines
1342 To save space, do not emit out-of-line copies of inline functions
1343 controlled by @samp{#pragma implementation}.  This will cause linker
1344 errors if these functions are not inlined everywhere they are called.
1345
1346 @item -fms-extensions
1347 @opindex fms-extensions
1348 Disable pedantic warnings about constructs used in MFC, such as implicit
1349 int and getting a pointer to member function via non-standard syntax.
1350
1351 @item -fno-nonansi-builtins
1352 @opindex fno-nonansi-builtins
1353 Disable built-in declarations of functions that are not mandated by
1354 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1355 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1356
1357 @item -fno-operator-names
1358 @opindex fno-operator-names
1359 Do not treat the operator name keywords @code{and}, @code{bitand},
1360 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1361 synonyms as keywords.
1362
1363 @item -fno-optional-diags
1364 @opindex fno-optional-diags
1365 Disable diagnostics that the standard says a compiler does not need to
1366 issue.  Currently, the only such diagnostic issued by G++ is the one for
1367 a name having multiple meanings within a class.
1368
1369 @item -fpermissive
1370 @opindex fpermissive
1371 Downgrade some diagnostics about nonconformant code from errors to
1372 warnings.  Thus, using @option{-fpermissive} will allow some
1373 nonconforming code to compile.
1374
1375 @item -frepo
1376 @opindex frepo
1377 Enable automatic template instantiation at link time.  This option also
1378 implies @option{-fno-implicit-templates}.  @xref{Template
1379 Instantiation}, for more information.
1380
1381 @item -fno-rtti
1382 @opindex fno-rtti
1383 Disable generation of information about every class with virtual
1384 functions for use by the C++ runtime type identification features
1385 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1386 of the language, you can save some space by using this flag.  Note that
1387 exception handling uses the same information, but it will generate it as
1388 needed.
1389
1390 @item -fstats
1391 @opindex fstats
1392 Emit statistics about front-end processing at the end of the compilation.
1393 This information is generally only useful to the G++ development team.
1394
1395 @item -ftemplate-depth-@var{n}
1396 @opindex ftemplate-depth
1397 Set the maximum instantiation depth for template classes to @var{n}.
1398 A limit on the template instantiation depth is needed to detect
1399 endless recursions during template class instantiation.  ANSI/ISO C++
1400 conforming programs must not rely on a maximum depth greater than 17.
1401
1402 @item -fuse-cxa-atexit
1403 @opindex fuse-cxa-atexit
1404 Register destructors for objects with static storage duration with the
1405 @code{__cxa_atexit} function rather than the @code{atexit} function.
1406 This option is required for fully standards-compliant handling of static
1407 destructors, but will only work if your C library supports
1408 @code{__cxa_atexit}.
1409
1410 @item -fno-weak
1411 @opindex fno-weak
1412 Do not use weak symbol support, even if it is provided by the linker.
1413 By default, G++ will use weak symbols if they are available.  This
1414 option exists only for testing, and should not be used by end-users;
1415 it will result in inferior code and has no benefits.  This option may
1416 be removed in a future release of G++.
1417
1418 @item -nostdinc++
1419 @opindex nostdinc++
1420 Do not search for header files in the standard directories specific to
1421 C++, but do still search the other standard directories.  (This option
1422 is used when building the C++ library.)
1423 @end table
1424
1425 In addition, these optimization, warning, and code generation options
1426 have meanings only for C++ programs:
1427
1428 @table @gcctabopt
1429 @item -fno-default-inline
1430 @opindex fno-default-inline
1431 Do not assume @samp{inline} for functions defined inside a class scope.
1432 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1433 functions will have linkage like inline functions; they just won't be
1434 inlined by default.
1435
1436 @item -Wabi @r{(C++ only)}
1437 @opindex Wabi
1438 Warn when G++ generates code that is probably not compatible with the
1439 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1440 all such cases, there are probably some cases that are not warned about,
1441 even though G++ is generating incompatible code.  There may also be
1442 cases where warnings are emitted even though the code that is generated
1443 will be compatible.
1444
1445 You should rewrite your code to avoid these warnings if you are
1446 concerned about the fact that code generated by G++ may not be binary
1447 compatible with code generated by other compilers.
1448
1449 The known incompatibilities at this point include:
1450
1451 @itemize @bullet
1452
1453 @item
1454 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1455 pack data into the same byte as a base class.  For example:
1456
1457 @smallexample
1458 struct A @{ virtual void f(); int f1 : 1; @};
1459 struct B : public A @{ int f2 : 1; @};
1460 @end smallexample
1461
1462 @noindent
1463 In this case, G++ will place @code{B::f2} into the same byte
1464 as@code{A::f1}; other compilers will not.  You can avoid this problem
1465 by explicitly padding @code{A} so that its size is a multiple of the
1466 byte size on your platform; that will cause G++ and other compilers to
1467 layout @code{B} identically.
1468
1469 @item
1470 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1471 tail padding when laying out virtual bases.  For example:
1472
1473 @smallexample
1474 struct A @{ virtual void f(); char c1; @};
1475 struct B @{ B(); char c2; @};
1476 struct C : public A, public virtual B @{@};
1477 @end smallexample
1478
1479 @noindent
1480 In this case, G++ will not place @code{B} into the tail-padding for
1481 @code{A}; other compilers will.  You can avoid this problem by
1482 explicitly padding @code{A} so that its size is a multiple of its
1483 alignment (ignoring virtual base classes); that will cause G++ and other
1484 compilers to layout @code{C} identically.
1485
1486 @item
1487 Incorrect handling of bit-fields with declared widths greater than that
1488 of their underlying types, when the bit-fields appear in a union.  For
1489 example:
1490
1491 @smallexample
1492 union U @{ int i : 4096; @};
1493 @end smallexample
1494
1495 @noindent
1496 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1497 union too small by the number of bits in an @code{int}.
1498
1499 @item
1500 Empty classes can be placed at incorrect offsets.  For example:
1501
1502 @smallexample
1503 struct A @{@};
1504
1505 struct B @{
1506   A a;
1507   virtual void f ();
1508 @};
1509
1510 struct C : public B, public A @{@};
1511 @end smallexample
1512
1513 @noindent
1514 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1515 it should be placed at offset zero.  G++ mistakenly believes that the
1516 @code{A} data member of @code{B} is already at offset zero.
1517
1518 @item
1519 Names of template functions whose types involve @code{typename} or
1520 template template parameters can be mangled incorrectly.
1521
1522 @smallexample
1523 template <typename Q>
1524 void f(typename Q::X) @{@}
1525
1526 template <template <typename> class Q>
1527 void f(typename Q<int>::X) @{@}
1528 @end smallexample
1529
1530 @noindent
1531 Instantiations of these templates may be mangled incorrectly.
1532
1533 @end itemize
1534
1535 @item -Wctor-dtor-privacy @r{(C++ only)}
1536 @opindex Wctor-dtor-privacy
1537 Warn when a class seems unusable because all the constructors or
1538 destructors in that class are private, and it has neither friends nor
1539 public static member functions.
1540
1541 @item -Wnon-virtual-dtor @r{(C++ only)}
1542 @opindex Wnon-virtual-dtor
1543 Warn when a class appears to be polymorphic, thereby requiring a virtual
1544 destructor, yet it declares a non-virtual one.
1545 This warning is enabled by @option{-Wall}.
1546
1547 @item -Wreorder @r{(C++ only)}
1548 @opindex Wreorder
1549 @cindex reordering, warning
1550 @cindex warning for reordering of member initializers
1551 Warn when the order of member initializers given in the code does not
1552 match the order in which they must be executed.  For instance:
1553
1554 @smallexample
1555 struct A @{
1556   int i;
1557   int j;
1558   A(): j (0), i (1) @{ @}
1559 @};
1560 @end smallexample
1561
1562 The compiler will rearrange the member initializers for @samp{i}
1563 and @samp{j} to match the declaration order of the members, emitting
1564 a warning to that effect.  This warning is enabled by @option{-Wall}.
1565 @end table
1566
1567 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1568
1569 @table @gcctabopt
1570 @item -Weffc++ @r{(C++ only)}
1571 @opindex Weffc++
1572 Warn about violations of the following style guidelines from Scott Meyers'
1573 @cite{Effective C++} book:
1574
1575 @itemize @bullet
1576 @item
1577 Item 11:  Define a copy constructor and an assignment operator for classes
1578 with dynamically allocated memory.
1579
1580 @item
1581 Item 12:  Prefer initialization to assignment in constructors.
1582
1583 @item
1584 Item 14:  Make destructors virtual in base classes.
1585
1586 @item
1587 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1588
1589 @item
1590 Item 23:  Don't try to return a reference when you must return an object.
1591
1592 @end itemize
1593
1594 Also warn about violations of the following style guidelines from
1595 Scott Meyers' @cite{More Effective C++} book:
1596
1597 @itemize @bullet
1598 @item
1599 Item 6:  Distinguish between prefix and postfix forms of increment and
1600 decrement operators.
1601
1602 @item
1603 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1604
1605 @end itemize
1606
1607 When selecting this option, be aware that the standard library
1608 headers do not obey all of these guidelines; use @samp{grep -v}
1609 to filter out those warnings.
1610
1611 @item -Wno-deprecated @r{(C++ only)}
1612 @opindex Wno-deprecated
1613 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1614
1615 @item -Wno-non-template-friend @r{(C++ only)}
1616 @opindex Wno-non-template-friend
1617 Disable warnings when non-templatized friend functions are declared
1618 within a template.  Since the advent of explicit template specification
1619 support in G++, if the name of the friend is an unqualified-id (i.e.,
1620 @samp{friend foo(int)}), the C++ language specification demands that the
1621 friend declare or define an ordinary, nontemplate function.  (Section
1622 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1623 could be interpreted as a particular specialization of a templatized
1624 function.  Because this non-conforming behavior is no longer the default
1625 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1626 check existing code for potential trouble spots and is on by default.
1627 This new compiler behavior can be turned off with
1628 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1629 but disables the helpful warning.
1630
1631 @item -Wold-style-cast @r{(C++ only)}
1632 @opindex Wold-style-cast
1633 Warn if an old-style (C-style) cast to a non-void type is used within
1634 a C++ program.  The new-style casts (@samp{static_cast},
1635 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1636 unintended effects and much easier to search for.
1637
1638 @item -Woverloaded-virtual @r{(C++ only)}
1639 @opindex Woverloaded-virtual
1640 @cindex overloaded virtual fn, warning
1641 @cindex warning for overloaded virtual fn
1642 Warn when a function declaration hides virtual functions from a
1643 base class.  For example, in:
1644
1645 @smallexample
1646 struct A @{
1647   virtual void f();
1648 @};
1649
1650 struct B: public A @{
1651   void f(int);
1652 @};
1653 @end smallexample
1654
1655 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1656 like:
1657
1658 @smallexample
1659 B* b;
1660 b->f();
1661 @end smallexample
1662
1663 will fail to compile.
1664
1665 @item -Wno-pmf-conversions @r{(C++ only)}
1666 @opindex Wno-pmf-conversions
1667 Disable the diagnostic for converting a bound pointer to member function
1668 to a plain pointer.
1669
1670 @item -Wsign-promo @r{(C++ only)}
1671 @opindex Wsign-promo
1672 Warn when overload resolution chooses a promotion from unsigned or
1673 enumeral type to a signed type, over a conversion to an unsigned type of
1674 the same size.  Previous versions of G++ would try to preserve
1675 unsignedness, but the standard mandates the current behavior.
1676
1677 @item -Wsynth @r{(C++ only)}
1678 @opindex Wsynth
1679 @cindex warning for synthesized methods
1680 @cindex synthesized methods, warning
1681 Warn when G++'s synthesis behavior does not match that of cfront.  For
1682 instance:
1683
1684 @smallexample
1685 struct A @{
1686   operator int ();
1687   A& operator = (int);
1688 @};
1689
1690 main ()
1691 @{
1692   A a,b;
1693   a = b;
1694 @}
1695 @end smallexample
1696
1697 In this example, G++ will synthesize a default @samp{A& operator =
1698 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1699 @end table
1700
1701 @node Objective-C Dialect Options
1702 @section Options Controlling Objective-C Dialect
1703
1704 @cindex compiler options, Objective-C
1705 @cindex Objective-C options, command line
1706 @cindex options, Objective-C
1707 (NOTE: This manual does not describe the Objective-C language itself.  See
1708 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1709
1710 This section describes the command-line options that are only meaningful
1711 for Objective-C programs, but you can also use most of the GNU compiler
1712 options regardless of what language your program is in.  For example,
1713 you might compile a file @code{some_class.m} like this:
1714
1715 @smallexample
1716 gcc -g -fgnu-runtime -O -c some_class.m
1717 @end smallexample
1718
1719 @noindent
1720 In this example, @option{-fgnu-runtime} is an option meant only for
1721 Objective-C programs; you can use the other options with any language
1722 supported by GCC@.
1723
1724 Here is a list of options that are @emph{only} for compiling Objective-C
1725 programs:
1726
1727 @table @gcctabopt
1728 @item -fconstant-string-class=@var{class-name}
1729 @opindex fconstant-string-class
1730 Use @var{class-name} as the name of the class to instantiate for each
1731 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1732 class name is @code{NXConstantString} if the GNU runtime is being used, and
1733 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1734 @option{-fconstant-cfstrings} option, if also present, will override the
1735 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1736 to be laid out as constant CoreFoundation strings.
1737
1738 @item -fgnu-runtime
1739 @opindex fgnu-runtime
1740 Generate object code compatible with the standard GNU Objective-C
1741 runtime.  This is the default for most types of systems.
1742
1743 @item -fnext-runtime
1744 @opindex fnext-runtime
1745 Generate output compatible with the NeXT runtime.  This is the default
1746 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1747 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1748 used.
1749
1750 @item -fno-nil-receivers
1751 @opindex -fno-nil-receivers
1752 Assume that all Objective-C message dispatches (e.g.,
1753 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1754 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1755 used.  Currently, this option is only available in conjunction with
1756 the NeXT runtime on Mac OS X 10.3 and later.
1757
1758 @item -fobjc-exceptions
1759 @opindex -fobjc-exceptions
1760 Enable syntactic support for structured exception handling in Objective-C,
1761 similar to what is offered by C++ and Java.  Currently, this option is only
1762 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1763
1764 @smallexample
1765   @@try @{
1766     @dots{}
1767        @@throw expr;
1768     @dots{}
1769   @}
1770   @@catch (AnObjCClass *exc) @{
1771     @dots{}
1772       @@throw expr;
1773     @dots{}
1774       @@throw;
1775     @dots{}
1776   @}
1777   @@catch (AnotherClass *exc) @{
1778     @dots{}
1779   @}
1780   @@catch (id allOthers) @{
1781     @dots{}
1782   @}
1783   @@finally @{
1784     @dots{}
1785       @@throw expr;
1786     @dots{}
1787   @}
1788 @end smallexample
1789
1790 The @code{@@throw} statement may appear anywhere in an Objective-C or
1791 Objective-C++ program; when used inside of a @code{@@catch} block, the
1792 @code{@@throw} may appear without an argument (as shown above), in which case
1793 the object caught by the @code{@@catch} will be rethrown.
1794
1795 Note that only (pointers to) Objective-C objects may be thrown and
1796 caught using this scheme.  When an object is thrown, it will be caught
1797 by the nearest @code{@@catch} clause capable of handling objects of that type,
1798 analogously to how @code{catch} blocks work in C++ and Java.  A
1799 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1800 any and all Objective-C exceptions not caught by previous @code{@@catch}
1801 clauses (if any).
1802
1803 The @code{@@finally} clause, if present, will be executed upon exit from the
1804 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1805 regardless of whether any exceptions are thrown, caught or rethrown
1806 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1807 of the @code{finally} clause in Java.
1808
1809 There are several caveats to using the new exception mechanism:
1810
1811 @itemize @bullet
1812 @item
1813 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1814 idioms provided by the @code{NSException} class, the new
1815 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1816 systems, due to additional functionality needed in the (NeXT) Objective-C
1817 runtime.
1818
1819 @item
1820 As mentioned above, the new exceptions do not support handling
1821 types other than Objective-C objects.   Furthermore, when used from
1822 Objective-C++, the Objective-C exception model does not interoperate with C++
1823 exceptions at this time.  This means you cannot @code{@@throw} an exception
1824 from Objective-C and @code{catch} it in C++, or vice versa
1825 (i.e., @code{throw @dots{} @@catch}).
1826 @end itemize
1827
1828 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1829 blocks for thread-safe execution:
1830
1831 @smallexample
1832   @@synchronized (ObjCClass *guard) @{
1833     @dots{}
1834   @}
1835 @end smallexample
1836
1837 Upon entering the @code{@@synchronized} block, a thread of execution shall
1838 first check whether a lock has been placed on the corresponding @code{guard}
1839 object by another thread.  If it has, the current thread shall wait until
1840 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1841 the current thread will place its own lock on it, execute the code contained in
1842 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1843 making @code{guard} available to other threads).
1844
1845 Unlike Java, Objective-C does not allow for entire methods to be marked
1846 @code{@@synchronized}.  Note that throwing exceptions out of
1847 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1848 to be unlocked properly.
1849
1850 @item -freplace-objc-classes
1851 @opindex -freplace-objc-classes
1852 Emit a special marker instructing @command{ld(1)} not to statically link in
1853 the resulting object file, and allow @command{dyld(1)} to load it in at
1854 run time instead.  This is used in conjunction with the Fix-and-Continue
1855 debugging mode, where the object file in question may be recompiled and
1856 dynamically reloaded in the course of program execution, without the need
1857 to restart the program itself.  Currently, Fix-and-Continue functionality
1858 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1859 and later.
1860
1861 @item -fzero-link
1862 @opindex -fzero-link
1863 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1864 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1865 compile time) with static class references that get initialized at load time,
1866 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1867 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1868 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1869 for individual class implementations to be modified during program execution.
1870
1871 @item -gen-decls
1872 @opindex gen-decls
1873 Dump interface declarations for all classes seen in the source file to a
1874 file named @file{@var{sourcename}.decl}.
1875
1876 @item -Wno-protocol
1877 @opindex Wno-protocol
1878 If a class is declared to implement a protocol, a warning is issued for
1879 every method in the protocol that is not implemented by the class.  The
1880 default behavior is to issue a warning for every method not explicitly
1881 implemented in the class, even if a method implementation is inherited
1882 from the superclass.  If you use the @code{-Wno-protocol} option, then
1883 methods inherited from the superclass are considered to be implemented,
1884 and no warning is issued for them.
1885
1886 @item -Wselector
1887 @opindex Wselector
1888 Warn if multiple methods of different types for the same selector are
1889 found during compilation.  The check is performed on the list of methods
1890 in the final stage of compilation.  Additionally, a check is performed
1891 for each selector appearing in a @code{@@selector(@dots{})}
1892 expression, and a corresponding method for that selector has been found
1893 during compilation.  Because these checks scan the method table only at
1894 the end of compilation, these warnings are not produced if the final
1895 stage of compilation is not reached, for example because an error is
1896 found during compilation, or because the @code{-fsyntax-only} option is
1897 being used.
1898
1899 @item -Wundeclared-selector
1900 @opindex Wundeclared-selector
1901 Warn if a @code{@@selector(@dots{})} expression referring to an
1902 undeclared selector is found.  A selector is considered undeclared if no
1903 method with that name has been declared before the
1904 @code{@@selector(@dots{})} expression, either explicitly in an
1905 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1906 an @code{@@implementation} section.  This option always performs its
1907 checks as soon as a @code{@@selector(@dots{})} expression is found,
1908 while @code{-Wselector} only performs its checks in the final stage of
1909 compilation.  This also enforces the coding style convention
1910 that methods and selectors must be declared before being used.
1911
1912 @item -print-objc-runtime-info
1913 @opindex -print-objc-runtime-info
1914 Generate C header describing the largest structure that is passed by
1915 value, if any.
1916
1917 @end table
1918
1919 @node Language Independent Options
1920 @section Options to Control Diagnostic Messages Formatting
1921 @cindex options to control diagnostics formatting
1922 @cindex diagnostic messages
1923 @cindex message formatting
1924
1925 Traditionally, diagnostic messages have been formatted irrespective of
1926 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1927 below can be used to control the diagnostic messages formatting
1928 algorithm, e.g.@: how many characters per line, how often source location
1929 information should be reported.  Right now, only the C++ front end can
1930 honor these options.  However it is expected, in the near future, that
1931 the remaining front ends would be able to digest them correctly.
1932
1933 @table @gcctabopt
1934 @item -fmessage-length=@var{n}
1935 @opindex fmessage-length
1936 Try to format error messages so that they fit on lines of about @var{n}
1937 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1938 the front ends supported by GCC@.  If @var{n} is zero, then no
1939 line-wrapping will be done; each error message will appear on a single
1940 line.
1941
1942 @opindex fdiagnostics-show-location
1943 @item -fdiagnostics-show-location=once
1944 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1945 reporter to emit @emph{once} source location information; that is, in
1946 case the message is too long to fit on a single physical line and has to
1947 be wrapped, the source location won't be emitted (as prefix) again,
1948 over and over, in subsequent continuation lines.  This is the default
1949 behavior.
1950
1951 @item -fdiagnostics-show-location=every-line
1952 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1953 messages reporter to emit the same source location information (as
1954 prefix) for physical lines that result from the process of breaking
1955 a message which is too long to fit on a single line.
1956
1957 @end table
1958
1959 @node Warning Options
1960 @section Options to Request or Suppress Warnings
1961 @cindex options to control warnings
1962 @cindex warning messages
1963 @cindex messages, warning
1964 @cindex suppressing warnings
1965
1966 Warnings are diagnostic messages that report constructions which
1967 are not inherently erroneous but which are risky or suggest there
1968 may have been an error.
1969
1970 You can request many specific warnings with options beginning @samp{-W},
1971 for example @option{-Wimplicit} to request warnings on implicit
1972 declarations.  Each of these specific warning options also has a
1973 negative form beginning @samp{-Wno-} to turn off warnings;
1974 for example, @option{-Wno-implicit}.  This manual lists only one of the
1975 two forms, whichever is not the default.
1976
1977 The following options control the amount and kinds of warnings produced
1978 by GCC; for further, language-specific options also refer to
1979 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1980
1981 @table @gcctabopt
1982 @cindex syntax checking
1983 @item -fsyntax-only
1984 @opindex fsyntax-only
1985 Check the code for syntax errors, but don't do anything beyond that.
1986
1987 @item -pedantic
1988 @opindex pedantic
1989 Issue all the warnings demanded by strict ISO C and ISO C++;
1990 reject all programs that use forbidden extensions, and some other
1991 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1992 version of the ISO C standard specified by any @option{-std} option used.
1993
1994 Valid ISO C and ISO C++ programs should compile properly with or without
1995 this option (though a rare few will require @option{-ansi} or a
1996 @option{-std} option specifying the required version of ISO C)@.  However,
1997 without this option, certain GNU extensions and traditional C and C++
1998 features are supported as well.  With this option, they are rejected.
1999
2000 @option{-pedantic} does not cause warning messages for use of the
2001 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2002 warnings are also disabled in the expression that follows
2003 @code{__extension__}.  However, only system header files should use
2004 these escape routes; application programs should avoid them.
2005 @xref{Alternate Keywords}.
2006
2007 Some users try to use @option{-pedantic} to check programs for strict ISO
2008 C conformance.  They soon find that it does not do quite what they want:
2009 it finds some non-ISO practices, but not all---only those for which
2010 ISO C @emph{requires} a diagnostic, and some others for which
2011 diagnostics have been added.
2012
2013 A feature to report any failure to conform to ISO C might be useful in
2014 some instances, but would require considerable additional work and would
2015 be quite different from @option{-pedantic}.  We don't have plans to
2016 support such a feature in the near future.
2017
2018 Where the standard specified with @option{-std} represents a GNU
2019 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2020 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2021 extended dialect is based.  Warnings from @option{-pedantic} are given
2022 where they are required by the base standard.  (It would not make sense
2023 for such warnings to be given only for features not in the specified GNU
2024 C dialect, since by definition the GNU dialects of C include all
2025 features the compiler supports with the given option, and there would be
2026 nothing to warn about.)
2027
2028 @item -pedantic-errors
2029 @opindex pedantic-errors
2030 Like @option{-pedantic}, except that errors are produced rather than
2031 warnings.
2032
2033 @item -w
2034 @opindex w
2035 Inhibit all warning messages.
2036
2037 @item -Wno-import
2038 @opindex Wno-import
2039 Inhibit warning messages about the use of @samp{#import}.
2040
2041 @item -Wchar-subscripts
2042 @opindex Wchar-subscripts
2043 Warn if an array subscript has type @code{char}.  This is a common cause
2044 of error, as programmers often forget that this type is signed on some
2045 machines.
2046
2047 @item -Wcomment
2048 @opindex Wcomment
2049 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2050 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2051
2052 @item -Wformat
2053 @opindex Wformat
2054 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2055 the arguments supplied have types appropriate to the format string
2056 specified, and that the conversions specified in the format string make
2057 sense.  This includes standard functions, and others specified by format
2058 attributes (@pxref{Function Attributes}), in the @code{printf},
2059 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2060 not in the C standard) families.
2061
2062 The formats are checked against the format features supported by GNU
2063 libc version 2.2.  These include all ISO C90 and C99 features, as well
2064 as features from the Single Unix Specification and some BSD and GNU
2065 extensions.  Other library implementations may not support all these
2066 features; GCC does not support warning about features that go beyond a
2067 particular library's limitations.  However, if @option{-pedantic} is used
2068 with @option{-Wformat}, warnings will be given about format features not
2069 in the selected standard version (but not for @code{strfmon} formats,
2070 since those are not in any version of the C standard).  @xref{C Dialect
2071 Options,,Options Controlling C Dialect}.
2072
2073 Since @option{-Wformat} also checks for null format arguments for
2074 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2075
2076 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2077 aspects of format checking, the options @option{-Wformat-y2k},
2078 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2079 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2080 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2081
2082 @item -Wformat-y2k
2083 @opindex Wformat-y2k
2084 If @option{-Wformat} is specified, also warn about @code{strftime}
2085 formats which may yield only a two-digit year.
2086
2087 @item -Wno-format-extra-args
2088 @opindex Wno-format-extra-args
2089 If @option{-Wformat} is specified, do not warn about excess arguments to a
2090 @code{printf} or @code{scanf} format function.  The C standard specifies
2091 that such arguments are ignored.
2092
2093 Where the unused arguments lie between used arguments that are
2094 specified with @samp{$} operand number specifications, normally
2095 warnings are still given, since the implementation could not know what
2096 type to pass to @code{va_arg} to skip the unused arguments.  However,
2097 in the case of @code{scanf} formats, this option will suppress the
2098 warning if the unused arguments are all pointers, since the Single
2099 Unix Specification says that such unused arguments are allowed.
2100
2101 @item -Wno-format-zero-length
2102 @opindex Wno-format-zero-length
2103 If @option{-Wformat} is specified, do not warn about zero-length formats.
2104 The C standard specifies that zero-length formats are allowed.
2105
2106 @item -Wformat-nonliteral
2107 @opindex Wformat-nonliteral
2108 If @option{-Wformat} is specified, also warn if the format string is not a
2109 string literal and so cannot be checked, unless the format function
2110 takes its format arguments as a @code{va_list}.
2111
2112 @item -Wformat-security
2113 @opindex Wformat-security
2114 If @option{-Wformat} is specified, also warn about uses of format
2115 functions that represent possible security problems.  At present, this
2116 warns about calls to @code{printf} and @code{scanf} functions where the
2117 format string is not a string literal and there are no format arguments,
2118 as in @code{printf (foo);}.  This may be a security hole if the format
2119 string came from untrusted input and contains @samp{%n}.  (This is
2120 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2121 in future warnings may be added to @option{-Wformat-security} that are not
2122 included in @option{-Wformat-nonliteral}.)
2123
2124 @item -Wformat=2
2125 @opindex Wformat=2
2126 Enable @option{-Wformat} plus format checks not included in
2127 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2128 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2129
2130 @item -Wnonnull
2131 @opindex Wnonnull
2132 Warn about passing a null pointer for arguments marked as
2133 requiring a non-null value by the @code{nonnull} function attribute.
2134
2135 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2136 can be disabled with the @option{-Wno-nonnull} option.
2137
2138 @item -Winit-self @r{(C, C++, and Objective-C only)}
2139 @opindex Winit-self
2140 Warn about uninitialized variables which are initialized with themselves.
2141 Note this option can only be used with the @option{-Wuninitialized} option,
2142 which in turn only works with @option{-O1} and above.
2143
2144 For example, GCC will warn about @code{i} being uninitialized in the
2145 following snippet only when @option{-Winit-self} has been specified:
2146 @smallexample
2147 @group
2148 int f()
2149 @{
2150   int i = i;
2151   return i;
2152 @}
2153 @end group
2154 @end smallexample
2155
2156 @item -Wimplicit-int
2157 @opindex Wimplicit-int
2158 Warn when a declaration does not specify a type.
2159
2160 @item -Wimplicit-function-declaration
2161 @itemx -Werror-implicit-function-declaration
2162 @opindex Wimplicit-function-declaration
2163 @opindex Werror-implicit-function-declaration
2164 Give a warning (or error) whenever a function is used before being
2165 declared.
2166
2167 @item -Wimplicit
2168 @opindex Wimplicit
2169 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2170
2171 @item -Wmain
2172 @opindex Wmain
2173 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2174 function with external linkage, returning int, taking either zero
2175 arguments, two, or three arguments of appropriate types.
2176
2177 @item -Wmissing-braces
2178 @opindex Wmissing-braces
2179 Warn if an aggregate or union initializer is not fully bracketed.  In
2180 the following example, the initializer for @samp{a} is not fully
2181 bracketed, but that for @samp{b} is fully bracketed.
2182
2183 @smallexample
2184 int a[2][2] = @{ 0, 1, 2, 3 @};
2185 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2186 @end smallexample
2187
2188 @item -Wparentheses
2189 @opindex Wparentheses
2190 Warn if parentheses are omitted in certain contexts, such
2191 as when there is an assignment in a context where a truth value
2192 is expected, or when operators are nested whose precedence people
2193 often get confused about.
2194
2195 Also warn about constructions where there may be confusion to which
2196 @code{if} statement an @code{else} branch belongs.  Here is an example of
2197 such a case:
2198
2199 @smallexample
2200 @group
2201 @{
2202   if (a)
2203     if (b)
2204       foo ();
2205   else
2206     bar ();
2207 @}
2208 @end group
2209 @end smallexample
2210
2211 In C, every @code{else} branch belongs to the innermost possible @code{if}
2212 statement, which in this example is @code{if (b)}.  This is often not
2213 what the programmer expected, as illustrated in the above example by
2214 indentation the programmer chose.  When there is the potential for this
2215 confusion, GCC will issue a warning when this flag is specified.
2216 To eliminate the warning, add explicit braces around the innermost
2217 @code{if} statement so there is no way the @code{else} could belong to
2218 the enclosing @code{if}.  The resulting code would look like this:
2219
2220 @smallexample
2221 @group
2222 @{
2223   if (a)
2224     @{
2225       if (b)
2226         foo ();
2227       else
2228         bar ();
2229     @}
2230 @}
2231 @end group
2232 @end smallexample
2233
2234 @item -Wsequence-point
2235 @opindex Wsequence-point
2236 Warn about code that may have undefined semantics because of violations
2237 of sequence point rules in the C standard.
2238
2239 The C standard defines the order in which expressions in a C program are
2240 evaluated in terms of @dfn{sequence points}, which represent a partial
2241 ordering between the execution of parts of the program: those executed
2242 before the sequence point, and those executed after it.  These occur
2243 after the evaluation of a full expression (one which is not part of a
2244 larger expression), after the evaluation of the first operand of a
2245 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2246 function is called (but after the evaluation of its arguments and the
2247 expression denoting the called function), and in certain other places.
2248 Other than as expressed by the sequence point rules, the order of
2249 evaluation of subexpressions of an expression is not specified.  All
2250 these rules describe only a partial order rather than a total order,
2251 since, for example, if two functions are called within one expression
2252 with no sequence point between them, the order in which the functions
2253 are called is not specified.  However, the standards committee have
2254 ruled that function calls do not overlap.
2255
2256 It is not specified when between sequence points modifications to the
2257 values of objects take effect.  Programs whose behavior depends on this
2258 have undefined behavior; the C standard specifies that ``Between the
2259 previous and next sequence point an object shall have its stored value
2260 modified at most once by the evaluation of an expression.  Furthermore,
2261 the prior value shall be read only to determine the value to be
2262 stored.''.  If a program breaks these rules, the results on any
2263 particular implementation are entirely unpredictable.
2264
2265 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2266 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2267 diagnosed by this option, and it may give an occasional false positive
2268 result, but in general it has been found fairly effective at detecting
2269 this sort of problem in programs.
2270
2271 The present implementation of this option only works for C programs.  A
2272 future implementation may also work for C++ programs.
2273
2274 The C standard is worded confusingly, therefore there is some debate
2275 over the precise meaning of the sequence point rules in subtle cases.
2276 Links to discussions of the problem, including proposed formal
2277 definitions, may be found on our readings page, at
2278 @w{@uref{http://gcc.gnu.org/readings.html}}.
2279
2280 @item -Wreturn-type
2281 @opindex Wreturn-type
2282 Warn whenever a function is defined with a return-type that defaults to
2283 @code{int}.  Also warn about any @code{return} statement with no
2284 return-value in a function whose return-type is not @code{void}.
2285
2286 For C++, a function without return type always produces a diagnostic
2287 message, even when @option{-Wno-return-type} is specified.  The only
2288 exceptions are @samp{main} and functions defined in system headers.
2289
2290 @item -Wswitch
2291 @opindex Wswitch
2292 Warn whenever a @code{switch} statement has an index of enumeral type
2293 and lacks a @code{case} for one or more of the named codes of that
2294 enumeration.  (The presence of a @code{default} label prevents this
2295 warning.)  @code{case} labels outside the enumeration range also
2296 provoke warnings when this option is used.
2297
2298 @item -Wswitch-default
2299 @opindex Wswitch-switch
2300 Warn whenever a @code{switch} statement does not have a @code{default}
2301 case.
2302
2303 @item -Wswitch-enum
2304 @opindex Wswitch-enum
2305 Warn whenever a @code{switch} statement has an index of enumeral type
2306 and lacks a @code{case} for one or more of the named codes of that
2307 enumeration.  @code{case} labels outside the enumeration range also
2308 provoke warnings when this option is used.
2309
2310 @item -Wtrigraphs
2311 @opindex Wtrigraphs
2312 Warn if any trigraphs are encountered that might change the meaning of
2313 the program (trigraphs within comments are not warned about).
2314
2315 @item -Wunused-function
2316 @opindex Wunused-function
2317 Warn whenever a static function is declared but not defined or a
2318 non\-inline static function is unused.
2319
2320 @item -Wunused-label
2321 @opindex Wunused-label
2322 Warn whenever a label is declared but not used.
2323
2324 To suppress this warning use the @samp{unused} attribute
2325 (@pxref{Variable Attributes}).
2326
2327 @item -Wunused-parameter
2328 @opindex Wunused-parameter
2329 Warn whenever a function parameter is unused aside from its declaration.
2330
2331 To suppress this warning use the @samp{unused} attribute
2332 (@pxref{Variable Attributes}).
2333
2334 @item -Wunused-variable
2335 @opindex Wunused-variable
2336 Warn whenever a local variable or non-constant static variable is unused
2337 aside from its declaration
2338
2339 To suppress this warning use the @samp{unused} attribute
2340 (@pxref{Variable Attributes}).
2341
2342 @item -Wunused-value
2343 @opindex Wunused-value
2344 Warn whenever a statement computes a result that is explicitly not used.
2345
2346 To suppress this warning cast the expression to @samp{void}.
2347
2348 @item -Wunused
2349 @opindex Wunused
2350 All the above @option{-Wunused} options combined.
2351
2352 In order to get a warning about an unused function parameter, you must
2353 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2354 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2355
2356 @item -Wuninitialized
2357 @opindex Wuninitialized
2358 Warn if an automatic variable is used without first being initialized or
2359 if a variable may be clobbered by a @code{setjmp} call.
2360
2361 These warnings are possible only in optimizing compilation,
2362 because they require data flow information that is computed only
2363 when optimizing.  If you don't specify @option{-O}, you simply won't
2364 get these warnings.
2365
2366 If you want to warn about code which uses the uninitialized value of the
2367 variable in its own initializer, use the @option{-Winit-self} option.
2368
2369 These warnings occur only for variables that are candidates for
2370 register allocation.  Therefore, they do not occur for a variable that
2371 is declared @code{volatile}, or whose address is taken, or whose size
2372 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2373 structures, unions or arrays, even when they are in registers.
2374
2375 Note that there may be no warning about a variable that is used only
2376 to compute a value that itself is never used, because such
2377 computations may be deleted by data flow analysis before the warnings
2378 are printed.
2379
2380 These warnings are made optional because GCC is not smart
2381 enough to see all the reasons why the code might be correct
2382 despite appearing to have an error.  Here is one example of how
2383 this can happen:
2384
2385 @smallexample
2386 @group
2387 @{
2388   int x;
2389   switch (y)
2390     @{
2391     case 1: x = 1;
2392       break;
2393     case 2: x = 4;
2394       break;
2395     case 3: x = 5;
2396     @}
2397   foo (x);
2398 @}
2399 @end group
2400 @end smallexample
2401
2402 @noindent
2403 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2404 always initialized, but GCC doesn't know this.  Here is
2405 another common case:
2406
2407 @smallexample
2408 @{
2409   int save_y;
2410   if (change_y) save_y = y, y = new_y;
2411   @dots{}
2412   if (change_y) y = save_y;
2413 @}
2414 @end smallexample
2415
2416 @noindent
2417 This has no bug because @code{save_y} is used only if it is set.
2418
2419 @cindex @code{longjmp} warnings
2420 This option also warns when a non-volatile automatic variable might be
2421 changed by a call to @code{longjmp}.  These warnings as well are possible
2422 only in optimizing compilation.
2423
2424 The compiler sees only the calls to @code{setjmp}.  It cannot know
2425 where @code{longjmp} will be called; in fact, a signal handler could
2426 call it at any point in the code.  As a result, you may get a warning
2427 even when there is in fact no problem because @code{longjmp} cannot
2428 in fact be called at the place which would cause a problem.
2429
2430 Some spurious warnings can be avoided if you declare all the functions
2431 you use that never return as @code{noreturn}.  @xref{Function
2432 Attributes}.
2433
2434 @item -Wunknown-pragmas
2435 @opindex Wunknown-pragmas
2436 @cindex warning for unknown pragmas
2437 @cindex unknown pragmas, warning
2438 @cindex pragmas, warning of unknown
2439 Warn when a #pragma directive is encountered which is not understood by
2440 GCC@.  If this command line option is used, warnings will even be issued
2441 for unknown pragmas in system header files.  This is not the case if
2442 the warnings were only enabled by the @option{-Wall} command line option.
2443
2444 @item -Wstrict-aliasing
2445 @opindex Wstrict-aliasing
2446 This option is only active when @option{-fstrict-aliasing} is active.
2447 It warns about code which might break the strict aliasing rules that the
2448 compiler is using for optimization. The warning does not catch all
2449 cases, but does attempt to catch the more common pitfalls. It is
2450 included in @option{-Wall}.
2451
2452 @item -Wstrict-aliasing=2
2453 @opindex Wstrict-aliasing=2
2454 This option is only active when @option{-fstrict-aliasing} is active.
2455 It warns about all code which might break the strict aliasing rules that the
2456 compiler is using for optimization.  This warning catches all cases, but
2457 it will also give a warning for some ambiguous cases that are safe.
2458
2459 @item -Wall
2460 @opindex Wall
2461 All of the above @samp{-W} options combined.  This enables all the
2462 warnings about constructions that some users consider questionable, and
2463 that are easy to avoid (or modify to prevent the warning), even in
2464 conjunction with macros.  This also enables some language-specific
2465 warnings described in @ref{C++ Dialect Options} and
2466 @ref{Objective-C Dialect Options}.
2467 @end table
2468
2469 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2470 Some of them warn about constructions that users generally do not
2471 consider questionable, but which occasionally you might wish to check
2472 for; others warn about constructions that are necessary or hard to avoid
2473 in some cases, and there is no simple way to modify the code to suppress
2474 the warning.
2475
2476 @table @gcctabopt
2477 @item -Wextra
2478 @opindex W
2479 @opindex Wextra
2480 (This option used to be called @option{-W}.  The older name is still
2481 supported, but the newer name is more descriptive.)  Print extra warning
2482 messages for these events:
2483
2484 @itemize @bullet
2485 @item
2486 A function can return either with or without a value.  (Falling
2487 off the end of the function body is considered returning without
2488 a value.)  For example, this function would evoke such a
2489 warning:
2490
2491 @smallexample
2492 @group
2493 foo (a)
2494 @{
2495   if (a > 0)
2496     return a;
2497 @}
2498 @end group
2499 @end smallexample
2500
2501 @item
2502 An expression-statement or the left-hand side of a comma expression
2503 contains no side effects.
2504 To suppress the warning, cast the unused expression to void.
2505 For example, an expression such as @samp{x[i,j]} will cause a warning,
2506 but @samp{x[(void)i,j]} will not.
2507
2508 @item
2509 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2510
2511 @item
2512 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2513 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2514 that of ordinary mathematical notation.
2515
2516 @item
2517 Storage-class specifiers like @code{static} are not the first things in
2518 a declaration.  According to the C Standard, this usage is obsolescent.
2519
2520 @item
2521 The return type of a function has a type qualifier such as @code{const}.
2522 Such a type qualifier has no effect, since the value returned by a
2523 function is not an lvalue.  (But don't warn about the GNU extension of
2524 @code{volatile void} return types.  That extension will be warned about
2525 if @option{-pedantic} is specified.)
2526
2527 @item
2528 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2529 arguments.
2530
2531 @item
2532 A comparison between signed and unsigned values could produce an
2533 incorrect result when the signed value is converted to unsigned.
2534 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2535
2536 @item
2537 An aggregate has an initializer which does not initialize all members.
2538 For example, the following code would cause such a warning, because
2539 @code{x.h} would be implicitly initialized to zero:
2540
2541 @smallexample
2542 struct s @{ int f, g, h; @};
2543 struct s x = @{ 3, 4 @};
2544 @end smallexample
2545
2546 @item
2547 A function parameter is declared without a type specifier in K&R-style
2548 functions:
2549
2550 @smallexample
2551 void foo(bar) @{ @}
2552 @end smallexample
2553
2554 @item
2555 An empty body occurs in an @samp{if} or @samp{else} statement.
2556
2557 @item
2558 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2559 @samp{>}, or @samp{>=}.
2560
2561 @item
2562 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2563
2564 @item
2565 Any of several floating-point events that often indicate errors, such as
2566 overflow, underflow, loss of precision, etc.
2567
2568 @item @r{(C++ only)}
2569 An enumerator and a non-enumerator both appear in a conditional expression.
2570
2571 @item @r{(C++ only)}
2572 A non-static reference or non-static @samp{const} member appears in a
2573 class without constructors.
2574
2575 @item @r{(C++ only)}
2576 Ambiguous virtual bases.
2577
2578 @item @r{(C++ only)}
2579 Subscripting an array which has been declared @samp{register}.
2580
2581 @item @r{(C++ only)}
2582 Taking the address of a variable which has been declared @samp{register}.
2583
2584 @item @r{(C++ only)}
2585 A base class is not initialized in a derived class' copy constructor.
2586 @end itemize
2587
2588 @item -Wno-div-by-zero
2589 @opindex Wno-div-by-zero
2590 @opindex Wdiv-by-zero
2591 Do not warn about compile-time integer division by zero.  Floating point
2592 division by zero is not warned about, as it can be a legitimate way of
2593 obtaining infinities and NaNs.
2594
2595 @item -Wsystem-headers
2596 @opindex Wsystem-headers
2597 @cindex warnings from system headers
2598 @cindex system headers, warnings from
2599 Print warning messages for constructs found in system header files.
2600 Warnings from system headers are normally suppressed, on the assumption
2601 that they usually do not indicate real problems and would only make the
2602 compiler output harder to read.  Using this command line option tells
2603 GCC to emit warnings from system headers as if they occurred in user
2604 code.  However, note that using @option{-Wall} in conjunction with this
2605 option will @emph{not} warn about unknown pragmas in system
2606 headers---for that, @option{-Wunknown-pragmas} must also be used.
2607
2608 @item -Wfloat-equal
2609 @opindex Wfloat-equal
2610 Warn if floating point values are used in equality comparisons.
2611
2612 The idea behind this is that sometimes it is convenient (for the
2613 programmer) to consider floating-point values as approximations to
2614 infinitely precise real numbers.  If you are doing this, then you need
2615 to compute (by analyzing the code, or in some other way) the maximum or
2616 likely maximum error that the computation introduces, and allow for it
2617 when performing comparisons (and when producing output, but that's a
2618 different problem).  In particular, instead of testing for equality, you
2619 would check to see whether the two values have ranges that overlap; and
2620 this is done with the relational operators, so equality comparisons are
2621 probably mistaken.
2622
2623 @item -Wtraditional @r{(C only)}
2624 @opindex Wtraditional
2625 Warn about certain constructs that behave differently in traditional and
2626 ISO C@.  Also warn about ISO C constructs that have no traditional C
2627 equivalent, and/or problematic constructs which should be avoided.
2628
2629 @itemize @bullet
2630 @item
2631 Macro parameters that appear within string literals in the macro body.
2632 In traditional C macro replacement takes place within string literals,
2633 but does not in ISO C@.
2634
2635 @item
2636 In traditional C, some preprocessor directives did not exist.
2637 Traditional preprocessors would only consider a line to be a directive
2638 if the @samp{#} appeared in column 1 on the line.  Therefore
2639 @option{-Wtraditional} warns about directives that traditional C
2640 understands but would ignore because the @samp{#} does not appear as the
2641 first character on the line.  It also suggests you hide directives like
2642 @samp{#pragma} not understood by traditional C by indenting them.  Some
2643 traditional implementations would not recognize @samp{#elif}, so it
2644 suggests avoiding it altogether.
2645
2646 @item
2647 A function-like macro that appears without arguments.
2648
2649 @item
2650 The unary plus operator.
2651
2652 @item
2653 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2654 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2655 constants.)  Note, these suffixes appear in macros defined in the system
2656 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2657 Use of these macros in user code might normally lead to spurious
2658 warnings, however GCC's integrated preprocessor has enough context to
2659 avoid warning in these cases.
2660
2661 @item
2662 A function declared external in one block and then used after the end of
2663 the block.
2664
2665 @item
2666 A @code{switch} statement has an operand of type @code{long}.
2667
2668 @item
2669 A non-@code{static} function declaration follows a @code{static} one.
2670 This construct is not accepted by some traditional C compilers.
2671
2672 @item
2673 The ISO type of an integer constant has a different width or
2674 signedness from its traditional type.  This warning is only issued if
2675 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2676 typically represent bit patterns, are not warned about.
2677
2678 @item
2679 Usage of ISO string concatenation is detected.
2680
2681 @item
2682 Initialization of automatic aggregates.
2683
2684 @item
2685 Identifier conflicts with labels.  Traditional C lacks a separate
2686 namespace for labels.
2687
2688 @item
2689 Initialization of unions.  If the initializer is zero, the warning is
2690 omitted.  This is done under the assumption that the zero initializer in
2691 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2692 initializer warnings and relies on default initialization to zero in the
2693 traditional C case.
2694
2695 @item
2696 Conversions by prototypes between fixed/floating point values and vice
2697 versa.  The absence of these prototypes when compiling with traditional
2698 C would cause serious problems.  This is a subset of the possible
2699 conversion warnings, for the full set use @option{-Wconversion}.
2700
2701 @item
2702 Use of ISO C style function definitions.  This warning intentionally is
2703 @emph{not} issued for prototype declarations or variadic functions
2704 because these ISO C features will appear in your code when using
2705 libiberty's traditional C compatibility macros, @code{PARAMS} and
2706 @code{VPARAMS}.  This warning is also bypassed for nested functions
2707 because that feature is already a GCC extension and thus not relevant to
2708 traditional C compatibility.
2709 @end itemize
2710
2711 @item -Wdeclaration-after-statement @r{(C only)}
2712 @opindex Wdeclaration-after-statement
2713 Warn when a declaration is found after a statement in a block.  This
2714 construct, known from C++, was introduced with ISO C99 and is by default
2715 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2716 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2717
2718 @item -Wundef
2719 @opindex Wundef
2720 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2721
2722 @item -Wendif-labels
2723 @opindex Wendif-labels
2724 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2725
2726 @item -Wshadow
2727 @opindex Wshadow
2728 Warn whenever a local variable shadows another local variable, parameter or
2729 global variable or whenever a built-in function is shadowed.
2730
2731 @item -Wlarger-than-@var{len}
2732 @opindex Wlarger-than
2733 Warn whenever an object of larger than @var{len} bytes is defined.
2734
2735 @item -Wpointer-arith
2736 @opindex Wpointer-arith
2737 Warn about anything that depends on the ``size of'' a function type or
2738 of @code{void}.  GNU C assigns these types a size of 1, for
2739 convenience in calculations with @code{void *} pointers and pointers
2740 to functions.
2741
2742 @item -Wbad-function-cast @r{(C only)}
2743 @opindex Wbad-function-cast
2744 Warn whenever a function call is cast to a non-matching type.
2745 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2746
2747 @item -Wcast-qual
2748 @opindex Wcast-qual
2749 Warn whenever a pointer is cast so as to remove a type qualifier from
2750 the target type.  For example, warn if a @code{const char *} is cast
2751 to an ordinary @code{char *}.
2752
2753 @item -Wcast-align
2754 @opindex Wcast-align
2755 Warn whenever a pointer is cast such that the required alignment of the
2756 target is increased.  For example, warn if a @code{char *} is cast to
2757 an @code{int *} on machines where integers can only be accessed at
2758 two- or four-byte boundaries.
2759
2760 @item -Wwrite-strings
2761 @opindex Wwrite-strings
2762 When compiling C, give string constants the type @code{const
2763 char[@var{length}]} so that
2764 copying the address of one into a non-@code{const} @code{char *}
2765 pointer will get a warning; when compiling C++, warn about the
2766 deprecated conversion from string constants to @code{char *}.
2767 These warnings will help you find at
2768 compile time code that can try to write into a string constant, but
2769 only if you have been very careful about using @code{const} in
2770 declarations and prototypes.  Otherwise, it will just be a nuisance;
2771 this is why we did not make @option{-Wall} request these warnings.
2772
2773 @item -Wconversion
2774 @opindex Wconversion
2775 Warn if a prototype causes a type conversion that is different from what
2776 would happen to the same argument in the absence of a prototype.  This
2777 includes conversions of fixed point to floating and vice versa, and
2778 conversions changing the width or signedness of a fixed point argument
2779 except when the same as the default promotion.
2780
2781 Also, warn if a negative integer constant expression is implicitly
2782 converted to an unsigned type.  For example, warn about the assignment
2783 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2784 casts like @code{(unsigned) -1}.
2785
2786 @item -Wsign-compare
2787 @opindex Wsign-compare
2788 @cindex warning for comparison of signed and unsigned values
2789 @cindex comparison of signed and unsigned values, warning
2790 @cindex signed and unsigned values, comparison warning
2791 Warn when a comparison between signed and unsigned values could produce
2792 an incorrect result when the signed value is converted to unsigned.
2793 This warning is also enabled by @option{-Wextra}; to get the other warnings
2794 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2795
2796 @item -Waggregate-return
2797 @opindex Waggregate-return
2798 Warn if any functions that return structures or unions are defined or
2799 called.  (In languages where you can return an array, this also elicits
2800 a warning.)
2801
2802 @item -Wstrict-prototypes @r{(C only)}
2803 @opindex Wstrict-prototypes
2804 Warn if a function is declared or defined without specifying the
2805 argument types.  (An old-style function definition is permitted without
2806 a warning if preceded by a declaration which specifies the argument
2807 types.)
2808
2809 @item -Wold-style-definition @r{(C only)}
2810 @opindex Wold-style-definition
2811 Warn if an old-style function definition is used.  A warning is given
2812 even if there is a previous prototype.
2813
2814 @item -Wmissing-prototypes @r{(C only)}
2815 @opindex Wmissing-prototypes
2816 Warn if a global function is defined without a previous prototype
2817 declaration.  This warning is issued even if the definition itself
2818 provides a prototype.  The aim is to detect global functions that fail
2819 to be declared in header files.
2820
2821 @item -Wmissing-declarations @r{(C only)}
2822 @opindex Wmissing-declarations
2823 Warn if a global function is defined without a previous declaration.
2824 Do so even if the definition itself provides a prototype.
2825 Use this option to detect global functions that are not declared in
2826 header files.
2827
2828 @item -Wmissing-noreturn
2829 @opindex Wmissing-noreturn
2830 Warn about functions which might be candidates for attribute @code{noreturn}.
2831 Note these are only possible candidates, not absolute ones.  Care should
2832 be taken to manually verify functions actually do not ever return before
2833 adding the @code{noreturn} attribute, otherwise subtle code generation
2834 bugs could be introduced.  You will not get a warning for @code{main} in
2835 hosted C environments.
2836
2837 @item -Wmissing-format-attribute
2838 @opindex Wmissing-format-attribute
2839 @opindex Wformat
2840 If @option{-Wformat} is enabled, also warn about functions which might be
2841 candidates for @code{format} attributes.  Note these are only possible
2842 candidates, not absolute ones.  GCC will guess that @code{format}
2843 attributes might be appropriate for any function that calls a function
2844 like @code{vprintf} or @code{vscanf}, but this might not always be the
2845 case, and some functions for which @code{format} attributes are
2846 appropriate may not be detected.  This option has no effect unless
2847 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2848
2849 @item -Wno-multichar
2850 @opindex Wno-multichar
2851 @opindex Wmultichar
2852 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2853 Usually they indicate a typo in the user's code, as they have
2854 implementation-defined values, and should not be used in portable code.
2855
2856 @item -Wno-deprecated-declarations
2857 @opindex Wno-deprecated-declarations
2858 Do not warn about uses of functions, variables, and types marked as
2859 deprecated by using the @code{deprecated} attribute.
2860 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2861 @pxref{Type Attributes}.)
2862
2863 @item -Wpacked
2864 @opindex Wpacked
2865 Warn if a structure is given the packed attribute, but the packed
2866 attribute has no effect on the layout or size of the structure.
2867 Such structures may be mis-aligned for little benefit.  For
2868 instance, in this code, the variable @code{f.x} in @code{struct bar}
2869 will be misaligned even though @code{struct bar} does not itself
2870 have the packed attribute:
2871
2872 @smallexample
2873 @group
2874 struct foo @{
2875   int x;
2876   char a, b, c, d;
2877 @} __attribute__((packed));
2878 struct bar @{
2879   char z;
2880   struct foo f;
2881 @};
2882 @end group
2883 @end smallexample
2884
2885 @item -Wpadded
2886 @opindex Wpadded
2887 Warn if padding is included in a structure, either to align an element
2888 of the structure or to align the whole structure.  Sometimes when this
2889 happens it is possible to rearrange the fields of the structure to
2890 reduce the padding and so make the structure smaller.
2891
2892 @item -Wredundant-decls
2893 @opindex Wredundant-decls
2894 Warn if anything is declared more than once in the same scope, even in
2895 cases where multiple declaration is valid and changes nothing.
2896
2897 @item -Wnested-externs @r{(C only)}
2898 @opindex Wnested-externs
2899 Warn if an @code{extern} declaration is encountered within a function.
2900
2901 @item -Wunreachable-code
2902 @opindex Wunreachable-code
2903 Warn if the compiler detects that code will never be executed.
2904
2905 This option is intended to warn when the compiler detects that at
2906 least a whole line of source code will never be executed, because
2907 some condition is never satisfied or because it is after a
2908 procedure that never returns.
2909
2910 It is possible for this option to produce a warning even though there
2911 are circumstances under which part of the affected line can be executed,
2912 so care should be taken when removing apparently-unreachable code.
2913
2914 For instance, when a function is inlined, a warning may mean that the
2915 line is unreachable in only one inlined copy of the function.
2916
2917 This option is not made part of @option{-Wall} because in a debugging
2918 version of a program there is often substantial code which checks
2919 correct functioning of the program and is, hopefully, unreachable
2920 because the program does work.  Another common use of unreachable
2921 code is to provide behavior which is selectable at compile-time.
2922
2923 @item -Winline
2924 @opindex Winline
2925 Warn if a function can not be inlined and it was declared as inline.
2926 Even with this option, the compiler will not warn about failures to
2927 inline functions declared in system headers.
2928
2929 The compiler uses a variety of heuristics to determine whether or not
2930 to inline a function.  For example, the compiler takes into account
2931 the size of the function being inlined and the the amount of inlining
2932 that has already been done in the current function.  Therefore,
2933 seemingly insignificant changes in the source program can cause the
2934 warnings produced by @option{-Winline} to appear or disappear.
2935
2936 @item -Wno-invalid-offsetof @r{(C++ only)}
2937 @opindex Wno-invalid-offsetof
2938 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2939 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2940 to a non-POD type is undefined.  In existing C++ implementations,
2941 however, @samp{offsetof} typically gives meaningful results even when
2942 applied to certain kinds of non-POD types. (Such as a simple
2943 @samp{struct} that fails to be a POD type only by virtue of having a
2944 constructor.)  This flag is for users who are aware that they are
2945 writing nonportable code and who have deliberately chosen to ignore the
2946 warning about it.
2947
2948 The restrictions on @samp{offsetof} may be relaxed in a future version
2949 of the C++ standard.
2950
2951 @item -Winvalid-pch
2952 @opindex Winvalid-pch
2953 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2954 the search path but can't be used.
2955
2956 @item -Wlong-long
2957 @opindex Wlong-long
2958 @opindex Wno-long-long
2959 Warn if @samp{long long} type is used.  This is default.  To inhibit
2960 the warning messages, use @option{-Wno-long-long}.  Flags
2961 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2962 only when @option{-pedantic} flag is used.
2963
2964 @item -Wvariadic-macros
2965 @opindex Wvariadic-macros
2966 @opindex Wno-variadic-macros
2967 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
2968 alternate syntax when in pedantic ISO C99 mode.  This is default.
2969 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
2970
2971 @item -Wdisabled-optimization
2972 @opindex Wdisabled-optimization
2973 Warn if a requested optimization pass is disabled.  This warning does
2974 not generally indicate that there is anything wrong with your code; it
2975 merely indicates that GCC's optimizers were unable to handle the code
2976 effectively.  Often, the problem is that your code is too big or too
2977 complex; GCC will refuse to optimize programs when the optimization
2978 itself is likely to take inordinate amounts of time.
2979
2980 @item -Werror
2981 @opindex Werror
2982 Make all warnings into errors.
2983 @end table
2984
2985 @node Debugging Options
2986 @section Options for Debugging Your Program or GCC
2987 @cindex options, debugging
2988 @cindex debugging information options
2989
2990 GCC has various special options that are used for debugging
2991 either your program or GCC:
2992
2993 @table @gcctabopt
2994 @item -g
2995 @opindex g
2996 Produce debugging information in the operating system's native format
2997 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2998 information.
2999
3000 On most systems that use stabs format, @option{-g} enables use of extra
3001 debugging information that only GDB can use; this extra information
3002 makes debugging work better in GDB but will probably make other debuggers
3003 crash or
3004 refuse to read the program.  If you want to control for certain whether
3005 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3006 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3007
3008 Unlike most other C compilers, GCC allows you to use @option{-g} with
3009 @option{-O}.  The shortcuts taken by optimized code may occasionally
3010 produce surprising results: some variables you declared may not exist
3011 at all; flow of control may briefly move where you did not expect it;
3012 some statements may not be executed because they compute constant
3013 results or their values were already at hand; some statements may
3014 execute in different places because they were moved out of loops.
3015
3016 Nevertheless it proves possible to debug optimized output.  This makes
3017 it reasonable to use the optimizer for programs that might have bugs.
3018
3019 The following options are useful when GCC is generated with the
3020 capability for more than one debugging format.
3021
3022 @item -ggdb
3023 @opindex ggdb
3024 Produce debugging information for use by GDB@.  This means to use the
3025 most expressive format available (DWARF 2, stabs, or the native format
3026 if neither of those are supported), including GDB extensions if at all
3027 possible.
3028
3029 @item -gstabs
3030 @opindex gstabs
3031 Produce debugging information in stabs format (if that is supported),
3032 without GDB extensions.  This is the format used by DBX on most BSD
3033 systems.  On MIPS, Alpha and System V Release 4 systems this option
3034 produces stabs debugging output which is not understood by DBX or SDB@.
3035 On System V Release 4 systems this option requires the GNU assembler.
3036
3037 @item -feliminate-unused-debug-symbols
3038 @opindex feliminate-unused-debug-symbols
3039 Produce debugging information in stabs format (if that is supported),
3040 for only symbols that are actually used.
3041
3042 @item -gstabs+
3043 @opindex gstabs+
3044 Produce debugging information in stabs format (if that is supported),
3045 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3046 use of these extensions is likely to make other debuggers crash or
3047 refuse to read the program.
3048
3049 @item -gcoff
3050 @opindex gcoff
3051 Produce debugging information in COFF format (if that is supported).
3052 This is the format used by SDB on most System V systems prior to
3053 System V Release 4.
3054
3055 @item -gxcoff
3056 @opindex gxcoff
3057 Produce debugging information in XCOFF format (if that is supported).
3058 This is the format used by the DBX debugger on IBM RS/6000 systems.
3059
3060 @item -gxcoff+
3061 @opindex gxcoff+
3062 Produce debugging information in XCOFF format (if that is supported),
3063 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3064 use of these extensions is likely to make other debuggers crash or
3065 refuse to read the program, and may cause assemblers other than the GNU
3066 assembler (GAS) to fail with an error.
3067
3068 @item -gdwarf-2
3069 @opindex gdwarf-2
3070 Produce debugging information in DWARF version 2 format (if that is
3071 supported).  This is the format used by DBX on IRIX 6.
3072
3073 @item -gvms
3074 @opindex gvms
3075 Produce debugging information in VMS debug format (if that is
3076 supported).  This is the format used by DEBUG on VMS systems.
3077
3078 @item -g@var{level}
3079 @itemx -ggdb@var{level}
3080 @itemx -gstabs@var{level}
3081 @itemx -gcoff@var{level}
3082 @itemx -gxcoff@var{level}
3083 @itemx -gvms@var{level}
3084 Request debugging information and also use @var{level} to specify how
3085 much information.  The default level is 2.
3086
3087 Level 1 produces minimal information, enough for making backtraces in
3088 parts of the program that you don't plan to debug.  This includes
3089 descriptions of functions and external variables, but no information
3090 about local variables and no line numbers.
3091
3092 Level 3 includes extra information, such as all the macro definitions
3093 present in the program.  Some debuggers support macro expansion when
3094 you use @option{-g3}.
3095
3096 Note that in order to avoid confusion between DWARF1 debug level 2,
3097 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3098 level.  Instead use an additional @option{-g@var{level}} option to
3099 change the debug level for DWARF2.
3100
3101 @item -feliminate-dwarf2-dups
3102 @opindex feliminate-dwarf2-dups
3103 Compress DWARF2 debugging information by eliminating duplicated
3104 information about each symbol.  This option only makes sense when
3105 generating DWARF2 debugging information with @option{-gdwarf-2}.
3106
3107 @cindex @command{prof}
3108 @item -p
3109 @opindex p
3110 Generate extra code to write profile information suitable for the
3111 analysis program @command{prof}.  You must use this option when compiling
3112 the source files you want data about, and you must also use it when
3113 linking.
3114
3115 @cindex @command{gprof}
3116 @item -pg
3117 @opindex pg
3118 Generate extra code to write profile information suitable for the
3119 analysis program @command{gprof}.  You must use this option when compiling
3120 the source files you want data about, and you must also use it when
3121 linking.
3122
3123 @item -Q
3124 @opindex Q
3125 Makes the compiler print out each function name as it is compiled, and
3126 print some statistics about each pass when it finishes.
3127
3128 @item -ftime-report
3129 @opindex ftime-report
3130 Makes the compiler print some statistics about the time consumed by each
3131 pass when it finishes.
3132
3133 @item -fmem-report
3134 @opindex fmem-report
3135 Makes the compiler print some statistics about permanent memory
3136 allocation when it finishes.
3137
3138 @item -fprofile-arcs
3139 @opindex fprofile-arcs
3140 Add code so that program flow @dfn{arcs} are instrumented.  During
3141 execution the program records how many times each branch and call is
3142 executed and how many times it is taken or returns.  When the compiled
3143 program exits it saves this data to a file called
3144 @file{@var{auxname}.gcda} for each source file. The data may be used for
3145 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3146 test coverage analysis (@option{-ftest-coverage}). Each object file's
3147 @var{auxname} is generated from the name of the output file, if
3148 explicitly specified and it is not the final executable, otherwise it is
3149 the basename of the source file. In both cases any suffix is removed
3150 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3151 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3152
3153 @itemize
3154
3155 @item
3156 Compile the source files with @option{-fprofile-arcs} plus optimization
3157 and code generation options. For test coverage analysis, use the
3158 additional @option{-ftest-coverage} option. You do not need to profile
3159 every source file in a program.
3160
3161 @item
3162 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3163 (the latter implies the former).
3164
3165 @item
3166 Run the program on a representative workload to generate the arc profile
3167 information. This may be repeated any number of times. You can run
3168 concurrent instances of your program, and provided that the file system
3169 supports locking, the data files will be correctly updated. Also
3170 @code{fork} calls are detected and correctly handled (double counting
3171 will not happen).
3172
3173 @item
3174 For profile-directed optimizations, compile the source files again with
3175 the same optimization and code generation options plus
3176 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3177 Control Optimization}).
3178
3179 @item
3180 For test coverage analysis, use @command{gcov} to produce human readable
3181 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3182 @command{gcov} documentation for further information.
3183
3184 @end itemize
3185
3186 With @option{-fprofile-arcs}, for each function of your program GCC
3187 creates a program flow graph, then finds a spanning tree for the graph.
3188 Only arcs that are not on the spanning tree have to be instrumented: the
3189 compiler adds code to count the number of times that these arcs are
3190 executed.  When an arc is the only exit or only entrance to a block, the
3191 instrumentation code can be added to the block; otherwise, a new basic
3192 block must be created to hold the instrumentation code.
3193
3194 @need 2000
3195 @item -ftest-coverage
3196 @opindex ftest-coverage
3197 Produce a notes file that the @command{gcov} code-coverage utility
3198 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3199 show program coverage. Each source file's note file is called
3200 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3201 above for a description of @var{auxname} and instructions on how to
3202 generate test coverage data. Coverage data will match the source files
3203 more closely, if you do not optimize.
3204
3205 @item -d@var{letters}
3206 @opindex d
3207 Says to make debugging dumps during compilation at times specified by
3208 @var{letters}.  This is used for debugging the compiler.  The file names
3209 for most of the dumps are made by appending a pass number and a word to
3210 the @var{dumpname}. @var{dumpname} is generated from the name of the
3211 output file, if explicitly specified and it is not an executable,
3212 otherwise it is the basename of the source file. In both cases any
3213 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3214 Here are the possible letters for use in @var{letters}, and their
3215 meanings:
3216
3217 @table @samp
3218 @item A
3219 @opindex dA
3220 Annotate the assembler output with miscellaneous debugging information.
3221 @item b
3222 @opindex db
3223 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3224 @item B
3225 @opindex dB
3226 Dump after block reordering, to @file{@var{file}.31.bbro}.
3227 @item c
3228 @opindex dc
3229 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3230 @item C
3231 @opindex dC
3232 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3233 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3234 @item d
3235 @opindex dd
3236 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3237 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3238 @item D
3239 @opindex dD
3240 Dump all macro definitions, at the end of preprocessing, in addition to
3241 normal output.
3242 @item E
3243 @opindex dE
3244 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3245 @item f
3246 @opindex df
3247 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3248 Also dump after life analysis, to @file{@var{file}.19.life}.
3249 @item F
3250 @opindex dF
3251 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3252 @item g
3253 @opindex dg
3254 Dump after global register allocation, to @file{@var{file}.25.greg}.
3255 @item G
3256 @opindex dG
3257 Dump after GCSE, to @file{@var{file}.08.gcse}.
3258 Also dump after jump bypassing and control flow optimizations, to
3259 @file{@var{file}.10.bypass}.
3260 @item h
3261 @opindex dh
3262 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3263 @item i
3264 @opindex di
3265 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3266 @item j
3267 @opindex dj
3268 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3269 @item k
3270 @opindex dk
3271 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3272 @item l
3273 @opindex dl
3274 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3275 @item L
3276 @opindex dL
3277 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3278 @file{@var{file}.16.loop2}.
3279 @item M
3280 @opindex dM
3281 Dump after performing the machine dependent reorganization pass, to
3282 @file{@var{file}.35.mach}.
3283 @item n
3284 @opindex dn
3285 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3286 @item N
3287 @opindex dN
3288 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3289 @item o
3290 @opindex do
3291 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3292 @item r
3293 @opindex dr
3294 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3295 @item R
3296 @opindex dR
3297 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3298 @item s
3299 @opindex ds
3300 Dump after CSE (including the jump optimization that sometimes follows
3301 CSE), to @file{@var{file}.06.cse}.
3302 @item S
3303 @opindex dS
3304 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3305 @item t
3306 @opindex dt
3307 Dump after the second CSE pass (including the jump optimization that
3308 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3309 @item T
3310 @opindex dT
3311 Dump after running tracer, to @file{@var{file}.15.tracer}.
3312 @item u
3313 @opindex du
3314 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3315 @item U
3316 @opindex dU
3317 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3318 @item V
3319 @opindex dV
3320 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3321 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3322 @item w
3323 @opindex dw
3324 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3325 @item z
3326 @opindex dz
3327 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3328 @item Z
3329 @opindex dZ
3330 Dump after constructing the web, to @file{@var{file}.17.web}.
3331 @item a
3332 @opindex da
3333 Produce all the dumps listed above.
3334 @item H
3335 @opindex dH
3336 Produce a core dump whenever an error occurs.
3337 @item m
3338 @opindex dm
3339 Print statistics on memory usage, at the end of the run, to
3340 standard error.
3341 @item p
3342 @opindex dp
3343 Annotate the assembler output with a comment indicating which
3344 pattern and alternative was used.  The length of each instruction is
3345 also printed.
3346 @item P
3347 @opindex dP
3348 Dump the RTL in the assembler output as a comment before each instruction.
3349 Also turns on @option{-dp} annotation.
3350 @item v
3351 @opindex dv
3352 For each of the other indicated dump files (except for
3353 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3354 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3355 @item x
3356 @opindex dx
3357 Just generate RTL for a function instead of compiling it.  Usually used
3358 with @samp{r}.
3359 @item y
3360 @opindex dy
3361 Dump debugging information during parsing, to standard error.
3362 @end table
3363
3364 @item -fdump-unnumbered
3365 @opindex fdump-unnumbered
3366 When doing debugging dumps (see @option{-d} option above), suppress instruction
3367 numbers and line number note output.  This makes it more feasible to
3368 use diff on debugging dumps for compiler invocations with different
3369 options, in particular with and without @option{-g}.
3370
3371 @item -fdump-translation-unit @r{(C and C++ only)}
3372 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3373 @opindex fdump-translation-unit
3374 Dump a representation of the tree structure for the entire translation
3375 unit to a file.  The file name is made by appending @file{.tu} to the
3376 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3377 controls the details of the dump as described for the
3378 @option{-fdump-tree} options.
3379
3380 @item -fdump-class-hierarchy @r{(C++ only)}
3381 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3382 @opindex fdump-class-hierarchy
3383 Dump a representation of each class's hierarchy and virtual function
3384 table layout to a file.  The file name is made by appending @file{.class}
3385 to the source file name.  If the @samp{-@var{options}} form is used,
3386 @var{options} controls the details of the dump as described for the
3387 @option{-fdump-tree} options.
3388
3389 @item -fdump-tree-@var{switch} @r{(C++ only)}
3390 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3391 @opindex fdump-tree
3392 Control the dumping at various stages of processing the intermediate
3393 language tree to a file.  The file name is generated by appending a switch
3394 specific suffix to the source file name.  If the @samp{-@var{options}}
3395 form is used, @var{options} is a list of @samp{-} separated options that
3396 control the details of the dump. Not all options are applicable to all
3397 dumps, those which are not meaningful will be ignored. The following
3398 options are available
3399
3400 @table @samp
3401 @item address
3402 Print the address of each node.  Usually this is not meaningful as it
3403 changes according to the environment and source file. Its primary use
3404 is for tying up a dump file with a debug environment.
3405 @item slim
3406 Inhibit dumping of members of a scope or body of a function merely
3407 because that scope has been reached. Only dump such items when they
3408 are directly reachable by some other path.
3409 @item all
3410 Turn on all options.
3411 @end table
3412
3413 The following tree dumps are possible:
3414 @table @samp
3415 @item original
3416 Dump before any tree based optimization, to @file{@var{file}.original}.
3417 @item optimized
3418 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3419 @item inlined
3420 Dump after function inlining, to @file{@var{file}.inlined}.
3421 @end table
3422
3423 @item -frandom-seed=@var{string}
3424 @opindex frandom-string
3425 This option provides a seed that GCC uses when it would otherwise use
3426 random numbers.  It is used to generate certain symbol names
3427 that have to be different in every compiled file. It is also used to
3428 place unique stamps in coverage data files and the object files that
3429 produce them. You can use the @option{-frandom-seed} option to produce
3430 reproducibly identical object files.
3431
3432 The @var{string} should be different for every file you compile.
3433
3434 @item -fsched-verbose=@var{n}
3435 @opindex fsched-verbose
3436 On targets that use instruction scheduling, this option controls the
3437 amount of debugging output the scheduler prints.  This information is
3438 written to standard error, unless @option{-dS} or @option{-dR} is
3439 specified, in which case it is output to the usual dump
3440 listing file, @file{.sched} or @file{.sched2} respectively.  However
3441 for @var{n} greater than nine, the output is always printed to standard
3442 error.
3443
3444 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3445 same information as @option{-dRS}.  For @var{n} greater than one, it
3446 also output basic block probabilities, detailed ready list information
3447 and unit/insn info.  For @var{n} greater than two, it includes RTL
3448 at abort point, control-flow and regions info.  And for @var{n} over
3449 four, @option{-fsched-verbose} also includes dependence info.
3450
3451 @item -save-temps
3452 @opindex save-temps
3453 Store the usual ``temporary'' intermediate files permanently; place them
3454 in the current directory and name them based on the source file.  Thus,
3455 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3456 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3457 preprocessed @file{foo.i} output file even though the compiler now
3458 normally uses an integrated preprocessor.
3459
3460 @item -time
3461 @opindex time
3462 Report the CPU time taken by each subprocess in the compilation
3463 sequence.  For C source files, this is the compiler proper and assembler
3464 (plus the linker if linking is done).  The output looks like this:
3465
3466 @smallexample
3467 # cc1 0.12 0.01
3468 # as 0.00 0.01
3469 @end smallexample
3470
3471 The first number on each line is the ``user time,'' that is time spent
3472 executing the program itself.  The second number is ``system time,''
3473 time spent executing operating system routines on behalf of the program.
3474 Both numbers are in seconds.
3475
3476 @item -fvar-tracking
3477 @opindex fvar-tracking
3478 Run variable tracking pass. It computes where variables are stored at each
3479 position in code. Better debugging information is then generated
3480 (if the debugging information format supports this information).
3481
3482 It is enabled by default when compiling with optimization (@option{-Os},
3483 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3484 the debug info format supports it.
3485
3486 @item -print-file-name=@var{library}
3487 @opindex print-file-name
3488 Print the full absolute name of the library file @var{library} that
3489 would be used when linking---and don't do anything else.  With this
3490 option, GCC does not compile or link anything; it just prints the
3491 file name.
3492
3493 @item -print-multi-directory
3494 @opindex print-multi-directory
3495 Print the directory name corresponding to the multilib selected by any
3496 other switches present in the command line.  This directory is supposed
3497 to exist in @env{GCC_EXEC_PREFIX}.
3498
3499 @item -print-multi-lib
3500 @opindex print-multi-lib
3501 Print the mapping from multilib directory names to compiler switches
3502 that enable them.  The directory name is separated from the switches by
3503 @samp{;}, and each switch starts with an @samp{@@} instead of the
3504 @samp{-}, without spaces between multiple switches.  This is supposed to
3505 ease shell-processing.
3506
3507 @item -print-prog-name=@var{program}
3508 @opindex print-prog-name
3509 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3510
3511 @item -print-libgcc-file-name
3512 @opindex print-libgcc-file-name
3513 Same as @option{-print-file-name=libgcc.a}.
3514
3515 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3516 but you do want to link with @file{libgcc.a}.  You can do
3517
3518 @smallexample
3519 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3520 @end smallexample
3521
3522 @item -print-search-dirs
3523 @opindex print-search-dirs
3524 Print the name of the configured installation directory and a list of
3525 program and library directories @command{gcc} will search---and don't do anything else.
3526
3527 This is useful when @command{gcc} prints the error message
3528 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3529 To resolve this you either need to put @file{cpp0} and the other compiler
3530 components where @command{gcc} expects to find them, or you can set the environment
3531 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3532 Don't forget the trailing '/'.
3533 @xref{Environment Variables}.
3534
3535 @item -dumpmachine
3536 @opindex dumpmachine
3537 Print the compiler's target machine (for example,
3538 @samp{i686-pc-linux-gnu})---and don't do anything else.
3539
3540 @item -dumpversion
3541 @opindex dumpversion
3542 Print the compiler version (for example, @samp{3.0})---and don't do
3543 anything else.
3544
3545 @item -dumpspecs
3546 @opindex dumpspecs
3547 Print the compiler's built-in specs---and don't do anything else.  (This
3548 is used when GCC itself is being built.)  @xref{Spec Files}.
3549
3550 @item -feliminate-unused-debug-types
3551 @opindex feliminate-unused-debug-types
3552 Normally, when producing DWARF2 output, GCC will emit debugging
3553 information for all types declared in a compilation
3554 unit, regardless of whether or not they are actually used
3555 in that compilation unit.  Sometimes this is useful, such as
3556 if, in the debugger, you want to cast a value to a type that is
3557 not actually used in your program (but is declared).  More often,
3558 however, this results in a significant amount of wasted space.
3559 With this option, GCC will avoid producing debug symbol output
3560 for types that are nowhere used in the source file being compiled.
3561 @end table
3562
3563 @node Optimize Options
3564 @section Options That Control Optimization
3565 @cindex optimize options
3566 @cindex options, optimization
3567
3568 These options control various sorts of optimizations.
3569
3570 Without any optimization option, the compiler's goal is to reduce the
3571 cost of compilation and to make debugging produce the expected
3572 results.  Statements are independent: if you stop the program with a
3573 breakpoint between statements, you can then assign a new value to any
3574 variable or change the program counter to any other statement in the
3575 function and get exactly the results you would expect from the source
3576 code.
3577
3578 Turning on optimization flags makes the compiler attempt to improve
3579 the performance and/or code size at the expense of compilation time
3580 and possibly the ability to debug the program.
3581
3582 The compiler performs optimization based on the knowledge it has of
3583 the program.  Using the @option{-funit-at-a-time} flag will allow the
3584 compiler to consider information gained from later functions in the
3585 file when compiling a function.  Compiling multiple files at once to a
3586 single output file (and using @option{-funit-at-a-time}) will allow
3587 the compiler to use information gained from all of the files when
3588 compiling each of them.
3589
3590 Not all optimizations are controlled directly by a flag.  Only
3591 optimizations that have a flag are listed.
3592
3593 @table @gcctabopt
3594 @item -O
3595 @itemx -O1
3596 @opindex O
3597 @opindex O1
3598 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3599 more memory for a large function.
3600
3601 With @option{-O}, the compiler tries to reduce code size and execution
3602 time, without performing any optimizations that take a great deal of
3603 compilation time.
3604
3605 @option{-O} turns on the following optimization flags:
3606 @gccoptlist{-fdefer-pop @gol
3607 -fmerge-constants @gol
3608 -fthread-jumps @gol
3609 -floop-optimize @gol
3610 -fif-conversion @gol
3611 -fif-conversion2 @gol
3612 -fdelayed-branch @gol
3613 -fguess-branch-probability @gol
3614 -fcprop-registers}
3615
3616 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3617 where doing so does not interfere with debugging.
3618
3619 @item -O2
3620 @opindex O2
3621 Optimize even more.  GCC performs nearly all supported optimizations
3622 that do not involve a space-speed tradeoff.  The compiler does not
3623 perform loop unrolling or function inlining when you specify @option{-O2}.
3624 As compared to @option{-O}, this option increases both compilation time
3625 and the performance of the generated code.
3626
3627 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3628 also turns on the following optimization flags:
3629 @gccoptlist{-fforce-mem @gol
3630 -foptimize-sibling-calls @gol
3631 -fstrength-reduce @gol
3632 -fcse-follow-jumps  -fcse-skip-blocks @gol
3633 -frerun-cse-after-loop  -frerun-loop-opt @gol
3634 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3635 -fdelete-null-pointer-checks @gol
3636 -fexpensive-optimizations @gol
3637 -fregmove @gol
3638 -fschedule-insns  -fschedule-insns2 @gol
3639 -fsched-interblock  -fsched-spec @gol
3640 -fcaller-saves @gol
3641 -fpeephole2 @gol
3642 -freorder-blocks  -freorder-functions @gol
3643 -fstrict-aliasing @gol
3644 -funit-at-a-time @gol
3645 -falign-functions  -falign-jumps @gol
3646 -falign-loops  -falign-labels @gol
3647 -fcrossjumping}
3648
3649 Please note the warning under @option{-fgcse} about
3650 invoking @option{-O2} on programs that use computed gotos.
3651
3652 @item -O3
3653 @opindex O3
3654 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3655 @option{-O2} and also turns on the @option{-finline-functions},
3656 @option{-fweb} and @option{-frename-registers} options.
3657
3658 @item -O0
3659 @opindex O0
3660 Do not optimize.  This is the default.
3661
3662 @item -Os
3663 @opindex Os
3664 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3665 do not typically increase code size.  It also performs further
3666 optimizations designed to reduce code size.
3667
3668 @option{-Os} disables the following optimization flags:
3669 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3670 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3671
3672 If you use multiple @option{-O} options, with or without level numbers,
3673 the last such option is the one that is effective.
3674 @end table
3675
3676 Options of the form @option{-f@var{flag}} specify machine-independent
3677 flags.  Most flags have both positive and negative forms; the negative
3678 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3679 below, only one of the forms is listed---the one you typically will
3680 use.  You can figure out the other form by either removing @samp{no-}
3681 or adding it.
3682
3683 The following options control specific optimizations.  They are either
3684 activated by @option{-O} options or are related to ones that are.  You
3685 can use the following flags in the rare cases when ``fine-tuning'' of
3686 optimizations to be performed is desired.
3687
3688 @table @gcctabopt
3689 @item -fno-default-inline
3690 @opindex fno-default-inline
3691 Do not make member functions inline by default merely because they are
3692 defined inside the class scope (C++ only).  Otherwise, when you specify
3693 @w{@option{-O}}, member functions defined inside class scope are compiled
3694 inline by default; i.e., you don't need to add @samp{inline} in front of
3695 the member function name.
3696
3697 @item -fno-defer-pop
3698 @opindex fno-defer-pop
3699 Always pop the arguments to each function call as soon as that function
3700 returns.  For machines which must pop arguments after a function call,
3701 the compiler normally lets arguments accumulate on the stack for several
3702 function calls and pops them all at once.
3703
3704 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3705
3706 @item -fforce-mem
3707 @opindex fforce-mem
3708 Force memory operands to be copied into registers before doing
3709 arithmetic on them.  This produces better code by making all memory
3710 references potential common subexpressions.  When they are not common
3711 subexpressions, instruction combination should eliminate the separate
3712 register-load.
3713
3714 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3715
3716 @item -fforce-addr
3717 @opindex fforce-addr
3718 Force memory address constants to be copied into registers before
3719 doing arithmetic on them.  This may produce better code just as
3720 @option{-fforce-mem} may.
3721
3722 @item -fomit-frame-pointer
3723 @opindex fomit-frame-pointer
3724 Don't keep the frame pointer in a register for functions that
3725 don't need one.  This avoids the instructions to save, set up and
3726 restore frame pointers; it also makes an extra register available
3727 in many functions.  @strong{It also makes debugging impossible on
3728 some machines.}
3729
3730 On some machines, such as the VAX, this flag has no effect, because
3731 the standard calling sequence automatically handles the frame pointer
3732 and nothing is saved by pretending it doesn't exist.  The
3733 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3734 whether a target machine supports this flag.  @xref{Registers,,Register
3735 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3736
3737 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3738
3739 @item -foptimize-sibling-calls
3740 @opindex foptimize-sibling-calls
3741 Optimize sibling and tail recursive calls.
3742
3743 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3744
3745 @item -fno-inline
3746 @opindex fno-inline
3747 Don't pay attention to the @code{inline} keyword.  Normally this option
3748 is used to keep the compiler from expanding any functions inline.
3749 Note that if you are not optimizing, no functions can be expanded inline.
3750
3751 @item -finline-functions
3752 @opindex finline-functions
3753 Integrate all simple functions into their callers.  The compiler
3754 heuristically decides which functions are simple enough to be worth
3755 integrating in this way.
3756
3757 If all calls to a given function are integrated, and the function is
3758 declared @code{static}, then the function is normally not output as
3759 assembler code in its own right.
3760
3761 Enabled at level @option{-O3}.
3762
3763 @item -finline-limit=@var{n}
3764 @opindex finline-limit
3765 By default, GCC limits the size of functions that can be inlined.  This flag
3766 allows the control of this limit for functions that are explicitly marked as
3767 inline (i.e., marked with the inline keyword or defined within the class
3768 definition in c++).  @var{n} is the size of functions that can be inlined in
3769 number of pseudo instructions (not counting parameter handling).  The default
3770 value of @var{n} is 600.
3771 Increasing this value can result in more inlined code at
3772 the cost of compilation time and memory consumption.  Decreasing usually makes
3773 the compilation faster and less code will be inlined (which presumably
3774 means slower programs).  This option is particularly useful for programs that
3775 use inlining heavily such as those based on recursive templates with C++.
3776
3777 Inlining is actually controlled by a number of parameters, which may be
3778 specified individually by using @option{--param @var{name}=@var{value}}.
3779 The @option{-finline-limit=@var{n}} option sets some of these parameters
3780 as follows:
3781
3782 @table @gcctabopt
3783  @item max-inline-insns-single
3784   is set to @var{n}/2.
3785  @item max-inline-insns-auto
3786   is set to @var{n}/2.
3787  @item min-inline-insns
3788   is set to 130 or @var{n}/4, whichever is smaller.
3789  @item max-inline-insns-rtl
3790   is set to @var{n}.
3791 @end table
3792
3793 See below for a documentation of the individual
3794 parameters controlling inlining.
3795
3796 @emph{Note:} pseudo instruction represents, in this particular context, an
3797 abstract measurement of function's size.  In no way, it represents a count
3798 of assembly instructions and as such its exact meaning might change from one
3799 release to an another.
3800
3801 @item -fkeep-inline-functions
3802 @opindex fkeep-inline-functions
3803 Even if all calls to a given function are integrated, and the function
3804 is declared @code{static}, nevertheless output a separate run-time
3805 callable version of the function.  This switch does not affect
3806 @code{extern inline} functions.
3807
3808 @item -fkeep-static-consts
3809 @opindex fkeep-static-consts
3810 Emit variables declared @code{static const} when optimization isn't turned
3811 on, even if the variables aren't referenced.
3812
3813 GCC enables this option by default.  If you want to force the compiler to
3814 check if the variable was referenced, regardless of whether or not
3815 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3816
3817 @item -fmerge-constants
3818 Attempt to merge identical constants (string constants and floating point
3819 constants) across compilation units.
3820
3821 This option is the default for optimized compilation if the assembler and
3822 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3823 behavior.
3824
3825 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3826
3827 @item -fmerge-all-constants
3828 Attempt to merge identical constants and identical variables.
3829
3830 This option implies @option{-fmerge-constants}.  In addition to
3831 @option{-fmerge-constants} this considers e.g. even constant initialized
3832 arrays or initialized constant variables with integral or floating point
3833 types.  Languages like C or C++ require each non-automatic variable to
3834 have distinct location, so using this option will result in non-conforming
3835 behavior.
3836
3837 @item -fnew-ra
3838 @opindex fnew-ra
3839 Use a graph coloring register allocator.  Currently this option is meant
3840 only for testing.  Users should not specify this option, since it is not
3841 yet ready for production use.
3842
3843 @item -fno-branch-count-reg
3844 @opindex fno-branch-count-reg
3845 Do not use ``decrement and branch'' instructions on a count register,
3846 but instead generate a sequence of instructions that decrement a
3847 register, compare it against zero, then branch based upon the result.
3848 This option is only meaningful on architectures that support such
3849 instructions, which include x86, PowerPC, IA-64 and S/390.
3850
3851 The default is @option{-fbranch-count-reg}, enabled when
3852 @option{-fstrength-reduce} is enabled.
3853
3854 @item -fno-function-cse
3855 @opindex fno-function-cse
3856 Do not put function addresses in registers; make each instruction that
3857 calls a constant function contain the function's address explicitly.
3858
3859 This option results in less efficient code, but some strange hacks
3860 that alter the assembler output may be confused by the optimizations
3861 performed when this option is not used.
3862
3863 The default is @option{-ffunction-cse}
3864
3865 @item -fno-zero-initialized-in-bss
3866 @opindex fno-zero-initialized-in-bss
3867 If the target supports a BSS section, GCC by default puts variables that
3868 are initialized to zero into BSS@.  This can save space in the resulting
3869 code.
3870
3871 This option turns off this behavior because some programs explicitly
3872 rely on variables going to the data section.  E.g., so that the
3873 resulting executable can find the beginning of that section and/or make
3874 assumptions based on that.
3875
3876 The default is @option{-fzero-initialized-in-bss}.
3877
3878 @item -fstrength-reduce
3879 @opindex fstrength-reduce
3880 Perform the optimizations of loop strength reduction and
3881 elimination of iteration variables.
3882
3883 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3884
3885 @item -fthread-jumps
3886 @opindex fthread-jumps
3887 Perform optimizations where we check to see if a jump branches to a
3888 location where another comparison subsumed by the first is found.  If
3889 so, the first branch is redirected to either the destination of the
3890 second branch or a point immediately following it, depending on whether
3891 the condition is known to be true or false.
3892
3893 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3894
3895 @item -fcse-follow-jumps
3896 @opindex fcse-follow-jumps
3897 In common subexpression elimination, scan through jump instructions
3898 when the target of the jump is not reached by any other path.  For
3899 example, when CSE encounters an @code{if} statement with an
3900 @code{else} clause, CSE will follow the jump when the condition
3901 tested is false.
3902
3903 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3904
3905 @item -fcse-skip-blocks
3906 @opindex fcse-skip-blocks
3907 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3908 follow jumps which conditionally skip over blocks.  When CSE
3909 encounters a simple @code{if} statement with no else clause,
3910 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3911 body of the @code{if}.
3912
3913 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3914
3915 @item -frerun-cse-after-loop
3916 @opindex frerun-cse-after-loop
3917 Re-run common subexpression elimination after loop optimizations has been
3918 performed.
3919
3920 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3921
3922 @item -frerun-loop-opt
3923 @opindex frerun-loop-opt
3924 Run the loop optimizer twice.
3925
3926 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3927
3928 @item -fgcse
3929 @opindex fgcse
3930 Perform a global common subexpression elimination pass.
3931 This pass also performs global constant and copy propagation.
3932
3933 @emph{Note:} When compiling a program using computed gotos, a GCC
3934 extension, you may get better runtime performance if you disable
3935 the global common subexpression elimination pass by adding
3936 @option{-fno-gcse} to the command line.
3937
3938 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3939
3940 @item -fgcse-lm
3941 @opindex fgcse-lm
3942 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3943 attempt to move loads which are only killed by stores into themselves.  This
3944 allows a loop containing a load/store sequence to be changed to a load outside
3945 the loop, and a copy/store within the loop.
3946
3947 Enabled by default when gcse is enabled.
3948
3949 @item -fgcse-sm
3950 @opindex fgcse-sm
3951 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3952 global common subexpression elimination.  This pass will attempt to move
3953 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3954 loops containing a load/store sequence can be changed to a load before
3955 the loop and a store after the loop.
3956
3957 Enabled by default when gcse is enabled.
3958
3959 @item -fgcse-las
3960 @opindex fgcse-las
3961 When @option{-fgcse-las} is enabled, the global common subexpression
3962 elimination pass eliminates redundant loads that come after stores to the
3963 same memory location (both partial and full redundancies).
3964
3965 Enabled by default when gcse is enabled.
3966
3967 @item -floop-optimize
3968 @opindex floop-optimize
3969 Perform loop optimizations: move constant expressions out of loops, simplify
3970 exit test conditions and optionally do strength-reduction and loop unrolling as
3971 well.
3972
3973 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3974
3975 @item -fcrossjumping
3976 @opindex crossjumping
3977 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3978 resulting code may or may not perform better than without cross-jumping.
3979
3980 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3981
3982 @item -fif-conversion
3983 @opindex if-conversion
3984 Attempt to transform conditional jumps into branch-less equivalents.  This
3985 include use of conditional moves, min, max, set flags and abs instructions, and
3986 some tricks doable by standard arithmetics.  The use of conditional execution
3987 on chips where it is available is controlled by @code{if-conversion2}.
3988
3989 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3990
3991 @item -fif-conversion2
3992 @opindex if-conversion2
3993 Use conditional execution (where available) to transform conditional jumps into
3994 branch-less equivalents.
3995
3996 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3997
3998 @item -fdelete-null-pointer-checks
3999 @opindex fdelete-null-pointer-checks
4000 Use global dataflow analysis to identify and eliminate useless checks
4001 for null pointers.  The compiler assumes that dereferencing a null
4002 pointer would have halted the program.  If a pointer is checked after
4003 it has already been dereferenced, it cannot be null.
4004
4005 In some environments, this assumption is not true, and programs can
4006 safely dereference null pointers.  Use
4007 @option{-fno-delete-null-pointer-checks} to disable this optimization
4008 for programs which depend on that behavior.
4009
4010 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4011
4012 @item -fexpensive-optimizations
4013 @opindex fexpensive-optimizations
4014 Perform a number of minor optimizations that are relatively expensive.
4015
4016 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4017
4018 @item -foptimize-register-move
4019 @itemx -fregmove
4020 @opindex foptimize-register-move
4021 @opindex fregmove
4022 Attempt to reassign register numbers in move instructions and as
4023 operands of other simple instructions in order to maximize the amount of
4024 register tying.  This is especially helpful on machines with two-operand
4025 instructions.
4026
4027 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4028 optimization.
4029
4030 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4031
4032 @item -fdelayed-branch
4033 @opindex fdelayed-branch
4034 If supported for the target machine, attempt to reorder instructions
4035 to exploit instruction slots available after delayed branch
4036 instructions.
4037
4038 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4039
4040 @item -fschedule-insns
4041 @opindex fschedule-insns
4042 If supported for the target machine, attempt to reorder instructions to
4043 eliminate execution stalls due to required data being unavailable.  This
4044 helps machines that have slow floating point or memory load instructions
4045 by allowing other instructions to be issued until the result of the load
4046 or floating point instruction is required.
4047
4048 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4049
4050 @item -fschedule-insns2
4051 @opindex fschedule-insns2
4052 Similar to @option{-fschedule-insns}, but requests an additional pass of
4053 instruction scheduling after register allocation has been done.  This is
4054 especially useful on machines with a relatively small number of
4055 registers and where memory load instructions take more than one cycle.
4056
4057 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4058
4059 @item -fno-sched-interblock
4060 @opindex fno-sched-interblock
4061 Don't schedule instructions across basic blocks.  This is normally
4062 enabled by default when scheduling before register allocation, i.e.@:
4063 with @option{-fschedule-insns} or at @option{-O2} or higher.
4064
4065 @item -fno-sched-spec
4066 @opindex fno-sched-spec
4067 Don't allow speculative motion of non-load instructions.  This is normally
4068 enabled by default when scheduling before register allocation, i.e.@:
4069 with @option{-fschedule-insns} or at @option{-O2} or higher.
4070
4071 @item -fsched-spec-load
4072 @opindex fsched-spec-load
4073 Allow speculative motion of some load instructions.  This only makes
4074 sense when scheduling before register allocation, i.e.@: with
4075 @option{-fschedule-insns} or at @option{-O2} or higher.
4076
4077 @item -fsched-spec-load-dangerous
4078 @opindex fsched-spec-load-dangerous
4079 Allow speculative motion of more load instructions.  This only makes
4080 sense when scheduling before register allocation, i.e.@: with
4081 @option{-fschedule-insns} or at @option{-O2} or higher.
4082
4083 @item -fsched-stalled-insns=@var{n}
4084 @opindex fsched-stalled-insns
4085 Define how many insns (if any) can be moved prematurely from the queue
4086 of stalled insns into the ready list, during the second scheduling pass.
4087
4088 @item -fsched-stalled-insns-dep=@var{n}
4089 @opindex fsched-stalled-insns-dep
4090 Define how many insn groups (cycles) will be examined for a dependency
4091 on a stalled insn that is candidate for premature removal from the queue
4092 of stalled insns.  Has an effect only during the second scheduling pass,
4093 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4094
4095 @item -fsched2-use-superblocks
4096 @opindex fsched2-use-superblocks
4097 When scheduling after register allocation, do use superblock scheduling
4098 algorithm.  Superblock scheduling allows motion across basic block boundaries
4099 resulting on faster schedules.  This option is experimental, as not all machine
4100 descriptions used by GCC model the CPU closely enough to avoid unreliable
4101 results from the algorithm.
4102
4103 This only makes sense when scheduling after register allocation, i.e.@: with
4104 @option{-fschedule-insns2} or at @option{-O2} or higher.
4105
4106 @item -fsched2-use-traces
4107 @opindex fsched2-use-traces
4108 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4109 allocation and additionally perform code duplication in order to increase the
4110 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4111 trace formation.
4112
4113 This mode should produce faster but significantly longer programs.  Also
4114 without @code{-fbranch-probabilities} the traces constructed may not match the
4115 reality and hurt the performance.  This only makes
4116 sense when scheduling after register allocation, i.e.@: with
4117 @option{-fschedule-insns2} or at @option{-O2} or higher.
4118
4119 @item -fcaller-saves
4120 @opindex fcaller-saves
4121 Enable values to be allocated in registers that will be clobbered by
4122 function calls, by emitting extra instructions to save and restore the
4123 registers around such calls.  Such allocation is done only when it
4124 seems to result in better code than would otherwise be produced.
4125
4126 This option is always enabled by default on certain machines, usually
4127 those which have no call-preserved registers to use instead.
4128
4129 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4130
4131 @item -fmove-all-movables
4132 @opindex fmove-all-movables
4133 Forces all invariant computations in loops to be moved
4134 outside the loop.
4135
4136 @item -freduce-all-givs
4137 @opindex freduce-all-givs
4138 Forces all general-induction variables in loops to be
4139 strength-reduced.
4140
4141 @emph{Note:} When compiling programs written in Fortran,
4142 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4143 by default when you use the optimizer.
4144
4145 These options may generate better or worse code; results are highly
4146 dependent on the structure of loops within the source code.
4147
4148 These two options are intended to be removed someday, once
4149 they have helped determine the efficacy of various
4150 approaches to improving loop optimizations.
4151
4152 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4153 know how use of these options affects
4154 the performance of your production code.
4155 We're very interested in code that runs @emph{slower}
4156 when these options are @emph{enabled}.
4157
4158 @item -fno-peephole
4159 @itemx -fno-peephole2
4160 @opindex fno-peephole
4161 @opindex fno-peephole2
4162 Disable any machine-specific peephole optimizations.  The difference
4163 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4164 are implemented in the compiler; some targets use one, some use the
4165 other, a few use both.
4166
4167 @option{-fpeephole} is enabled by default.
4168 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4169
4170 @item -fno-guess-branch-probability
4171 @opindex fno-guess-branch-probability
4172 Do not guess branch probabilities using a randomized model.
4173
4174 Sometimes GCC will opt to use a randomized model to guess branch
4175 probabilities, when none are available from either profiling feedback
4176 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4177 different runs of the compiler on the same program may produce different
4178 object code.
4179
4180 In a hard real-time system, people don't want different runs of the
4181 compiler to produce code that has different behavior; minimizing
4182 non-determinism is of paramount import.  This switch allows users to
4183 reduce non-determinism, possibly at the expense of inferior
4184 optimization.
4185
4186 The default is @option{-fguess-branch-probability} at levels
4187 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4188
4189 @item -freorder-blocks
4190 @opindex freorder-blocks
4191 Reorder basic blocks in the compiled function in order to reduce number of
4192 taken branches and improve code locality.
4193
4194 Enabled at levels @option{-O2}, @option{-O3}.
4195
4196 @item -freorder-functions
4197 @opindex freorder-functions
4198 Reorder basic blocks in the compiled function in order to reduce number of
4199 taken branches and improve code locality. This is implemented by using special
4200 subsections @code{text.hot} for most frequently executed functions and
4201 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4202 the linker so object file format must support named sections and linker must
4203 place them in a reasonable way.
4204
4205 Also profile feedback must be available in to make this option effective.  See
4206 @option{-fprofile-arcs} for details.
4207
4208 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4209
4210 @item -fstrict-aliasing
4211 @opindex fstrict-aliasing
4212 Allows the compiler to assume the strictest aliasing rules applicable to
4213 the language being compiled.  For C (and C++), this activates
4214 optimizations based on the type of expressions.  In particular, an
4215 object of one type is assumed never to reside at the same address as an
4216 object of a different type, unless the types are almost the same.  For
4217 example, an @code{unsigned int} can alias an @code{int}, but not a
4218 @code{void*} or a @code{double}.  A character type may alias any other
4219 type.
4220
4221 Pay special attention to code like this:
4222 @smallexample
4223 union a_union @{
4224   int i;
4225   double d;
4226 @};
4227
4228 int f() @{
4229   a_union t;
4230   t.d = 3.0;
4231   return t.i;
4232 @}
4233 @end smallexample
4234 The practice of reading from a different union member than the one most
4235 recently written to (called ``type-punning'') is common.  Even with
4236 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4237 is accessed through the union type.  So, the code above will work as
4238 expected.  However, this code might not:
4239 @smallexample
4240 int f() @{
4241   a_union t;
4242   int* ip;
4243   t.d = 3.0;
4244   ip = &t.i;
4245   return *ip;
4246 @}
4247 @end smallexample
4248
4249 Every language that wishes to perform language-specific alias analysis
4250 should define a function that computes, given an @code{tree}
4251 node, an alias set for the node.  Nodes in different alias sets are not
4252 allowed to alias.  For an example, see the C front-end function
4253 @code{c_get_alias_set}.
4254
4255 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4256
4257 @item -falign-functions
4258 @itemx -falign-functions=@var{n}
4259 @opindex falign-functions
4260 Align the start of functions to the next power-of-two greater than
4261 @var{n}, skipping up to @var{n} bytes.  For instance,
4262 @option{-falign-functions=32} aligns functions to the next 32-byte
4263 boundary, but @option{-falign-functions=24} would align to the next
4264 32-byte boundary only if this can be done by skipping 23 bytes or less.
4265
4266 @option{-fno-align-functions} and @option{-falign-functions=1} are
4267 equivalent and mean that functions will not be aligned.
4268
4269 Some assemblers only support this flag when @var{n} is a power of two;
4270 in that case, it is rounded up.
4271
4272 If @var{n} is not specified or is zero, use a machine-dependent default.
4273
4274 Enabled at levels @option{-O2}, @option{-O3}.
4275
4276 @item -falign-labels
4277 @itemx -falign-labels=@var{n}
4278 @opindex falign-labels
4279 Align all branch targets to a power-of-two boundary, skipping up to
4280 @var{n} bytes like @option{-falign-functions}.  This option can easily
4281 make code slower, because it must insert dummy operations for when the
4282 branch target is reached in the usual flow of the code.
4283
4284 @option{-fno-align-labels} and @option{-falign-labels=1} are
4285 equivalent and mean that labels will not be aligned.
4286
4287 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4288 are greater than this value, then their values are used instead.
4289
4290 If @var{n} is not specified or is zero, use a machine-dependent default
4291 which is very likely to be @samp{1}, meaning no alignment.
4292
4293 Enabled at levels @option{-O2}, @option{-O3}.
4294
4295 @item -falign-loops
4296 @itemx -falign-loops=@var{n}
4297 @opindex falign-loops
4298 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4299 like @option{-falign-functions}.  The hope is that the loop will be
4300 executed many times, which will make up for any execution of the dummy
4301 operations.
4302
4303 @option{-fno-align-loops} and @option{-falign-loops=1} are
4304 equivalent and mean that loops will not be aligned.
4305
4306 If @var{n} is not specified or is zero, use a machine-dependent default.
4307
4308 Enabled at levels @option{-O2}, @option{-O3}.
4309
4310 @item -falign-jumps
4311 @itemx -falign-jumps=@var{n}
4312 @opindex falign-jumps
4313 Align branch targets to a power-of-two boundary, for branch targets
4314 where the targets can only be reached by jumping, skipping up to @var{n}
4315 bytes like @option{-falign-functions}.  In this case, no dummy operations
4316 need be executed.
4317
4318 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4319 equivalent and mean that loops will not be aligned.
4320
4321 If @var{n} is not specified or is zero, use a machine-dependent default.
4322
4323 Enabled at levels @option{-O2}, @option{-O3}.
4324
4325 @item -frename-registers
4326 @opindex frename-registers
4327 Attempt to avoid false dependencies in scheduled code by making use
4328 of registers left over after register allocation.  This optimization
4329 will most benefit processors with lots of registers.  It can, however,
4330 make debugging impossible, since variables will no longer stay in
4331 a ``home register''.
4332
4333 @item -fweb