OSDN Git Service

* doc/invoke.texi (SPARC options): Remove -mflat and
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), 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 @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo  -Wsynth}
192
193 @item Objective-C Language Options
194 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
195 @gccoptlist{
196 -fconstant-string-class=@var{class-name} @gol
197 -fgnu-runtime  -fnext-runtime @gol
198 -fno-nil-receivers @gol
199 -fobjc-exceptions @gol
200 -freplace-objc-classes @gol
201 -fzero-link @gol
202 -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
204
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{-fmessage-length=@var{n}  @gol
208 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209
210 @item Warning Options
211 @xref{Warning Options,,Options to Request or Suppress Warnings}.
212 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
213 -w  -Wextra  -Wall  -Waggregate-return @gol
214 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
215 -Wconversion  -Wno-deprecated-declarations @gol
216 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
217 -Werror  -Werror-implicit-function-declaration @gol
218 -Wfloat-equal  -Wformat  -Wformat=2 @gol
219 -Wno-format-extra-args -Wformat-nonliteral @gol
220 -Wformat-security  -Wformat-y2k @gol
221 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
222 -Wimport  -Wno-import  -Winit-self  -Winline @gol
223 -Wno-invalid-offsetof  -Winvalid-pch @gol
224 -Wlarger-than-@var{len}  -Wlong-long @gol
225 -Wmain  -Wmissing-braces @gol
226 -Wmissing-format-attribute  -Wmissing-noreturn @gol
227 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
228 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
229 -Wreturn-type  -Wsequence-point  -Wshadow @gol
230 -Wsign-compare  -Wstrict-aliasing @gol
231 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
232 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings}
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 @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 -msoft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpe=@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-sb1  -mno-fix-sb1  -mflush-func=@var{func} @gol
482 -mno-flush-func  -mbranch-likely  -mno-branch-likely}
483
484 @emph{i386 and x86-64 Options}
485 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
486 -mfpmath=@var{unit} @gol
487 -masm=@var{dialect}  -mno-fancy-math-387 @gol
488 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
489 -mno-wide-multiply  -mrtd  -malign-double @gol
490 -mpreferred-stack-boundary=@var{num} @gol
491 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
492 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
493 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
494 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
495 -mno-red-zone -mno-tls-direct-seg-refs @gol
496 -mcmodel=@var{code-model} @gol
497 -m32  -m64}
498
499 @emph{HPPA Options}
500 @gccoptlist{-march=@var{architecture-type} @gol
501 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
502 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
503 -mjump-in-delay -mlinker-opt -mlong-calls @gol
504 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
505 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
506 -mno-jump-in-delay  -mno-long-load-store @gol
507 -mno-portable-runtime  -mno-soft-float @gol
508 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
509 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
510 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
511 -nolibdld  -static  -threads}
512
513 @emph{Intel 960 Options}
514 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
515 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
516 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
517 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
518 -mno-complex-addr  -mno-leaf-procedures @gol
519 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
520 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
521 -mtail-call}
522
523 @emph{DEC Alpha Options}
524 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
525 -mieee  -mieee-with-inexact  -mieee-conformant @gol
526 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
527 -mtrap-precision=@var{mode}  -mbuild-constants @gol
528 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
529 -mbwx  -mmax  -mfix  -mcix @gol
530 -mfloat-vax  -mfloat-ieee @gol
531 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
532 -msmall-text  -mlarge-text @gol
533 -mmemory-latency=@var{time}}
534
535 @emph{DEC Alpha/VMS Options}
536 @gccoptlist{-mvms-return-codes}
537
538 @emph{H8/300 Options}
539 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
540
541 @emph{SH Options}
542 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
543 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
544 -m5-64media  -m5-64media-nofpu @gol
545 -m5-32media  -m5-32media-nofpu @gol
546 -m5-compact  -m5-compact-nofpu @gol
547 -mb  -ml  -mdalign  -mrelax @gol
548 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
549 -mieee  -misize  -mpadstruct  -mspace @gol
550 -mprefergot  -musermode}
551
552 @emph{System V Options}
553 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
554
555 @emph{ARC Options}
556 @gccoptlist{-EB  -EL @gol
557 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
558 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
559
560 @emph{TMS320C3x/C4x Options}
561 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
562 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
563 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
564 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
565
566 @emph{V850 Options}
567 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
568 -mprolog-function  -mno-prolog-function  -mspace @gol
569 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
570 -mapp-regs  -mno-app-regs @gol
571 -mdisable-callt  -mno-disable-callt @gol
572 -mv850e1 @gol
573 -mv850e @gol
574 -mv850  -mbig-switch}
575
576 @emph{NS32K Options}
577 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
578 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
579 -mregparam  -mnoregparam  -msb  -mnosb @gol
580 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
581
582 @emph{AVR Options}
583 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
584 -mcall-prologues  -mno-tablejump  -mtiny-stack}
585
586 @emph{MCore Options}
587 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
588 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
589 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
590 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
591 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
592
593 @emph{MMIX Options}
594 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
595 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
596 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
597 -mno-base-addresses  -msingle-exit  -mno-single-exit}
598
599 @emph{IA-64 Options}
600 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
601 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
602 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
603 -minline-float-divide-max-throughput @gol
604 -minline-int-divide-min-latency @gol
605 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
606 -mfixed-range=@var{register-range}}
607
608 @emph{D30V Options}
609 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
610 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
611
612 @emph{S/390 and zSeries Options}
613 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
614 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
615 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
616 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
617
618 @emph{CRIS Options}
619 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
620 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
621 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
622 -mstack-align  -mdata-align  -mconst-align @gol
623 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
624 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
625
626 @emph{PDP-11 Options}
627 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
628 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
629 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
630 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
631 -mbranch-expensive  -mbranch-cheap @gol
632 -msplit  -mno-split  -munix-asm  -mdec-asm}
633
634 @emph{Xstormy16 Options}
635 @gccoptlist{-msim}
636
637 @emph{Xtensa Options}
638 @gccoptlist{-mconst16 -mno-const16 @gol
639 -mfused-madd  -mno-fused-madd @gol
640 -mtext-section-literals  -mno-text-section-literals @gol
641 -mtarget-align  -mno-target-align @gol
642 -mlongcalls  -mno-longcalls}
643
644 @emph{FRV Options}
645 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
646 -mhard-float  -msoft-float @gol
647 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
648 -mdouble  -mno-double @gol
649 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
650 -mlibrary-pic  -macc-4 -macc-8 @gol
651 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
652 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
653 -mvliw-branch  -mno-vliw-branch @gol
654 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
655 -mno-nested-cond-exec  -mtomcat-stats @gol
656 -mcpu=@var{cpu}}
657
658 @item Code Generation Options
659 @xref{Code Gen Options,,Options for Code Generation Conventions}.
660 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
661 -ffixed-@var{reg}  -fexceptions @gol
662 -fnon-call-exceptions  -funwind-tables @gol
663 -fasynchronous-unwind-tables @gol
664 -finhibit-size-directive  -finstrument-functions @gol
665 -fno-common  -fno-ident @gol
666 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
667 -freg-struct-return  -fshared-data  -fshort-enums @gol
668 -fshort-double  -fshort-wchar @gol
669 -fverbose-asm  -fpack-struct  -fstack-check @gol
670 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
671 -fargument-alias  -fargument-noalias @gol
672 -fargument-noalias-global  -fleading-underscore @gol
673 -ftls-model=@var{model} @gol
674 -ftrapv  -fwrapv  -fbounds-check}
675 @end table
676
677 @menu
678 * Overall Options::     Controlling the kind of output:
679                         an executable, object files, assembler files,
680                         or preprocessed source.
681 * C Dialect Options::   Controlling the variant of C language compiled.
682 * C++ Dialect Options:: Variations on C++.
683 * Objective-C Dialect Options:: Variations on Objective-C.
684 * Language Independent Options:: Controlling how diagnostics should be
685                         formatted.
686 * Warning Options::     How picky should the compiler be?
687 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
688 * Optimize Options::    How much optimization?
689 * Preprocessor Options:: Controlling header files and macro definitions.
690                          Also, getting dependency information for Make.
691 * Assembler Options::   Passing options to the assembler.
692 * Link Options::        Specifying libraries and so on.
693 * Directory Options::   Where to find header files and libraries.
694                         Where to find the compiler executable files.
695 * Spec Files::          How to pass switches to sub-processes.
696 * Target Options::      Running a cross-compiler, or an old version of GCC.
697 @end menu
698
699 @node Overall Options
700 @section Options Controlling the Kind of Output
701
702 Compilation can involve up to four stages: preprocessing, compilation
703 proper, assembly and linking, always in that order.  GCC is capable of
704 preprocessing and compiling several files either into several
705 assembler input files, or into one assembler input file; then each
706 assembler input file produces an object file, and linking combines all
707 the object files (those newly compiled, and those specified as input)
708 into an executable file.
709
710 @cindex file name suffix
711 For any given input file, the file name suffix determines what kind of
712 compilation is done:
713
714 @table @gcctabopt
715 @item @var{file}.c
716 C source code which must be preprocessed.
717
718 @item @var{file}.i
719 C source code which should not be preprocessed.
720
721 @item @var{file}.ii
722 C++ source code which should not be preprocessed.
723
724 @item @var{file}.m
725 Objective-C source code.  Note that you must link with the library
726 @file{libobjc.a} to make an Objective-C program work.
727
728 @item @var{file}.mi
729 Objective-C source code which should not be preprocessed.
730
731 @item @var{file}.h
732 C or C++ header file to be turned into a precompiled header.
733
734 @item @var{file}.cc
735 @itemx @var{file}.cp
736 @itemx @var{file}.cxx
737 @itemx @var{file}.cpp
738 @itemx @var{file}.CPP
739 @itemx @var{file}.c++
740 @itemx @var{file}.C
741 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
742 the last two letters must both be literally @samp{x}.  Likewise,
743 @samp{.C} refers to a literal capital C@.
744
745 @item @var{file}.hh
746 @itemx @var{file}.H
747 C++ header file to be turned into a precompiled header.
748
749 @item @var{file}.f
750 @itemx @var{file}.for
751 @itemx @var{file}.FOR
752 Fortran source code which should not be preprocessed.
753
754 @item @var{file}.F
755 @itemx @var{file}.fpp
756 @itemx @var{file}.FPP
757 Fortran source code which must be preprocessed (with the traditional
758 preprocessor).
759
760 @item @var{file}.r
761 Fortran source code which must be preprocessed with a RATFOR
762 preprocessor (not included with GCC)@.
763
764 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
765 Using and Porting GNU Fortran}, for more details of the handling of
766 Fortran input files.
767
768 @c FIXME: Descriptions of Java file types.
769 @c @var{file}.java
770 @c @var{file}.class
771 @c @var{file}.zip
772 @c @var{file}.jar
773
774 @item @var{file}.ads
775 Ada source code file which contains a library unit declaration (a
776 declaration of a package, subprogram, or generic, or a generic
777 instantiation), or a library unit renaming declaration (a package,
778 generic, or subprogram renaming declaration).  Such files are also
779 called @dfn{specs}.
780
781 @itemx @var{file}.adb
782 Ada source code file containing a library unit body (a subprogram or
783 package body).  Such files are also called @dfn{bodies}.
784
785 @c GCC also knows about some suffixes for languages not yet included:
786 @c Pascal:
787 @c @var{file}.p
788 @c @var{file}.pas
789
790 @item @var{file}.s
791 Assembler code.
792
793 @item @var{file}.S
794 Assembler code which must be preprocessed.
795
796 @item @var{other}
797 An object file to be fed straight into linking.
798 Any file name with no recognized suffix is treated this way.
799 @end table
800
801 @opindex x
802 You can specify the input language explicitly with the @option{-x} option:
803
804 @table @gcctabopt
805 @item -x @var{language}
806 Specify explicitly the @var{language} for the following input files
807 (rather than letting the compiler choose a default based on the file
808 name suffix).  This option applies to all following input files until
809 the next @option{-x} option.  Possible values for @var{language} are:
810 @smallexample
811 c  c-header  cpp-output
812 c++  c++-header  c++-cpp-output
813 objective-c  objective-c-header  objc-cpp-output
814 assembler  assembler-with-cpp
815 ada
816 f77  f77-cpp-input  ratfor
817 java
818 treelang
819 @end smallexample
820
821 @item -x none
822 Turn off any specification of a language, so that subsequent files are
823 handled according to their file name suffixes (as they are if @option{-x}
824 has not been used at all).
825
826 @item -pass-exit-codes
827 @opindex pass-exit-codes
828 Normally the @command{gcc} program will exit with the code of 1 if any
829 phase of the compiler returns a non-success return code.  If you specify
830 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
831 numerically highest error produced by any phase that returned an error
832 indication.
833 @end table
834
835 If you only want some of the stages of compilation, you can use
836 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
837 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
838 @command{gcc} is to stop.  Note that some combinations (for example,
839 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
840
841 @table @gcctabopt
842 @item -c
843 @opindex c
844 Compile or assemble the source files, but do not link.  The linking
845 stage simply is not done.  The ultimate output is in the form of an
846 object file for each source file.
847
848 By default, the object file name for a source file is made by replacing
849 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
850
851 Unrecognized input files, not requiring compilation or assembly, are
852 ignored.
853
854 @item -S
855 @opindex S
856 Stop after the stage of compilation proper; do not assemble.  The output
857 is in the form of an assembler code file for each non-assembler input
858 file specified.
859
860 By default, the assembler file name for a source file is made by
861 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
862
863 Input files that don't require compilation are ignored.
864
865 @item -E
866 @opindex E
867 Stop after the preprocessing stage; do not run the compiler proper.  The
868 output is in the form of preprocessed source code, which is sent to the
869 standard output.
870
871 Input files which don't require preprocessing are ignored.
872
873 @cindex output file option
874 @item -o @var{file}
875 @opindex o
876 Place output in file @var{file}.  This applies regardless to whatever
877 sort of output is being produced, whether it be an executable file,
878 an object file, an assembler file or preprocessed C code.
879
880 If you specify @option{-o} when compiling more than one input file, or
881 you are producing an executable file as output, all the source files
882 on the command line will be compiled at once.
883
884 If @option{-o} is not specified, the default is to put an executable file
885 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
886 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
887 all preprocessed C source on standard output.
888
889 @item -v
890 @opindex v
891 Print (on standard error output) the commands executed to run the stages
892 of compilation.  Also print the version number of the compiler driver
893 program and of the preprocessor and the compiler proper.
894
895 @item -###
896 @opindex ###
897 Like @option{-v} except the commands are not executed and all command
898 arguments are quoted.  This is useful for shell scripts to capture the
899 driver-generated command lines.
900
901 @item -pipe
902 @opindex pipe
903 Use pipes rather than temporary files for communication between the
904 various stages of compilation.  This fails to work on some systems where
905 the assembler is unable to read from a pipe; but the GNU assembler has
906 no trouble.
907
908 @item --help
909 @opindex help
910 Print (on the standard output) a description of the command line options
911 understood by @command{gcc}.  If the @option{-v} option is also specified
912 then @option{--help} will also be passed on to the various processes
913 invoked by @command{gcc}, so that they can display the command line options
914 they accept.  If the @option{-Wextra} option is also specified then command
915 line options which have no documentation associated with them will also
916 be displayed.
917
918 @item --target-help
919 @opindex target-help
920 Print (on the standard output) a description of target specific command
921 line options for each tool.
922
923 @item --version
924 @opindex version
925 Display the version number and copyrights of the invoked GCC.
926 @end table
927
928 @node Invoking G++
929 @section Compiling C++ Programs
930
931 @cindex suffixes for C++ source
932 @cindex C++ source file suffixes
933 C++ source files conventionally use one of the suffixes @samp{.C},
934 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
935 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
936 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
937 files with these names and compiles them as C++ programs even if you
938 call the compiler the same way as for compiling C programs (usually
939 with the name @command{gcc}).
940
941 @findex g++
942 @findex c++
943 However, C++ programs often require class libraries as well as a
944 compiler that understands the C++ language---and under some
945 circumstances, you might want to compile programs or header files from
946 standard input, or otherwise without a suffix that flags them as C++
947 programs.  You might also like to precompile a C header file with a
948 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
949 program that calls GCC with the default language set to C++, and
950 automatically specifies linking against the C++ library.  On many
951 systems, @command{g++} is also installed with the name @command{c++}.
952
953 @cindex invoking @command{g++}
954 When you compile C++ programs, you may specify many of the same
955 command-line options that you use for compiling programs in any
956 language; or command-line options meaningful for C and related
957 languages; or options that are meaningful only for C++ programs.
958 @xref{C Dialect Options,,Options Controlling C Dialect}, for
959 explanations of options for languages related to C@.
960 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
961 explanations of options that are meaningful only for C++ programs.
962
963 @node C Dialect Options
964 @section Options Controlling C Dialect
965 @cindex dialect options
966 @cindex language dialect options
967 @cindex options, dialect
968
969 The following options control the dialect of C (or languages derived
970 from C, such as C++ and Objective-C) that the compiler accepts:
971
972 @table @gcctabopt
973 @cindex ANSI support
974 @cindex ISO support
975 @item -ansi
976 @opindex ansi
977 In C mode, support all ISO C90 programs.  In C++ mode,
978 remove GNU extensions that conflict with ISO C++.
979
980 This turns off certain features of GCC that are incompatible with ISO
981 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
982 such as the @code{asm} and @code{typeof} keywords, and
983 predefined macros such as @code{unix} and @code{vax} that identify the
984 type of system you are using.  It also enables the undesirable and
985 rarely used ISO trigraph feature.  For the C compiler,
986 it disables recognition of C++ style @samp{//} comments as well as
987 the @code{inline} keyword.
988
989 The alternate keywords @code{__asm__}, @code{__extension__},
990 @code{__inline__} and @code{__typeof__} continue to work despite
991 @option{-ansi}.  You would not want to use them in an ISO C program, of
992 course, but it is useful to put them in header files that might be included
993 in compilations done with @option{-ansi}.  Alternate predefined macros
994 such as @code{__unix__} and @code{__vax__} are also available, with or
995 without @option{-ansi}.
996
997 The @option{-ansi} option does not cause non-ISO programs to be
998 rejected gratuitously.  For that, @option{-pedantic} is required in
999 addition to @option{-ansi}.  @xref{Warning Options}.
1000
1001 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1002 option is used.  Some header files may notice this macro and refrain
1003 from declaring certain functions or defining certain macros that the
1004 ISO standard doesn't call for; this is to avoid interfering with any
1005 programs that might use these names for other things.
1006
1007 Functions which would normally be built in but do not have semantics
1008 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1009 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1010 built-in functions provided by GCC}, for details of the functions
1011 affected.
1012
1013 @item -std=
1014 @opindex std
1015 Determine the language standard.  This option is currently only
1016 supported when compiling C or C++.  A value for this option must be
1017 provided; possible values are
1018
1019 @table @samp
1020 @item c89
1021 @itemx iso9899:1990
1022 ISO C90 (same as @option{-ansi}).
1023
1024 @item iso9899:199409
1025 ISO C90 as modified in amendment 1.
1026
1027 @item c99
1028 @itemx c9x
1029 @itemx iso9899:1999
1030 @itemx iso9899:199x
1031 ISO C99.  Note that this standard is not yet fully supported; see
1032 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1033 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1034
1035 @item gnu89
1036 Default, ISO C90 plus GNU extensions (including some C99 features).
1037
1038 @item gnu99
1039 @itemx gnu9x
1040 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1041 this will become the default.  The name @samp{gnu9x} is deprecated.
1042
1043 @item c++98
1044 The 1998 ISO C++ standard plus amendments.
1045
1046 @item gnu++98
1047 The same as @option{-std=c++98} plus GNU extensions.  This is the
1048 default for C++ code.
1049 @end table
1050
1051 Even when this option is not specified, you can still use some of the
1052 features of newer standards in so far as they do not conflict with
1053 previous C standards.  For example, you may use @code{__restrict__} even
1054 when @option{-std=c99} is not specified.
1055
1056 The @option{-std} options specifying some version of ISO C have the same
1057 effects as @option{-ansi}, except that features that were not in ISO C90
1058 but are in the specified version (for example, @samp{//} comments and
1059 the @code{inline} keyword in ISO C99) are not disabled.
1060
1061 @xref{Standards,,Language Standards Supported by GCC}, for details of
1062 these standard versions.
1063
1064 @item -aux-info @var{filename}
1065 @opindex aux-info
1066 Output to the given filename prototyped declarations for all functions
1067 declared and/or defined in a translation unit, including those in header
1068 files.  This option is silently ignored in any language other than C@.
1069
1070 Besides declarations, the file indicates, in comments, the origin of
1071 each declaration (source file and line), whether the declaration was
1072 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1073 @samp{O} for old, respectively, in the first character after the line
1074 number and the colon), and whether it came from a declaration or a
1075 definition (@samp{C} or @samp{F}, respectively, in the following
1076 character).  In the case of function definitions, a K&R-style list of
1077 arguments followed by their declarations is also provided, inside
1078 comments, after the declaration.
1079
1080 @item -fno-asm
1081 @opindex fno-asm
1082 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1083 keyword, so that code can use these words as identifiers.  You can use
1084 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1085 instead.  @option{-ansi} implies @option{-fno-asm}.
1086
1087 In C++, this switch only affects the @code{typeof} keyword, since
1088 @code{asm} and @code{inline} are standard keywords.  You may want to
1089 use the @option{-fno-gnu-keywords} flag instead, which has the same
1090 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1091 switch only affects the @code{asm} and @code{typeof} keywords, since
1092 @code{inline} is a standard keyword in ISO C99.
1093
1094 @item -fno-builtin
1095 @itemx -fno-builtin-@var{function}
1096 @opindex fno-builtin
1097 @cindex built-in functions
1098 Don't recognize built-in functions that do not begin with
1099 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1100 functions provided by GCC}, for details of the functions affected,
1101 including those which are not built-in functions when @option{-ansi} or
1102 @option{-std} options for strict ISO C conformance are used because they
1103 do not have an ISO standard meaning.
1104
1105 GCC normally generates special code to handle certain built-in functions
1106 more efficiently; for instance, calls to @code{alloca} may become single
1107 instructions that adjust the stack directly, and calls to @code{memcpy}
1108 may become inline copy loops.  The resulting code is often both smaller
1109 and faster, but since the function calls no longer appear as such, you
1110 cannot set a breakpoint on those calls, nor can you change the behavior
1111 of the functions by linking with a different library.
1112
1113 With the @option{-fno-builtin-@var{function}} option
1114 only the built-in function @var{function} is
1115 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1116 function is named this is not built-in in this version of GCC, this
1117 option is ignored.  There is no corresponding
1118 @option{-fbuiltin-@var{function}} option; if you wish to enable
1119 built-in functions selectively when using @option{-fno-builtin} or
1120 @option{-ffreestanding}, you may define macros such as:
1121
1122 @smallexample
1123 #define abs(n)          __builtin_abs ((n))
1124 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1125 @end smallexample
1126
1127 @item -fhosted
1128 @opindex fhosted
1129 @cindex hosted environment
1130
1131 Assert that compilation takes place in a hosted environment.  This implies
1132 @option{-fbuiltin}.  A hosted environment is one in which the
1133 entire standard library is available, and in which @code{main} has a return
1134 type of @code{int}.  Examples are nearly everything except a kernel.
1135 This is equivalent to @option{-fno-freestanding}.
1136
1137 @item -ffreestanding
1138 @opindex ffreestanding
1139 @cindex hosted environment
1140
1141 Assert that compilation takes place in a freestanding environment.  This
1142 implies @option{-fno-builtin}.  A freestanding environment
1143 is one in which the standard library may not exist, and program startup may
1144 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1145 This is equivalent to @option{-fno-hosted}.
1146
1147 @xref{Standards,,Language Standards Supported by GCC}, for details of
1148 freestanding and hosted environments.
1149
1150 @item -fms-extensions
1151 @opindex fms-extensions
1152 Accept some non-standard constructs used in Microsoft header files.
1153
1154 @item -trigraphs
1155 @opindex trigraphs
1156 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1157 options for strict ISO C conformance) implies @option{-trigraphs}.
1158
1159 @item -no-integrated-cpp
1160 @opindex no-integrated-cpp
1161 Performs a compilation in two passes: preprocessing and compiling.  This
1162 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1163 @option{-B} option. The user supplied compilation step can then add in
1164 an additional preprocessing step after normal preprocessing but before
1165 compiling. The default is to use the integrated cpp (internal cpp)
1166
1167 The semantics of this option will change if "cc1", "cc1plus", and
1168 "cc1obj" are merged.
1169
1170 @cindex traditional C language
1171 @cindex C language, traditional
1172 @item -traditional
1173 @itemx -traditional-cpp
1174 @opindex traditional-cpp
1175 @opindex traditional
1176 Formerly, these options caused GCC to attempt to emulate a pre-standard
1177 C compiler.  They are now only supported with the @option{-E} switch.
1178 The preprocessor continues to support a pre-standard mode.  See the GNU
1179 CPP manual for details.
1180
1181 @item -fcond-mismatch
1182 @opindex fcond-mismatch
1183 Allow conditional expressions with mismatched types in the second and
1184 third arguments.  The value of such an expression is void.  This option
1185 is not supported for C++.
1186
1187 @item -funsigned-char
1188 @opindex funsigned-char
1189 Let the type @code{char} be unsigned, like @code{unsigned char}.
1190
1191 Each kind of machine has a default for what @code{char} should
1192 be.  It is either like @code{unsigned char} by default or like
1193 @code{signed char} by default.
1194
1195 Ideally, a portable program should always use @code{signed char} or
1196 @code{unsigned char} when it depends on the signedness of an object.
1197 But many programs have been written to use plain @code{char} and
1198 expect it to be signed, or expect it to be unsigned, depending on the
1199 machines they were written for.  This option, and its inverse, let you
1200 make such a program work with the opposite default.
1201
1202 The type @code{char} is always a distinct type from each of
1203 @code{signed char} or @code{unsigned char}, even though its behavior
1204 is always just like one of those two.
1205
1206 @item -fsigned-char
1207 @opindex fsigned-char
1208 Let the type @code{char} be signed, like @code{signed char}.
1209
1210 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1211 the negative form of @option{-funsigned-char}.  Likewise, the option
1212 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1213
1214 @item -fsigned-bitfields
1215 @itemx -funsigned-bitfields
1216 @itemx -fno-signed-bitfields
1217 @itemx -fno-unsigned-bitfields
1218 @opindex fsigned-bitfields
1219 @opindex funsigned-bitfields
1220 @opindex fno-signed-bitfields
1221 @opindex fno-unsigned-bitfields
1222 These options control whether a bit-field is signed or unsigned, when the
1223 declaration does not use either @code{signed} or @code{unsigned}.  By
1224 default, such a bit-field is signed, because this is consistent: the
1225 basic integer types such as @code{int} are signed types.
1226
1227 @item -fwritable-strings
1228 @opindex fwritable-strings
1229 Store string constants in the writable data segment and don't uniquize
1230 them.  This is for compatibility with old programs which assume they can
1231 write into string constants.
1232
1233 Writing into string constants is a very bad idea; ``constants'' should
1234 be constant.
1235
1236 This option is deprecated.
1237 @end table
1238
1239 @node C++ Dialect Options
1240 @section Options Controlling C++ Dialect
1241
1242 @cindex compiler options, C++
1243 @cindex C++ options, command line
1244 @cindex options, C++
1245 This section describes the command-line options that are only meaningful
1246 for C++ programs; but you can also use most of the GNU compiler options
1247 regardless of what language your program is in.  For example, you
1248 might compile a file @code{firstClass.C} like this:
1249
1250 @smallexample
1251 g++ -g -frepo -O -c firstClass.C
1252 @end smallexample
1253
1254 @noindent
1255 In this example, only @option{-frepo} is an option meant
1256 only for C++ programs; you can use the other options with any
1257 language supported by GCC@.
1258
1259 Here is a list of options that are @emph{only} for compiling C++ programs:
1260
1261 @table @gcctabopt
1262
1263 @item -fabi-version=@var{n}
1264 @opindex fabi-version
1265 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1266 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1267 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1268 the version that conforms most closely to the C++ ABI specification.
1269 Therefore, the ABI obtained using version 0 will change as ABI bugs
1270 are fixed.
1271
1272 The default is version 1.
1273
1274 @item -fno-access-control
1275 @opindex fno-access-control
1276 Turn off all access checking.  This switch is mainly useful for working
1277 around bugs in the access control code.
1278
1279 @item -fcheck-new
1280 @opindex fcheck-new
1281 Check that the pointer returned by @code{operator new} is non-null
1282 before attempting to modify the storage allocated.  This check is
1283 normally unnecessary because the C++ standard specifies that
1284 @code{operator new} will only return @code{0} if it is declared
1285 @samp{throw()}, in which case the compiler will always check the
1286 return value even without this option.  In all other cases, when
1287 @code{operator new} has a non-empty exception specification, memory
1288 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1289 @samp{new (nothrow)}.
1290
1291 @item -fconserve-space
1292 @opindex fconserve-space
1293 Put uninitialized or runtime-initialized global variables into the
1294 common segment, as C does.  This saves space in the executable at the
1295 cost of not diagnosing duplicate definitions.  If you compile with this
1296 flag and your program mysteriously crashes after @code{main()} has
1297 completed, you may have an object that is being destroyed twice because
1298 two definitions were merged.
1299
1300 This option is no longer useful on most targets, now that support has
1301 been added for putting variables into BSS without making them common.
1302
1303 @item -fno-const-strings
1304 @opindex fno-const-strings
1305 Give string constants type @code{char *} instead of type @code{const
1306 char *}.  By default, G++ uses type @code{const char *} as required by
1307 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1308 actually modify the value of a string constant, unless you also use
1309 @option{-fwritable-strings}.
1310
1311 This option might be removed in a future release of G++.  For maximum
1312 portability, you should structure your code so that it works with
1313 string constants that have type @code{const char *}.
1314
1315 @item -fno-elide-constructors
1316 @opindex fno-elide-constructors
1317 The C++ standard allows an implementation to omit creating a temporary
1318 which is only used to initialize another object of the same type.
1319 Specifying this option disables that optimization, and forces G++ to
1320 call the copy constructor in all cases.
1321
1322 @item -fno-enforce-eh-specs
1323 @opindex fno-enforce-eh-specs
1324 Don't check for violation of exception specifications at runtime.  This
1325 option violates the C++ standard, but may be useful for reducing code
1326 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1327 will still optimize based on the exception specifications.
1328
1329 @item -ffor-scope
1330 @itemx -fno-for-scope
1331 @opindex ffor-scope
1332 @opindex fno-for-scope
1333 If @option{-ffor-scope} is specified, the scope of variables declared in
1334 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1335 as specified by the C++ standard.
1336 If @option{-fno-for-scope} is specified, the scope of variables declared in
1337 a @i{for-init-statement} extends to the end of the enclosing scope,
1338 as was the case in old versions of G++, and other (traditional)
1339 implementations of C++.
1340
1341 The default if neither flag is given to follow the standard,
1342 but to allow and give a warning for old-style code that would
1343 otherwise be invalid, or have different behavior.
1344
1345 @item -fno-gnu-keywords
1346 @opindex fno-gnu-keywords
1347 Do not recognize @code{typeof} as a keyword, so that code can use this
1348 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1349 @option{-ansi} implies @option{-fno-gnu-keywords}.
1350
1351 @item -fno-implicit-templates
1352 @opindex fno-implicit-templates
1353 Never emit code for non-inline templates which are instantiated
1354 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1355 @xref{Template Instantiation}, for more information.
1356
1357 @item -fno-implicit-inline-templates
1358 @opindex fno-implicit-inline-templates
1359 Don't emit code for implicit instantiations of inline templates, either.
1360 The default is to handle inlines differently so that compiles with and
1361 without optimization will need the same set of explicit instantiations.
1362
1363 @item -fno-implement-inlines
1364 @opindex fno-implement-inlines
1365 To save space, do not emit out-of-line copies of inline functions
1366 controlled by @samp{#pragma implementation}.  This will cause linker
1367 errors if these functions are not inlined everywhere they are called.
1368
1369 @item -fms-extensions
1370 @opindex fms-extensions
1371 Disable pedantic warnings about constructs used in MFC, such as implicit
1372 int and getting a pointer to member function via non-standard syntax.
1373
1374 @item -fno-nonansi-builtins
1375 @opindex fno-nonansi-builtins
1376 Disable built-in declarations of functions that are not mandated by
1377 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1378 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1379
1380 @item -fno-operator-names
1381 @opindex fno-operator-names
1382 Do not treat the operator name keywords @code{and}, @code{bitand},
1383 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1384 synonyms as keywords.
1385
1386 @item -fno-optional-diags
1387 @opindex fno-optional-diags
1388 Disable diagnostics that the standard says a compiler does not need to
1389 issue.  Currently, the only such diagnostic issued by G++ is the one for
1390 a name having multiple meanings within a class.
1391
1392 @item -fpermissive
1393 @opindex fpermissive
1394 Downgrade some diagnostics about nonconformant code from errors to
1395 warnings.  Thus, using @option{-fpermissive} will allow some
1396 nonconforming code to compile.
1397
1398 @item -frepo
1399 @opindex frepo
1400 Enable automatic template instantiation at link time.  This option also
1401 implies @option{-fno-implicit-templates}.  @xref{Template
1402 Instantiation}, for more information.
1403
1404 @item -fno-rtti
1405 @opindex fno-rtti
1406 Disable generation of information about every class with virtual
1407 functions for use by the C++ runtime type identification features
1408 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1409 of the language, you can save some space by using this flag.  Note that
1410 exception handling uses the same information, but it will generate it as
1411 needed.
1412
1413 @item -fstats
1414 @opindex fstats
1415 Emit statistics about front-end processing at the end of the compilation.
1416 This information is generally only useful to the G++ development team.
1417
1418 @item -ftemplate-depth-@var{n}
1419 @opindex ftemplate-depth
1420 Set the maximum instantiation depth for template classes to @var{n}.
1421 A limit on the template instantiation depth is needed to detect
1422 endless recursions during template class instantiation.  ANSI/ISO C++
1423 conforming programs must not rely on a maximum depth greater than 17.
1424
1425 @item -fuse-cxa-atexit
1426 @opindex fuse-cxa-atexit
1427 Register destructors for objects with static storage duration with the
1428 @code{__cxa_atexit} function rather than the @code{atexit} function.
1429 This option is required for fully standards-compliant handling of static
1430 destructors, but will only work if your C library supports
1431 @code{__cxa_atexit}.
1432
1433 @item -fno-weak
1434 @opindex fno-weak
1435 Do not use weak symbol support, even if it is provided by the linker.
1436 By default, G++ will use weak symbols if they are available.  This
1437 option exists only for testing, and should not be used by end-users;
1438 it will result in inferior code and has no benefits.  This option may
1439 be removed in a future release of G++.
1440
1441 @item -nostdinc++
1442 @opindex nostdinc++
1443 Do not search for header files in the standard directories specific to
1444 C++, but do still search the other standard directories.  (This option
1445 is used when building the C++ library.)
1446 @end table
1447
1448 In addition, these optimization, warning, and code generation options
1449 have meanings only for C++ programs:
1450
1451 @table @gcctabopt
1452 @item -fno-default-inline
1453 @opindex fno-default-inline
1454 Do not assume @samp{inline} for functions defined inside a class scope.
1455 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1456 functions will have linkage like inline functions; they just won't be
1457 inlined by default.
1458
1459 @item -Wabi @r{(C++ only)}
1460 @opindex Wabi
1461 Warn when G++ generates code that is probably not compatible with the
1462 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1463 all such cases, there are probably some cases that are not warned about,
1464 even though G++ is generating incompatible code.  There may also be
1465 cases where warnings are emitted even though the code that is generated
1466 will be compatible.
1467
1468 You should rewrite your code to avoid these warnings if you are
1469 concerned about the fact that code generated by G++ may not be binary
1470 compatible with code generated by other compilers.
1471
1472 The known incompatibilities at this point include:
1473
1474 @itemize @bullet
1475
1476 @item
1477 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1478 pack data into the same byte as a base class.  For example:
1479
1480 @smallexample
1481 struct A @{ virtual void f(); int f1 : 1; @};
1482 struct B : public A @{ int f2 : 1; @};
1483 @end smallexample
1484
1485 @noindent
1486 In this case, G++ will place @code{B::f2} into the same byte
1487 as@code{A::f1}; other compilers will not.  You can avoid this problem
1488 by explicitly padding @code{A} so that its size is a multiple of the
1489 byte size on your platform; that will cause G++ and other compilers to
1490 layout @code{B} identically.
1491
1492 @item
1493 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1494 tail padding when laying out virtual bases.  For example:
1495
1496 @smallexample
1497 struct A @{ virtual void f(); char c1; @};
1498 struct B @{ B(); char c2; @};
1499 struct C : public A, public virtual B @{@};
1500 @end smallexample
1501
1502 @noindent
1503 In this case, G++ will not place @code{B} into the tail-padding for
1504 @code{A}; other compilers will.  You can avoid this problem by
1505 explicitly padding @code{A} so that its size is a multiple of its
1506 alignment (ignoring virtual base classes); that will cause G++ and other
1507 compilers to layout @code{C} identically.
1508
1509 @item
1510 Incorrect handling of bit-fields with declared widths greater than that
1511 of their underlying types, when the bit-fields appear in a union.  For
1512 example:
1513
1514 @smallexample
1515 union U @{ int i : 4096; @};
1516 @end smallexample
1517
1518 @noindent
1519 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1520 union too small by the number of bits in an @code{int}.
1521
1522 @item
1523 Empty classes can be placed at incorrect offsets.  For example:
1524
1525 @smallexample
1526 struct A @{@};
1527
1528 struct B @{
1529   A a;
1530   virtual void f ();
1531 @};
1532
1533 struct C : public B, public A @{@};
1534 @end smallexample
1535
1536 @noindent
1537 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1538 it should be placed at offset zero.  G++ mistakenly believes that the
1539 @code{A} data member of @code{B} is already at offset zero.
1540
1541 @item
1542 Names of template functions whose types involve @code{typename} or
1543 template template parameters can be mangled incorrectly.
1544
1545 @smallexample
1546 template <typename Q>
1547 void f(typename Q::X) @{@}
1548
1549 template <template <typename> class Q>
1550 void f(typename Q<int>::X) @{@}
1551 @end smallexample
1552
1553 @noindent
1554 Instantiations of these templates may be mangled incorrectly.
1555
1556 @end itemize
1557
1558 @item -Wctor-dtor-privacy @r{(C++ only)}
1559 @opindex Wctor-dtor-privacy
1560 Warn when a class seems unusable because all the constructors or
1561 destructors in that class are private, and it has neither friends nor
1562 public static member functions.
1563
1564 @item -Wnon-virtual-dtor @r{(C++ only)}
1565 @opindex Wnon-virtual-dtor
1566 Warn when a class appears to be polymorphic, thereby requiring a virtual
1567 destructor, yet it declares a non-virtual one.
1568 This warning is enabled by @option{-Wall}.
1569
1570 @item -Wreorder @r{(C++ only)}
1571 @opindex Wreorder
1572 @cindex reordering, warning
1573 @cindex warning for reordering of member initializers
1574 Warn when the order of member initializers given in the code does not
1575 match the order in which they must be executed.  For instance:
1576
1577 @smallexample
1578 struct A @{
1579   int i;
1580   int j;
1581   A(): j (0), i (1) @{ @}
1582 @};
1583 @end smallexample
1584
1585 The compiler will rearrange the member initializers for @samp{i}
1586 and @samp{j} to match the declaration order of the members, emitting
1587 a warning to that effect.  This warning is enabled by @option{-Wall}.
1588 @end table
1589
1590 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1591
1592 @table @gcctabopt
1593 @item -Weffc++ @r{(C++ only)}
1594 @opindex Weffc++
1595 Warn about violations of the following style guidelines from Scott Meyers'
1596 @cite{Effective C++} book:
1597
1598 @itemize @bullet
1599 @item
1600 Item 11:  Define a copy constructor and an assignment operator for classes
1601 with dynamically allocated memory.
1602
1603 @item
1604 Item 12:  Prefer initialization to assignment in constructors.
1605
1606 @item
1607 Item 14:  Make destructors virtual in base classes.
1608
1609 @item
1610 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1611
1612 @item
1613 Item 23:  Don't try to return a reference when you must return an object.
1614
1615 @end itemize
1616
1617 Also warn about violations of the following style guidelines from
1618 Scott Meyers' @cite{More Effective C++} book:
1619
1620 @itemize @bullet
1621 @item
1622 Item 6:  Distinguish between prefix and postfix forms of increment and
1623 decrement operators.
1624
1625 @item
1626 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1627
1628 @end itemize
1629
1630 When selecting this option, be aware that the standard library
1631 headers do not obey all of these guidelines; use @samp{grep -v}
1632 to filter out those warnings.
1633
1634 @item -Wno-deprecated @r{(C++ only)}
1635 @opindex Wno-deprecated
1636 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1637
1638 @item -Wno-non-template-friend @r{(C++ only)}
1639 @opindex Wno-non-template-friend
1640 Disable warnings when non-templatized friend functions are declared
1641 within a template.  Since the advent of explicit template specification
1642 support in G++, if the name of the friend is an unqualified-id (i.e.,
1643 @samp{friend foo(int)}), the C++ language specification demands that the
1644 friend declare or define an ordinary, nontemplate function.  (Section
1645 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1646 could be interpreted as a particular specialization of a templatized
1647 function.  Because this non-conforming behavior is no longer the default
1648 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1649 check existing code for potential trouble spots and is on by default.
1650 This new compiler behavior can be turned off with
1651 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1652 but disables the helpful warning.
1653
1654 @item -Wold-style-cast @r{(C++ only)}
1655 @opindex Wold-style-cast
1656 Warn if an old-style (C-style) cast to a non-void type is used within
1657 a C++ program.  The new-style casts (@samp{static_cast},
1658 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1659 unintended effects and much easier to search for.
1660
1661 @item -Woverloaded-virtual @r{(C++ only)}
1662 @opindex Woverloaded-virtual
1663 @cindex overloaded virtual fn, warning
1664 @cindex warning for overloaded virtual fn
1665 Warn when a function declaration hides virtual functions from a
1666 base class.  For example, in:
1667
1668 @smallexample
1669 struct A @{
1670   virtual void f();
1671 @};
1672
1673 struct B: public A @{
1674   void f(int);
1675 @};
1676 @end smallexample
1677
1678 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1679 like:
1680
1681 @smallexample
1682 B* b;
1683 b->f();
1684 @end smallexample
1685
1686 will fail to compile.
1687
1688 @item -Wno-pmf-conversions @r{(C++ only)}
1689 @opindex Wno-pmf-conversions
1690 Disable the diagnostic for converting a bound pointer to member function
1691 to a plain pointer.
1692
1693 @item -Wsign-promo @r{(C++ only)}
1694 @opindex Wsign-promo
1695 Warn when overload resolution chooses a promotion from unsigned or
1696 enumeral type to a signed type, over a conversion to an unsigned type of
1697 the same size.  Previous versions of G++ would try to preserve
1698 unsignedness, but the standard mandates the current behavior.
1699
1700 @item -Wsynth @r{(C++ only)}
1701 @opindex Wsynth
1702 @cindex warning for synthesized methods
1703 @cindex synthesized methods, warning
1704 Warn when G++'s synthesis behavior does not match that of cfront.  For
1705 instance:
1706
1707 @smallexample
1708 struct A @{
1709   operator int ();
1710   A& operator = (int);
1711 @};
1712
1713 main ()
1714 @{
1715   A a,b;
1716   a = b;
1717 @}
1718 @end smallexample
1719
1720 In this example, G++ will synthesize a default @samp{A& operator =
1721 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1722 @end table
1723
1724 @node Objective-C Dialect Options
1725 @section Options Controlling Objective-C Dialect
1726
1727 @cindex compiler options, Objective-C
1728 @cindex Objective-C options, command line
1729 @cindex options, Objective-C
1730 (NOTE: This manual does not describe the Objective-C language itself.  See
1731 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1732
1733 This section describes the command-line options that are only meaningful
1734 for Objective-C programs, but you can also use most of the GNU compiler
1735 options regardless of what language your program is in.  For example,
1736 you might compile a file @code{some_class.m} like this:
1737
1738 @smallexample
1739 gcc -g -fgnu-runtime -O -c some_class.m
1740 @end smallexample
1741
1742 @noindent
1743 In this example, @option{-fgnu-runtime} is an option meant only for
1744 Objective-C programs; you can use the other options with any language
1745 supported by GCC@.
1746
1747 Here is a list of options that are @emph{only} for compiling Objective-C
1748 programs:
1749
1750 @table @gcctabopt
1751 @item -fconstant-string-class=@var{class-name}
1752 @opindex fconstant-string-class
1753 Use @var{class-name} as the name of the class to instantiate for each
1754 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1755 class name is @code{NXConstantString} if the GNU runtime is being used, and
1756 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1757 @option{-fconstant-cfstrings} option, if also present, will override the
1758 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1759 to be laid out as constant CoreFoundation strings.
1760
1761 @item -fgnu-runtime
1762 @opindex fgnu-runtime
1763 Generate object code compatible with the standard GNU Objective-C
1764 runtime.  This is the default for most types of systems.
1765
1766 @item -fnext-runtime
1767 @opindex fnext-runtime
1768 Generate output compatible with the NeXT runtime.  This is the default
1769 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1770 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1771 used.
1772
1773 @item -fno-nil-receivers
1774 @opindex -fno-nil-receivers
1775 Assume that all Objective-C message dispatches (e.g.,
1776 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1777 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1778 used.  Currently, this option is only available in conjunction with
1779 the NeXT runtime on Mac OS X 10.3 and later.
1780
1781 @item -fobjc-exceptions
1782 @opindex -fobjc-exceptions
1783 Enable syntactic support for structured exception handling in Objective-C,
1784 similar to what is offered by C++ and Java.  Currently, this option is only
1785 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1786
1787 @smallexample
1788   @@try @{
1789     @dots{}
1790        @@throw expr;
1791     @dots{}
1792   @}
1793   @@catch (AnObjCClass *exc) @{
1794     @dots{}
1795       @@throw expr;
1796     @dots{}
1797       @@throw;
1798     @dots{}
1799   @}
1800   @@catch (AnotherClass *exc) @{
1801     @dots{}
1802   @}
1803   @@catch (id allOthers) @{
1804     @dots{}
1805   @}
1806   @@finally @{
1807     @dots{}
1808       @@throw expr;
1809     @dots{}
1810   @}
1811 @end smallexample
1812
1813 The @code{@@throw} statement may appear anywhere in an Objective-C or
1814 Objective-C++ program; when used inside of a @code{@@catch} block, the
1815 @code{@@throw} may appear without an argument (as shown above), in which case
1816 the object caught by the @code{@@catch} will be rethrown.
1817
1818 Note that only (pointers to) Objective-C objects may be thrown and
1819 caught using this scheme.  When an object is thrown, it will be caught
1820 by the nearest @code{@@catch} clause capable of handling objects of that type,
1821 analogously to how @code{catch} blocks work in C++ and Java.  A
1822 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1823 any and all Objective-C exceptions not caught by previous @code{@@catch}
1824 clauses (if any).
1825
1826 The @code{@@finally} clause, if present, will be executed upon exit from the
1827 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1828 regardless of whether any exceptions are thrown, caught or rethrown
1829 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1830 of the @code{finally} clause in Java.
1831
1832 There are several caveats to using the new exception mechanism:
1833
1834 @itemize @bullet
1835 @item
1836 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1837 idioms provided by the @code{NSException} class, the new
1838 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1839 systems, due to additional functionality needed in the (NeXT) Objective-C
1840 runtime.
1841
1842 @item
1843 As mentioned above, the new exceptions do not support handling
1844 types other than Objective-C objects.   Furthermore, when used from
1845 Objective-C++, the Objective-C exception model does not interoperate with C++
1846 exceptions at this time.  This means you cannot @code{@@throw} an exception
1847 from Objective-C and @code{catch} it in C++, or vice versa
1848 (i.e., @code{throw @dots{} @@catch}).
1849 @end itemize
1850
1851 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1852 blocks for thread-safe execution:
1853
1854 @smallexample
1855   @@synchronized (ObjCClass *guard) @{
1856     @dots{}
1857   @}
1858 @end smallexample
1859
1860 Upon entering the @code{@@synchronized} block, a thread of execution shall
1861 first check whether a lock has been placed on the corresponding @code{guard}
1862 object by another thread.  If it has, the current thread shall wait until
1863 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1864 the current thread will place its own lock on it, execute the code contained in
1865 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1866 making @code{guard} available to other threads).
1867
1868 Unlike Java, Objective-C does not allow for entire methods to be marked
1869 @code{@@synchronized}.  Note that throwing exceptions out of
1870 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1871 to be unlocked properly.
1872
1873 @item -freplace-objc-classes
1874 @opindex -freplace-objc-classes
1875 Emit a special marker instructing @command{ld(1)} not to statically link in
1876 the resulting object file, and allow @command{dyld(1)} to load it in at
1877 run time instead.  This is used in conjunction with the Fix-and-Continue
1878 debugging mode, where the object file in question may be recompiled and
1879 dynamically reloaded in the course of program execution, without the need
1880 to restart the program itself.  Currently, Fix-and-Continue functionality
1881 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1882 and later.
1883
1884 @item -fzero-link
1885 @opindex -fzero-link
1886 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1887 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1888 compile time) with static class references that get initialized at load time,
1889 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1890 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1891 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1892 for individual class implementations to be modified during program execution.
1893
1894 @item -gen-decls
1895 @opindex gen-decls
1896 Dump interface declarations for all classes seen in the source file to a
1897 file named @file{@var{sourcename}.decl}.
1898
1899 @item -Wno-protocol
1900 @opindex Wno-protocol
1901 If a class is declared to implement a protocol, a warning is issued for
1902 every method in the protocol that is not implemented by the class.  The
1903 default behavior is to issue a warning for every method not explicitly
1904 implemented in the class, even if a method implementation is inherited
1905 from the superclass.  If you use the @code{-Wno-protocol} option, then
1906 methods inherited from the superclass are considered to be implemented,
1907 and no warning is issued for them.
1908
1909 @item -Wselector
1910 @opindex Wselector
1911 Warn if multiple methods of different types for the same selector are
1912 found during compilation.  The check is performed on the list of methods
1913 in the final stage of compilation.  Additionally, a check is performed
1914 for each selector appearing in a @code{@@selector(@dots{})}
1915 expression, and a corresponding method for that selector has been found
1916 during compilation.  Because these checks scan the method table only at
1917 the end of compilation, these warnings are not produced if the final
1918 stage of compilation is not reached, for example because an error is
1919 found during compilation, or because the @code{-fsyntax-only} option is
1920 being used.
1921
1922 @item -Wundeclared-selector
1923 @opindex Wundeclared-selector
1924 Warn if a @code{@@selector(@dots{})} expression referring to an
1925 undeclared selector is found.  A selector is considered undeclared if no
1926 method with that name has been declared before the
1927 @code{@@selector(@dots{})} expression, either explicitly in an
1928 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1929 an @code{@@implementation} section.  This option always performs its
1930 checks as soon as a @code{@@selector(@dots{})} expression is found,
1931 while @code{-Wselector} only performs its checks in the final stage of
1932 compilation.  This also enforces the coding style convention
1933 that methods and selectors must be declared before being used.
1934
1935 @item -print-objc-runtime-info
1936 @opindex -print-objc-runtime-info
1937 Generate C header describing the largest structure that is passed by
1938 value, if any.
1939
1940 @end table
1941
1942 @node Language Independent Options
1943 @section Options to Control Diagnostic Messages Formatting
1944 @cindex options to control diagnostics formatting
1945 @cindex diagnostic messages
1946 @cindex message formatting
1947
1948 Traditionally, diagnostic messages have been formatted irrespective of
1949 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1950 below can be used to control the diagnostic messages formatting
1951 algorithm, e.g.@: how many characters per line, how often source location
1952 information should be reported.  Right now, only the C++ front end can
1953 honor these options.  However it is expected, in the near future, that
1954 the remaining front ends would be able to digest them correctly.
1955
1956 @table @gcctabopt
1957 @item -fmessage-length=@var{n}
1958 @opindex fmessage-length
1959 Try to format error messages so that they fit on lines of about @var{n}
1960 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1961 the front ends supported by GCC@.  If @var{n} is zero, then no
1962 line-wrapping will be done; each error message will appear on a single
1963 line.
1964
1965 @opindex fdiagnostics-show-location
1966 @item -fdiagnostics-show-location=once
1967 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1968 reporter to emit @emph{once} source location information; that is, in
1969 case the message is too long to fit on a single physical line and has to
1970 be wrapped, the source location won't be emitted (as prefix) again,
1971 over and over, in subsequent continuation lines.  This is the default
1972 behavior.
1973
1974 @item -fdiagnostics-show-location=every-line
1975 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1976 messages reporter to emit the same source location information (as
1977 prefix) for physical lines that result from the process of breaking
1978 a message which is too long to fit on a single line.
1979
1980 @end table
1981
1982 @node Warning Options
1983 @section Options to Request or Suppress Warnings
1984 @cindex options to control warnings
1985 @cindex warning messages
1986 @cindex messages, warning
1987 @cindex suppressing warnings
1988
1989 Warnings are diagnostic messages that report constructions which
1990 are not inherently erroneous but which are risky or suggest there
1991 may have been an error.
1992
1993 You can request many specific warnings with options beginning @samp{-W},
1994 for example @option{-Wimplicit} to request warnings on implicit
1995 declarations.  Each of these specific warning options also has a
1996 negative form beginning @samp{-Wno-} to turn off warnings;
1997 for example, @option{-Wno-implicit}.  This manual lists only one of the
1998 two forms, whichever is not the default.
1999
2000 The following options control the amount and kinds of warnings produced
2001 by GCC; for further, language-specific options also refer to
2002 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2003
2004 @table @gcctabopt
2005 @cindex syntax checking
2006 @item -fsyntax-only
2007 @opindex fsyntax-only
2008 Check the code for syntax errors, but don't do anything beyond that.
2009
2010 @item -pedantic
2011 @opindex pedantic
2012 Issue all the warnings demanded by strict ISO C and ISO C++;
2013 reject all programs that use forbidden extensions, and some other
2014 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2015 version of the ISO C standard specified by any @option{-std} option used.
2016
2017 Valid ISO C and ISO C++ programs should compile properly with or without
2018 this option (though a rare few will require @option{-ansi} or a
2019 @option{-std} option specifying the required version of ISO C)@.  However,
2020 without this option, certain GNU extensions and traditional C and C++
2021 features are supported as well.  With this option, they are rejected.
2022
2023 @option{-pedantic} does not cause warning messages for use of the
2024 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2025 warnings are also disabled in the expression that follows
2026 @code{__extension__}.  However, only system header files should use
2027 these escape routes; application programs should avoid them.
2028 @xref{Alternate Keywords}.
2029
2030 Some users try to use @option{-pedantic} to check programs for strict ISO
2031 C conformance.  They soon find that it does not do quite what they want:
2032 it finds some non-ISO practices, but not all---only those for which
2033 ISO C @emph{requires} a diagnostic, and some others for which
2034 diagnostics have been added.
2035
2036 A feature to report any failure to conform to ISO C might be useful in
2037 some instances, but would require considerable additional work and would
2038 be quite different from @option{-pedantic}.  We don't have plans to
2039 support such a feature in the near future.
2040
2041 Where the standard specified with @option{-std} represents a GNU
2042 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2043 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2044 extended dialect is based.  Warnings from @option{-pedantic} are given
2045 where they are required by the base standard.  (It would not make sense
2046 for such warnings to be given only for features not in the specified GNU
2047 C dialect, since by definition the GNU dialects of C include all
2048 features the compiler supports with the given option, and there would be
2049 nothing to warn about.)
2050
2051 @item -pedantic-errors
2052 @opindex pedantic-errors
2053 Like @option{-pedantic}, except that errors are produced rather than
2054 warnings.
2055
2056 @item -w
2057 @opindex w
2058 Inhibit all warning messages.
2059
2060 @item -Wno-import
2061 @opindex Wno-import
2062 Inhibit warning messages about the use of @samp{#import}.
2063
2064 @item -Wchar-subscripts
2065 @opindex Wchar-subscripts
2066 Warn if an array subscript has type @code{char}.  This is a common cause
2067 of error, as programmers often forget that this type is signed on some
2068 machines.
2069
2070 @item -Wcomment
2071 @opindex Wcomment
2072 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2073 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2074
2075 @item -Wformat
2076 @opindex Wformat
2077 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2078 the arguments supplied have types appropriate to the format string
2079 specified, and that the conversions specified in the format string make
2080 sense.  This includes standard functions, and others specified by format
2081 attributes (@pxref{Function Attributes}), in the @code{printf},
2082 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2083 not in the C standard) families.
2084
2085 The formats are checked against the format features supported by GNU
2086 libc version 2.2.  These include all ISO C90 and C99 features, as well
2087 as features from the Single Unix Specification and some BSD and GNU
2088 extensions.  Other library implementations may not support all these
2089 features; GCC does not support warning about features that go beyond a
2090 particular library's limitations.  However, if @option{-pedantic} is used
2091 with @option{-Wformat}, warnings will be given about format features not
2092 in the selected standard version (but not for @code{strfmon} formats,
2093 since those are not in any version of the C standard).  @xref{C Dialect
2094 Options,,Options Controlling C Dialect}.
2095
2096 Since @option{-Wformat} also checks for null format arguments for
2097 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2098
2099 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2100 aspects of format checking, the options @option{-Wformat-y2k},
2101 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2102 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2103 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2104
2105 @item -Wformat-y2k
2106 @opindex Wformat-y2k
2107 If @option{-Wformat} is specified, also warn about @code{strftime}
2108 formats which may yield only a two-digit year.
2109
2110 @item -Wno-format-extra-args
2111 @opindex Wno-format-extra-args
2112 If @option{-Wformat} is specified, do not warn about excess arguments to a
2113 @code{printf} or @code{scanf} format function.  The C standard specifies
2114 that such arguments are ignored.
2115
2116 Where the unused arguments lie between used arguments that are
2117 specified with @samp{$} operand number specifications, normally
2118 warnings are still given, since the implementation could not know what
2119 type to pass to @code{va_arg} to skip the unused arguments.  However,
2120 in the case of @code{scanf} formats, this option will suppress the
2121 warning if the unused arguments are all pointers, since the Single
2122 Unix Specification says that such unused arguments are allowed.
2123
2124 @item -Wno-format-zero-length
2125 @opindex Wno-format-zero-length
2126 If @option{-Wformat} is specified, do not warn about zero-length formats.
2127 The C standard specifies that zero-length formats are allowed.
2128
2129 @item -Wformat-nonliteral
2130 @opindex Wformat-nonliteral
2131 If @option{-Wformat} is specified, also warn if the format string is not a
2132 string literal and so cannot be checked, unless the format function
2133 takes its format arguments as a @code{va_list}.
2134
2135 @item -Wformat-security
2136 @opindex Wformat-security
2137 If @option{-Wformat} is specified, also warn about uses of format
2138 functions that represent possible security problems.  At present, this
2139 warns about calls to @code{printf} and @code{scanf} functions where the
2140 format string is not a string literal and there are no format arguments,
2141 as in @code{printf (foo);}.  This may be a security hole if the format
2142 string came from untrusted input and contains @samp{%n}.  (This is
2143 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2144 in future warnings may be added to @option{-Wformat-security} that are not
2145 included in @option{-Wformat-nonliteral}.)
2146
2147 @item -Wformat=2
2148 @opindex Wformat=2
2149 Enable @option{-Wformat} plus format checks not included in
2150 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2151 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2152
2153 @item -Wnonnull
2154 @opindex Wnonnull
2155 Warn about passing a null pointer for arguments marked as
2156 requiring a non-null value by the @code{nonnull} function attribute.
2157
2158 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2159 can be disabled with the @option{-Wno-nonnull} option.
2160
2161 @item -Winit-self @r{(C, C++, and Objective-C only)}
2162 @opindex Winit-self
2163 Warn about uninitialized variables which are initialized with themselves.
2164 Note this option can only be used with the @option{-Wuninitialized} option,
2165 which in turn only works with @option{-O1} and above.
2166
2167 For example, GCC will warn about @code{i} being uninitialized in the
2168 following snippet only when @option{-Winit-self} has been specified:
2169 @smallexample
2170 @group
2171 int f()
2172 @{
2173   int i = i;
2174   return i;
2175 @}
2176 @end group
2177 @end smallexample
2178
2179 @item -Wimplicit-int
2180 @opindex Wimplicit-int
2181 Warn when a declaration does not specify a type.
2182
2183 @item -Wimplicit-function-declaration
2184 @itemx -Werror-implicit-function-declaration
2185 @opindex Wimplicit-function-declaration
2186 @opindex Werror-implicit-function-declaration
2187 Give a warning (or error) whenever a function is used before being
2188 declared.
2189
2190 @item -Wimplicit
2191 @opindex Wimplicit
2192 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2193
2194 @item -Wmain
2195 @opindex Wmain
2196 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2197 function with external linkage, returning int, taking either zero
2198 arguments, two, or three arguments of appropriate types.
2199
2200 @item -Wmissing-braces
2201 @opindex Wmissing-braces
2202 Warn if an aggregate or union initializer is not fully bracketed.  In
2203 the following example, the initializer for @samp{a} is not fully
2204 bracketed, but that for @samp{b} is fully bracketed.
2205
2206 @smallexample
2207 int a[2][2] = @{ 0, 1, 2, 3 @};
2208 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2209 @end smallexample
2210
2211 @item -Wparentheses
2212 @opindex Wparentheses
2213 Warn if parentheses are omitted in certain contexts, such
2214 as when there is an assignment in a context where a truth value
2215 is expected, or when operators are nested whose precedence people
2216 often get confused about.
2217
2218 Also warn about constructions where there may be confusion to which
2219 @code{if} statement an @code{else} branch belongs.  Here is an example of
2220 such a case:
2221
2222 @smallexample
2223 @group
2224 @{
2225   if (a)
2226     if (b)
2227       foo ();
2228   else
2229     bar ();
2230 @}
2231 @end group
2232 @end smallexample
2233
2234 In C, every @code{else} branch belongs to the innermost possible @code{if}
2235 statement, which in this example is @code{if (b)}.  This is often not
2236 what the programmer expected, as illustrated in the above example by
2237 indentation the programmer chose.  When there is the potential for this
2238 confusion, GCC will issue a warning when this flag is specified.
2239 To eliminate the warning, add explicit braces around the innermost
2240 @code{if} statement so there is no way the @code{else} could belong to
2241 the enclosing @code{if}.  The resulting code would look like this:
2242
2243 @smallexample
2244 @group
2245 @{
2246   if (a)
2247     @{
2248       if (b)
2249         foo ();
2250       else
2251         bar ();
2252     @}
2253 @}
2254 @end group
2255 @end smallexample
2256
2257 @item -Wsequence-point
2258 @opindex Wsequence-point
2259 Warn about code that may have undefined semantics because of violations
2260 of sequence point rules in the C standard.
2261
2262 The C standard defines the order in which expressions in a C program are
2263 evaluated in terms of @dfn{sequence points}, which represent a partial
2264 ordering between the execution of parts of the program: those executed
2265 before the sequence point, and those executed after it.  These occur
2266 after the evaluation of a full expression (one which is not part of a
2267 larger expression), after the evaluation of the first operand of a
2268 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2269 function is called (but after the evaluation of its arguments and the
2270 expression denoting the called function), and in certain other places.
2271 Other than as expressed by the sequence point rules, the order of
2272 evaluation of subexpressions of an expression is not specified.  All
2273 these rules describe only a partial order rather than a total order,
2274 since, for example, if two functions are called within one expression
2275 with no sequence point between them, the order in which the functions
2276 are called is not specified.  However, the standards committee have
2277 ruled that function calls do not overlap.
2278
2279 It is not specified when between sequence points modifications to the
2280 values of objects take effect.  Programs whose behavior depends on this
2281 have undefined behavior; the C standard specifies that ``Between the
2282 previous and next sequence point an object shall have its stored value
2283 modified at most once by the evaluation of an expression.  Furthermore,
2284 the prior value shall be read only to determine the value to be
2285 stored.''.  If a program breaks these rules, the results on any
2286 particular implementation are entirely unpredictable.
2287
2288 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2289 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2290 diagnosed by this option, and it may give an occasional false positive
2291 result, but in general it has been found fairly effective at detecting
2292 this sort of problem in programs.
2293
2294 The present implementation of this option only works for C programs.  A
2295 future implementation may also work for C++ programs.
2296
2297 The C standard is worded confusingly, therefore there is some debate
2298 over the precise meaning of the sequence point rules in subtle cases.
2299 Links to discussions of the problem, including proposed formal
2300 definitions, may be found on our readings page, at
2301 @w{@uref{http://gcc.gnu.org/readings.html}}.
2302
2303 @item -Wreturn-type
2304 @opindex Wreturn-type
2305 Warn whenever a function is defined with a return-type that defaults to
2306 @code{int}.  Also warn about any @code{return} statement with no
2307 return-value in a function whose return-type is not @code{void}.
2308
2309 For C++, a function without return type always produces a diagnostic
2310 message, even when @option{-Wno-return-type} is specified.  The only
2311 exceptions are @samp{main} and functions defined in system headers.
2312
2313 @item -Wswitch
2314 @opindex Wswitch
2315 Warn whenever a @code{switch} statement has an index of enumeral type
2316 and lacks a @code{case} for one or more of the named codes of that
2317 enumeration.  (The presence of a @code{default} label prevents this
2318 warning.)  @code{case} labels outside the enumeration range also
2319 provoke warnings when this option is used.
2320
2321 @item -Wswitch-default
2322 @opindex Wswitch-switch
2323 Warn whenever a @code{switch} statement does not have a @code{default}
2324 case.
2325
2326 @item -Wswitch-enum
2327 @opindex Wswitch-enum
2328 Warn whenever a @code{switch} statement has an index of enumeral type
2329 and lacks a @code{case} for one or more of the named codes of that
2330 enumeration.  @code{case} labels outside the enumeration range also
2331 provoke warnings when this option is used.
2332
2333 @item -Wtrigraphs
2334 @opindex Wtrigraphs
2335 Warn if any trigraphs are encountered that might change the meaning of
2336 the program (trigraphs within comments are not warned about).
2337
2338 @item -Wunused-function
2339 @opindex Wunused-function
2340 Warn whenever a static function is declared but not defined or a
2341 non\-inline static function is unused.
2342
2343 @item -Wunused-label
2344 @opindex Wunused-label
2345 Warn whenever a label is declared but not used.
2346
2347 To suppress this warning use the @samp{unused} attribute
2348 (@pxref{Variable Attributes}).
2349
2350 @item -Wunused-parameter
2351 @opindex Wunused-parameter
2352 Warn whenever a function parameter is unused aside from its declaration.
2353
2354 To suppress this warning use the @samp{unused} attribute
2355 (@pxref{Variable Attributes}).
2356
2357 @item -Wunused-variable
2358 @opindex Wunused-variable
2359 Warn whenever a local variable or non-constant static variable is unused
2360 aside from its declaration
2361
2362 To suppress this warning use the @samp{unused} attribute
2363 (@pxref{Variable Attributes}).
2364
2365 @item -Wunused-value
2366 @opindex Wunused-value
2367 Warn whenever a statement computes a result that is explicitly not used.
2368
2369 To suppress this warning cast the expression to @samp{void}.
2370
2371 @item -Wunused
2372 @opindex Wunused
2373 All the above @option{-Wunused} options combined.
2374
2375 In order to get a warning about an unused function parameter, you must
2376 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2377 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2378
2379 @item -Wuninitialized
2380 @opindex Wuninitialized
2381 Warn if an automatic variable is used without first being initialized or
2382 if a variable may be clobbered by a @code{setjmp} call.
2383
2384 These warnings are possible only in optimizing compilation,
2385 because they require data flow information that is computed only
2386 when optimizing.  If you don't specify @option{-O}, you simply won't
2387 get these warnings.
2388
2389 If you want to warn about code which uses the uninitialized value of the
2390 variable in its own initializer, use the @option{-Winit-self} option.
2391
2392 These warnings occur only for variables that are candidates for
2393 register allocation.  Therefore, they do not occur for a variable that
2394 is declared @code{volatile}, or whose address is taken, or whose size
2395 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2396 structures, unions or arrays, even when they are in registers.
2397
2398 Note that there may be no warning about a variable that is used only
2399 to compute a value that itself is never used, because such
2400 computations may be deleted by data flow analysis before the warnings
2401 are printed.
2402
2403 These warnings are made optional because GCC is not smart
2404 enough to see all the reasons why the code might be correct
2405 despite appearing to have an error.  Here is one example of how
2406 this can happen:
2407
2408 @smallexample
2409 @group
2410 @{
2411   int x;
2412   switch (y)
2413     @{
2414     case 1: x = 1;
2415       break;
2416     case 2: x = 4;
2417       break;
2418     case 3: x = 5;
2419     @}
2420   foo (x);
2421 @}
2422 @end group
2423 @end smallexample
2424
2425 @noindent
2426 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2427 always initialized, but GCC doesn't know this.  Here is
2428 another common case:
2429
2430 @smallexample
2431 @{
2432   int save_y;
2433   if (change_y) save_y = y, y = new_y;
2434   @dots{}
2435   if (change_y) y = save_y;
2436 @}
2437 @end smallexample
2438
2439 @noindent
2440 This has no bug because @code{save_y} is used only if it is set.
2441
2442 @cindex @code{longjmp} warnings
2443 This option also warns when a non-volatile automatic variable might be
2444 changed by a call to @code{longjmp}.  These warnings as well are possible
2445 only in optimizing compilation.
2446
2447 The compiler sees only the calls to @code{setjmp}.  It cannot know
2448 where @code{longjmp} will be called; in fact, a signal handler could
2449 call it at any point in the code.  As a result, you may get a warning
2450 even when there is in fact no problem because @code{longjmp} cannot
2451 in fact be called at the place which would cause a problem.
2452
2453 Some spurious warnings can be avoided if you declare all the functions
2454 you use that never return as @code{noreturn}.  @xref{Function
2455 Attributes}.
2456
2457 @item -Wunknown-pragmas
2458 @opindex Wunknown-pragmas
2459 @cindex warning for unknown pragmas
2460 @cindex unknown pragmas, warning
2461 @cindex pragmas, warning of unknown
2462 Warn when a #pragma directive is encountered which is not understood by
2463 GCC@.  If this command line option is used, warnings will even be issued
2464 for unknown pragmas in system header files.  This is not the case if
2465 the warnings were only enabled by the @option{-Wall} command line option.
2466
2467 @item -Wstrict-aliasing
2468 @opindex Wstrict-aliasing
2469 This option is only active when @option{-fstrict-aliasing} is active.
2470 It warns about code which might break the strict aliasing rules that the
2471 compiler is using for optimization. The warning does not catch all
2472 cases, but does attempt to catch the more common pitfalls. It is
2473 included in @option{-Wall}.
2474
2475 @item -Wall
2476 @opindex Wall
2477 All of the above @samp{-W} options combined.  This enables all the
2478 warnings about constructions that some users consider questionable, and
2479 that are easy to avoid (or modify to prevent the warning), even in
2480 conjunction with macros.  This also enables some language-specific
2481 warnings described in @ref{C++ Dialect Options} and
2482 @ref{Objective-C Dialect Options}.
2483 @end table
2484
2485 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2486 Some of them warn about constructions that users generally do not
2487 consider questionable, but which occasionally you might wish to check
2488 for; others warn about constructions that are necessary or hard to avoid
2489 in some cases, and there is no simple way to modify the code to suppress
2490 the warning.
2491
2492 @table @gcctabopt
2493 @item -Wextra
2494 @opindex W
2495 @opindex Wextra
2496 (This option used to be called @option{-W}.  The older name is still
2497 supported, but the newer name is more descriptive.)  Print extra warning
2498 messages for these events:
2499
2500 @itemize @bullet
2501 @item
2502 A function can return either with or without a value.  (Falling
2503 off the end of the function body is considered returning without
2504 a value.)  For example, this function would evoke such a
2505 warning:
2506
2507 @smallexample
2508 @group
2509 foo (a)
2510 @{
2511   if (a > 0)
2512     return a;
2513 @}
2514 @end group
2515 @end smallexample
2516
2517 @item
2518 An expression-statement or the left-hand side of a comma expression
2519 contains no side effects.
2520 To suppress the warning, cast the unused expression to void.
2521 For example, an expression such as @samp{x[i,j]} will cause a warning,
2522 but @samp{x[(void)i,j]} will not.
2523
2524 @item
2525 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2526
2527 @item
2528 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2529 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2530 that of ordinary mathematical notation.
2531
2532 @item
2533 Storage-class specifiers like @code{static} are not the first things in
2534 a declaration.  According to the C Standard, this usage is obsolescent.
2535
2536 @item
2537 The return type of a function has a type qualifier such as @code{const}.
2538 Such a type qualifier has no effect, since the value returned by a
2539 function is not an lvalue.  (But don't warn about the GNU extension of
2540 @code{volatile void} return types.  That extension will be warned about
2541 if @option{-pedantic} is specified.)
2542
2543 @item
2544 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2545 arguments.
2546
2547 @item
2548 A comparison between signed and unsigned values could produce an
2549 incorrect result when the signed value is converted to unsigned.
2550 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2551
2552 @item
2553 An aggregate has an initializer which does not initialize all members.
2554 For example, the following code would cause such a warning, because
2555 @code{x.h} would be implicitly initialized to zero:
2556
2557 @smallexample
2558 struct s @{ int f, g, h; @};
2559 struct s x = @{ 3, 4 @};
2560 @end smallexample
2561
2562 @item
2563 A function parameter is declared without a type specifier in K&R-style
2564 functions:
2565
2566 @smallexample
2567 void foo(bar) @{ @}
2568 @end smallexample
2569
2570 @item
2571 An empty body occurs in an @samp{if} or @samp{else} statement.
2572
2573 @item
2574 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2575 @samp{>}, or @samp{>=}.
2576
2577 @item
2578 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2579
2580 @item
2581 Any of several floating-point events that often indicate errors, such as
2582 overflow, underflow, loss of precision, etc.
2583
2584 @item @r{(C++ only)}
2585 An enumerator and a non-enumerator both appear in a conditional expression.
2586
2587 @item @r{(C++ only)}
2588 A non-static reference or non-static @samp{const} member appears in a
2589 class without constructors.
2590
2591 @item @r{(C++ only)}
2592 Ambiguous virtual bases.
2593
2594 @item @r{(C++ only)}
2595 Subscripting an array which has been declared @samp{register}.
2596
2597 @item @r{(C++ only)}
2598 Taking the address of a variable which has been declared @samp{register}.
2599
2600 @item @r{(C++ only)}
2601 A base class is not initialized in a derived class' copy constructor.
2602 @end itemize
2603
2604 @item -Wno-div-by-zero
2605 @opindex Wno-div-by-zero
2606 @opindex Wdiv-by-zero
2607 Do not warn about compile-time integer division by zero.  Floating point
2608 division by zero is not warned about, as it can be a legitimate way of
2609 obtaining infinities and NaNs.
2610
2611 @item -Wsystem-headers
2612 @opindex Wsystem-headers
2613 @cindex warnings from system headers
2614 @cindex system headers, warnings from
2615 Print warning messages for constructs found in system header files.
2616 Warnings from system headers are normally suppressed, on the assumption
2617 that they usually do not indicate real problems and would only make the
2618 compiler output harder to read.  Using this command line option tells
2619 GCC to emit warnings from system headers as if they occurred in user
2620 code.  However, note that using @option{-Wall} in conjunction with this
2621 option will @emph{not} warn about unknown pragmas in system
2622 headers---for that, @option{-Wunknown-pragmas} must also be used.
2623
2624 @item -Wfloat-equal
2625 @opindex Wfloat-equal
2626 Warn if floating point values are used in equality comparisons.
2627
2628 The idea behind this is that sometimes it is convenient (for the
2629 programmer) to consider floating-point values as approximations to
2630 infinitely precise real numbers.  If you are doing this, then you need
2631 to compute (by analyzing the code, or in some other way) the maximum or
2632 likely maximum error that the computation introduces, and allow for it
2633 when performing comparisons (and when producing output, but that's a
2634 different problem).  In particular, instead of testing for equality, you
2635 would check to see whether the two values have ranges that overlap; and
2636 this is done with the relational operators, so equality comparisons are
2637 probably mistaken.
2638
2639 @item -Wtraditional @r{(C only)}
2640 @opindex Wtraditional
2641 Warn about certain constructs that behave differently in traditional and
2642 ISO C@.  Also warn about ISO C constructs that have no traditional C
2643 equivalent, and/or problematic constructs which should be avoided.
2644
2645 @itemize @bullet
2646 @item
2647 Macro parameters that appear within string literals in the macro body.
2648 In traditional C macro replacement takes place within string literals,
2649 but does not in ISO C@.
2650
2651 @item
2652 In traditional C, some preprocessor directives did not exist.
2653 Traditional preprocessors would only consider a line to be a directive
2654 if the @samp{#} appeared in column 1 on the line.  Therefore
2655 @option{-Wtraditional} warns about directives that traditional C
2656 understands but would ignore because the @samp{#} does not appear as the
2657 first character on the line.  It also suggests you hide directives like
2658 @samp{#pragma} not understood by traditional C by indenting them.  Some
2659 traditional implementations would not recognize @samp{#elif}, so it
2660 suggests avoiding it altogether.
2661
2662 @item
2663 A function-like macro that appears without arguments.
2664
2665 @item
2666 The unary plus operator.
2667
2668 @item
2669 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2670 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2671 constants.)  Note, these suffixes appear in macros defined in the system
2672 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2673 Use of these macros in user code might normally lead to spurious
2674 warnings, however gcc's integrated preprocessor has enough context to
2675 avoid warning in these cases.
2676
2677 @item
2678 A function declared external in one block and then used after the end of
2679 the block.
2680
2681 @item
2682 A @code{switch} statement has an operand of type @code{long}.
2683
2684 @item
2685 A non-@code{static} function declaration follows a @code{static} one.
2686 This construct is not accepted by some traditional C compilers.
2687
2688 @item
2689 The ISO type of an integer constant has a different width or
2690 signedness from its traditional type.  This warning is only issued if
2691 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2692 typically represent bit patterns, are not warned about.
2693
2694 @item
2695 Usage of ISO string concatenation is detected.
2696
2697 @item
2698 Initialization of automatic aggregates.
2699
2700 @item
2701 Identifier conflicts with labels.  Traditional C lacks a separate
2702 namespace for labels.
2703
2704 @item
2705 Initialization of unions.  If the initializer is zero, the warning is
2706 omitted.  This is done under the assumption that the zero initializer in
2707 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2708 initializer warnings and relies on default initialization to zero in the
2709 traditional C case.
2710
2711 @item
2712 Conversions by prototypes between fixed/floating point values and vice
2713 versa.  The absence of these prototypes when compiling with traditional
2714 C would cause serious problems.  This is a subset of the possible
2715 conversion warnings, for the full set use @option{-Wconversion}.
2716
2717 @item
2718 Use of ISO C style function definitions.  This warning intentionally is
2719 @emph{not} issued for prototype declarations or variadic functions
2720 because these ISO C features will appear in your code when using
2721 libiberty's traditional C compatibility macros, @code{PARAMS} and
2722 @code{VPARAMS}.  This warning is also bypassed for nested functions
2723 because that feature is already a gcc extension and thus not relevant to
2724 traditional C compatibility.
2725 @end itemize
2726
2727 @item -Wdeclaration-after-statement @r{(C only)}
2728 @opindex Wdeclaration-after-statement
2729 Warn when a declaration is found after a statement in a block.  This
2730 construct, known from C++, was introduced with ISO C99 and is by default
2731 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2732 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2733
2734 @item -Wundef
2735 @opindex Wundef
2736 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2737
2738 @item -Wendif-labels
2739 @opindex Wendif-labels
2740 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2741
2742 @item -Wshadow
2743 @opindex Wshadow
2744 Warn whenever a local variable shadows another local variable, parameter or
2745 global variable or whenever a built-in function is shadowed.
2746
2747 @item -Wlarger-than-@var{len}
2748 @opindex Wlarger-than
2749 Warn whenever an object of larger than @var{len} bytes is defined.
2750
2751 @item -Wpointer-arith
2752 @opindex Wpointer-arith
2753 Warn about anything that depends on the ``size of'' a function type or
2754 of @code{void}.  GNU C assigns these types a size of 1, for
2755 convenience in calculations with @code{void *} pointers and pointers
2756 to functions.
2757
2758 @item -Wbad-function-cast @r{(C only)}
2759 @opindex Wbad-function-cast
2760 Warn whenever a function call is cast to a non-matching type.
2761 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2762
2763 @item -Wcast-qual
2764 @opindex Wcast-qual
2765 Warn whenever a pointer is cast so as to remove a type qualifier from
2766 the target type.  For example, warn if a @code{const char *} is cast
2767 to an ordinary @code{char *}.
2768
2769 @item -Wcast-align
2770 @opindex Wcast-align
2771 Warn whenever a pointer is cast such that the required alignment of the
2772 target is increased.  For example, warn if a @code{char *} is cast to
2773 an @code{int *} on machines where integers can only be accessed at
2774 two- or four-byte boundaries.
2775
2776 @item -Wwrite-strings
2777 @opindex Wwrite-strings
2778 When compiling C, give string constants the type @code{const
2779 char[@var{length}]} so that
2780 copying the address of one into a non-@code{const} @code{char *}
2781 pointer will get a warning; when compiling C++, warn about the
2782 deprecated conversion from string constants to @code{char *}.
2783 These warnings will help you find at
2784 compile time code that can try to write into a string constant, but
2785 only if you have been very careful about using @code{const} in
2786 declarations and prototypes.  Otherwise, it will just be a nuisance;
2787 this is why we did not make @option{-Wall} request these warnings.
2788
2789 @item -Wconversion
2790 @opindex Wconversion
2791 Warn if a prototype causes a type conversion that is different from what
2792 would happen to the same argument in the absence of a prototype.  This
2793 includes conversions of fixed point to floating and vice versa, and
2794 conversions changing the width or signedness of a fixed point argument
2795 except when the same as the default promotion.
2796
2797 Also, warn if a negative integer constant expression is implicitly
2798 converted to an unsigned type.  For example, warn about the assignment
2799 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2800 casts like @code{(unsigned) -1}.
2801
2802 @item -Wsign-compare
2803 @opindex Wsign-compare
2804 @cindex warning for comparison of signed and unsigned values
2805 @cindex comparison of signed and unsigned values, warning
2806 @cindex signed and unsigned values, comparison warning
2807 Warn when a comparison between signed and unsigned values could produce
2808 an incorrect result when the signed value is converted to unsigned.
2809 This warning is also enabled by @option{-Wextra}; to get the other warnings
2810 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2811
2812 @item -Waggregate-return
2813 @opindex Waggregate-return
2814 Warn if any functions that return structures or unions are defined or
2815 called.  (In languages where you can return an array, this also elicits
2816 a warning.)
2817
2818 @item -Wstrict-prototypes @r{(C only)}
2819 @opindex Wstrict-prototypes
2820 Warn if a function is declared or defined without specifying the
2821 argument types.  (An old-style function definition is permitted without
2822 a warning if preceded by a declaration which specifies the argument
2823 types.)
2824
2825 @item -Wold-style-definition @r{(C only)}
2826 @opindex Wold-style-definition
2827 Warn if an old-style function definition is used.  A warning is given
2828 even if there is a previous prototype.
2829
2830 @item -Wmissing-prototypes @r{(C only)}
2831 @opindex Wmissing-prototypes
2832 Warn if a global function is defined without a previous prototype
2833 declaration.  This warning is issued even if the definition itself
2834 provides a prototype.  The aim is to detect global functions that fail
2835 to be declared in header files.
2836
2837 @item -Wmissing-declarations @r{(C only)}
2838 @opindex Wmissing-declarations
2839 Warn if a global function is defined without a previous declaration.
2840 Do so even if the definition itself provides a prototype.
2841 Use this option to detect global functions that are not declared in
2842 header files.
2843
2844 @item -Wmissing-noreturn
2845 @opindex Wmissing-noreturn
2846 Warn about functions which might be candidates for attribute @code{noreturn}.
2847 Note these are only possible candidates, not absolute ones.  Care should
2848 be taken to manually verify functions actually do not ever return before
2849 adding the @code{noreturn} attribute, otherwise subtle code generation
2850 bugs could be introduced.  You will not get a warning for @code{main} in
2851 hosted C environments.
2852
2853 @item -Wmissing-format-attribute
2854 @opindex Wmissing-format-attribute
2855 @opindex Wformat
2856 If @option{-Wformat} is enabled, also warn about functions which might be
2857 candidates for @code{format} attributes.  Note these are only possible
2858 candidates, not absolute ones.  GCC will guess that @code{format}
2859 attributes might be appropriate for any function that calls a function
2860 like @code{vprintf} or @code{vscanf}, but this might not always be the
2861 case, and some functions for which @code{format} attributes are
2862 appropriate may not be detected.  This option has no effect unless
2863 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2864
2865 @item -Wno-multichar
2866 @opindex Wno-multichar
2867 @opindex Wmultichar
2868 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2869 Usually they indicate a typo in the user's code, as they have
2870 implementation-defined values, and should not be used in portable code.
2871
2872 @item -Wno-deprecated-declarations
2873 @opindex Wno-deprecated-declarations
2874 Do not warn about uses of functions, variables, and types marked as
2875 deprecated by using the @code{deprecated} attribute.
2876 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2877 @pxref{Type Attributes}.)
2878
2879 @item -Wpacked
2880 @opindex Wpacked
2881 Warn if a structure is given the packed attribute, but the packed
2882 attribute has no effect on the layout or size of the structure.
2883 Such structures may be mis-aligned for little benefit.  For
2884 instance, in this code, the variable @code{f.x} in @code{struct bar}
2885 will be misaligned even though @code{struct bar} does not itself
2886 have the packed attribute:
2887
2888 @smallexample
2889 @group
2890 struct foo @{
2891   int x;
2892   char a, b, c, d;
2893 @} __attribute__((packed));
2894 struct bar @{
2895   char z;
2896   struct foo f;
2897 @};
2898 @end group
2899 @end smallexample
2900
2901 @item -Wpadded
2902 @opindex Wpadded
2903 Warn if padding is included in a structure, either to align an element
2904 of the structure or to align the whole structure.  Sometimes when this
2905 happens it is possible to rearrange the fields of the structure to
2906 reduce the padding and so make the structure smaller.
2907
2908 @item -Wredundant-decls
2909 @opindex Wredundant-decls
2910 Warn if anything is declared more than once in the same scope, even in
2911 cases where multiple declaration is valid and changes nothing.
2912
2913 @item -Wnested-externs @r{(C only)}
2914 @opindex Wnested-externs
2915 Warn if an @code{extern} declaration is encountered within a function.
2916
2917 @item -Wunreachable-code
2918 @opindex Wunreachable-code
2919 Warn if the compiler detects that code will never be executed.
2920
2921 This option is intended to warn when the compiler detects that at
2922 least a whole line of source code will never be executed, because
2923 some condition is never satisfied or because it is after a
2924 procedure that never returns.
2925
2926 It is possible for this option to produce a warning even though there
2927 are circumstances under which part of the affected line can be executed,
2928 so care should be taken when removing apparently-unreachable code.
2929
2930 For instance, when a function is inlined, a warning may mean that the
2931 line is unreachable in only one inlined copy of the function.
2932
2933 This option is not made part of @option{-Wall} because in a debugging
2934 version of a program there is often substantial code which checks
2935 correct functioning of the program and is, hopefully, unreachable
2936 because the program does work.  Another common use of unreachable
2937 code is to provide behavior which is selectable at compile-time.
2938
2939 @item -Winline
2940 @opindex Winline
2941 Warn if a function can not be inlined and it was declared as inline.
2942 Even with this option, the compiler will not warn about failures to
2943 inline functions declared in system headers.
2944
2945 The compiler uses a variety of heuristics to determine whether or not
2946 to inline a function.  For example, the compiler takes into account
2947 the size of the function being inlined and the the amount of inlining
2948 that has already been done in the current function.  Therefore,
2949 seemingly insignificant changes in the source program can cause the
2950 warnings produced by @option{-Winline} to appear or disappear.
2951
2952 @item -Wno-invalid-offsetof @r{(C++ only)}
2953 @opindex Wno-invalid-offsetof
2954 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2955 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2956 to a non-POD type is undefined.  In existing C++ implementations,
2957 however, @samp{offsetof} typically gives meaningful results even when
2958 applied to certain kinds of non-POD types. (Such as a simple
2959 @samp{struct} that fails to be a POD type only by virtue of having a
2960 constructor.)  This flag is for users who are aware that they are
2961 writing nonportable code and who have deliberately chosen to ignore the
2962 warning about it.
2963
2964 The restrictions on @samp{offsetof} may be relaxed in a future version
2965 of the C++ standard.
2966
2967 @item -Winvalid-pch
2968 @opindex Winvalid-pch
2969 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2970 the search path but can't be used.
2971
2972 @item -Wlong-long
2973 @opindex Wlong-long
2974 @opindex Wno-long-long
2975 Warn if @samp{long long} type is used.  This is default.  To inhibit
2976 the warning messages, use @option{-Wno-long-long}.  Flags
2977 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2978 only when @option{-pedantic} flag is used.
2979
2980 @item -Wdisabled-optimization
2981 @opindex Wdisabled-optimization
2982 Warn if a requested optimization pass is disabled.  This warning does
2983 not generally indicate that there is anything wrong with your code; it
2984 merely indicates that GCC's optimizers were unable to handle the code
2985 effectively.  Often, the problem is that your code is too big or too
2986 complex; GCC will refuse to optimize programs when the optimization
2987 itself is likely to take inordinate amounts of time.
2988
2989 @item -Werror
2990 @opindex Werror
2991 Make all warnings into errors.
2992 @end table
2993
2994 @node Debugging Options
2995 @section Options for Debugging Your Program or GCC
2996 @cindex options, debugging
2997 @cindex debugging information options
2998
2999 GCC has various special options that are used for debugging
3000 either your program or GCC:
3001
3002 @table @gcctabopt
3003 @item -g
3004 @opindex g
3005 Produce debugging information in the operating system's native format
3006 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3007 information.
3008
3009 On most systems that use stabs format, @option{-g} enables use of extra
3010 debugging information that only GDB can use; this extra information
3011 makes debugging work better in GDB but will probably make other debuggers
3012 crash or
3013 refuse to read the program.  If you want to control for certain whether
3014 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3015 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3016
3017 Unlike most other C compilers, GCC allows you to use @option{-g} with
3018 @option{-O}.  The shortcuts taken by optimized code may occasionally
3019 produce surprising results: some variables you declared may not exist
3020 at all; flow of control may briefly move where you did not expect it;
3021 some statements may not be executed because they compute constant
3022 results or their values were already at hand; some statements may
3023 execute in different places because they were moved out of loops.
3024
3025 Nevertheless it proves possible to debug optimized output.  This makes
3026 it reasonable to use the optimizer for programs that might have bugs.
3027
3028 The following options are useful when GCC is generated with the
3029 capability for more than one debugging format.
3030
3031 @item -ggdb
3032 @opindex ggdb
3033 Produce debugging information for use by GDB@.  This means to use the
3034 most expressive format available (DWARF 2, stabs, or the native format
3035 if neither of those are supported), including GDB extensions if at all
3036 possible.
3037
3038 @item -gstabs
3039 @opindex gstabs
3040 Produce debugging information in stabs format (if that is supported),
3041 without GDB extensions.  This is the format used by DBX on most BSD
3042 systems.  On MIPS, Alpha and System V Release 4 systems this option
3043 produces stabs debugging output which is not understood by DBX or SDB@.
3044 On System V Release 4 systems this option requires the GNU assembler.
3045
3046 @item -feliminate-unused-debug-symbols
3047 @opindex feliminate-unused-debug-symbols
3048 Produce debugging information in stabs format (if that is supported),
3049 for only symbols that are actually used.
3050
3051 @item -gstabs+
3052 @opindex gstabs+
3053 Produce debugging information in stabs format (if that is supported),
3054 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3055 use of these extensions is likely to make other debuggers crash or
3056 refuse to read the program.
3057
3058 @item -gcoff
3059 @opindex gcoff
3060 Produce debugging information in COFF format (if that is supported).
3061 This is the format used by SDB on most System V systems prior to
3062 System V Release 4.
3063
3064 @item -gxcoff
3065 @opindex gxcoff
3066 Produce debugging information in XCOFF format (if that is supported).
3067 This is the format used by the DBX debugger on IBM RS/6000 systems.
3068
3069 @item -gxcoff+
3070 @opindex gxcoff+
3071 Produce debugging information in XCOFF format (if that is supported),
3072 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3073 use of these extensions is likely to make other debuggers crash or
3074 refuse to read the program, and may cause assemblers other than the GNU
3075 assembler (GAS) to fail with an error.
3076
3077 @item -gdwarf-2
3078 @opindex gdwarf-2
3079 Produce debugging information in DWARF version 2 format (if that is
3080 supported).  This is the format used by DBX on IRIX 6.
3081
3082 @item -gvms
3083 @opindex gvms
3084 Produce debugging information in VMS debug format (if that is
3085 supported).  This is the format used by DEBUG on VMS systems.
3086
3087 @item -g@var{level}
3088 @itemx -ggdb@var{level}
3089 @itemx -gstabs@var{level}
3090 @itemx -gcoff@var{level}
3091 @itemx -gxcoff@var{level}
3092 @itemx -gvms@var{level}
3093 Request debugging information and also use @var{level} to specify how
3094 much information.  The default level is 2.
3095
3096 Level 1 produces minimal information, enough for making backtraces in
3097 parts of the program that you don't plan to debug.  This includes
3098 descriptions of functions and external variables, but no information
3099 about local variables and no line numbers.
3100
3101 Level 3 includes extra information, such as all the macro definitions
3102 present in the program.  Some debuggers support macro expansion when
3103 you use @option{-g3}.
3104
3105 Note that in order to avoid confusion between DWARF1 debug level 2,
3106 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3107 level.  Instead use an additional @option{-g@var{level}} option to
3108 change the debug level for DWARF2.
3109
3110 @item -feliminate-dwarf2-dups
3111 @opindex feliminate-dwarf2-dups
3112 Compress DWARF2 debugging information by eliminating duplicated
3113 information about each symbol.  This option only makes sense when
3114 generating DWARF2 debugging information with @option{-gdwarf-2}.
3115
3116 @cindex @command{prof}
3117 @item -p
3118 @opindex p
3119 Generate extra code to write profile information suitable for the
3120 analysis program @command{prof}.  You must use this option when compiling
3121 the source files you want data about, and you must also use it when
3122 linking.
3123
3124 @cindex @command{gprof}
3125 @item -pg
3126 @opindex pg
3127 Generate extra code to write profile information suitable for the
3128 analysis program @command{gprof}.  You must use this option when compiling
3129 the source files you want data about, and you must also use it when
3130 linking.
3131
3132 @item -Q
3133 @opindex Q
3134 Makes the compiler print out each function name as it is compiled, and
3135 print some statistics about each pass when it finishes.
3136
3137 @item -ftime-report
3138 @opindex ftime-report
3139 Makes the compiler print some statistics about the time consumed by each
3140 pass when it finishes.
3141
3142 @item -fmem-report
3143 @opindex fmem-report
3144 Makes the compiler print some statistics about permanent memory
3145 allocation when it finishes.
3146
3147 @item -fprofile-arcs
3148 @opindex fprofile-arcs
3149 Add code so that program flow @dfn{arcs} are instrumented.  During
3150 execution the program records how many times each branch and call is
3151 executed and how many times it is taken or returns.  When the compiled
3152 program exits it saves this data to a file called
3153 @file{@var{auxname}.gcda} for each source file. The data may be used for
3154 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3155 test coverage analysis (@option{-ftest-coverage}). Each object file's
3156 @var{auxname} is generated from the name of the output file, if
3157 explicitly specified and it is not the final executable, otherwise it is
3158 the basename of the source file. In both cases any suffix is removed
3159 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3160 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3161
3162 @itemize
3163
3164 @item
3165 Compile the source files with @option{-fprofile-arcs} plus optimization
3166 and code generation options. For test coverage analysis, use the
3167 additional @option{-ftest-coverage} option. You do not need to profile
3168 every source file in a program.
3169
3170 @item
3171 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3172 (the latter implies the former).
3173
3174 @item
3175 Run the program on a representative workload to generate the arc profile
3176 information. This may be repeated any number of times. You can run
3177 concurrent instances of your program, and provided that the file system
3178 supports locking, the data files will be correctly updated. Also
3179 @code{fork} calls are detected and correctly handled (double counting
3180 will not happen).
3181
3182 @item
3183 For profile-directed optimizations, compile the source files again with
3184 the same optimization and code generation options plus
3185 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3186 Control Optimization}).
3187
3188 @item
3189 For test coverage analysis, use @command{gcov} to produce human readable
3190 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3191 @command{gcov} documentation for further information.
3192
3193 @end itemize
3194
3195 With @option{-fprofile-arcs}, for each function of your program GCC
3196 creates a program flow graph, then finds a spanning tree for the graph.
3197 Only arcs that are not on the spanning tree have to be instrumented: the
3198 compiler adds code to count the number of times that these arcs are
3199 executed.  When an arc is the only exit or only entrance to a block, the
3200 instrumentation code can be added to the block; otherwise, a new basic
3201 block must be created to hold the instrumentation code.
3202
3203 @need 2000
3204 @item -ftest-coverage
3205 @opindex ftest-coverage
3206 Produce a notes file that the @command{gcov} code-coverage utility
3207 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3208 show program coverage. Each source file's note file is called
3209 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3210 above for a description of @var{auxname} and instructions on how to
3211 generate test coverage data. Coverage data will match the source files
3212 more closely, if you do not optimize.
3213
3214 @item -d@var{letters}
3215 @opindex d
3216 Says to make debugging dumps during compilation at times specified by
3217 @var{letters}.  This is used for debugging the compiler.  The file names
3218 for most of the dumps are made by appending a pass number and a word to
3219 the @var{dumpname}. @var{dumpname} is generated from the name of the
3220 output file, if explicitly specified and it is not an executable,
3221 otherwise it is the basename of the source file. In both cases any
3222 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3223 Here are the possible letters for use in @var{letters}, and their
3224 meanings:
3225
3226 @table @samp
3227 @item A
3228 @opindex dA
3229 Annotate the assembler output with miscellaneous debugging information.
3230 @item b
3231 @opindex db
3232 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3233 @item B
3234 @opindex dB
3235 Dump after block reordering, to @file{@var{file}.31.bbro}.
3236 @item c
3237 @opindex dc
3238 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3239 @item C
3240 @opindex dC
3241 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3242 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3243 @item d
3244 @opindex dd
3245 Dump after branch target load optimization, to to @file{@var{file}.32.btl}.
3246 Also dump after delayed branch scheduling, to @file{@var{file}.36.dbr}.
3247 @item D
3248 @opindex dD
3249 Dump all macro definitions, at the end of preprocessing, in addition to
3250 normal output.
3251 @item E
3252 @opindex dE
3253 Dump after the third if conversion, to @file{@var{file}.30.ce3}.
3254 @item f
3255 @opindex df
3256 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3257 Also dump after life analysis, to @file{@var{file}.19.life}.
3258 @item F
3259 @opindex dF
3260 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.07.addressof}.
3261 @item g
3262 @opindex dg
3263 Dump after global register allocation, to @file{@var{file}.25.greg}.
3264 @item G
3265 @opindex dG
3266 Dump after GCSE, to @file{@var{file}.08.gcse}.
3267 Also dump after jump bypassing and control flow optimizations, to
3268 @file{@var{file}.10.bypass}.
3269 @item h
3270 @opindex dh
3271 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3272 @item i
3273 @opindex di
3274 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3275 @item j
3276 @opindex dj
3277 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3278 @item k
3279 @opindex dk
3280 Dump after conversion from registers to stack, to @file{@var{file}.34.stack}.
3281 @item l
3282 @opindex dl
3283 Dump after local register allocation, to @file{@var{file}.24.lreg}.
3284 @item L
3285 @opindex dL
3286 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3287 @file{@var{file}.16.loop2}.
3288 @item M
3289 @opindex dM
3290 Dump after performing the machine dependent reorganization pass, to
3291 @file{@var{file}.35.mach}.
3292 @item n
3293 @opindex dn
3294 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3295 @item N
3296 @opindex dN
3297 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3298 @item o
3299 @opindex do
3300 Dump after post-reload optimizations, to @file{@var{file}.26.postreload}.
3301 @item r
3302 @opindex dr
3303 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3304 @item R
3305 @opindex dR
3306 Dump after the second scheduling pass, to @file{@var{file}.33.sched2}.
3307 @item s
3308 @opindex ds
3309 Dump after CSE (including the jump optimization that sometimes follows
3310 CSE), to @file{@var{file}.06.cse}.
3311 @item S
3312 @opindex dS
3313 Dump after the first scheduling pass, to @file{@var{file}.23.sched}.
3314 @item t
3315 @opindex dt
3316 Dump after the second CSE pass (including the jump optimization that
3317 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3318 @item T
3319 @opindex dT
3320 Dump after running tracer, to @file{@var{file}.15.tracer}.
3321 @item u
3322 @opindex du
3323 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3324 @item U
3325 @opindex dU
3326 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3327 @item V
3328 @opindex dV
3329 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3330 @item w
3331 @opindex dw
3332 Dump after the second flow pass, to @file{@var{file}.27.flow2}.
3333 @item z
3334 @opindex dz
3335 Dump after the peephole pass, to @file{@var{file}.28.peephole2}.
3336 @item Z
3337 @opindex dZ
3338 Dump after constructing the web, to @file{@var{file}.17.web}.
3339 @item a
3340 @opindex da
3341 Produce all the dumps listed above.
3342 @item H
3343 @opindex dH
3344 Produce a core dump whenever an error occurs.
3345 @item m
3346 @opindex dm
3347 Print statistics on memory usage, at the end of the run, to
3348 standard error.
3349 @item p
3350 @opindex dp
3351 Annotate the assembler output with a comment indicating which
3352 pattern and alternative was used.  The length of each instruction is
3353 also printed.
3354 @item P
3355 @opindex dP
3356 Dump the RTL in the assembler output as a comment before each instruction.
3357 Also turns on @option{-dp} annotation.
3358 @item v
3359 @opindex dv
3360 For each of the other indicated dump files (except for
3361 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3362 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3363 @item x
3364 @opindex dx
3365 Just generate RTL for a function instead of compiling it.  Usually used
3366 with @samp{r}.
3367 @item y
3368 @opindex dy
3369 Dump debugging information during parsing, to standard error.
3370 @end table
3371
3372 @item -fdump-unnumbered
3373 @opindex fdump-unnumbered
3374 When doing debugging dumps (see @option{-d} option above), suppress instruction
3375 numbers and line number note output.  This makes it more feasible to
3376 use diff on debugging dumps for compiler invocations with different
3377 options, in particular with and without @option{-g}.
3378
3379 @item -fdump-translation-unit @r{(C and C++ only)}
3380 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3381 @opindex fdump-translation-unit
3382 Dump a representation of the tree structure for the entire translation
3383 unit to a file.  The file name is made by appending @file{.tu} to the
3384 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3385 controls the details of the dump as described for the
3386 @option{-fdump-tree} options.
3387
3388 @item -fdump-class-hierarchy @r{(C++ only)}
3389 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3390 @opindex fdump-class-hierarchy
3391 Dump a representation of each class's hierarchy and virtual function
3392 table layout to a file.  The file name is made by appending @file{.class}
3393 to the source file name.  If the @samp{-@var{options}} form is used,
3394 @var{options} controls the details of the dump as described for the
3395 @option{-fdump-tree} options.
3396
3397 @item -fdump-tree-@var{switch} @r{(C++ only)}
3398 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3399 @opindex fdump-tree
3400 Control the dumping at various stages of processing the intermediate
3401 language tree to a file.  The file name is generated by appending a switch
3402 specific suffix to the source file name.  If the @samp{-@var{options}}
3403 form is used, @var{options} is a list of @samp{-} separated options that
3404 control the details of the dump. Not all options are applicable to all
3405 dumps, those which are not meaningful will be ignored. The following
3406 options are available
3407
3408 @table @samp
3409 @item address
3410 Print the address of each node.  Usually this is not meaningful as it
3411 changes according to the environment and source file. Its primary use
3412 is for tying up a dump file with a debug environment.
3413 @item slim
3414 Inhibit dumping of members of a scope or body of a function merely
3415 because that scope has been reached. Only dump such items when they
3416 are directly reachable by some other path.
3417 @item all
3418 Turn on all options.
3419 @end table
3420
3421 The following tree dumps are possible:
3422 @table @samp
3423 @item original
3424 Dump before any tree based optimization, to @file{@var{file}.original}.
3425 @item optimized
3426 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3427 @item inlined
3428 Dump after function inlining, to @file{@var{file}.inlined}.
3429 @end table
3430
3431 @item -frandom-seed=@var{string}
3432 @opindex frandom-string
3433 This option provides a seed that GCC uses when it would otherwise use
3434 random numbers.  It is used to generate certain symbol names
3435 that have to be different in every compiled file. It is also used to
3436 place unique stamps in coverage data files and the object files that
3437 produce them. You can use the @option{-frandom-seed} option to produce
3438 reproducibly identical object files.
3439
3440 The @var{string} should be different for every file you compile.
3441
3442 @item -fsched-verbose=@var{n}
3443 @opindex fsched-verbose
3444 On targets that use instruction scheduling, this option controls the
3445 amount of debugging output the scheduler prints.  This information is
3446 written to standard error, unless @option{-dS} or @option{-dR} is
3447 specified, in which case it is output to the usual dump
3448 listing file, @file{.sched} or @file{.sched2} respectively.  However
3449 for @var{n} greater than nine, the output is always printed to standard
3450 error.
3451
3452 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3453 same information as @option{-dRS}.  For @var{n} greater than one, it
3454 also output basic block probabilities, detailed ready list information
3455 and unit/insn info.  For @var{n} greater than two, it includes RTL
3456 at abort point, control-flow and regions info.  And for @var{n} over
3457 four, @option{-fsched-verbose} also includes dependence info.
3458
3459 @item -save-temps
3460 @opindex save-temps
3461 Store the usual ``temporary'' intermediate files permanently; place them
3462 in the current directory and name them based on the source file.  Thus,
3463 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3464 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3465 preprocessed @file{foo.i} output file even though the compiler now
3466 normally uses an integrated preprocessor.
3467
3468 @item -time
3469 @opindex time
3470 Report the CPU time taken by each subprocess in the compilation
3471 sequence.  For C source files, this is the compiler proper and assembler
3472 (plus the linker if linking is done).  The output looks like this:
3473
3474 @smallexample
3475 # cc1 0.12 0.01
3476 # as 0.00 0.01
3477 @end smallexample
3478
3479 The first number on each line is the ``user time,'' that is time spent
3480 executing the program itself.  The second number is ``system time,''
3481 time spent executing operating system routines on behalf of the program.
3482 Both numbers are in seconds.
3483
3484 @item -print-file-name=@var{library}
3485 @opindex print-file-name
3486 Print the full absolute name of the library file @var{library} that
3487 would be used when linking---and don't do anything else.  With this
3488 option, GCC does not compile or link anything; it just prints the
3489 file name.
3490
3491 @item -print-multi-directory
3492 @opindex print-multi-directory
3493 Print the directory name corresponding to the multilib selected by any
3494 other switches present in the command line.  This directory is supposed
3495 to exist in @env{GCC_EXEC_PREFIX}.
3496
3497 @item -print-multi-lib
3498 @opindex print-multi-lib
3499 Print the mapping from multilib directory names to compiler switches
3500 that enable them.  The directory name is separated from the switches by
3501 @samp{;}, and each switch starts with an @samp{@@} instead of the
3502 @samp{-}, without spaces between multiple switches.  This is supposed to
3503 ease shell-processing.
3504
3505 @item -print-prog-name=@var{program}
3506 @opindex print-prog-name
3507 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3508
3509 @item -print-libgcc-file-name
3510 @opindex print-libgcc-file-name
3511 Same as @option{-print-file-name=libgcc.a}.
3512
3513 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3514 but you do want to link with @file{libgcc.a}.  You can do
3515
3516 @smallexample
3517 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3518 @end smallexample
3519
3520 @item -print-search-dirs
3521 @opindex print-search-dirs
3522 Print the name of the configured installation directory and a list of
3523 program and library directories gcc will search---and don't do anything else.
3524
3525 This is useful when gcc prints the error message
3526 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3527 To resolve this you either need to put @file{cpp0} and the other compiler
3528 components where gcc expects to find them, or you can set the environment
3529 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3530 Don't forget the trailing '/'.
3531 @xref{Environment Variables}.
3532
3533 @item -dumpmachine
3534 @opindex dumpmachine
3535 Print the compiler's target machine (for example,
3536 @samp{i686-pc-linux-gnu})---and don't do anything else.
3537
3538 @item -dumpversion
3539 @opindex dumpversion
3540 Print the compiler version (for example, @samp{3.0})---and don't do
3541 anything else.
3542
3543 @item -dumpspecs
3544 @opindex dumpspecs
3545 Print the compiler's built-in specs---and don't do anything else.  (This
3546 is used when GCC itself is being built.)  @xref{Spec Files}.
3547
3548 @item -feliminate-unused-debug-types
3549 @opindex feliminate-unused-debug-types
3550 Normally, when producing DWARF2 output, GCC will emit debugging
3551 information for all types declared in a compilation
3552 unit, regardless of whether or not they are actually used
3553 in that compilation unit.  Sometimes this is useful, such as
3554 if, in the debugger, you want to cast a value to a type that is
3555 not actually used in your program (but is declared).  More often,
3556 however, this results in a significant amount of wasted space.
3557 With this option, GCC will avoid producing debug symbol output
3558 for types that are nowhere used in the source file being compiled.
3559 @end table
3560
3561 @node Optimize Options
3562 @section Options That Control Optimization
3563 @cindex optimize options
3564 @cindex options, optimization
3565
3566 These options control various sorts of optimizations.
3567
3568 Without any optimization option, the compiler's goal is to reduce the
3569 cost of compilation and to make debugging produce the expected
3570 results.  Statements are independent: if you stop the program with a
3571 breakpoint between statements, you can then assign a new value to any
3572 variable or change the program counter to any other statement in the
3573 function and get exactly the results you would expect from the source
3574 code.
3575
3576 Turning on optimization flags makes the compiler attempt to improve
3577 the performance and/or code size at the expense of compilation time
3578 and possibly the ability to debug the program.
3579
3580 The compiler performs optimization based on the knowledge it has of
3581 the program.  Using the @option{-funit-at-a-time} flag will allow the
3582 compiler to consider information gained from later functions in the
3583 file when compiling a function.  Compiling multiple files at once to a
3584 single output file (and using @option{-funit-at-a-time}) will allow
3585 the compiler to use information gained from all of the files when
3586 compiling each of them.
3587
3588 Not all optimizations are controlled directly by a flag.  Only
3589 optimizations that have a flag are listed.
3590
3591 @table @gcctabopt
3592 @item -O
3593 @itemx -O1
3594 @opindex O
3595 @opindex O1
3596 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3597 more memory for a large function.
3598
3599 With @option{-O}, the compiler tries to reduce code size and execution
3600 time, without performing any optimizations that take a great deal of
3601 compilation time.
3602
3603 @option{-O} turns on the following optimization flags:
3604 @gccoptlist{-fdefer-pop @gol
3605 -fmerge-constants @gol
3606 -fthread-jumps @gol
3607 -floop-optimize @gol
3608 -fif-conversion @gol
3609 -fif-conversion2 @gol
3610 -fdelayed-branch @gol
3611 -fguess-branch-probability @gol
3612 -fcprop-registers}
3613
3614 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3615 where doing so does not interfere with debugging.
3616
3617 @item -O2
3618 @opindex O2
3619 Optimize even more.  GCC performs nearly all supported optimizations
3620 that do not involve a space-speed tradeoff.  The compiler does not
3621 perform loop unrolling or function inlining when you specify @option{-O2}.
3622 As compared to @option{-O}, this option increases both compilation time
3623 and the performance of the generated code.
3624
3625 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3626 also turns on the following optimization flags:
3627 @gccoptlist{-fforce-mem @gol
3628 -foptimize-sibling-calls @gol
3629 -fstrength-reduce @gol
3630 -fcse-follow-jumps  -fcse-skip-blocks @gol
3631 -frerun-cse-after-loop  -frerun-loop-opt @gol
3632 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3633 -fdelete-null-pointer-checks @gol
3634 -fexpensive-optimizations @gol
3635 -fregmove @gol
3636 -fschedule-insns  -fschedule-insns2 @gol
3637 -fsched-interblock  -fsched-spec @gol
3638 -fcaller-saves @gol
3639 -fpeephole2 @gol
3640 -freorder-blocks  -freorder-functions @gol
3641 -fstrict-aliasing @gol
3642 -funit-at-a-time @gol
3643 -falign-functions  -falign-jumps @gol
3644 -falign-loops  -falign-labels @gol
3645 -fcrossjumping}
3646
3647 Please note the warning under @option{-fgcse} about
3648 invoking @option{-O2} on programs that use computed gotos.
3649
3650 @item -O3
3651 @opindex O3
3652 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3653 @option{-O2} and also turns on the @option{-finline-functions},
3654 @option{-fweb} and @option{-frename-registers} options.
3655
3656 @item -O0
3657 @opindex O0
3658 Do not optimize.  This is the default.
3659
3660 @item -Os
3661 @opindex Os
3662 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3663 do not typically increase code size.  It also performs further
3664 optimizations designed to reduce code size.
3665
3666 @option{-Os} disables the following optimization flags:
3667 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3668 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3669
3670 If you use multiple @option{-O} options, with or without level numbers,
3671 the last such option is the one that is effective.
3672 @end table
3673
3674 Options of the form @option{-f@var{flag}} specify machine-independent
3675 flags.  Most flags have both positive and negative forms; the negative
3676 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3677 below, only one of the forms is listed---the one you typically will
3678 use.  You can figure out the other form by either removing @samp{no-}
3679 or adding it.
3680
3681 The following options control specific optimizations.  They are either
3682 activated by @option{-O} options or are related to ones that are.  You
3683 can use the following flags in the rare cases when ``fine-tuning'' of
3684 optimizations to be performed is desired.
3685
3686 @table @gcctabopt
3687 @item -fno-default-inline
3688 @opindex fno-default-inline
3689 Do not make member functions inline by default merely because they are
3690 defined inside the class scope (C++ only).  Otherwise, when you specify
3691 @w{@option{-O}}, member functions defined inside class scope are compiled
3692 inline by default; i.e., you don't need to add @samp{inline} in front of
3693 the member function name.
3694
3695 @item -fno-defer-pop
3696 @opindex fno-defer-pop
3697 Always pop the arguments to each function call as soon as that function
3698 returns.  For machines which must pop arguments after a function call,
3699 the compiler normally lets arguments accumulate on the stack for several
3700 function calls and pops them all at once.
3701
3702 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3703
3704 @item -fforce-mem
3705 @opindex fforce-mem
3706 Force memory operands to be copied into registers before doing
3707 arithmetic on them.  This produces better code by making all memory
3708 references potential common subexpressions.  When they are not common
3709 subexpressions, instruction combination should eliminate the separate
3710 register-load.
3711
3712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3713
3714 @item -fforce-addr
3715 @opindex fforce-addr
3716 Force memory address constants to be copied into registers before
3717 doing arithmetic on them.  This may produce better code just as
3718 @option{-fforce-mem} may.
3719
3720 @item -fomit-frame-pointer
3721 @opindex fomit-frame-pointer
3722 Don't keep the frame pointer in a register for functions that
3723 don't need one.  This avoids the instructions to save, set up and
3724 restore frame pointers; it also makes an extra register available
3725 in many functions.  @strong{It also makes debugging impossible on
3726 some machines.}
3727
3728 On some machines, such as the VAX, this flag has no effect, because
3729 the standard calling sequence automatically handles the frame pointer
3730 and nothing is saved by pretending it doesn't exist.  The
3731 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3732 whether a target machine supports this flag.  @xref{Registers,,Register
3733 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3734
3735 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3736
3737 @item -foptimize-sibling-calls
3738 @opindex foptimize-sibling-calls
3739 Optimize sibling and tail recursive calls.
3740
3741 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3742
3743 @item -fno-inline
3744 @opindex fno-inline
3745 Don't pay attention to the @code{inline} keyword.  Normally this option
3746 is used to keep the compiler from expanding any functions inline.
3747 Note that if you are not optimizing, no functions can be expanded inline.
3748
3749 @item -finline-functions
3750 @opindex finline-functions
3751 Integrate all simple functions into their callers.  The compiler
3752 heuristically decides which functions are simple enough to be worth
3753 integrating in this way.
3754
3755 If all calls to a given function are integrated, and the function is
3756 declared @code{static}, then the function is normally not output as
3757 assembler code in its own right.
3758
3759 Enabled at level @option{-O3}.
3760
3761 @item -finline-limit=@var{n}
3762 @opindex finline-limit
3763 By default, gcc limits the size of functions that can be inlined.  This flag
3764 allows the control of this limit for functions that are explicitly marked as
3765 inline (i.e., marked with the inline keyword or defined within the class
3766 definition in c++).  @var{n} is the size of functions that can be inlined in
3767 number of pseudo instructions (not counting parameter handling).  The default
3768 value of @var{n} is 600.
3769 Increasing this value can result in more inlined code at
3770 the cost of compilation time and memory consumption.  Decreasing usually makes
3771 the compilation faster and less code will be inlined (which presumably
3772 means slower programs).  This option is particularly useful for programs that
3773 use inlining heavily such as those based on recursive templates with C++.
3774
3775 Inlining is actually controlled by a number of parameters, which may be
3776 specified individually by using @option{--param @var{name}=@var{value}}.
3777 The @option{-finline-limit=@var{n}} option sets some of these parameters
3778 as follows:
3779
3780 @table @gcctabopt
3781  @item max-inline-insns-single
3782   is set to @var{n}/2.
3783  @item max-inline-insns-auto
3784   is set to @var{n}/2.
3785  @item min-inline-insns
3786   is set to 130 or @var{n}/4, whichever is smaller.
3787  @item max-inline-insns-rtl
3788   is set to @var{n}.
3789 @end table
3790
3791 See below for a documentation of the individual
3792 parameters controlling inlining.
3793
3794 @emph{Note:} pseudo instruction represents, in this particular context, an
3795 abstract measurement of function's size.  In no way, it represents a count
3796 of assembly instructions and as such its exact meaning might change from one
3797 release to an another.
3798
3799 @item -fkeep-inline-functions
3800 @opindex fkeep-inline-functions
3801 Even if all calls to a given function are integrated, and the function
3802 is declared @code{static}, nevertheless output a separate run-time
3803 callable version of the function.  This switch does not affect
3804 @code{extern inline} functions.
3805
3806 @item -fkeep-static-consts
3807 @opindex fkeep-static-consts
3808 Emit variables declared @code{static const} when optimization isn't turned
3809 on, even if the variables aren't referenced.
3810
3811 GCC enables this option by default.  If you want to force the compiler to
3812 check if the variable was referenced, regardless of whether or not
3813 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3814
3815 @item -fmerge-constants
3816 Attempt to merge identical constants (string constants and floating point
3817 constants) across compilation units.
3818
3819 This option is the default for optimized compilation if the assembler and
3820 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3821 behavior.
3822
3823 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3824
3825 @item -fmerge-all-constants
3826 Attempt to merge identical constants and identical variables.
3827
3828 This option implies @option{-fmerge-constants}.  In addition to
3829 @option{-fmerge-constants} this considers e.g. even constant initialized
3830 arrays or initialized constant variables with integral or floating point
3831 types.  Languages like C or C++ require each non-automatic variable to
3832 have distinct location, so using this option will result in non-conforming
3833 behavior.
3834
3835 @item -fnew-ra
3836 @opindex fnew-ra
3837 Use a graph coloring register allocator.  Currently this option is meant
3838 for testing, so we are interested to hear about miscompilations with
3839 @option{-fnew-ra}.
3840
3841 @item -fno-branch-count-reg
3842 @opindex fno-branch-count-reg
3843 Do not use ``decrement and branch'' instructions on a count register,
3844 but instead generate a sequence of instructions that decrement a
3845 register, compare it against zero, then branch based upon the result.
3846 This option is only meaningful on architectures that support such
3847 instructions, which include x86, PowerPC, IA-64 and S/390.
3848
3849 The default is @option{-fbranch-count-reg}, enabled when
3850 @option{-fstrength-reduce} is enabled.
3851
3852 @item -fno-function-cse
3853 @opindex fno-function-cse
3854 Do not put function addresses in registers; make each instruction that
3855 calls a constant function contain the function's address explicitly.
3856
3857 This option results in less efficient code, but some strange hacks
3858 that alter the assembler output may be confused by the optimizations
3859 performed when this option is not used.
3860
3861 The default is @option{-ffunction-cse}
3862
3863 @item -fno-zero-initialized-in-bss
3864 @opindex fno-zero-initialized-in-bss
3865 If the target supports a BSS section, GCC by default puts variables that
3866 are initialized to zero into BSS@.  This can save space in the resulting
3867 code.
3868
3869 This option turns off this behavior because some programs explicitly
3870 rely on variables going to the data section.  E.g., so that the
3871 resulting executable can find the beginning of that section and/or make
3872 assumptions based on that.
3873
3874 The default is @option{-fzero-initialized-in-bss}.
3875
3876 @item -fstrength-reduce
3877 @opindex fstrength-reduce
3878 Perform the optimizations of loop strength reduction and
3879 elimination of iteration variables.
3880
3881 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3882
3883 @item -fthread-jumps
3884 @opindex fthread-jumps
3885 Perform optimizations where we check to see if a jump branches to a
3886 location where another comparison subsumed by the first is found.  If
3887 so, the first branch is redirected to either the destination of the
3888 second branch or a point immediately following it, depending on whether
3889 the condition is known to be true or false.
3890
3891 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3892
3893 @item -fcse-follow-jumps
3894 @opindex fcse-follow-jumps
3895 In common subexpression elimination, scan through jump instructions
3896 when the target of the jump is not reached by any other path.  For
3897 example, when CSE encounters an @code{if} statement with an
3898 @code{else} clause, CSE will follow the jump when the condition
3899 tested is false.
3900
3901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3902
3903 @item -fcse-skip-blocks
3904 @opindex fcse-skip-blocks
3905 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3906 follow jumps which conditionally skip over blocks.  When CSE
3907 encounters a simple @code{if} statement with no else clause,
3908 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3909 body of the @code{if}.
3910
3911 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3912
3913 @item -frerun-cse-after-loop
3914 @opindex frerun-cse-after-loop
3915 Re-run common subexpression elimination after loop optimizations has been
3916 performed.
3917
3918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3919
3920 @item -frerun-loop-opt
3921 @opindex frerun-loop-opt
3922 Run the loop optimizer twice.
3923
3924 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3925
3926 @item -fgcse
3927 @opindex fgcse
3928 Perform a global common subexpression elimination pass.
3929 This pass also performs global constant and copy propagation.
3930
3931 @emph{Note:} When compiling a program using computed gotos, a GCC
3932 extension, you may get better runtime performance if you disable
3933 the global common subexpression elimination pass by adding
3934 @option{-fno-gcse} to the command line.
3935
3936 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3937
3938 @item -fgcse-lm
3939 @opindex fgcse-lm
3940 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3941 attempt to move loads which are only killed by stores into themselves.  This
3942 allows a loop containing a load/store sequence to be changed to a load outside
3943 the loop, and a copy/store within the loop.
3944
3945 Enabled by default when gcse is enabled.
3946
3947 @item -fgcse-sm
3948 @opindex fgcse-sm
3949 When @option{-fgcse-sm} is enabled, a store motion pass is run after
3950 global common subexpression elimination.  This pass will attempt to move
3951 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
3952 loops containing a load/store sequence can be changed to a load before
3953 the loop and a store after the loop.
3954
3955 Enabled by default when gcse is enabled.
3956
3957 @item -fgcse-las
3958 @opindex fgcse-las
3959 When @option{-fgcse-las} is enabled, the global common subexpression
3960 elimination pass eliminates redundant loads that come after stores to the
3961 same memory location (both partial and full redundancies).
3962
3963 Enabled by default when gcse is enabled.
3964
3965 @item -floop-optimize
3966 @opindex floop-optimize
3967 Perform loop optimizations: move constant expressions out of loops, simplify
3968 exit test conditions and optionally do strength-reduction and loop unrolling as
3969 well.
3970
3971 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3972
3973 @item -fcrossjumping
3974 @opindex crossjumping
3975 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3976 resulting code may or may not perform better than without cross-jumping.
3977
3978 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3979
3980 @item -fif-conversion
3981 @opindex if-conversion
3982 Attempt to transform conditional jumps into branch-less equivalents.  This
3983 include use of conditional moves, min, max, set flags and abs instructions, and
3984 some tricks doable by standard arithmetics.  The use of conditional execution
3985 on chips where it is available is controlled by @code{if-conversion2}.
3986
3987 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3988
3989 @item -fif-conversion2
3990 @opindex if-conversion2
3991 Use conditional execution (where available) to transform conditional jumps into
3992 branch-less equivalents.
3993
3994 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3995
3996 @item -fdelete-null-pointer-checks
3997 @opindex fdelete-null-pointer-checks
3998 Use global dataflow analysis to identify and eliminate useless checks
3999 for null pointers.  The compiler assumes that dereferencing a null
4000 pointer would have halted the program.  If a pointer is checked after
4001 it has already been dereferenced, it cannot be null.
4002
4003 In some environments, this assumption is not true, and programs can
4004 safely dereference null pointers.  Use
4005 @option{-fno-delete-null-pointer-checks} to disable this optimization
4006 for programs which depend on that behavior.
4007
4008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4009
4010 @item -fexpensive-optimizations
4011 @opindex fexpensive-optimizations
4012 Perform a number of minor optimizations that are relatively expensive.
4013
4014 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015
4016 @item -foptimize-register-move
4017 @itemx -fregmove
4018 @opindex foptimize-register-move
4019 @opindex fregmove
4020 Attempt to reassign register numbers in move instructions and as
4021 operands of other simple instructions in order to maximize the amount of
4022 register tying.  This is especially helpful on machines with two-operand
4023 instructions.
4024
4025 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4026 optimization.
4027
4028 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4029
4030 @item -fdelayed-branch
4031 @opindex fdelayed-branch
4032 If supported for the target machine, attempt to reorder instructions
4033 to exploit instruction slots available after delayed branch
4034 instructions.
4035
4036 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4037
4038 @item -fschedule-insns
4039 @opindex fschedule-insns
4040 If supported for the target machine, attempt to reorder instructions to
4041 eliminate execution stalls due to required data being unavailable.  This
4042 helps machines that have slow floating point or memory load instructions
4043 by allowing other instructions to be issued until the result of the load
4044 or floating point instruction is required.
4045
4046 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4047
4048 @item -fschedule-insns2
4049 @opindex fschedule-insns2
4050 Similar to @option{-fschedule-insns}, but requests an additional pass of
4051 instruction scheduling after register allocation has been done.  This is
4052 especially useful on machines with a relatively small number of
4053 registers and where memory load instructions take more than one cycle.
4054
4055 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4056
4057 @item -fno-sched-interblock
4058 @opindex fno-sched-interblock
4059 Don't schedule instructions across basic blocks.  This is normally
4060 enabled by default when scheduling before register allocation, i.e.@:
4061 with @option{-fschedule-insns} or at @option{-O2} or higher.
4062
4063 @item -fno-sched-spec
4064 @opindex fno-sched-spec
4065 Don't allow speculative motion of non-load instructions.  This is normally
4066 enabled by default when scheduling before register allocation, i.e.@:
4067 with @option{-fschedule-insns} or at @option{-O2} or higher.
4068
4069 @item -fsched-spec-load
4070 @opindex fsched-spec-load
4071 Allow speculative motion of some load instructions.  This only makes
4072 sense when scheduling before register allocation, i.e.@: with
4073 @option{-fschedule-insns} or at @option{-O2} or higher.
4074
4075 @item -fsched-spec-load-dangerous
4076 @opindex fsched-spec-load-dangerous
4077 Allow speculative motion of more load instructions.  This only makes
4078 sense when scheduling before register allocation, i.e.@: with
4079 @option{-fschedule-insns} or at @option{-O2} or higher.
4080
4081 @item -fsched-stalled-insns=@var{n}
4082 @opindex fsched-stalled-insns
4083 Define how many insns (if any) can be moved prematurely from the queue
4084 of stalled insns into the ready list, during the second scheduling pass.
4085
4086 @item -fsched-stalled-insns-dep=@var{n}
4087 @opindex fsched-stalled-insns-dep
4088 Define how many insn groups (cycles) will be examined for a dependency
4089 on a stalled insn that is candidate for premature removal from the queue
4090 of stalled insns.  Has an effect only during the second scheduling pass,
4091 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4092
4093 @item -fsched2-use-superblocks
4094 @opindex fsched2-use-superblocks
4095 When scheduling after register allocation, do use superblock scheduling
4096 algorithm.  Superblock scheduling allows motion across basic block boundaries
4097 resulting on faster schedules.  This option is experimental, as not all machine
4098 descriptions used by GCC model the CPU closely enough to avoid unreliable
4099 results from the algorithm.
4100
4101 This only makes sense when scheduling after register allocation, i.e.@: with
4102 @option{-fschedule-insns2} or at @option{-O2} or higher.
4103
4104 @item -fsched2-use-traces
4105 @opindex fsched2-use-traces
4106 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4107 allocation and additionally perform code duplication in order to increase the
4108 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4109 trace formation.
4110
4111 This mode should produce faster but significantly longer programs.  Also
4112 without @code{-fbranch-probabilities} the traces constructed may not match the
4113 reality and hurt the performance.  This only makes
4114 sense when scheduling after register allocation, i.e.@: with
4115 @option{-fschedule-insns2} or at @option{-O2} or higher.
4116
4117 @item -fcaller-saves
4118 @opindex fcaller-saves
4119 Enable values to be allocated in registers that will be clobbered by
4120 function calls, by emitting extra instructions to save and restore the
4121 registers around such calls.  Such allocation is done only when it
4122 seems to result in better code than would otherwise be produced.
4123
4124 This option is always enabled by default on certain machines, usually
4125 those which have no call-preserved registers to use instead.
4126
4127 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4128
4129 @item -fmove-all-movables
4130 @opindex fmove-all-movables
4131 Forces all invariant computations in loops to be moved
4132 outside the loop.
4133
4134 @item -freduce-all-givs
4135 @opindex freduce-all-givs
4136 Forces all general-induction variables in loops to be
4137 strength-reduced.
4138
4139 @emph{Note:} When compiling programs written in Fortran,
4140 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4141 by default when you use the optimizer.
4142
4143 These options may generate better or worse code; results are highly
4144 dependent on the structure of loops within the source code.
4145
4146 These two options are intended to be removed someday, once
4147 they have helped determine the efficacy of various
4148 approaches to improving loop optimizations.
4149
4150 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4151 know how use of these options affects
4152 the performance of your production code.
4153 We're very interested in code that runs @emph{slower}
4154 when these options are @emph{enabled}.
4155
4156 @item -fno-peephole
4157 @itemx -fno-peephole2
4158 @opindex fno-peephole
4159 @opindex fno-peephole2
4160 Disable any machine-specific peephole optimizations.  The difference
4161 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4162 are implemented in the compiler; some targets use one, some use the
4163 other, a few use both.
4164
4165 @option{-fpeephole} is enabled by default.
4166 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4167
4168 @item -fno-guess-branch-probability
4169 @opindex fno-guess-branch-probability
4170 Do not guess branch probabilities using a randomized model.
4171
4172 Sometimes gcc will opt to use a randomized model to guess branch
4173 probabilities, when none are available from either profiling feedback
4174 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4175 different runs of the compiler on the same program may produce different
4176 object code.
4177
4178 In a hard real-time system, people don't want different runs of the
4179 compiler to produce code that has different behavior; minimizing
4180 non-determinism is of paramount import.  This switch allows users to
4181 reduce non-determinism, possibly at the expense of inferior
4182 optimization.
4183
4184 The default is @option{-fguess-branch-probability} at levels
4185 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186
4187 @item -freorder-blocks
4188 @opindex freorder-blocks
4189 Reorder basic blocks in the compiled function in order to reduce number of
4190 taken branches and improve code locality.
4191
4192 Enabled at levels @option{-O2}, @option{-O3}.
4193
4194 @item -freorder-functions
4195 @opindex freorder-functions
4196 Reorder basic blocks in the compiled function in order to reduce number of
4197 taken branches and improve code locality. This is implemented by using special
4198 subsections @code{text.hot} for most frequently executed functions and
4199 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4200 the linker so object file format must support named sections and linker must
4201 place them in a reasonable way.
4202
4203 Also profile feedback must be available in to make this option effective.  See
4204 @option{-fprofile-arcs} for details.
4205
4206 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4207
4208 @item -fstrict-aliasing
4209 @opindex fstrict-aliasing
4210 Allows the compiler to assume the strictest aliasing rules applicable to
4211 the language being compiled.  For C (and C++), this activates
4212 optimizations based on the type of expressions.  In particular, an
4213 object of one type is assumed never to reside at the same address as an
4214 object of a different type, unless the types are almost the same.  For
4215 example, an @code{unsigned int} can alias an @code{int}, but not a
4216 @code{void*} or a @code{double}.  A character type may alias any other
4217 type.
4218
4219 Pay special attention to code like this:
4220 @smallexample
4221 union a_union @{
4222   int i;
4223   double d;
4224 @};
4225
4226 int f() @{
4227   a_union t;
4228   t.d = 3.0;
4229   return t.i;
4230 @}
4231 @end smallexample
4232 The practice of reading from a different union member than the one most
4233 recently written to (called ``type-punning'') is common.  Even with
4234 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4235 is accessed through the union type.  So, the code above will work as
4236 expected.  However, this code might not:
4237 @smallexample
4238 int f() @{
4239   a_union t;
4240   int* ip;
4241   t.d = 3.0;
4242   ip = &t.i;
4243   return *ip;
4244 @}
4245 @end smallexample
4246
4247 Every language that wishes to perform language-specific alias analysis
4248 should define a function that computes, given an @code{tree}
4249 node, an alias set for the node.  Nodes in different alias sets are not
4250 allowed to alias.  For an example, see the C front-end function
4251 @code{c_get_alias_set}.
4252
4253 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4254
4255 @item -falign-functions
4256 @itemx -falign-functions=@var{n}
4257 @opindex falign-functions
4258 Align the start of functions to the next power-of-two greater than
4259 @var{n}, skipping up to @var{n} bytes.  For instance,
4260 @option{-falign-functions=32} aligns functions to the next 32-byte
4261 boundary, but @option{-falign-functions=24} would align to the next
4262 32-byte boundary only if this can be done by skipping 23 bytes or less.
4263
4264 @option{-fno-align-functions} and @option{-falign-functions=1} are
4265 equivalent and mean that functions will not be aligned.
4266
4267 Some assemblers only support this flag when @var{n} is a power of two;
4268 in that case, it is rounded up.
4269
4270 If @var{n} is not specified or is zero, use a machine-dependent default.
4271
4272 Enabled at levels @option{-O2}, @option{-O3}.
4273
4274 @item -falign-labels
4275 @itemx -falign-labels=@var{n}
4276 @opindex falign-labels
4277 Align all branch targets to a power-of-two boundary, skipping up to
4278 @var{n} bytes like @option{-falign-functions}.  This option can easily
4279 make code slower, because it must insert dummy operations for when the
4280 branch target is reached in the usual flow of the code.
4281
4282 @option{-fno-align-labels} and @option{-falign-labels=1} are
4283 equivalent and mean that labels will not be aligned.
4284
4285 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4286 are greater than this value, then their values are used instead.
4287
4288 If @var{n} is not specified or is zero, use a machine-dependent default
4289 which is very likely to be @samp{1}, meaning no alignment.
4290
4291 Enabled at levels @option{-O2}, @option{-O3}.
4292
4293 @item -falign-loops
4294 @itemx -falign-loops=@var{n}
4295 @opindex falign-loops
4296 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4297 like @option{-falign-functions}.  The hope is that the loop will be
4298 executed many times, which will make up for any execution of the dummy
4299 operations.
4300
4301 @option{-fno-align-loops} and @option{-falign-loops=1} are
4302 equivalent and mean that loops will not be aligned.
4303
4304 If @var{n} is not specified or is zero, use a machine-dependent default.
4305
4306 Enabled at levels @option{-O2}, @option{-O3}.
4307
4308 @item -falign-jumps
4309 @itemx -falign-jumps=@var{n}
4310 @opindex falign-jumps
4311 Align branch targets to a power-of-two boundary, for branch targets
4312 where the targets can only be reached by jumping, skipping up to @var{n}
4313 bytes like @option{-falign-functions}.  In this case, no dummy operations
4314 need be executed.
4315
4316 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4317 equivalent and mean that loops will not be aligned.
4318
4319 If @var{n} is not specified or is zero, use a machine-dependent default.
4320
4321 Enabled at levels @option{-O2}, @option{-O3}.
4322
4323 @item -frename-registers
4324 @opindex frename-registers
4325 Attempt to avoid false dependencies in scheduled code by making use
4326 of registers left over after register allocation.  This optimization
4327 will most benefit processors with lots of registers.  It can, however,
4328 make debugging impossible, since variables will no longer stay in
4329 a ``home register''.
4330
4331 @item -fweb
4332 @opindex fweb
4333 Constructs webs as commonly used for register allocation purposes and assign
4334 each web individual pseudo register.  This allows our register allocation pass
4335 to operate on pseudos directly, but also strengthens several other optimization
4336 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4337 however, make debugging impossible, since variables will no longer stay in a
4338 ``home register''.
4339
4340 Enabled at levels @option{-O3}.
4341
4342 @item -fno-cprop-registers
4343 @opindex fno-cprop-registers
4344 After register allocation and post-register allocation instruction splitting,
4345 we perform a copy-propagation pass to try to reduce scheduling dependencies
4346 and occasionally eliminate the copy.
4347
4348 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4349
4350 @item -fprofile-generate
4351 @opindex fprofile-generate
4352 Enable options usually used for instrumenting application to produce profile usefull
4353 for later recompilation profile feedback based optimization.
4354
4355 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}
4356
4357 @item -fprofile-use
4358 @opindex fprofile-use
4359 Enable profile feedback directed optimizations, and optimizations
4360 generally profitable only with profile feedback available.
4361
4362 The following options are enabled: @code{-fbranch-probabilities},
4363 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4364
4365 @end table
4366
4367 The following options control compiler behavior regarding floating
4368 point arithmetic.  These options trade off between speed and
4369 correctness.  All must be specifically enabled.
4370
4371 @table @gcctabopt
4372 @item -ffloat-store
4373 @opindex ffloat-store
4374 Do not store floating point variables in registers, and inhibit other
4375 options that might change whether a floating point value is taken from a
4376 register or memory.
4377
4378 @cindex floating point precision
4379 This option prevents undesirable excess precision on machines such as
4380 the 68000 where the floating registers (of the 68881) keep more
4381 precision than a @code{double} is supposed to have.  Similarly for the
4382 x86 architecture.  For most programs, the excess precision does only
4383 good, but a few programs rely on the precise definition of IEEE floating
4384 point.  Use @option{-ffloat-store} for such programs, after modifying
4385 them to store all pertinent intermediate computations into variables.
4386
4387 @item -ffast-math
4388 @opindex ffast-math
4389 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4390 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4391 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4392
4393 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4394
4395 This option should never be turned on by any @option{-O} option since
4396 it can result in incorrect output for programs which depend on
4397 an exact implementation of IEEE or ISO rules/specifications for
4398 math functions.
4399
4400 @item -fno-math-errno
4401 @opindex fno-math-errno
4402 Do not set ERRNO after calling math functions that are executed
4403 with a single instruction, e.g., sqrt.  A program that relies on
4404 IEEE exceptions for math error handling may want to use this flag
4405 for speed while maintaining IEEE arithmetic compatibility.
4406
4407 This option should never be turned on by any @option{-O} option since
4408 it can result in incorrect output for programs which depend on
4409 an exact implementation of IEEE or ISO rules/specifications for
4410 math functions.
4411
4412 The default is @option{-fmath-errno}.
4413
4414 @item -funsafe-math-optimizations
4415 @opindex funsafe-math-optimizations
4416 Allow optimizations for floating-point arithmetic that (a) assume
4417 that arguments and results are valid and (b) may violate IEEE or
4418 ANSI standards.  When used at link-time, it may include libraries
4419 or startup files that change the default FPU control word or other
4420 similar optimizations.
4421
4422 This option should never be turned on by any @option{-O} option since
4423 it can result in incorrect output for programs which depend on
4424 an exact implementation of IEEE or ISO rules/specifications for
4425 math functions.
4426
4427 The default is @option{-fno-unsafe-math-optimizations}.
4428
4429 @item -ffinite-math-only
4430 @opindex ffinite-math-only
4431 Allow optimizations for floating-point arithmetic that assume
4432 that arguments and results are not NaNs or +-Infs.
4433
4434 This option should never be turned on by any @option{-O} option since
4435 it can result in incorrect output for programs which depend on
4436 an exact implementation of IEEE or ISO rules/specifications.
4437
4438 The default is @option{-fno-finite-math-only}.
4439
4440 @item -fno-trapping-math
4441 @opindex fno-trapping-math
4442 Compile code assuming that floating-point operations cannot generate
4443 user-visible traps.  These traps include division by zero, overflow,
4444 underflow, inexact result and invalid operation.  This option implies
4445 @option{-fno-signaling-nans}.  Setting this option may allow faster
4446 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4447
4448 This option should never be turned on by any @option{-O} option since
4449 it can result in incorrect output for programs which depend on
4450 an exact implementation of IEEE or ISO rules/specifications for
4451 math functions.
4452
4453 The default is @option{-ftrapping-math}.
4454
4455 @item -frounding-math
4456 @opindex frounding-math
4457 Disable transformations and optimizations that assume default floating
4458 point rounding behavior.  This is round-to-zero for all floating point
4459 to integer conversions, and round-to-nearest for all other arithmetic
4460 truncations.  This option should be specified for programs that change
4461 the FP rounding mode dynamically, or that may be executed with a
4462 non-default rounding mode.  This option disables constant folding of
4463 floating point expressions at compile-time (which may be affected by
4464 rounding mode) and arithmetic transformations that are unsafe in the
4465 presence of sign-dependent rounding modes.
4466
4467 The default is @option{-fno-rounding-math}.
4468
4469 This option is experimental and does not currently guarantee to
4470 disable all GCC optimizations that are affected by rounding mode.
4471 Future versions of gcc may provide finer control of this setting
4472 using C99's @code{FENV_ACCESS} pragma.  This command line option
4473 will be used to specify the default state for @code{FENV_ACCESS}.
4474
4475 @item -fsignaling-nans
4476 @opindex fsignaling-nans
4477 Compile code assuming that IEEE signaling NaNs may generate user-visible
4478 traps during floating-point operations.  Setting this option disables
4479 optimizations that may change the number of exceptions visible with
4480 signaling NaNs.  This option implies @option{-ftrapping-math}.
4481
4482 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4483 be defined.
4484
4485 The default is @option{-fno-signaling-nans}.
4486
4487 This option is experimental and does not currently guarantee to
4488 disable all GCC optimizations that affect signaling NaN behavior.
4489
4490 @item -fsingle-precision-constant
4491 @opindex fsingle-precision-constant
4492 Treat floating point constant as single precision constant instead of
4493 implicitly converting it to double precision constant.
4494
4495
4496 @end table
4497
4498 The following options control optimizations that may improve
4499 performance, but are not enabled by any @option{-O} options.  This
4500 section includes experimental options that may produce broken code.
4501
4502 @table @gcctabopt
4503 @item -fbranch-probabilities
4504 @opindex fbranch-probabilities
4505 After running a program compiled with @option{-fprofile-arcs}
4506 (@pxref{Debugging Options,, Options for Debugging Your Program or
4507 @command{gcc}}), you can compile it a second time using
4508 @option{-fbranch-probabilities}, to improve optimizations based on
4509 the number of times each branch was taken.  When the program
4510 compiled with @option{-fprofile-arcs} exits it saves arc execution
4511 counts to a file called @file{@var{sourcename}.gcda} for each source
4512 file  The information in this data file is very dependent on the
4513 structure of the generated code, so you must use the same source code
4514 and the same optimization options for both compilations.
4515
4516 With @option{-fbranch-probabilities}, GCC puts a
4517 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4518 These can be used to improve optimization.  Currently, they are only
4519 used in one place: in @file{reorg.c}, instead of guessing which path a
4520 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4521 exactly determine which path is taken more often.
4522
4523 @item -fprofile-values
4524 @opindex fprofile-values
4525 If combined with @option{-fprofile-arcs}, it adds code so that some
4526 data about values of expressions in the program is gathered.
4527
4528 With @option{-fbranch-probabilities}, it reads back the data gathered
4529 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4530 notes to instructions for their later usage in optimizations.
4531
4532 @item -fvpt
4533 @opindex fvpt
4534 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4535 a code to gather information about values of expressions.
4536
4537 With @option{-fbranch-probabilities}, it reads back the data gathered
4538 and actually performs the optimizations based on them.
4539 Currently the optimizations include specialization of division operation
4540 using the knowledge about the value of the denominator.
4541
4542 @item -fnew-ra
4543 @opindex fnew-ra
4544 Use a graph coloring register allocator.  Currently this option is meant
4545 for testing, so we are interested to hear about miscompilations with
4546 @option{-fnew-ra}.
4547
4548 @item -ftracer
4549 @opindex ftracer
4550 Perform tail duplication to enlarge superblock size. This transformation
4551 simplifies the control flow of the function allowing other optimizations to do
4552 better job.
4553
4554 @item -funit-at-a-time
4555 @opindex funit-at-a-time
4556 Parse the whole compilation unit before starting to produce code.
4557 This allows some extra optimizations to take place but consumes more
4558 memory.
4559
4560 @item -funroll-loops
4561 @opindex funroll-loops
4562 Unroll loops whose number of iterations can be determined at compile time or
4563 upon entry to the loop.  @option{-funroll-loops} implies
4564 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4565 (i.e. complete removal of loops with small constant number of iterations).
4566 This option makes code larger, and may or may not make it run faster.
4567
4568 @item -funroll-all-loops
4569 @opindex funroll-all-loops
4570 Unroll all loops, even if their number of iterations is uncertain when
4571 the loop is entered.  This usually makes programs run more slowly.
4572 @option{-funroll-all-loops} implies the same options as
4573 @option{-funroll-loops}.
4574
4575 @item -fpeel-loops
4576 @opindex fpeel-loops
4577 Peels the loops for that there is enough information that they do not
4578 roll much (from profile feedback).  It also turns on complete loop peeling
4579 (i.e. complete removal of loops with small constant number of iterations).
4580
4581 @item -funswitch-loops
4582 @opindex funswitch-loops
4583 Move branches with loop invariant conditions out of the loop, with duplicates
4584 of the loop on both branches (modified according to result of the condition).
4585
4586 @item -fold-unroll-loops
4587 @opindex fold-unroll-loops
4588 Unroll loops whose number of iterations can be determined at compile
4589 time or upon entry to the loop, using the old loop unroller whose loop
4590 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4591 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4592 option makes code larger, and may or may not make it run faster.
4593
4594 @item -fold-unroll-all-loops
4595 @opindex fold-unroll-all-loops
4596 Unroll all loops, even if their number of iterations is uncertain when
4597 the loop is entered. This is done using the old loop unroller whose loop
4598 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4599 @option{-fold-unroll-all-loops} implies the same options as
4600 @option{-fold-unroll-loops}.
4601
4602 @item -funswitch-loops
4603 @opindex funswitch-loops
4604 Move branches with loop invariant conditions out of the loop, with duplicates
4605 of the loop on both branches (modified according to result of the condition).
4606
4607 @item -funswitch-loops
4608 @opindex funswitch-loops
4609 Move branches with loop invariant conditions out of the loop, with duplicates
4610 of the loop on both branches (modified according to result of the condition).
4611
4612 @item -fprefetch-loop-arrays
4613 @opindex fprefetch-loop-arrays
4614 If supported by the target machine, generate instructions to prefetch
4615 memory to improve the performance of loops that access large arrays.
4616
4617 Disabled at level @option{-Os}.
4618
4619 @item -ffunction-sections
4620 @itemx -fdata-sections
4621 @opindex ffunction-sections
4622 @opindex fdata-sections
4623 Place each function or data item into its own section in the output
4624 file if the target supports arbitrary sections.  The name of the
4625 function or the name of the data item determines the section's name
4626 in the output file.
4627
4628 Use these options on systems where the linker can perform optimizations
4629 to improve locality of reference in the instruction space.  Most systems
4630 using the ELF object format and SPARC processors running Solaris 2 have
4631 linkers with such optimizations.  AIX may have these optimizations in
4632 the future.
4633
4634 Only use these options when there are significant benefits from doing
4635 so.  When you specify these options, the assembler and linker will
4636 create larger object and executable files and will also be slower.
4637 You will not be able to use @code{gprof} on all systems if you
4638 specify this option and you may have problems with debugging if
4639 you specify both this option and @option{-g}.
4640
4641 @item -fbranch-target-load-optimize
4642 @opindex fbranch-target-load-optimize
4643 Perform branch target register load optimization before prologue / epilogue
4644 threading.
4645 The use of target registers can typically be exposed only during reload,
4646 thus hoisting loads out of loops and doing inter-block scheduling needs
4647 a separate optimization pass.
4648
4649 @item -fbranch-target-load-optimize2
4650 @opindex fbranch-target-load-optimize2
4651 Perform branch target register load optimization after prologue / epilogue
4652 threading.
4653
4654 @item -fbtr-bb-exclusive
4655 @opindex fbtr-bb-exclusive
4656 WHen performing branch target register load optimization, don't reuse
4657 branch target registers in within any basic block.
4658
4659 @item --param @var{name}=@var{value}
4660 @opindex param
4661 In some places, GCC uses various constants to control the amount of
4662 optimization that is done.  For example, GCC will not inline functions
4663 that contain more that a certain number of instructions.  You can
4664 control some of these constants on the command-line using the
4665 @option{--param} option.
4666
4667 The names of specific parameters, and the meaning of the values, are
4668 tied to the internals of the compiler, and are subject to change
4669 without notice in future releases.
4670
4671 In each case, the @var{value} is an integer.  The allowable choices for
4672 @var{name} are given in the following table:
4673
4674 @table @gcctabopt
4675 @item max-crossjump-edges
4676 The maximum number of incoming edges to consider for crossjumping.
4677 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4678 the number of edges incoming to each block.  Increasing values mean
4679 more aggressive optimization, making the compile time increase with
4680 probably small improvement in executable size.
4681
4682 @item max-delay-slot-insn-search
4683 The maximum number of instructions to consider when looking for an
4684 instruction to fill a delay slot.  If more than this arbitrary number of
4685 instructions is searched, the time savings from filling the delay slot
4686 will be minimal so stop searching.  Increasing values mean more
4687 aggressive optimization, making the compile time increase with probably
4688 small improvement in executable run time.
4689
4690 @item max-delay-slot-live-search
4691 When trying to fill delay slots, the maximum number of instructions to
4692 consider when searching for a block with valid live register
4693 information.  Increasing this arbitrarily chosen value means more
4694 aggressive optimization, increasing the compile time.  This parameter
4695 should be removed when the delay slot code is rewritten to maintain the
4696 control-flow graph.
4697
4698 @item max-gcse-memory
4699 The approximate maximum amount of memory that will be allocated in
4700 order to perform the global common subexpression elimination
4701 optimization.  If more memory than specified is required, the
4702 optimization will not be done.
4703
4704 @item max-gcse-passes
4705 The maximum number of passes of GCSE to run.
4706
4707 @item max-pending-list-length
4708 The maximum number of pending dependencies scheduling will allow
4709 before flushing the current state and starting over.  Large functions
4710 with few branches or calls can create excessively large lists which
4711 needlessly consume memory and resources.
4712
4713 @item max-inline-insns-single
4714 Several parameters control the tree inliner used in gcc.
4715 This number sets the maximum number of instructions (counted in gcc's
4716 internal representation) in a single function that the tree inliner
4717 will consider for inlining.  This only affects functions declared
4718 inline and methods implemented in a class declaration (C++).
4719 The default value is 500.
4720
4721 @item max-inline-insns-auto
4722 When you use @option{-finline-functions} (included in @option{-O3}),
4723 a lot of functions that would otherwise not be considered for inlining
4724 by the compiler will be investigated.  To those functions, a different
4725 (more restrictive) limit compared to functions declared inline can
4726 be applied.
4727 The default value is 120.
4728
4729 @item large-function-insns
4730 The limit specifying really large functions.  For functions greater than this
4731 limit inlining is constrained by @option{--param large-function-growth}.
4732 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4733 algorithms used by the backend.
4734 This parameter is ignored when @option{-funit-at-a-time} is not used.
4735 The default value is 3000.
4736
4737 @item large-function-growth
4738 Specifies maximal growth of large function caused by inlining in percents.
4739 This parameter is ignored when @option{-funit-at-a-time} is not used.
4740 The default value is 200.
4741
4742 @item inline-unit-growth
4743 Specifies maximal overall growth of the compilation unit caused by inlining.
4744 This parameter is ignored when @option{-funit-at-a-time} is not used.
4745 The default value is 150.
4746
4747 @item max-inline-insns-rtl
4748 For languages that use the RTL inliner (this happens at a later stage
4749 than tree inlining), you can set the maximum allowable size (counted
4750 in RTL instructions) for the RTL inliner with this parameter.
4751 The default value is 600.
4752
4753 @item max-unrolled-insns
4754 The maximum number of instructions that a loop should have if that loop
4755 is unrolled, and if the loop is unrolled, it determines how many times
4756 the loop code is unrolled.
4757
4758 @item max-average-unrolled-insns
4759 The maximum number of instructions biased by probabilities of their execution
4760 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4761 it determines how many times the loop code is unrolled.
4762
4763 @item max-unroll-times
4764 The maximum number of unrollings of a single loop.
4765
4766 @item max-peeled-insns
4767 The maximum number of instructions that a loop should have if that loop
4768 is peeled, and if the loop is peeled, it determines how many times
4769 the loop code is peeled.
4770
4771 @item max-peel-times
4772 The maximum number of peelings of a single loop.
4773
4774 @item max-completely-peeled-insns
4775 The maximum number of insns of a completely peeled loop.
4776
4777 @item max-completely-peel-times
4778 The maximum number of iterations of a loop to be suitable for complete peeling.
4779
4780 @item max-unswitch-insns
4781 The maximum number of insns of an unswitched loop.
4782
4783 @item max-unswitch-level
4784 The maximum number of branches unswitched in a single loop.
4785
4786 @item hot-bb-count-fraction
4787 Select fraction of the maximal count of repetitions of basic block in program
4788 given basic block needs to have to be considered hot.
4789
4790 @item hot-bb-frequency-fraction
4791 Select fraction of the maximal frequency of executions of basic block in
4792 function given basic block needs to have to be considered hot
4793
4794 @item tracer-dynamic-coverage
4795 @itemx tracer-dynamic-coverage-feedback
4796
4797 This value is used to limit superblock formation once the given percentage of
4798 executed instructions is covered.  This limits unnecessary code size
4799 expansion.
4800
4801 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4802 feedback is available.  The real profiles (as opposed to statically estimated
4803 ones) are much less balanced allowing the threshold to be larger value.
4804
4805 @item tracer-max-code-growth
4806 Stop tail duplication once code growth has reached given percentage.  This is
4807 rather hokey argument, as most of the duplicates will be eliminated later in
4808 cross jumping, so it may be set to much higher values than is the desired code
4809 growth.
4810
4811 @item tracer-min-branch-ratio
4812
4813 Stop reverse growth when the reverse probability of best edge is less than this
4814 threshold (in percent).
4815
4816 @item tracer-min-branch-ratio
4817 @itemx tracer-min-branch-ratio-feedback
4818
4819 Stop forward growth if the best edge do have probability lower than this
4820 threshold.
4821
4822 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4823 compilation for profile feedback and one for compilation without.  The value
4824 for compilation with profile feedback needs to be more conservative (higher) in
4825 order to make tracer effective.
4826
4827 @item max-cse-path-length
4828
4829 Maximum number of basic blocks on path that cse considers.
4830
4831 @item ggc-min-expand
4832
4833 GCC uses a garbage collector to manage its own memory allocation.  This
4834 parameter specifies the minimum percentage by which the garbage
4835 collector's heap should be allowed to expand between collections.
4836 Tuning this may improve compilation speed; it has no effect on code
4837 generation.
4838
4839 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4840 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4841 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4842 GCC is not able to calculate RAM on a particular platform, the lower
4843 bound of 30% is used.  Setting this parameter and
4844 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4845 every opportunity.  This is extremely slow, but can be useful for
4846 debugging.
4847
4848 @item ggc-min-heapsize
4849
4850 Minimum size of the garbage collector's heap before it begins bothering
4851 to collect garbage.  The first collection occurs after the heap expands
4852 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4853 tuning this may improve compilation speed, and has no effect on code
4854 generation.
4855
4856 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4857 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4858 available, the notion of "RAM" is the smallest of actual RAM,
4859 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4860 RAM on a particular platform, the lower bound is used.  Setting this
4861 parameter very large effectively disables garbage collection.  Setting
4862 this parameter and @option{ggc-min-expand} to zero causes a full
4863 collection to occur at every opportunity.
4864
4865 @item max-reload-search-insns
4866 The maximum number of instruction reload should look backward for equivalent
4867 register.  Increasing values mean more aggressive optimization, making the
4868 compile time increase with probably slightly better performance.  The default
4869 value is 100.
4870
4871 @item max-cselib-memory-location
4872 The maximum number of memory locations cselib should take into acount.
4873 Increasing values mean more aggressive optimization, making the compile time
4874 increase with probably slightly better performance.  The default value is 500.
4875
4876 @item reorder-blocks-duplicate
4877 @itemx reorder-blocks-duplicate-feedback
4878
4879 Used by basic block reordering pass to decide whether to use unconditional
4880 branch or duplicate the code on its destination.  Code is duplicated when its
4881 estimated size is smaller than this value multiplied by the estimated size of
4882 unconditional jump in the hot spots of the program.
4883
4884 The @option{reorder-block-duplicate-feedback} is used only when profile
4885 feedback is available and may be set to higher values than
4886 @option{reorder-block-duplicate} since information about the hot spots is more
4887 accurate.
4888 @end table
4889 @end table
4890
4891 @node Preprocessor Options
4892 @section Options Controlling the Preprocessor
4893 @cindex preprocessor options
4894 @cindex options, preprocessor
4895
4896 These options control the C preprocessor, which is run on each C source
4897 file before actual compilation.
4898
4899 If you use the @option{-E} option, nothing is done except preprocessing.
4900 Some of these options make sense only together with @option{-E} because
4901 they cause the preprocessor output to be unsuitable for actual
4902 compilation.
4903
4904 @table @gcctabopt
4905 @opindex Wp
4906 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4907 and pass @var{option} directly through to the preprocessor.  If
4908 @var{option} contains commas, it is split into multiple options at the
4909 commas.  However, many options are modified, translated or interpreted
4910 by the compiler driver before being passed to the preprocessor, and
4911 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4912 interface is undocumented and subject to change, so whenever possible
4913 you should avoid using @option{-Wp} and let the driver handle the
4914 options instead.
4915
4916 @item -Xpreprocessor @var{option}
4917 @opindex preprocessor
4918 Pass @var{option} as an option to the preprocessor.  You can use this to
4919 supply system-specific preprocessor options which GCC does not know how to
4920 recognize.
4921
4922 If you want to pass an option that takes an argument, you must use
4923 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4924 @end table
4925
4926 @include cppopts.texi
4927
4928 @node Assembler Options
4929 @section Passing Options to the Assembler
4930
4931 @c prevent bad page break with this line
4932 You can pass options to the assembler.
4933
4934 @table @gcctabopt
4935 @item -Wa,@var{option}
4936 @opindex Wa
4937 Pass @var{option} as an option to the assembler.  If @var{option}
4938 contains commas, it is split into multiple options at the commas.
4939
4940 @item -Xassembler @var{option}
4941 @opindex Xassembler
4942 Pass @var{option} as an option to the assembler.  You can use this to
4943 supply system-specific assembler options which GCC does not know how to
4944 recognize.
4945
4946 If you want to pass an option that takes an argument, you must use
4947 @option{-Xassembler} twice, once for the option and once for the argument.
4948
4949 @end table
4950
4951 @node Link Options
4952 @section Options for Linking
4953 @cindex link options
4954 @cindex options, linking
4955
4956 These options come into play when the compiler links object files into
4957 an executable output file.  They are meaningless if the compiler is
4958 not doing a link step.
4959
4960 @table @gcctabopt
4961 @cindex file names
4962 @item @var{object-file-name}
4963 A file name that does not end in a special recognized suffix is
4964 considered to name an object file or library.  (Object files are
4965 distinguished from libraries by the linker according to the file
4966 contents.)  If linking is done, these object files are used as input
4967 to the linker.
4968
4969 @item -c
4970 @itemx -S
4971 @itemx -E
4972 @opindex c
4973 @opindex S
4974 @opindex E
4975 If any of these options is used, then the linker is not run, and
4976 object file names should not be used as arguments.  @xref{Overall
4977 Options}.
4978
4979 @cindex Libraries
4980 @item -l@var{library}
4981 @itemx -l @var{library}
4982 @opindex l
4983 Search the library named @var{library} when linking.  (The second
4984 alternative with the library as a separate argument is only for
4985 POSIX compliance and is not recommended.)
4986
4987 It makes a difference where in the command you write this option; the
4988 linker searches and processes libraries and object files in the order they
4989 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4990 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4991 to functions in @samp{z}, those functions may not be loaded.
4992
4993 The linker searches a standard list of directories for the library,
4994 which is actually a file named @file{lib@var{library}.a}.  The linker
4995 then uses this file as if it had been specified precisely by name.
4996
4997 The directories searched include several standard system directories
4998 plus any that you specify with @option{-L}.
4999
5000 Normally the files found this way are library files---archive files
5001 whose members are object files.  The linker handles an archive file by
5002 scanning through it for members which define symbols that have so far
5003 been referenced but not defined.  But if the file that is found is an
5004 ordinary object file, it is linked in the usual fashion.  The only
5005 difference between using an @option{-l} option and specifying a file name
5006 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5007 and searches several directories.
5008
5009 @item -lobjc
5010 @opindex lobjc
5011 You need this special case of the @option{-l} option in order to
5012 link an Objective-C program.
5013
5014 @item -nostartfiles
5015 @opindex nostartfiles
5016 Do not use the standard system startup files when linking.
5017 The standard system libraries are used normally, unless @option{-nostdlib}
5018 or @option{-nodefaultlibs} is used.
5019
5020 @item -nodefaultlibs
5021 @opindex nodefaultlibs
5022 Do not use the standard system libraries when linking.
5023 Only the libraries you specify will be passed to the linker.
5024 The standard startup files are used normally, unless @option{-nostartfiles}
5025 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5026 for System V (and ISO C) environments or to bcopy and bzero for
5027 BSD environments.  These entries are usually resolved by entries in
5028 libc.  These entry points should be supplied through some other
5029 mechanism when this option is specified.
5030
5031 @item -nostdlib
5032 @opindex nostdlib
5033 Do not use the standard system startup files or libraries when linking.
5034 No startup files and only the libraries you specify will be passed to
5035 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5036 for System V (and ISO C) environments or to bcopy and bzero for
5037 BSD environments.  These entries are usually resolved by entries in
5038 libc.  These entry points should be supplied through some other
5039 mechanism when this option is specified.
5040
5041 @cindex @option{-lgcc}, use with @option{-nostdlib}
5042 @cindex @option{-nostdlib} and unresolved references
5043 @cindex unresolved references and @option{-nostdlib}
5044 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5045 @cindex @option{-nodefaultlibs} and unresolved references
5046 @cindex unresolved references and @option{-nodefaultlibs}
5047 One of the standard libraries bypassed by @option{-nostdlib} and
5048 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5049 that GCC uses to overcome shortcomings of particular machines, or special
5050 needs for some languages.
5051 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5052 Collection (GCC) Internals},
5053 for more discussion of @file{libgcc.a}.)
5054 In most cases, you need @file{libgcc.a} even when you want to avoid
5055 other standard libraries.  In other words, when you specify @option{-nostdlib}
5056 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5057 This ensures that you have no unresolved references to internal GCC
5058 library subroutines.  (For example, @samp{__main}, used to ensure C++
5059 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5060 GNU Compiler Collection (GCC) Internals}.)
5061
5062 @item -pie
5063 @opindex pie
5064 Produce a position independent executable on targets which support it.
5065 For predictable results, you must also specify the same set of options
5066 that were used to generate code (@option{-fpie}, @option{-fPIE},
5067 or model suboptions) when you specify this option.
5068
5069 @item -s
5070 @opindex s
5071 Remove all symbol table and relocation information from the executable.
5072
5073 @item -static
5074 @opindex static
5075 On systems that support dynamic linking, this prevents linking with the shared
5076 libraries.  On other systems, this option has no effect.
5077
5078 @item -shared
5079 @opindex shared
5080 Produce a shared object which can then be linked with other objects to
5081 form an executable.  Not all systems support this option.  For predictable
5082 results, you must also specify the same set of options that were used to
5083 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5084 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5085 needs to build supplementary stub code for constructors to work.  On
5086 multi-libbed systems, @samp{gcc -shared} must select the correct support
5087 libraries to link against.  Failing to supply the correct flags may lead
5088 to subtle defects.  Supplying them in cases where they are not necessary
5089 is innocuous.}
5090
5091 @item -shared-libgcc
5092 @itemx -static-libgcc
5093 @opindex shared-libgcc
5094 @opindex static-libgcc
5095 On systems that provide @file{libgcc} as a shared library, these options
5096 force the use of either the shared or static version respectively.
5097 If no shared version of @file{libgcc} was built when the compiler was
5098 configured, these options have no effect.
5099
5100 There are several situations in which an application should use the
5101 shared @file{libgcc} instead of the static version.  The most common
5102 of these is when the application wishes to throw and catch exceptions
5103 across different shared libraries.  In that case, each of the libraries
5104 as well as the application itself should use the shared @file{libgcc}.
5105
5106 Therefore, the G++ and GCJ drivers automatically add
5107 @option{-shared-libgcc} whenever you build a shared library or a main
5108 executable, because C++ and Java programs typically use exceptions, so
5109 this is the right thing to do.
5110
5111 If, instead, you use the GCC driver to create shared libraries, you may
5112 find that they will not always be linked with the shared @file{libgcc}.
5113 If GCC finds, at its configuration time, that you have a GNU linker that
5114 does not support option @option{--eh-frame-hdr}, it will link the shared
5115 version of @file{libgcc} into shared libraries by default.  Otherwise,
5116 it will take advantage of the linker and optimize away the linking with
5117 the shared version of @file{libgcc}, linking with the static version of
5118 libgcc by default.  This allows exceptions to propagate through such
5119 shared libraries, without incurring relocation costs at library load
5120 time.
5121
5122 However, if a library or main executable is supposed to throw or catch
5123 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5124 for the languages used in the program, or using the option
5125 @option{-shared-libgcc}, such that it is linked with the shared
5126 @file{libgcc}.
5127
5128 @item -symbolic
5129 @opindex symbolic
5130 Bind references to global symbols when building a shared object.  Warn
5131 about any unresolved references (unless overridden by the link editor
5132 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5133 this option.
5134
5135 @item -Xlinker @var{option}
5136 @opindex Xlinker
5137 Pass @var{option} as an option to the linker.  You can use this to
5138 supply system-specific linker options which GCC does not know how to
5139 recognize.
5140
5141 If you want to pass an option that takes an argument, you must use
5142 @option{-Xlinker} twice, once for the option and once for the argument.
5143 For example, to pass @option{-assert definitions}, you must write
5144 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5145 @option{-Xlinker "-assert definitions"}, because this passes the entire
5146 string as a single argument, which is not what the linker expects.
5147
5148 @item -Wl,@var{option}
5149 @opindex Wl
5150 Pass @var{option} as an option to the linker.  If @var{option} contains
5151 commas, it is split into multiple options at the commas.
5152
5153 @item -u @var{symbol}
5154 @opindex u
5155 Pretend the symbol @var{symbol} is undefined, to force linking of
5156 library modules to define it.  You can use @option{-u} multiple times with
5157 different symbols to force loading of additional library modules.
5158 @end table
5159
5160 @node Directory Options
5161 @section Options for Directory Search
5162 @cindex directory options
5163 @cindex options, directory search
5164 @cindex search path
5165
5166 These options specify directories to search for header files, for
5167 libraries and for parts of the compiler:
5168
5169 @table @gcctabopt
5170 @item -I@var{dir}
5171 @opindex I
5172 Add the directory @var{dir} to the head of the list of directories to be
5173 searched for header files.  This can be used to override a system header
5174 file, substituting your own version, since these directories are
5175 searched before the system header file directories.  However, you should
5176 not use this option to add directories that contain vendor-supplied
5177 system header files (use @option{-isystem} for that).  If you use more than
5178 one @option{-I} option, the directories are scanned in left-to-right
5179 order; the standard system directories come after.
5180
5181 If a standard system include directory, or a directory specified with
5182 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5183 option will be ignored.  The directory will still be searched but as a
5184 system directory at its normal position in the system include chain.
5185 This is to ensure that GCC's procedure to fix buggy system headers and
5186 the ordering for the include_next directive are not inadvertently changed.
5187 If you really need to change the search order for system directories,
5188 use the @option{-nostdinc} and/or @option{-isystem} options.
5189
5190 @item -I-
5191 @opindex I-
5192 Any directories you specify with @option{-I} options before the @option{-I-}
5193 option are searched only for the case of @samp{#include "@var{file}"};
5194 they are not searched for @samp{#include <@var{file}>}.
5195
5196 If additional directories are specified with @option{-I} options after
5197 the @option{-I-}, these directories are searched for all @samp{#include}
5198 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5199 this way.)
5200
5201 In addition, the @option{-I-} option inhibits the use of the current
5202 directory (where the current input file came from) as the first search
5203 directory for @samp{#include "@var{file}"}.  There is no way to
5204 override this effect of @option{-I-}.  With @option{-I.} you can specify
5205 searching the directory which was current when the compiler was
5206 invoked.  That is not exactly the same as what the preprocessor does
5207 by default, but it is often satisfactory.
5208
5209 @option{-I-} does not inhibit the use of the standard system directories
5210 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5211 independent.
5212
5213 @item -L@var{dir}
5214 @opindex L
5215 Add directory @var{dir} to the list of directories to be searched
5216 for @option{-l}.
5217
5218 @item -B@var{prefix}
5219 @opindex B
5220 This option specifies where to find the executables, libraries,
5221 include files, and data files of the compiler itself.
5222
5223 The compiler driver program runs one or more of the subprograms
5224 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5225 @var{prefix} as a prefix for each program it tries to run, both with and
5226 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5227
5228 For each subprogram to be run, the compiler driver first tries the
5229 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5230 was not specified, the driver tries two standard prefixes, which are
5231 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5232 those results in a file name that is found, the unmodified program
5233 name is searched for using the directories specified in your
5234 @env{PATH} environment variable.
5235
5236 The compiler will check to see if the path provided by the @option{-B}
5237 refers to a directory, and if necessary it will add a directory
5238 separator character at the end of the path.
5239
5240 @option{-B} prefixes that effectively specify directory names also apply
5241 to libraries in the linker, because the compiler translates these
5242 options into @option{-L} options for the linker.  They also apply to
5243 includes files in the preprocessor, because the compiler translates these
5244 options into @option{-isystem} options for the preprocessor.  In this case,
5245 the compiler appends @samp{include} to the prefix.
5246
5247 The run-time support file @file{libgcc.a} can also be searched for using
5248 the @option{-B} prefix, if needed.  If it is not found there, the two
5249 standard prefixes above are tried, and that is all.  The file is left
5250 out of the link if it is not found by those means.
5251
5252 Another way to specify a prefix much like the @option{-B} prefix is to use
5253 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5254 Variables}.
5255
5256 As a special kludge, if the path provided by @option{-B} is
5257 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5258 9, then it will be replaced by @file{[dir/]include}.  This is to help
5259 with boot-strapping the compiler.
5260
5261 @item -specs=@var{file}
5262 @opindex specs
5263 Process @var{file} after the compiler reads in the standard @file{specs}
5264 file, in order to override the defaults that the @file{gcc} driver
5265 program uses when determining what switches to pass to @file{cc1},
5266 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5267 @option{-specs=@var{file}} can be specified on the command line, and they
5268 are processed in order, from left to right.
5269 @end table
5270
5271 @c man end
5272
5273 @node Spec Files
5274 @section Specifying subprocesses and the switches to pass to them
5275 @cindex Spec Files
5276
5277 @command{gcc} is a driver program.  It performs its job by invoking a
5278 sequence of other programs to do the work of compiling, assembling and
5279 linking.  GCC interprets its command-line parameters and uses these to
5280 deduce which programs it should invoke, and which command-line options
5281 it ought to place on their command lines.  This behavior is controlled
5282 by @dfn{spec strings}.  In most cases there is one spec string for each
5283 program that GCC can invoke, but a few programs have multiple spec
5284 strings to control their behavior.  The spec strings built into GCC can
5285 be overridden by using the @option{-specs=} command-line switch to specify
5286 a spec file.
5287
5288 @dfn{Spec files} are plaintext files that are used to construct spec
5289 strings.  They consist of a sequence of directives separated by blank
5290 lines.  The type of directive is determined by the first non-whitespace
5291 character on the line and it can be one of the following:
5292
5293 @table @code
5294 @item %@var{command}
5295 Issues a @var{command} to the spec file processor.  The commands that can
5296 appear here are:
5297
5298 @table @code
5299 @item %include <@var{file}>
5300 @cindex %include
5301 Search for @var{file} and insert its text at the current point in the
5302 specs file.
5303
5304 @item %include_noerr <@var{file}>
5305 @cindex %include_noerr
5306 Just like @samp{%include}, but do not generate an error message if the include
5307 file cannot be found.
5308
5309 @item %rename @var{old_name} @var{new_name}
5310 @cindex %rename
5311 Rename the spec string @var{old_name} to @var{new_name}.
5312
5313 @end table
5314
5315 @item *[@var{spec_name}]:
5316 This tells the compiler to create, override or delete the named spec
5317 string.  All lines after this directive up to the next directive or
5318 blank line are considered to be the text for the spec string.  If this
5319 results in an empty string then the spec will be deleted.  (Or, if the
5320 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5321 does not currently exist a new spec will be created.  If the spec does
5322 exist then its contents will be overridden by the text of this
5323 directive, unless the first character of that text is the @samp{+}
5324 character, in which case the text will be appended to the spec.
5325
5326 @item [@var{suffix}]:
5327 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5328 and up to the next directive or blank line are considered to make up the
5329 spec string for the indicated suffix.  When the compiler encounters an
5330 input file with the named suffix, it will processes the spec string in
5331 order to work out how to compile that file.  For example:
5332
5333 @smallexample
5334 .ZZ:
5335 z-compile -input %i
5336 @end smallexample
5337
5338 This says that any input file whose name ends in @samp{.ZZ} should be
5339 passed to the program @samp{z-compile}, which should be invoked with the
5340 command-line switch @option{-input} and with the result of performing the
5341 @samp{%i} substitution.  (See below.)
5342
5343 As an alternative to providing a spec string, the text that follows a
5344 suffix directive can be one of the following:
5345
5346 @table @code
5347 @item @@@var{language}
5348 This says that the suffix is an alias for a known @var{language}.  This is
5349 similar to using the @option{-x} command-line switch to GCC to specify a
5350 language explicitly.  For example:
5351
5352 @smallexample
5353 .ZZ:
5354 @@c++
5355 @end smallexample
5356
5357 Says that .ZZ files are, in fact, C++ source files.
5358
5359 @item #@var{name}
5360 This causes an error messages saying:
5361
5362 @smallexample
5363 @var{name} compiler not installed on this system.
5364 @end smallexample
5365 @end table
5366
5367 GCC already has an extensive list of suffixes built into it.
5368 This directive will add an entry to the end of the list of suffixes, but
5369 since the list is searched from the end backwards, it is effectively
5370 possible to override earlier entries using this technique.
5371
5372 @end table
5373
5374 GCC has the following spec strings built into it.  Spec files can
5375 override these strings or create their own.  Note that individual
5376 targets can also add their own spec strings to this list.
5377
5378 @smallexample
5379 asm          Options to pass to the assembler
5380 asm_final    Options to pass to the assembler post-processor
5381 cpp          Options to pass to the C preprocessor
5382 cc1          Options to pass to the C compiler
5383 cc1plus      Options to pass to the C++ compiler
5384 endfile      Object files to include at the end of the link
5385 link         Options to pass to the linker
5386 lib          Libraries to include on the command line to the linker
5387 libgcc       Decides which GCC support library to pass to the linker
5388 linker       Sets the name of the linker
5389 predefines   Defines to be passed to the C preprocessor
5390 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5391              by default
5392 startfile    Object files to include at the start of the link
5393 @end smallexample
5394
5395 Here is a small example of a spec file:
5396
5397 @smallexample
5398 %rename lib                 old_lib
5399
5400 *lib:
5401 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5402 @end smallexample
5403
5404 This example renames the spec called @samp{lib} to @samp{old_lib} and
5405 then overrides the previous definition of @samp{lib} with a new one.
5406 The new definition adds in some extra command-line options before
5407 including the text of the old definition.
5408
5409 @dfn{Spec strings} are a list of command-line options to be passed to their
5410 corresponding program.  In addition, the spec strings can contain
5411 @samp{%}-prefixed sequences to substitute variable text or to
5412 conditionally insert text into the command line.  Using these constructs
5413 it is possible to generate quite complex command lines.
5414
5415 Here is a table of all defined @samp{%}-sequences for spec
5416 strings.  Note that spaces are not generated automatically around the
5417 results of expanding these sequences.  Therefore you can concatenate them
5418 together or combine them with constant text in a single argument.
5419
5420 @table @code
5421 @item %%
5422 Substitute one @samp{%} into the program name or argument.
5423
5424 @item %i
5425 Substitute the name of the input file being processed.
5426
5427 @item %b
5428 Substitute the basename of the input file being processed.
5429 This is the substring up to (and not including) the last period
5430 and not including the directory.
5431
5432 @item %B
5433 This is the same as @samp{%b}, but include the file suffix (text after
5434 the last period).
5435
5436 @item %d
5437 Marks the argument containing or following the @samp{%d} as a
5438 temporary file name, so that that file will be deleted if GCC exits
5439 successfully.  Unlike @samp{%g}, this contributes no text to the
5440 argument.
5441
5442 @item %g@var{suffix}
5443 Substitute a file name that has suffix @var{suffix} and is chosen
5444 once per compilation, and mark the argument in the same way as
5445 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5446 name is now chosen in a way that is hard to predict even when previously
5447 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5448 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5449 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5450 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5451 was simply substituted with a file name chosen once per compilation,
5452 without regard to any appended suffix (which was therefore treated
5453 just like ordinary text), making such attacks more likely to succeed.
5454
5455 @item %u@var{suffix}
5456 Like @samp{%g}, but generates a new temporary file name even if
5457 @samp{%u@var{suffix}} was already seen.
5458
5459 @item %U@var{suffix}
5460 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5461 new one if there is no such last file name.  In the absence of any
5462 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5463 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5464 would involve the generation of two distinct file names, one
5465 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5466 simply substituted with a file name chosen for the previous @samp{%u},
5467 without regard to any appended suffix.
5468
5469 @item %j@var{suffix}
5470 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5471 writable, and if save-temps is off; otherwise, substitute the name
5472 of a temporary file, just like @samp{%u}.  This temporary file is not
5473 meant for communication between processes, but rather as a junk
5474 disposal mechanism.
5475
5476 @item %|@var{suffix}
5477 @itemx %m@var{suffix}
5478 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5479 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5480 all.  These are the two most common ways to instruct a program that it
5481 should read from standard input or write to standard output.  If you
5482 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5483 construct: see for example @file{f/lang-specs.h}.
5484
5485 @item %.@var{SUFFIX}
5486 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5487 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5488 terminated by the next space or %.
5489
5490 @item %w
5491 Marks the argument containing or following the @samp{%w} as the
5492 designated output file of this compilation.  This puts the argument
5493 into the sequence of arguments that @samp{%o} will substitute later.
5494
5495 @item %o
5496 Substitutes the names of all the output files, with spaces
5497 automatically placed around them.  You should write spaces
5498 around the @samp{%o} as well or the results are undefined.
5499 @samp{%o} is for use in the specs for running the linker.
5500 Input files whose names have no recognized suffix are not compiled
5501 at all, but they are included among the output files, so they will
5502 be linked.
5503
5504 @item %O
5505 Substitutes the suffix for object files.  Note that this is
5506 handled specially when it immediately follows @samp{%g, %u, or %U},
5507 because of the need for those to form complete file names.  The
5508 handling is such that @samp{%O} is treated exactly as if it had already
5509 been substituted, except that @samp{%g, %u, and %U} do not currently
5510 support additional @var{suffix} characters following @samp{%O} as they would
5511 following, for example, @samp{.o}.
5512
5513 @item %p
5514 Substitutes the standard macro predefinitions for the
5515 current target machine.  Use this when running @code{cpp}.
5516
5517 @item %P
5518 Like @samp{%p}, but puts @samp{__} before and after the name of each
5519 predefined macro, except for macros that start with @samp{__} or with
5520 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5521 C@.
5522
5523 @item %I
5524 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5525 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5526 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5527 as necessary.
5528
5529 @item %s
5530 Current argument is the name of a library or startup file of some sort.
5531 Search for that file in a standard list of directories and substitute
5532 the full name found.
5533
5534 @item %e@var{str}
5535 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5536 Use this when inconsistent options are detected.
5537
5538 @item %(@var{name})
5539 Substitute the contents of spec string @var{name} at this point.
5540
5541 @item %[@var{name}]
5542 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5543
5544 @item %x@{@var{option}@}
5545 Accumulate an option for @samp{%X}.
5546
5547 @item %X
5548 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5549 spec string.
5550
5551 @item %Y
5552 Output the accumulated assembler options specified by @option{-Wa}.
5553
5554 @item %Z
5555 Output the accumulated preprocessor options specified by @option{-Wp}.
5556
5557 @item %a
5558 Process the @code{asm} spec.  This is used to compute the
5559 switches to be passed to the assembler.
5560
5561 @item %A
5562 Process the @code{asm_final} spec.  This is a spec string for
5563 passing switches to an assembler post-processor, if such a program is
5564 needed.
5565
5566 @item %l
5567 Process the @code{link} spec.  This is the spec for computing the
5568 command line passed to the linker.  Typically it will make use of the
5569 @samp{%L %G %S %D and %E} sequences.
5570
5571 @item %D
5572 Dump out a @option{-L} option for each directory that GCC believes might
5573 contain startup files.  If the target supports multilibs then the
5574 current multilib directory will be prepended to each of these paths.
5575
5576 @item %M
5577 Output the multilib directory with directory separators replaced with
5578 @samp{_}.  If multilib directories are not set, or the multilib directory is
5579 @file{.} then this option emits nothing.
5580
5581 @item %L
5582 Process the @code{lib} spec.  This is a spec string for deciding which
5583 libraries should be included on the command line to the linker.
5584
5585 @item %G
5586 Process the @code{libgcc} spec.  This is a spec string for deciding
5587 which GCC support library should be included on the command line to the linker.
5588
5589 @item %S
5590 Process the @code{startfile} spec.  This is a spec for deciding which
5591 object files should be the first ones passed to the linker.  Typically
5592 this might be a file named @file{crt0.o}.
5593
5594 @item %E
5595 Process the @code{endfile} spec.  This is a spec string that specifies
5596 the last object files that will be passed to the linker.
5597
5598 @item %C
5599 Process the @code{cpp} spec.  This is used to construct the arguments
5600 to be passed to the C preprocessor.
5601
5602 @item %c
5603 Process the @code{signed_char} spec.  This is intended to be used
5604 to tell cpp whether a char is signed.  It typically has the definition:
5605 @smallexample
5606 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5607 @end smallexample
5608
5609 @item %1
5610 Process the @code{cc1} spec.  This is used to construct the options to be
5611 passed to the actual C compiler (@samp{cc1}).
5612
5613 @item %2
5614 Process the @code{cc1plus} spec.  This is used to construct the options to be
5615 passed to the actual C++ compiler (@samp{cc1plus}).
5616
5617 @item %*
5618 Substitute the variable part of a matched option.  See below.
5619 Note that each comma in the substituted string is replaced by
5620 a single space.
5621
5622 @item %<@code{S}
5623 Remove all occurrences of @code{-S} from the command line.  Note---this
5624 command is position dependent.  @samp{%} commands in the spec string
5625 before this one will see @code{-S}, @samp{%} commands in the spec string
5626 after this one will not.
5627
5628 @item %:@var{function}(@var{args})
5629 Call the named function @var{function}, passing it @var{args}.
5630 @var{args} is first processed as a nested spec string, then split
5631 into an argument vector in the usual fashion.  The function returns
5632 a string which is processed as if it had appeared literally as part
5633 of the current spec.
5634
5635 The following built-in spec functions are provided:
5636
5637 @table @code
5638 @item @code{if-exists}
5639 The @code{if-exists} spec function takes one argument, an absolute
5640 pathname to a file.  If the file exists, @code{if-exists} returns the
5641 pathname.  Here is a small example of its usage:
5642
5643 @smallexample
5644 *startfile:
5645 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5646 @end smallexample
5647
5648 @item @code{if-exists-else}
5649 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5650 spec function, except that it takes two arguments.  The first argument is
5651 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5652 returns the pathname.  If it does not exist, it returns the second argument.
5653 This way, @code{if-exists-else} can be used to select one file or another,
5654 based on the existence of the first.  Here is a small example of its usage:
5655
5656 @smallexample
5657 *startfile:
5658 crt0%O%s %:if-exists(crti%O%s) \
5659 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5660 @end smallexample
5661 @end table
5662
5663 @item %@{@code{S}@}
5664 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5665 If that switch was not specified, this substitutes nothing.  Note that
5666 the leading dash is omitted when specifying this option, and it is
5667 automatically inserted if the substitution is performed.  Thus the spec
5668 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5669 and would output the command line option @option{-foo}.
5670
5671 @item %W@{@code{S}@}
5672 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5673 deleted on failure.
5674
5675 @item %@{@code{S}*@}
5676 Substitutes all the switches specified to GCC whose names start
5677 with @code{-S}, but which also take an argument.  This is used for
5678 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5679 GCC considers @option{-o foo} as being
5680 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5681 text, including the space.  Thus two arguments would be generated.
5682
5683 @item %@{@code{S}*&@code{T}*@}
5684 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5685 (the order of @code{S} and @code{T} in the spec is not significant).
5686 There can be any number of ampersand-separated variables; for each the
5687 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5688
5689 @item %@{@code{S}:@code{X}@}
5690 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5691
5692 @item %@{!@code{S}:@code{X}@}
5693 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5694
5695 @item %@{@code{S}*:@code{X}@}
5696 Substitutes @code{X} if one or more switches whose names start with
5697 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5698 once, no matter how many such switches appeared.  However, if @code{%*}
5699 appears somewhere in @code{X}, then @code{X} will be substituted once
5700 for each matching switch, with the @code{%*} replaced by the part of
5701 that switch that matched the @code{*}.
5702
5703 @item %@{.@code{S}:@code{X}@}
5704 Substitutes @code{X}, if processing a file with suffix @code{S}.
5705
5706 @item %@{!.@code{S}:@code{X}@}
5707 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5708
5709 @item %@{@code{S}|@code{P}:@code{X}@}
5710 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5711 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5712 although they have a stronger binding than the @samp{|}.  If @code{%*}
5713 appears in @code{X}, all of the alternatives must be starred, and only
5714 the first matching alternative is substituted.
5715
5716 For example, a spec string like this:
5717
5718 @smallexample
5719 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5720 @end smallexample
5721
5722 will output the following command-line options from the following input
5723 command-line options:
5724
5725 @smallexample
5726 fred.c        -foo -baz
5727 jim.d         -bar -boggle
5728 -d fred.c     -foo -baz -boggle
5729 -d jim.d      -bar -baz -boggle
5730 @end smallexample
5731
5732 @item %@{S:X; T:Y; :D@}
5733
5734 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5735 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5736 be as many clauses as you need.  This may be combined with @code{.},
5737 @code{!}, @code{|}, and @code{*} as needed.
5738
5739
5740 @end table
5741
5742 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5743 construct may contain other nested @samp{%} constructs or spaces, or
5744 even newlines.  They are processed as usual, as described above.
5745 Trailing white space in @code{X} is ignored.  White space may also
5746 appear anywhere on the left side of the colon in these constructs,
5747 except between @code{.} or @code{*} and the corresponding word.
5748
5749 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5750 handled specifically in these constructs.  If another value of
5751 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5752 @option{-W} switch is found later in the command line, the earlier
5753 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5754 just one letter, which passes all matching options.
5755
5756 The character @samp{|} at the beginning of the predicate text is used to
5757 indicate that a command should be piped to the following command, but
5758 only if @option{-pipe} is specified.
5759
5760 It is built into GCC which switches take arguments and which do not.
5761 (You might think it would be useful to generalize this to allow each
5762 compiler's spec to say which switches take arguments.  But this cannot
5763 be done in a consistent fashion.  GCC cannot even decide which input
5764 files have been specified without knowing which switches take arguments,
5765 and it must know which input files to compile in order to tell which
5766 compilers to run).
5767
5768 GCC also knows implicitly that arguments starting in @option{-l} are to be
5769 treated as compiler output files, and passed to the linker in their
5770 proper position among the other output files.
5771
5772 @c man begin OPTIONS
5773
5774 @node Target Options
5775 @section Specifying Target Machine and Compiler Version
5776 @cindex target options
5777 @cindex cross compiling
5778 @cindex specifying machine version
5779 @cindex specifying compiler version and target machine
5780 @cindex compiler version, specifying
5781 @cindex target machine, specifying
5782
5783 The usual way to run GCC is to run the executable called @file{gcc}, or
5784 @file{<machine>-gcc} when cross-compiling, or
5785 @file{<machine>-gcc-<version>} to run a version other than the one that
5786 was installed last.  Sometimes this is inconvenient, so GCC provides
5787 options that will switch to another cross-compiler or version.
5788
5789 @table @gcctabopt
5790 @item -b @var{machine}
5791 @opindex b
5792 The argument @var{machine} specifies the target machine for compilation.
5793
5794 The value to use for @var{machine} is the same as was specified as the
5795 machine type when configuring GCC as a cross-compiler.  For
5796 example, if a cross-compiler was configured with @samp{configure
5797 i386v}, meaning to compile for an 80386 running System V, then you
5798 would specify @option{-b i386v} to run that cross compiler.
5799
5800 @item -V @var{version}
5801 @opindex V
5802 The argument @var{version} specifies which version of GCC to run.
5803 This is useful when multiple versions are installed.  For example,
5804 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5805 @end table
5806
5807 The @option{-V} and @option{-b} options work by running the
5808 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5809 use them if you can just run that directly.
5810
5811 @node Submodel Options
5812 @section Hardware Models and Configurations
5813 @cindex submodel options
5814 @cindex specifying hardware config
5815 @cindex hardware models and configurations, specifying
5816 @cindex machine dependent options
5817
5818 Earlier we discussed the standard option @option{-b} which chooses among
5819 different installed compilers for completely different target
5820 machines, such as VAX vs.@: 68000 vs.@: 80386.
5821
5822 In addition, each of these target machine types can have its own
5823 special options, starting with @samp{-m}, to choose among various
5824 hardware models or configurations---for example, 68010 vs 68020,
5825 floating coprocessor or none.  A single installed version of the
5826 compiler can compile for any model or configuration, according to the
5827 options specified.
5828
5829 Some configurations of the compiler also support additional special
5830 options, usually for compatibility with other compilers on the same
5831 platform.
5832
5833 These options are defined by the macro @code{TARGET_SWITCHES} in the
5834 machine description.  The default for the options is also defined by
5835 that macro, which enables you to change the defaults.
5836
5837 @menu
5838 * M680x0 Options::
5839 * M68hc1x Options::
5840 * VAX Options::
5841 * SPARC Options::
5842 * ARM Options::
5843 * MN10300 Options::
5844 * M32R/D Options::
5845 * RS/6000 and PowerPC Options::
5846 * Darwin Options::
5847 * MIPS Options::
5848 * i386 and x86-64 Options::
5849 * HPPA Options::
5850 * Intel 960 Options::
5851 * DEC Alpha Options::
5852 * DEC Alpha/VMS Options::
5853 * H8/300 Options::
5854 * SH Options::
5855 * System V Options::
5856 * TMS320C3x/C4x Options::
5857 * V850 Options::
5858 * ARC Options::
5859 * NS32K Options::
5860 * AVR Options::
5861 * MCore Options::
5862 * IA-64 Options::
5863 * D30V Options::
5864 * S/390 and zSeries Options::
5865 * CRIS Options::
5866 * MMIX Options::
5867 * PDP-11 Options::
5868 * Xstormy16 Options::
5869 * Xtensa Options::
5870 * FRV Options::
5871 @end menu
5872
5873 @node M680x0 Options
5874 @subsection M680x0 Options
5875 @cindex M680x0 options
5876
5877 These are the @samp{-m} options defined for the 68000 series.  The default
5878 values for these options depends on which style of 68000 was selected when
5879 the compiler was configured; the defaults for the most common choices are
5880 given below.
5881
5882 @table @gcctabopt
5883 @item -m68000
5884 @itemx -mc68000
5885 @opindex m68000
5886 @opindex mc68000
5887 Generate output for a 68000.  This is the default
5888 when the compiler is configured for 68000-based systems.
5889
5890 Use this option for microcontrollers with a 68000 or EC000 core,
5891 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5892
5893 @item -m68020
5894 @itemx -mc68020
5895 @opindex m68020
5896 @opindex mc68020
5897 Generate output for a 68020.  This is the default
5898 when the compiler is configured for 68020-based systems.
5899
5900 @item -m68881
5901 @opindex m68881
5902 Generate output containing 68881 instructions for floating point.
5903 This is the default for most 68020 systems unless @option{--nfp} was
5904 specified when the compiler was configured.
5905
5906 @item -m68030
5907 @opindex m68030
5908 Generate output for a 68030.  This is the default when the compiler is
5909 configured for 68030-based systems.
5910
5911 @item -m68040
5912 @opindex m68040
5913 Generate output for a 68040.  This is the default when the compiler is
5914 configured for 68040-based systems.
5915
5916 This option inhibits the use of 68881/68882 instructions that have to be
5917 emulated by software on the 68040.  Use this option if your 68040 does not
5918 have code to emulate those instructions.
5919
5920 @item -m68060
5921 @opindex m68060
5922 Generate output for a 68060.  This is the default when the compiler is
5923 configured for 68060-based systems.
5924
5925 This option inhibits the use of 68020 and 68881/68882 instructions that
5926 have to be emulated by software on the 68060.  Use this option if your 68060
5927 does not have code to emulate those instructions.
5928
5929 @item -mcpu32
5930 @opindex mcpu32
5931 Generate output for a CPU32.  This is the default
5932 when the compiler is configured for CPU32-based systems.
5933
5934 Use this option for microcontrollers with a
5935 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5936 68336, 68340, 68341, 68349 and 68360.
5937
5938 @item -m5200
5939 @opindex m5200
5940 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5941 when the compiler is configured for 520X-based systems.
5942
5943 Use this option for microcontroller with a 5200 core, including
5944 the MCF5202, MCF5203, MCF5204 and MCF5202.
5945
5946
5947 @item -m68020-40
5948 @opindex m68020-40
5949 Generate output for a 68040, without using any of the new instructions.
5950 This results in code which can run relatively efficiently on either a
5951 68020/68881 or a 68030 or a 68040.  The generated code does use the
5952 68881 instructions that are emulated on the 68040.
5953
5954 @item -m68020-60
5955 @opindex m68020-60
5956 Generate output for a 68060, without using any of the new instructions.
5957 This results in code which can run relatively efficiently on either a
5958 68020/68881 or a 68030 or a 68040.  The generated code does use the
5959 68881 instructions that are emulated on the 68060.
5960
5961 @item -msoft-float
5962 @opindex msoft-float
5963 Generate output containing library calls for floating point.
5964 @strong{Warning:} the requisite libraries are not available for all m68k
5965 targets.  Normally the facilities of the machine's usual C compiler are
5966 used, but this can't be done directly in cross-compilation.  You must
5967 make your own arrangements to provide suitable library functions for
5968 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5969 @samp{m68k-*-coff} do provide software floating point support.
5970
5971 @item -mshort
5972 @opindex mshort
5973 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5974
5975 @item -mnobitfield
5976 @opindex mnobitfield
5977 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5978 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5979
5980 @item -mbitfield
5981 @opindex mbitfield
5982 Do use the bit-field instructions.  The @option{-m68020} option implies
5983 @option{-mbitfield}.  This is the default if you use a configuration
5984 designed for a 68020.
5985
5986 @item -mrtd
5987 @opindex mrtd
5988 Use a different function-calling convention, in which functions
5989 that take a fixed number of arguments return with the @code{rtd}
5990 instruction, which pops their arguments while returning.  This
5991 saves one instruction in the caller since there is no need to pop
5992 the arguments there.
5993
5994 This calling convention is incompatible with the one normally
5995 used on Unix, so you cannot use it if you need to call libraries
5996 compiled with the Unix compiler.
5997
5998 Also, you must provide function prototypes for all functions that
5999 take variable numbers of arguments (including @code{printf});
6000 otherwise incorrect code will be generated for calls to those
6001 functions.
6002
6003 In addition, seriously incorrect code will result if you call a
6004 function with too many arguments.  (Normally, extra arguments are
6005 harmlessly ignored.)
6006
6007 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6008 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6009
6010 @item -malign-int
6011 @itemx -mno-align-int
6012 @opindex malign-int
6013 @opindex mno-align-int
6014 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6015 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6016 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6017 Aligning variables on 32-bit boundaries produces code that runs somewhat
6018 faster on processors with 32-bit busses at the expense of more memory.
6019
6020 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6021 align structures containing the above types  differently than
6022 most published application binary interface specifications for the m68k.
6023
6024 @item -mpcrel
6025 @opindex mpcrel
6026 Use the pc-relative addressing mode of the 68000 directly, instead of
6027 using a global offset table.  At present, this option implies @option{-fpic},
6028 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6029 not presently supported with @option{-mpcrel}, though this could be supported for
6030 68020 and higher processors.
6031
6032 @item -mno-strict-align
6033 @itemx -mstrict-align
6034 @opindex mno-strict-align
6035 @opindex mstrict-align
6036 Do not (do) assume that unaligned memory references will be handled by
6037 the system.
6038
6039 @item -msep-data
6040 Generate code that allows the data segment to be located in a different
6041 area of memory from the text segment.  This allows for execute in place in
6042 an environment without virtual memory management.  This option implies -fPIC.
6043
6044 @item -mno-sep-data
6045 Generate code that assumes that the data segment follows the text segment.
6046 This is the default.
6047
6048 @item -mid-shared-library
6049 Generate code that supports shared libraries via the library ID method.
6050 This allows for execute in place and shared libraries in an environment
6051 without virtual memory management.  This option implies -fPIC.
6052
6053 @item -mno-id-shared-library
6054 Generate code that doesn't assume ID based shared libraries are being used.
6055 This is the default.
6056
6057 @item -mshared-library-id=n
6058 Specified the identification number of the ID based shared library being
6059 compiled.  Specifying a value of 0 will generate more compact code, specifying
6060 other values will force the allocation of that number to the current
6061 library but is no more space or time efficient than omitting this option.
6062
6063 @end table
6064
6065 @node M68hc1x Options
6066 @subsection M68hc1x Options
6067 @cindex M68hc1x options
6068
6069 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6070 microcontrollers.  The default values for these options depends on
6071 which style of microcontroller was selected when the compiler was configured;
6072 the defaults for the most common choices are given below.
6073
6074 @table @gcctabopt
6075 @item -m6811
6076 @itemx -m68hc11
6077 @opindex m6811
6078 @opindex m68hc11
6079 Generate output for a 68HC11.  This is the default
6080 when the compiler is configured for 68HC11-based systems.
6081
6082 @item -m6812
6083 @itemx -m68hc12
6084 @opindex m6812
6085 @opindex m68hc12
6086 Generate output for a 68HC12.  This is the default
6087 when the compiler is configured for 68HC12-based systems.
6088
6089 @item -m68S12
6090 @itemx -m68hcs12
6091 @opindex m68S12
6092 @opindex m68hcs12
6093 Generate output for a 68HCS12.
6094
6095 @item -mauto-incdec
6096 @opindex mauto-incdec
6097 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6098 addressing modes.
6099
6100 @item -minmax
6101 @itemx -nominmax
6102 @opindex minmax
6103 @opindex mnominmax
6104 Enable the use of 68HC12 min and max instructions.
6105
6106 @item -mlong-calls
6107 @itemx -mno-long-calls
6108 @opindex mlong-calls
6109 @opindex mno-long-calls
6110 Treat all calls as being far away (near).  If calls are assumed to be
6111 far away, the compiler will use the @code{call} instruction to
6112 call a function and the @code{rtc} instruction for returning.
6113
6114 @item -mshort
6115 @opindex mshort
6116 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6117
6118 @item -msoft-reg-count=@var{count}
6119 @opindex msoft-reg-count
6120 Specify the number of pseudo-soft registers which are used for the
6121 code generation.  The maximum number is 32.  Using more pseudo-soft
6122 register may or may not result in better code depending on the program.
6123 The default is 4 for 68HC11 and 2 for 68HC12.
6124
6125 @end table
6126
6127 @node VAX Options
6128 @subsection VAX Options
6129 @cindex VAX options
6130
6131 These @samp{-m} options are defined for the VAX:
6132
6133 @table @gcctabopt
6134 @item -munix
6135 @opindex munix
6136 Do not output certain jump instructions (@code{aobleq} and so on)
6137 that the Unix assembler for the VAX cannot handle across long
6138 ranges.
6139
6140 @item -mgnu
6141 @opindex mgnu
6142 Do output those jump instructions, on the assumption that you
6143 will assemble with the GNU assembler.
6144
6145 @item -mg
6146 @opindex mg
6147 Output code for g-format floating point numbers instead of d-format.
6148 @end table
6149
6150 @node SPARC Options
6151 @subsection SPARC Options
6152 @cindex SPARC options
6153
6154 These @samp{-m} options are supported on the SPARC:
6155
6156 @table @gcctabopt
6157 @item -mno-app-regs
6158 @itemx -mapp-regs
6159 @opindex mno-app-regs
6160 @opindex mapp-regs
6161 Specify @option{-mapp-regs} to generate output using the global registers
6162 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6163 is the default.
6164
6165 To be fully SVR4 ABI compliant at the cost of some performance loss,
6166 specify @option{-mno-app-regs}.  You should compile libraries and system
6167 software with this option.
6168
6169 @item -mfpu
6170 @itemx -mhard-float
6171 @opindex mfpu
6172 @opindex mhard-float
6173 Generate output containing floating point instructions.  This is the
6174 default.
6175
6176 @item -mno-fpu
6177 @itemx -msoft-float
6178 @opindex mno-fpu
6179 @opindex msoft-float
6180 Generate output containing library calls for floating point.
6181 @strong{Warning:} the requisite libraries are not available for all SPARC
6182 targets.  Normally the facilities of the machine's usual C compiler are
6183 used, but this cannot be done directly in cross-compilation.  You must make
6184 your own arrangements to provide suitable library functions for
6185 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6186 @samp{sparclite-*-*} do provide software floating point support.
6187
6188 @option{-msoft-float} changes the calling convention in the output file;
6189 therefore, it is only useful if you compile @emph{all} of a program with
6190 this option.  In particular, you need to compile @file{libgcc.a}, the
6191 library that comes with GCC, with @option{-msoft-float} in order for
6192 this to work.
6193
6194 @item -mhard-quad-float
6195 @opindex mhard-quad-float
6196 Generate output containing quad-word (long double) floating point
6197 instructions.
6198
6199 @item -msoft-quad-float
6200 @opindex msoft-quad-float
6201 Generate output containing library calls for quad-word (long double)
6202 floating point instructions.  The functions called are those specified
6203 in the SPARC ABI@.  This is the default.
6204
6205 As of this writing, there are no SPARC implementations that have hardware
6206 support for the quad-word floating point instructions.  They all invoke
6207 a trap handler for one of these instructions, and then the trap handler
6208 emulates the effect of the instruction.  Because of the trap handler overhead,
6209 this is much slower than calling the ABI library routines.  Thus the
6210 @option{-msoft-quad-float} option is the default.
6211
6212 @item -mno-unaligned-doubles
6213 @itemx -munaligned-doubles
6214 @opindex mno-unaligned-doubles
6215 @opindex munaligned-doubles
6216 Assume that doubles have 8 byte alignment.  This is the default.
6217
6218 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6219 alignment only if they are contained in another type, or if they have an
6220 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6221 Specifying this option avoids some rare compatibility problems with code
6222 generated by other compilers.  It is not the default because it results
6223 in a performance loss, especially for floating point code.
6224
6225 @item -mno-faster-structs
6226 @itemx -mfaster-structs
6227 @opindex mno-faster-structs
6228 @opindex mfaster-structs
6229 With @option{-mfaster-structs}, the compiler assumes that structures
6230 should have 8 byte alignment.  This enables the use of pairs of
6231 @code{ldd} and @code{std} instructions for copies in structure
6232 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6233 However, the use of this changed alignment directly violates the SPARC
6234 ABI@.  Thus, it's intended only for use on targets where the developer
6235 acknowledges that their resulting code will not be directly in line with
6236 the rules of the ABI@.
6237
6238 @item -mimpure-text
6239 @opindex mimpure-text
6240 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6241 the compiler to not pass @option{-z text} to the linker when linking a
6242 shared object.  Using this option, you can link position-dependent
6243 code into a shared object.
6244
6245 @option{-mimpure-text} suppresses the ``relocations remain against
6246 allocatable but non-writable sections'' linker error message.
6247 However, the necessary relocations will trigger copy-on-write, and the
6248 shared object is not actually shared across processes.  Instead of
6249 using @option{-mimpure-text}, you should compile all source code with
6250 @option{-fpic} or @option{-fPIC}.
6251
6252 This option is only available on SunOS and Solaris.
6253
6254 @item -mcpu=@var{cpu_type}
6255 @opindex mcpu
6256 Set the instruction set, register set, and instruction scheduling parameters
6257 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6258 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6259 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
6260 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6261 @samp{ultrasparc3}.
6262
6263 Default instruction scheduling parameters are used for values that select
6264 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6265 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6266
6267 Here is a list of each supported architecture and their supported
6268 implementations.
6269
6270 @smallexample
6271     v7:             cypress
6272     v8:             supersparc, hypersparc
6273     sparclite:      f930, f934, sparclite86x
6274     sparclet:       tsc701
6275     v9:             ultrasparc, ultrasparc3
6276 @end smallexample
6277
6278 By default (unless configured otherwise), GCC generates code for the V7
6279 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
6280 additionally optimizes it for the Cypress CY7C602 chip, as used in the
6281 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
6282 SPARCStation 1, 2, IPX etc.
6283
6284 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
6285 architecture.  The only difference from V7 code is that the compiler emits
6286 the integer multiply and integer divide instructions which exist in SPARC-V8
6287 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
6288 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
6289 2000 series.
6290
6291 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
6292 the SPARC architecture.  This adds the integer multiply, integer divide step
6293 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
6294 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
6295 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
6296 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
6297 MB86934 chip, which is the more recent SPARClite with FPU.
6298
6299 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
6300 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
6301 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
6302 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
6303 optimizes it for the TEMIC SPARClet chip.
6304
6305 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
6306 architecture.  This adds 64-bit integer and floating-point move instructions,
6307 3 additional floating-point condition code registers and conditional move
6308 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
6309 optimizes it for the Sun UltraSPARC I/II chips.  With
6310 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
6311 Sun UltraSPARC III chip.
6312
6313 @item -mtune=@var{cpu_type}
6314 @opindex mtune
6315 Set the instruction scheduling parameters for machine type
6316 @var{cpu_type}, but do not set the instruction set or register set that the
6317 option @option{-mcpu=@var{cpu_type}} would.
6318
6319 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6320 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6321 that select a particular cpu implementation.  Those are @samp{cypress},
6322 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6323 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6324 @samp{ultrasparc3}.
6325
6326 @item -mv8plus
6327 @itemx -mno-v8plus
6328 @opindex -mv8plus
6329 @opindex -mno-v8plus
6330 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
6331 difference from the V8 ABI is that the global and out registers are
6332 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
6333 mode for all SPARC-V9 processors.
6334
6335 @item -mvis
6336 @itemx -mno-vis
6337 @opindex -mvis
6338 @opindex -mno-vis
6339 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
6340 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
6341 @end table
6342
6343 These @samp{-m} options are supported in addition to the above
6344 on SPARC-V9 processors in 64-bit environments:
6345
6346 @table @gcctabopt
6347 @item -mlittle-endian
6348 @opindex mlittle-endian
6349 Generate code for a processor running in little-endian mode. It is only
6350 available for a few configurations and most notably not on Solaris.
6351
6352 @item -m32
6353 @itemx -m64
6354 @opindex m32
6355 @opindex m64
6356 Generate code for a 32-bit or 64-bit environment.
6357 The 32-bit environment sets int, long and pointer to 32 bits.
6358 The 64-bit environment sets int to 32 bits and long and pointer
6359 to 64 bits.
6360
6361 @item -mcmodel=medlow
6362 @opindex mcmodel=medlow
6363 Generate code for the Medium/Low code model: the program must be linked
6364 in the low 32 bits of the address space.  Pointers are 64 bits.
6365 Programs can be statically or dynamically linked.
6366
6367 @item -mcmodel=medmid
6368 @opindex mcmodel=medmid
6369 Generate code for the Medium/Middle code model: the program must be linked
6370 in the low 44 bits of the address space, the text segment must be less than
6371 2G bytes, and data segment must be within 2G of the text segment.
6372 Pointers are 64 bits.
6373
6374 @item -mcmodel=medany
6375 @opindex mcmodel=medany
6376 Generate code for the Medium/Anywhere code model: the program may be linked
6377 anywhere in the address space, the text segment must be less than
6378 2G bytes, and data segment must be within 2G of the text segment.
6379 Pointers are 64 bits.
6380
6381 @item -mcmodel=embmedany
6382 @opindex mcmodel=embmedany
6383 Generate code for the Medium/Anywhere code model for embedded systems:
6384 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6385 (determined at link time).  Register %g4 points to the base of the
6386 data segment.  Pointers are still 64 bits.
6387 Programs are statically linked, PIC is not supported.
6388
6389 @item -mstack-bias
6390 @itemx -mno-stack-bias
6391 @opindex mstack-bias
6392 @opindex mno-stack-bias
6393 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6394 frame pointer if present, are offset by @minus{}2047 which must be added back
6395 when making stack frame references.  This is the default in 64-bit mode.
6396 Otherwise, assume no such offset is present.
6397 @end table
6398
6399 @node ARM Options
6400 @subsection ARM Options
6401 @cindex ARM options
6402
6403 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6404 architectures:
6405
6406 @table @gcctabopt
6407 @item -mapcs-frame
6408 @opindex mapcs-frame
6409 Generate a stack frame that is compliant with the ARM Procedure Call
6410 Standard for all functions, even if this is not strictly necessary for
6411 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6412 with this option will cause the stack frames not to be generated for
6413 leaf functions.  The default is @option{-mno-apcs-frame}.
6414
6415 @item -mapcs
6416 @opindex mapcs
6417 This is a synonym for @option{-mapcs-frame}.
6418
6419 @item -mapcs-26
6420 @opindex mapcs-26
6421 Generate code for a processor running with a 26-bit program counter,
6422 and conforming to the function calling standards for the APCS 26-bit
6423 option.  This option replaces the @option{-m2} and @option{-m3} options
6424 of previous releases of the compiler.
6425
6426 @item -mapcs-32
6427 @opindex mapcs-32
6428 Generate code for a processor running with a 32-bit program counter,
6429 and conforming to the function calling standards for the APCS 32-bit
6430 option.  This option replaces the @option{-m6} option of previous releases
6431 of the compiler.
6432
6433 @ignore
6434 @c not currently implemented
6435 @item -mapcs-stack-check
6436 @opindex mapcs-stack-check
6437 Generate code to check the amount of stack space available upon entry to
6438 every function (that actually uses some stack space).  If there is
6439 insufficient space available then either the function
6440 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6441 called, depending upon the amount of stack space required.  The run time
6442 system is required to provide these functions.  The default is
6443 @option{-mno-apcs-stack-check}, since this produces smaller code.
6444
6445 @c not currently implemented
6446 @item -mapcs-float
6447 @opindex mapcs-float
6448 Pass floating point arguments using the float point registers.  This is
6449 one of the variants of the APCS@.  This option is recommended if the
6450 target hardware has a floating point unit or if a lot of floating point
6451 arithmetic is going to be performed by the code.  The default is
6452 @option{-mno-apcs-float}, since integer only code is slightly increased in
6453 size if @option{-mapcs-float} is used.
6454
6455 @c not currently implemented
6456 @item -mapcs-reentrant
6457 @opindex mapcs-reentrant
6458 Generate reentrant, position independent code.  The default is
6459 @option{-mno-apcs-reentrant}.
6460 @end ignore
6461
6462 @item -mthumb-interwork
6463 @opindex mthumb-interwork
6464 Generate code which supports calling between the ARM and Thumb
6465 instruction sets.  Without this option the two instruction sets cannot
6466 be reliably used inside one program.  The default is
6467 @option{-mno-thumb-interwork}, since slightly larger code is generated
6468 when @option{-mthumb-interwork} is specified.
6469
6470 @item -mno-sched-prolog
6471 @opindex mno-sched-prolog
6472 Prevent the reordering of instructions in the function prolog, or the
6473 merging of those instruction with the instructions in the function's
6474 body.  This means that all functions will start with a recognizable set
6475 of instructions (or in fact one of a choice from a small set of
6476 different function prologues), and this information can be used to
6477 locate the start if functions inside an executable piece of code.  The
6478 default is @option{-msched-prolog}.
6479
6480 @item -mhard-float
6481 @opindex mhard-float
6482 Generate output containing floating point instructions.  This is the
6483 default.
6484
6485 @item -msoft-float
6486 @opindex msoft-float
6487 Generate output containing library calls for floating point.
6488 @strong{Warning:} the requisite libraries are not available for all ARM
6489 targets.  Normally the facilities of the machine's usual C compiler are
6490 used, but this cannot be done directly in cross-compilation.  You must make
6491 your own arrangements to provide suitable library functions for
6492 cross-compilation.
6493
6494 @option{-msoft-float} changes the calling convention in the output file;
6495 therefore, it is only useful if you compile @emph{all} of a program with
6496 this option.  In particular, you need to compile @file{libgcc.a}, the
6497 library that comes with GCC, with @option{-msoft-float} in order for
6498 this to work.
6499
6500 @item -mlittle-endian
6501 @opindex mlittle-endian
6502 Generate code for a processor running in little-endian mode.  This is
6503 the default for all standard configurations.
6504
6505 @item -mbig-endian
6506 @opindex mbig-endian
6507 Generate code for a processor running in big-endian mode; the default is
6508 to compile code for a little-endian processor.
6509
6510 @item -mwords-little-endian
6511 @opindex mwords-little-endian
6512 This option only applies when generating code for big-endian processors.
6513 Generate code for a little-endian word order but a big-endian byte
6514 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6515 option should only be used if you require compatibility with code for
6516 big-endian ARM processors generated by versions of the compiler prior to
6517 2.8.
6518
6519 @item -malignment-traps
6520 @opindex malignment-traps
6521 Generate code that will not trap if the MMU has alignment traps enabled.
6522 On ARM architectures prior to ARMv4, there were no instructions to
6523 access half-word objects stored in memory.  However, when reading from
6524 memory a feature of the ARM architecture allows a word load to be used,
6525 even if the address is unaligned, and the processor core will rotate the
6526 data as it is being loaded.  This option tells the compiler that such
6527 misaligned accesses will cause a MMU trap and that it should instead
6528 synthesize the access as a series of byte accesses.  The compiler can
6529 still use word accesses to load half-word data if it knows that the
6530 address is aligned to a word boundary.
6531
6532 This option is ignored when compiling for ARM architecture 4 or later,
6533 since these processors have instructions to directly access half-word
6534 objects in memory.
6535
6536 @item -mno-alignment-traps
6537 @opindex mno-alignment-traps
6538 Generate code that assumes that the MMU will not trap unaligned
6539 accesses.  This produces better code when the target instruction set
6540 does not have half-word memory operations (i.e.@: implementations prior to
6541 ARMv4).
6542
6543 Note that you cannot use this option to access unaligned word objects,
6544 since the processor will only fetch one 32-bit aligned object from
6545 memory.
6546
6547 The default setting for most targets is @option{-mno-alignment-traps}, since
6548 this produces better code when there are no half-word memory
6549 instructions available.
6550
6551 @item -mshort-load-bytes
6552 @itemx -mno-short-load-words
6553 @opindex mshort-load-bytes
6554 @opindex mno-short-load-words
6555 These are deprecated aliases for @option{-malignment-traps}.
6556
6557 @item -mno-short-load-bytes
6558 @itemx -mshort-load-words
6559 @opindex mno-short-load-bytes
6560 @opindex mshort-load-words
6561 This are deprecated aliases for @option{-mno-alignment-traps}.
6562
6563 @item -mcpu=@var{name}
6564 @opindex mcpu
6565 This specifies the name of the target ARM processor.  GCC uses this name
6566 to determine what kind of instructions it can emit when generating
6567 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6568 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6569 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6570 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6571 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6572 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6573 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6574 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6575 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6576 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6577 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6578 @samp{ep9312}.
6579
6580 @itemx -mtune=@var{name}
6581 @opindex mtune
6582 This option is very similar to the @option{-mcpu=} option, except that
6583 instead of specifying the actual target processor type, and hence
6584 restricting which instructions can be used, it specifies that GCC should
6585 tune the performance of the code as if the target were of the type
6586 specified in this option, but still choosing the instructions that it
6587 will generate based on the cpu specified by a @option{-mcpu=} option.
6588 For some ARM implementations better performance can be obtained by using
6589 this option.
6590
6591 @item -march=@var{name}
6592 @opindex march
6593 This specifies the name of the target ARM architecture.  GCC uses this
6594 name to determine what kind of instructions it can emit when generating
6595 assembly code.  This option can be used in conjunction with or instead
6596 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6597 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6598 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6599 @samp{iwmmxt}, @samp{ep9312}.
6600
6601 @item -mfpe=@var{number}
6602 @itemx -mfp=@var{number}
6603 @opindex mfpe
6604 @opindex mfp
6605 This specifies the version of the floating point emulation available on
6606 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6607 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6608
6609 @item -mstructure-size-boundary=@var{n}
6610 @opindex mstructure-size-boundary
6611 The size of all structures and unions will be rounded up to a multiple
6612 of the number of bits set by this option.  Permissible values are 8 and
6613 32.  The default value varies for different toolchains.  For the COFF
6614 targeted toolchain the default value is 8.  Specifying the larger number
6615 can produce faster, more efficient code, but can also increase the size
6616 of the program.  The two values are potentially incompatible.  Code
6617 compiled with one value cannot necessarily expect to work with code or
6618 libraries compiled with the other value, if they exchange information
6619 using structures or unions.
6620
6621 @item -mabort-on-noreturn
6622 @opindex mabort-on-noreturn
6623 Generate a call to the function @code{abort} at the end of a
6624 @code{noreturn} function.  It will be executed if the function tries to
6625 return.
6626
6627 @item -mlong-calls
6628 @itemx -mno-long-calls
6629 @opindex mlong-calls
6630 @opindex mno-long-calls
6631 Tells the compiler to perform function calls by first loading the
6632 address of the function into a register and then performing a subroutine
6633 call on this register.  This switch is needed if the target function
6634 will lie outside of the 64 megabyte addressing range of the offset based
6635 version of subroutine call instruction.
6636
6637 Even if this switch is enabled, not all function calls will be turned
6638 into long calls.  The heuristic is that static functions, functions
6639 which have the @samp{short-call} attribute, functions that are inside
6640 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6641 definitions have already been compiled within the current compilation
6642 unit, will not be turned into long calls.  The exception to this rule is
6643 that weak function definitions, functions with the @samp{long-call}
6644 attribute or the @samp{section} attribute, and functions that are within
6645 the scope of a @samp{#pragma long_calls} directive, will always be
6646 turned into long calls.
6647
6648 This feature is not enabled by default.  Specifying
6649 @option{-mno-long-calls} will restore the default behavior, as will
6650 placing the function calls within the scope of a @samp{#pragma
6651 long_calls_off} directive.  Note these switches have no effect on how
6652 the compiler generates code to handle function calls via function
6653 pointers.
6654
6655 @item -mnop-fun-dllimport
6656 @opindex mnop-fun-dllimport
6657 Disable support for the @code{dllimport} attribute.
6658
6659 @item -msingle-pic-base
6660 @opindex msingle-pic-base
6661 Treat the register used for PIC addressing as read-only, rather than
6662 loading it in the prologue for each function.  The run-time system is
6663 responsible for initializing this register with an appropriate value
6664 before execution begins.
6665
6666 @item -mpic-register=@var{reg}
6667 @opindex mpic-register
6668 Specify the register to be used for PIC addressing.  The default is R10
6669 unless stack-checking is enabled, when R9 is used.
6670
6671 @item -mcirrus-fix-invalid-insns
6672 @opindex mcirrus-fix-invalid-insns
6673 @opindex mno-cirrus-fix-invalid-insns
6674 Insert NOPs into the instruction stream to in order to work around
6675 problems with invalid Maverick instruction combinations.  This option
6676 is only valid if the @option{-mcpu=ep9312} option has been used to
6677 enable generation of instructions for the Cirrus Maverick floating
6678 point co-processor.  This option is not enabled by default, since the
6679 problem is only present in older Maverick implementations.  The default
6680 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6681 switch.
6682
6683 @item -mpoke-function-name
6684 @opindex mpoke-function-name
6685 Write the name of each function into the text section, directly
6686 preceding the function prologue.  The generated code is similar to this:
6687
6688 @smallexample
6689      t0
6690          .ascii "arm_poke_function_name", 0
6691          .align
6692      t1
6693          .word 0xff000000 + (t1 - t0)
6694      arm_poke_function_name
6695          mov     ip, sp
6696          stmfd   sp!, @{fp, ip, lr, pc@}
6697          sub     fp, ip, #4
6698 @end smallexample
6699
6700 When performing a stack backtrace, code can inspect the value of
6701 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6702 location @code{pc - 12} and the top 8 bits are set, then we know that
6703 there is a function name embedded immediately preceding this location
6704 and has length @code{((pc[-3]) & 0xff000000)}.
6705
6706 @item -mthumb
6707 @opindex mthumb
6708 Generate code for the 16-bit Thumb instruction set.  The default is to
6709 use the 32-bit ARM instruction set.
6710
6711 @item -mtpcs-frame
6712 @opindex mtpcs-frame
6713 Generate a stack frame that is compliant with the Thumb Procedure Call
6714 Standard for all non-leaf functions.  (A leaf function is one that does
6715 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6716
6717 @item -mtpcs-leaf-frame
6718 @opindex mtpcs-leaf-frame
6719 Generate a stack frame that is compliant with the Thumb Procedure Call
6720 Standard for all leaf functions.  (A leaf function is one that does
6721 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6722
6723 @item -mcallee-super-interworking
6724 @opindex mcallee-super-interworking
6725 Gives all externally visible functions in the file being compiled an ARM
6726 instruction set header which switches to Thumb mode before executing the
6727 rest of the function.  This allows these functions to be called from
6728 non-interworking code.
6729
6730 @item -mcaller-super-interworking
6731 @opindex mcaller-super-interworking
6732 Allows calls via function pointers (including virtual functions) to
6733 execute correctly regardless of whether the target code has been
6734 compiled for interworking or not.  There is a small overhead in the cost
6735 of executing a function pointer if this option is enabled.
6736
6737 @end table
6738
6739 @node MN10300 Options
6740 @subsection MN10300 Options
6741 @cindex MN10300 options
6742
6743 These @option{-m} options are defined for Matsushita MN10300 architectures:
6744
6745 @table @gcctabopt
6746 @item -mmult-bug
6747 @opindex mmult-bug
6748 Generate code to avoid bugs in the multiply instructions for the MN10300
6749 processors.  This is the default.
6750
6751 @item -mno-mult-bug
6752 @opindex mno-mult-bug
6753 Do not generate code to avoid bugs in the multiply instructions for the
6754 MN10300 processors.
6755
6756 @item -mam33
6757 @opindex mam33
6758 Generate code which uses features specific to the AM33 processor.
6759
6760 @item -mno-am33
6761 @opindex mno-am33
6762 Do not generate code which uses features specific to the AM33 processor.  This
6763 is the default.
6764
6765 @item -mno-crt0
6766 @opindex mno-crt0
6767 Do not link in the C run-time initialization object file.
6768
6769 @item -mrelax
6770 @opindex mrelax
6771 Indicate to the linker that it should perform a relaxation optimization pass
6772 to shorten branches, calls and absolute memory addresses.  This option only
6773 has an effect when used on the command line for the final link step.
6774
6775 This option makes symbolic debugging impossible.
6776 @end table
6777
6778
6779 @node M32R/D Options
6780 @subsection M32R/D Options
6781 @cindex M32R/D options
6782
6783 These @option{-m} options are defined for Renesas M32R/D architectures:
6784
6785 @table @gcctabopt
6786 @item -m32r2
6787 @opindex m32r2
6788 Generate code for the M32R/2@.
6789
6790 @item -m32rx
6791 @opindex m32rx
6792 Generate code for the M32R/X@.
6793
6794 @item -m32r
6795 @opindex m32r
6796 Generate code for the M32R@.  This is the default.
6797
6798 @item -mmodel=small
6799 @opindex mmodel=small
6800 Assume all objects live in the lower 16MB of memory (so that their addresses
6801 can be loaded with the @code{ld24} instruction), and assume all subroutines
6802 are reachable with the @code{bl} instruction.
6803 This is the default.
6804
6805 The addressability of a particular object can be set with the
6806 @code{model} attribute.
6807
6808 @item -mmodel=medium
6809 @opindex mmodel=medium
6810 Assume objects may be anywhere in the 32-bit address space (the compiler
6811 will generate @code{seth/add3} instructions to load their addresses), and
6812 assume all subroutines are reachable with the @code{bl} instruction.
6813
6814 @item -mmodel=large
6815 @opindex mmodel=large
6816 Assume objects may be anywhere in the 32-bit address space (the compiler
6817 will generate @code{seth/add3} instructions to load their addresses), and
6818 assume subroutines may not be reachable with the @code{bl} instruction
6819 (the compiler will generate the much slower @code{seth/add3/jl}
6820 instruction sequence).
6821
6822 @item -msdata=none
6823 @opindex msdata=none
6824 Disable use of the small data area.  Variables will be put into
6825 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6826 @code{section} attribute has been specified).
6827 This is the default.
6828
6829 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6830 Objects may be explicitly put in the small data area with the
6831 @code{section} attribute using one of these sections.
6832
6833 @item -msdata=sdata
6834 @opindex msdata=sdata
6835 Put small global and static data in the small data area, but do not
6836 generate special code to reference them.
6837
6838 @item -msdata=use
6839 @opindex msdata=use
6840 Put small global and static data in the small data area, and generate
6841 special instructions to reference them.
6842
6843 @item -G @var{num}
6844 @opindex G
6845 @cindex smaller data references
6846 Put global and static objects less than or equal to @var{num} bytes
6847 into the small data or bss sections instead of the normal data or bss
6848 sections.  The default value of @var{num} is 8.
6849 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6850 for this option to have any effect.
6851
6852 All modules should be compiled with the same @option{-G @var{num}} value.
6853 Compiling with different values of @var{num} may or may not work; if it
6854 doesn't the linker will give an error message---incorrect code will not be
6855 generated.
6856
6857 @item -mdebug
6858 @opindex -mdebug
6859 Makes the M32R specific code in the compiler display some statistics
6860 that might help in debugging programs.
6861
6862 @item -malign-loops
6863 @opindex malign-loops
6864 Align all loops to a 32-byte boundary.
6865
6866 @item -mno-align-loops
6867 @opindex mno-align-loops
6868 Do not enforce a 32-byte alignment for loops.  This is the default.
6869
6870 @item -missue-rate=@var{number}
6871 @opindex missue-rate=@var{number}
6872 Issue @var{number} instructions per cycle.  @var{number} can only be 1
6873 or 2.
6874
6875 @item -mbranch-cost=@var{number}
6876 @opindex mbranch-cost=@var{number}
6877 @var{number} can only be 1 or 2.  If it is 1 then branches will be
6878 preferred over conditional code, if it is 2, then the opposite will
6879 apply.
6880
6881 @item -mflush-trap=@var{number}
6882 @opindex mflush-trap=@var{number}
6883 Specifies the trap number to use to flush the cache.  The default is
6884 12.  Valid numbers are between 0 and 15 inclusive.
6885
6886 @item -mno-flush-trap
6887 @opindex mno-flush-trap
6888 Specifies that the cache cannot be flushed by using a trap.
6889
6890 @item -mflush-func=@var{name}
6891 @opindex mflush-func=@var{name}
6892 Specifies the name of the operating system function to call to flush
6893 the cache.  The default is @emph{_flush_cache}, but a function call
6894 will only be used if a trap is not available.
6895
6896 @item -mno-flush-func
6897 @opindex mno-flush-func
6898 Indicates that there is no OS function for flushing the cache.
6899
6900 @end table
6901
6902 @node RS/6000 and PowerPC Options
6903 @subsection IBM RS/6000 and PowerPC Options
6904 @cindex RS/6000 and PowerPC Options
6905 @cindex IBM RS/6000 and PowerPC Options
6906
6907 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6908 @table @gcctabopt
6909 @item -mpower
6910 @itemx -mno-power
6911 @itemx -mpower2
6912 @itemx -mno-power2
6913 @itemx -mpowerpc
6914 @itemx -mno-powerpc
6915 @itemx -mpowerpc-gpopt
6916 @itemx -mno-powerpc-gpopt
6917 @itemx -mpowerpc-gfxopt
6918 @itemx -mno-powerpc-gfxopt
6919 @itemx -mpowerpc64
6920 @itemx -mno-powerpc64
6921 @opindex mpower
6922 @opindex mno-power
6923 @opindex mpower2
6924 @opindex mno-power2
6925 @opindex mpowerpc
6926 @opindex mno-powerpc
6927 @opindex mpowerpc-gpopt
6928 @opindex mno-powerpc-gpopt
6929 @opindex mpowerpc-gfxopt
6930 @opindex mno-powerpc-gfxopt
6931 @opindex mpowerpc64
6932 @opindex mno-powerpc64
6933 GCC supports two related instruction set architectures for the
6934 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6935 instructions supported by the @samp{rios} chip set used in the original
6936 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6937 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6938 the IBM 4xx microprocessors.
6939
6940 Neither architecture is a subset of the other.  However there is a
6941 large common subset of instructions supported by both.  An MQ
6942 register is included in processors supporting the POWER architecture.
6943
6944 You use these options to specify which instructions are available on the
6945 processor you are using.  The default value of these options is
6946 determined when configuring GCC@.  Specifying the
6947 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6948 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6949 rather than the options listed above.
6950
6951 The @option{-mpower} option allows GCC to generate instructions that
6952 are found only in the POWER architecture and to use the MQ register.
6953 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6954 to generate instructions that are present in the POWER2 architecture but
6955 not the original POWER architecture.
6956
6957 The @option{-mpowerpc} option allows GCC to generate instructions that
6958 are found only in the 32-bit subset of the PowerPC architecture.
6959 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6960 GCC to use the optional PowerPC architecture instructions in the
6961 General Purpose group, including floating-point square root.  Specifying
6962 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6963 use the optional PowerPC architecture instructions in the Graphics
6964 group, including floating-point select.
6965
6966 The @option{-mpowerpc64} option allows GCC to generate the additional
6967 64-bit instructions that are found in the full PowerPC64 architecture
6968 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6969 @option{-mno-powerpc64}.
6970
6971 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6972 will use only the instructions in the common subset of both
6973 architectures plus some special AIX common-mode calls, and will not use
6974 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6975 permits GCC to use any instruction from either architecture and to
6976 allow use of the MQ register; specify this for the Motorola MPC601.
6977
6978 @item -mnew-mnemonics
6979 @itemx -mold-mnemonics
6980 @opindex mnew-mnemonics
6981 @opindex mold-mnemonics
6982 Select which mnemonics to use in the generated assembler code.  With
6983 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6984 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6985 assembler mnemonics defined for the POWER architecture.  Instructions
6986 defined in only one architecture have only one mnemonic; GCC uses that
6987 mnemonic irrespective of which of these options is specified.
6988
6989 GCC defaults to the mnemonics appropriate for the architecture in
6990 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6991 value of these option.  Unless you are building a cross-compiler, you
6992 should normally not specify either @option{-mnew-mnemonics} or
6993 @option{-mold-mnemonics}, but should instead accept the default.
6994
6995 @item -mcpu=@var{cpu_type}
6996 @opindex mcpu
6997 Set architecture type, register usage, choice of mnemonics, and
6998 instruction scheduling parameters for machine type @var{cpu_type}.
6999 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
7000 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
7001 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
7002 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
7003 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
7004 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
7005 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
7006 @samp{power4}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
7007 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
7008
7009 @option{-mcpu=common} selects a completely generic processor.  Code
7010 generated under this option will run on any POWER or PowerPC processor.
7011 GCC will use only the instructions in the common subset of both
7012 architectures, and will not use the MQ register.  GCC assumes a generic
7013 processor model for scheduling purposes.
7014
7015 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7016 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7017 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7018 types, with an appropriate, generic processor model assumed for
7019 scheduling purposes.
7020
7021 The other options specify a specific processor.  Code generated under
7022 those options will run best on that processor, and may not run at all on
7023 others.
7024
7025 The @option{-mcpu} options automatically enable or disable the
7026 following options: @option{-maltivec}, @option{-mhard-float},
7027 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
7028 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
7029 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
7030 @option{-mstring}.  The particular options set for any particular CPU
7031 will vary between compiler versions, depending on what setting seems
7032 to produce optimal code for that CPU; it doesn't necessarily reflect
7033 the actual hardware's capabilities.  If you wish to set an individual
7034 option to a particular value, you may specify it after the
7035 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
7036
7037 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
7038 not enabled or disabled by the @option{-mcpu} option at present, since
7039 AIX does not have full support for these options.  You may still
7040 enable or disable them individually if you're sure it'll work in your
7041 environment.
7042
7043 @item -mtune=@var{cpu_type}
7044 @opindex mtune
7045 Set the instruction scheduling parameters for machine type
7046 @var{cpu_type}, but do not set the architecture type, register usage, or
7047 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7048 values for @var{cpu_type} are used for @option{-mtune} as for
7049 @option{-mcpu}.  If both are specified, the code generated will use the
7050 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7051 scheduling parameters set by @option{-mtune}.
7052
7053 @item -maltivec
7054 @itemx -mno-altivec
7055 @opindex maltivec
7056 @opindex mno-altivec
7057 These switches enable or disable the use of built-in functions that
7058 allow access to the AltiVec instruction set.  You may also need to set
7059 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7060 enhancements.
7061
7062 @item -mabi=spe
7063 @opindex mabi=spe
7064 Extend the current ABI with SPE ABI extensions.  This does not change
7065 the default ABI, instead it adds the SPE ABI extensions to the current
7066 ABI@.
7067
7068 @item -mabi=no-spe
7069 @opindex mabi=no-spe
7070 Disable Booke SPE ABI extensions for the current ABI.
7071
7072 @item -misel=@var{yes/no}
7073 @itemx -misel
7074 @opindex misel
7075 This switch enables or disables the generation of ISEL instructions.
7076
7077 @item -mspe=@var{yes/no}
7078 @itemx -mspe
7079 @opindex mspe
7080 This switch enables or disables the generation of SPE simd
7081 instructions.
7082
7083 @item -mfloat-gprs=@var{yes/no}
7084 @itemx -mfloat-gprs
7085 @opindex mfloat-gprs
7086 This switch enables or disables the generation of floating point
7087 operations on the general purpose registers for architectures that
7088 support it.  This option is currently only available on the MPC8540.
7089
7090 @item -mfull-toc
7091 @itemx -mno-fp-in-toc
7092 @itemx -mno-sum-in-toc
7093 @itemx -mminimal-toc
7094 @opindex mfull-toc
7095 @opindex mno-fp-in-toc
7096 @opindex mno-sum-in-toc
7097 @opindex mminimal-toc
7098 Modify generation of the TOC (Table Of Contents), which is created for
7099 every executable file.  The @option{-mfull-toc} option is selected by
7100 default.  In that case, GCC will allocate at least one TOC entry for
7101 each unique non-automatic variable reference in your program.  GCC
7102 will also place floating-point constants in the TOC@.  However, only
7103 16,384 entries are available in the TOC@.
7104
7105 If you receive a linker error message that saying you have overflowed
7106 the available TOC space, you can reduce the amount of TOC space used
7107 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7108 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7109 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7110 generate code to calculate the sum of an address and a constant at
7111 run-time instead of putting that sum into the TOC@.  You may specify one
7112 or both of these options.  Each causes GCC to produce very slightly
7113 slower and larger code at the expense of conserving TOC space.
7114
7115 If you still run out of space in the TOC even when you specify both of
7116 these options, specify @option{-mminimal-toc} instead.  This option causes
7117 GCC to make only one TOC entry for every file.  When you specify this
7118 option, GCC will produce code that is slower and larger but which
7119 uses extremely little TOC space.  You may wish to use this option
7120 only on files that contain less frequently executed code.
7121
7122 @item -maix64
7123 @itemx -maix32
7124 @opindex maix64
7125 @opindex maix32
7126 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7127 @code{long} type, and the infrastructure needed to support them.
7128 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7129 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7130 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7131
7132 @item -mxl-call
7133 @itemx -mno-xl-call
7134 @opindex mxl-call
7135 @opindex mno-xl-call
7136 On AIX, pass floating-point arguments to prototyped functions beyond the
7137 register save area (RSA) on the stack in addition to argument FPRs.  The
7138 AIX calling convention was extended but not initially documented to
7139 handle an obscure K&R C case of calling a function that takes the
7140 address of its arguments with fewer arguments than declared.  AIX XL
7141 compilers access floating point arguments which do not fit in the
7142 RSA from the stack when a subroutine is compiled without
7143 optimization.  Because always storing floating-point arguments on the
7144 stack is inefficient and rarely needed, this option is not enabled by
7145 default and only is necessary when calling subroutines compiled by AIX
7146 XL compilers without optimization.
7147
7148 @item -mpe
7149 @opindex mpe
7150 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7151 application written to use message passing with special startup code to
7152 enable the application to run.  The system must have PE installed in the
7153 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7154 must be overridden with the @option{-specs=} option to specify the
7155 appropriate directory location.  The Parallel Environment does not
7156 support threads, so the @option{-mpe} option and the @option{-pthread}
7157 option are incompatible.
7158
7159 @item -malign-natural
7160 @itemx -malign-power
7161 @opindex malign-natural
7162 @opindex malign-power
7163 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
7164 @option{-malign-natural} overrides the ABI-defined alignment of larger
7165 types, such as floating-point doubles, on their natural size-based boundary.
7166 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7167 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7168
7169 @item -msoft-float
7170 @itemx -mhard-float
7171 @opindex msoft-float
7172 @opindex mhard-float
7173 Generate code that does not use (uses) the floating-point register set.
7174 Software floating point emulation is provided if you use the
7175 @option{-msoft-float} option, and pass the option to GCC when linking.
7176
7177 @item -mmultiple
7178 @itemx -mno-multiple
7179 @opindex mmultiple
7180 @opindex mno-multiple
7181 Generate code that uses (does not use) the load multiple word
7182 instructions and the store multiple word instructions.  These
7183 instructions are generated by default on POWER systems, and not
7184 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7185 endian PowerPC systems, since those instructions do not work when the
7186 processor is in little endian mode.  The exceptions are PPC740 and
7187 PPC750 which permit the instructions usage in little endian mode.
7188
7189 @item -mstring
7190 @itemx -mno-string
7191 @opindex mstring
7192 @opindex mno-string
7193 Generate code that uses (does not use) the load string instructions
7194 and the store string word instructions to save multiple registers and
7195 do small block moves.  These instructions are generated by default on
7196 POWER systems, and not generated on PowerPC systems.  Do not use
7197 @option{-mstring} on little endian PowerPC systems, since those
7198 instructions do not work when the processor is in little endian mode.
7199 The exceptions are PPC740 and PPC750 which permit the instructions
7200 usage in little endian mode.
7201
7202 @item -mupdate
7203 @itemx -mno-update
7204 @opindex mupdate
7205 @opindex mno-update
7206 Generate code that uses (does not use) the load or store instructions
7207 that update the base register to the address of the calculated memory
7208 location.  These instructions are generated by default.  If you use
7209 @option{-mno-update}, there is a small window between the time that the
7210 stack pointer is updated and the address of the previous frame is
7211 stored, which means code that walks the stack frame across interrupts or
7212 signals may get corrupted data.
7213
7214 @item -mfused-madd
7215 @itemx -mno-fused-madd
7216 @opindex mfused-madd
7217 @opindex mno-fused-madd
7218 Generate code that uses (does not use) the floating point multiply and
7219 accumulate instructions.  These instructions are generated by default if
7220 hardware floating is used.
7221
7222 @item -mno-bit-align
7223 @itemx -mbit-align
7224 @opindex mno-bit-align
7225 @opindex mbit-align
7226 On System V.4 and embedded PowerPC systems do not (do) force structures
7227 and unions that contain bit-fields to be aligned to the base type of the
7228 bit-field.
7229
7230 For example, by default a structure containing nothing but 8
7231 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7232 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7233 the structure would be aligned to a 1 byte boundary and be one byte in
7234 size.
7235
7236 @item -mno-strict-align
7237 @itemx -mstrict-align
7238 @opindex mno-strict-align
7239 @opindex mstrict-align
7240 On System V.4 and embedded PowerPC systems do not (do) assume that
7241 unaligned memory references will be handled by the system.
7242
7243 @item -mrelocatable
7244 @itemx -mno-relocatable
7245 @opindex mrelocatable
7246 @opindex mno-relocatable
7247 On embedded PowerPC systems generate code that allows (does not allow)
7248 the program to be relocated to a different address at runtime.  If you
7249 use @option{-mrelocatable} on any module, all objects linked together must
7250 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7251
7252 @item -mrelocatable-lib
7253 @itemx -mno-relocatable-lib
7254 @opindex mrelocatable-lib
7255 @opindex mno-relocatable-lib
7256 On embedded PowerPC systems generate code that allows (does not allow)
7257 the program to be relocated to a different address at runtime.  Modules
7258 compiled with @option{-mrelocatable-lib} can be linked with either modules
7259 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7260 with modules compiled with the @option{-mrelocatable} options.
7261
7262 @item -mno-toc
7263 @itemx -mtoc
7264 @opindex mno-toc
7265 @opindex mtoc
7266 On System V.4 and embedded PowerPC systems do not (do) assume that
7267 register 2 contains a pointer to a global area pointing to the addresses
7268 used in the program.
7269
7270 @item -mlittle
7271 @itemx -mlittle-endian
7272 @opindex mlittle
7273 @opindex mlittle-endian
7274 On System V.4 and embedded PowerPC systems compile code for the
7275 processor in little endian mode.  The @option{-mlittle-endian} option is
7276 the same as @option{-mlittle}.
7277
7278 @item -mbig
7279 @itemx -mbig-endian
7280 @opindex mbig
7281 @opindex mbig-endian
7282 On System V.4 and embedded PowerPC systems compile code for the
7283 processor in big endian mode.  The @option{-mbig-endian} option is
7284 the same as @option{-mbig}.
7285
7286 @item -mdynamic-no-pic
7287 @opindex mdynamic-no-pic
7288 On Darwin and Mac OS X systems, compile code so that it is not
7289 relocatable, but that its external references are relocatable.  The
7290 resulting code is suitable for applications, but not shared
7291 libraries.
7292
7293 @item -mprioritize-restricted-insns=@var{priority}
7294 @opindex mprioritize-restricted-insns
7295 This option controls the priority that is assigned to
7296 dispatch-slot restricted instructions during the second scheduling
7297 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
7298 @var{no/highest/second-highest} priority to dispatch slot restricted
7299 instructions.
7300
7301 @item -msched-costly-dep=@var{dependence_type}
7302 @opindex msched-costly-dep
7303 This option controls which dependences are considered costly
7304 by the target during instruction scheduling.  The argument
7305 @var{dependence_type} takes one of the following values:
7306 @var{no}: no dependence is costly,
7307 @var{all}: all dependences are costly,
7308 @var{true_store_to_load}: a true dependence from store to load is costly,
7309 @var{store_to_load}: any dependence from store to load is costly,
7310 @var{number}: any dependence which latency >= @var{number} is costly.
7311
7312 @item -minsert-sched-nops=@var{scheme}
7313 @opindex minsert-sched-nops
7314 This option controls which nop insertion scheme will be used during
7315 the second scheduling pass. The argument @var{scheme} takes one of the
7316 following values:
7317 @var{no}: Don't insert nops.
7318 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7319 according to the scheduler's grouping.
7320 @var{regroup_exact}: Insert nops to force costly dependent insns into
7321 separate groups.  Insert exactly as many nops as needed to force an insn
7322 to a new group, according to the estimated processor grouping.
7323 @var{number}: Insert nops to force costly dependent insns into
7324 separate groups.  Insert @var{number} nops to force an insn to a new group.
7325
7326 @item -mcall-sysv
7327 @opindex mcall-sysv
7328 On System V.4 and embedded PowerPC systems compile code using calling
7329 conventions that adheres to the March 1995 draft of the System V
7330 Application Binary Interface, PowerPC processor supplement.  This is the
7331 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7332
7333 @item -mcall-sysv-eabi
7334 @opindex mcall-sysv-eabi
7335 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7336
7337 @item -mcall-sysv-noeabi
7338 @opindex mcall-sysv-noeabi
7339 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7340
7341 @item -mcall-solaris
7342 @opindex mcall-solaris
7343 On System V.4 and embedded PowerPC systems compile code for the Solaris
7344 operating system.
7345
7346 @item -mcall-linux
7347 @opindex mcall-linux
7348 On System V.4 and embedded PowerPC systems compile code for the
7349 Linux-based GNU system.
7350
7351 @item -mcall-gnu
7352 @opindex mcall-gnu
7353 On System V.4 and embedded PowerPC systems compile code for the
7354 Hurd-based GNU system.
7355
7356 @item -mcall-netbsd
7357 @opindex mcall-netbsd
7358 On System V.4 and embedded PowerPC systems compile code for the
7359 NetBSD operating system.
7360
7361 @item -maix-struct-return
7362 @opindex maix-struct-return
7363 Return all structures in memory (as specified by the AIX ABI)@.
7364
7365 @item -msvr4-struct-return
7366 @opindex msvr4-struct-return
7367 Return structures smaller than 8 bytes in registers (as specified by the
7368 SVR4 ABI)@.
7369
7370 @item -mabi=altivec
7371 @opindex mabi=altivec
7372 Extend the current ABI with AltiVec ABI extensions.  This does not
7373 change the default ABI, instead it adds the AltiVec ABI extensions to
7374 the current ABI@.
7375
7376 @item -mabi=no-altivec
7377 @opindex mabi=no-altivec
7378 Disable AltiVec ABI extensions for the current ABI.
7379
7380 @item -mprototype
7381 @itemx -mno-prototype
7382 @opindex mprototype
7383 @opindex mno-prototype
7384 On System V.4 and embedded PowerPC systems assume that all calls to
7385 variable argument functions are properly prototyped.  Otherwise, the
7386 compiler must insert an instruction before every non prototyped call to
7387 set or clear bit 6 of the condition code register (@var{CR}) to
7388 indicate whether floating point values were passed in the floating point
7389 registers in case the function takes a variable arguments.  With
7390 @option{-mprototype}, only calls to prototyped variable argument functions
7391 will set or clear the bit.
7392
7393 @item -msim
7394 @opindex msim
7395 On embedded PowerPC systems, assume that the startup module is called
7396 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7397 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7398 configurations.
7399
7400 @item -mmvme
7401 @opindex mmvme
7402 On embedded PowerPC systems, assume that the startup module is called
7403 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7404 @file{libc.a}.
7405
7406 @item -mads
7407 @opindex mads
7408 On embedded PowerPC systems, assume that the startup module is called
7409 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7410 @file{libc.a}.
7411
7412 @item -myellowknife
7413 @opindex myellowknife
7414 On embedded PowerPC systems, assume that the startup module is called
7415 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7416 @file{libc.a}.
7417
7418 @item -mvxworks
7419 @opindex mvxworks
7420 On System V.4 and embedded PowerPC systems, specify that you are
7421 compiling for a VxWorks system.
7422
7423 @item -mwindiss
7424 @opindex mwindiss
7425 Specify that you are compiling for the WindISS simulation environment.
7426
7427 @item -memb
7428 @opindex memb
7429 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7430 header to indicate that @samp{eabi} extended relocations are used.
7431
7432 @item -meabi
7433 @itemx -mno-eabi
7434 @opindex meabi
7435 @opindex mno-eabi
7436 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7437 Embedded Applications Binary Interface (eabi) which is a set of
7438 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7439 means that the stack is aligned to an 8 byte boundary, a function
7440 @code{__eabi} is called to from @code{main} to set up the eabi
7441 environment, and the @option{-msdata} option can use both @code{r2} and
7442 @code{r13} to point to two separate small data areas.  Selecting
7443 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7444 do not call an initialization function from @code{main}, and the
7445 @option{-msdata} option will only use @code{r13} to point to a single
7446 small data area.  The @option{-meabi} option is on by default if you
7447 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7448
7449 @item -msdata=eabi
7450 @opindex msdata=eabi
7451 On System V.4 and embedded PowerPC systems, put small initialized
7452 @code{const} global and static data in the @samp{.sdata2} section, which
7453 is pointed to by register @code{r2}.  Put small initialized
7454 non-@code{const} global and static data in the @samp{.sdata} section,
7455 which is pointed to by register @code{r13}.  Put small uninitialized
7456 global and static data in the @samp{.sbss} section, which is adjacent to
7457 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7458 incompatible with the @option{-mrelocatable} option.  The
7459 @option{-msdata=eabi} option also sets the @option{-memb} option.
7460
7461 @item -msdata=sysv
7462 @opindex msdata=sysv
7463 On System V.4 and embedded PowerPC systems, put small global and static
7464 data in the @samp{.sdata} section, which is pointed to by register
7465 @code{r13}.  Put small uninitialized global and static data in the
7466 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7467 The @option{-msdata=sysv} option is incompatible with the
7468 @option{-mrelocatable} option.
7469
7470 @item -msdata=default
7471 @itemx -msdata
7472 @opindex msdata=default
7473 @opindex msdata
7474 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7475 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7476 same as @option{-msdata=sysv}.
7477
7478 @item -msdata-data
7479 @opindex msdata-data
7480 On System V.4 and embedded PowerPC systems, put small global and static
7481 data in the @samp{.sdata} section.  Put small uninitialized global and
7482 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7483 to address small data however.  This is the default behavior unless
7484 other @option{-msdata} options are used.
7485
7486 @item -msdata=none
7487 @itemx -mno-sdata
7488 @opindex msdata=none
7489 @opindex mno-sdata
7490 On embedded PowerPC systems, put all initialized global and static data
7491 in the @samp{.data} section, and all uninitialized data in the
7492 @samp{.bss} section.
7493
7494 @item -G @var{num}
7495 @opindex G
7496 @cindex smaller data references (PowerPC)
7497 @cindex .sdata/.sdata2 references (PowerPC)
7498 On embedded PowerPC systems, put global and static items less than or
7499 equal to @var{num} bytes into the small data or bss sections instead of
7500 the normal data or bss section.  By default, @var{num} is 8.  The
7501 @option{-G @var{num}} switch is also passed to the linker.
7502 All modules should be compiled with the same @option{-G @var{num}} value.
7503
7504 @item -mregnames
7505 @itemx -mno-regnames
7506 @opindex mregnames
7507 @opindex mno-regnames
7508 On System V.4 and embedded PowerPC systems do (do not) emit register
7509 names in the assembly language output using symbolic forms.
7510
7511 @item -mlongcall
7512 @itemx -mno-longcall
7513 @opindex mlongcall
7514 @opindex mno-longcall
7515 Default to making all function calls via pointers, so that functions
7516 which reside further than 64 megabytes (67,108,864 bytes) from the
7517 current location can be called.  This setting can be overridden by the
7518 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7519
7520 Some linkers are capable of detecting out-of-range calls and generating
7521 glue code on the fly.  On these systems, long calls are unnecessary and
7522 generate slower code.  As of this writing, the AIX linker can do this,
7523 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7524 to the GNU linker for 32-bit PowerPC systems as well.
7525
7526 On Mach-O (Darwin) systems, this option directs the compiler emit to
7527 the glue for every direct call, and the Darwin linker decides whether
7528 to use or discard it.
7529
7530 In the future, we may cause GCC to ignore all longcall specifications
7531 when the linker is known to generate glue.
7532
7533 @item -pthread
7534 @opindex pthread
7535 Adds support for multithreading with the @dfn{pthreads} library.
7536 This option sets flags for both the preprocessor and linker.
7537
7538 @end table
7539
7540 @node Darwin Options
7541 @subsection Darwin Options
7542 @cindex Darwin options
7543
7544 These options are defined for all architectures running the Darwin operating
7545 system.  They are useful for compatibility with other Mac OS compilers.
7546
7547 @table @gcctabopt
7548 @item -all_load
7549 @opindex all_load
7550 Loads all members of static archive libraries.
7551 See man ld(1) for more information.
7552
7553 @item -arch_errors_fatal
7554 @opindex arch_errors_fatal
7555 Cause the errors having to do with files that have the wrong architecture
7556 to be fatal.
7557
7558 @item -bind_at_load
7559 @opindex bind_at_load
7560 Causes the output file to be marked such that the dynamic linker will
7561 bind all undefined references when the file is loaded or launched.
7562
7563 @item -bundle
7564 @opindex bundle
7565 Produce a Mach-o bundle format file.
7566 See man ld(1) for more information.
7567
7568 @item -bundle_loader @var{executable}
7569 @opindex bundle_loader
7570 This specifies the @var{executable} that will be loading the build
7571 output file being linked. See man ld(1) for more information.
7572
7573 @item -allowable_client  @var{client_name}
7574 @itemx -arch_only
7575
7576 @itemx -client_name
7577 @itemx -compatibility_version
7578 @itemx -current_version
7579 @itemx -dependency-file
7580 @itemx -dylib_file
7581 @itemx -dylinker_install_name
7582 @itemx -dynamic
7583 @itemx -dynamiclib
7584 @itemx -exported_symbols_list
7585 @itemx -filelist
7586 @itemx -flat_namespace
7587 @itemx -force_cpusubtype_ALL
7588 @itemx -force_flat_namespace
7589 @itemx -headerpad_max_install_names
7590 @itemx -image_base
7591 @itemx -init
7592 @itemx -install_name
7593 @itemx -keep_private_externs
7594 @itemx -multi_module
7595 @itemx -multiply_defined
7596 @itemx -multiply_defined_unused
7597 @itemx -noall_load
7598 @itemx -nofixprebinding
7599 @itemx -nomultidefs
7600 @itemx -noprebind
7601 @itemx -noseglinkedit
7602 @itemx -pagezero_size
7603 @itemx -prebind
7604 @itemx -prebind_all_twolevel_modules
7605 @itemx -private_bundle
7606 @itemx -read_only_relocs
7607 @itemx -sectalign
7608 @itemx -sectobjectsymbols
7609 @itemx -whyload
7610 @itemx -seg1addr
7611 @itemx -sectcreate
7612 @itemx -sectobjectsymbols
7613 @itemx -sectorder
7614 @itemx -seg_addr_table
7615 @itemx -seg_addr_table_filename
7616 @itemx -seglinkedit
7617 @itemx -segprot
7618 @itemx -segs_read_only_addr
7619 @itemx -segs_read_write_addr
7620 @itemx -single_module
7621 @itemx -static
7622 @itemx -sub_library
7623 @itemx -sub_umbrella
7624 @itemx -twolevel_namespace
7625 @itemx -umbrella
7626 @itemx -undefined
7627 @itemx -unexported_symbols_list
7628 @itemx -weak_reference_mismatches
7629 @itemx -whatsloaded
7630
7631 @opindex allowable_client
7632 @opindex arch_only
7633 @opindex client_name
7634 @opindex compatibility_version
7635 @opindex current_version
7636 @opindex dependency-file
7637 @opindex dylib_file
7638 @opindex dylinker_install_name
7639 @opindex dynamic
7640 @opindex dynamiclib
7641 @opindex exported_symbols_list
7642 @opindex filelist
7643 @opindex flat_namespace
7644 @opindex force_cpusubtype_ALL
7645 @opindex force_flat_namespace
7646 @opindex headerpad_max_install_names
7647 @opindex image_base
7648 @opindex init
7649 @opindex install_name
7650 @opindex keep_private_externs
7651 @opindex multi_module
7652 @opindex multiply_defined
7653 @opindex multiply_defined_unused
7654 @opindex noall_load
7655 @opindex nofixprebinding
7656 @opindex nomultidefs
7657 @opindex noprebind
7658 @opindex noseglinkedit
7659 @opindex pagezero_size
7660 @opindex prebind
7661 @opindex prebind_all_twolevel_modules
7662 @opindex private_bundle
7663 @opindex read_only_relocs
7664 @opindex sectalign
7665 @opindex sectobjectsymbols
7666 @opindex whyload
7667 @opindex seg1addr
7668 @opindex sectcreate
7669 @opindex sectobjectsymbols
7670 @opindex sectorder
7671 @opindex seg_addr_table
7672 @opindex seg_addr_table_filename
7673 @opindex seglinkedit
7674 @opindex segprot
7675 @opindex segs_read_only_addr
7676 @opindex segs_read_write_addr
7677 @opindex single_module
7678 @opindex static
7679 @opindex sub_library
7680 @opindex sub_umbrella
7681 @opindex twolevel_namespace
7682 @opindex umbrella
7683 @opindex undefined
7684 @opindex unexported_symbols_list
7685 @opindex weak_reference_mismatches
7686 @opindex whatsloaded
7687
7688 These options are available for Darwin linker. Darwin linker man page
7689 describes them in detail.
7690 @end table
7691
7692
7693 @node MIPS Options
7694 @subsection MIPS Options
7695 @cindex MIPS options
7696
7697 @table @gcctabopt
7698
7699 @item -EB
7700 @opindex EB
7701 Generate big-endian code.
7702
7703 @item -EL
7704 @opindex EL
7705 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
7706 configurations.
7707
7708 @item -march=@var{arch}
7709 @opindex march
7710 Generate code that will run on @var{arch}, which can be the name of a
7711 generic MIPS ISA, or the name of a particular processor.
7712 The ISA names are:
7713 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7714 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7715 The processor names are:
7716 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7717 @samp{m4k},
7718 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7719 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
7720 @samp{rm9000},
7721 @samp{orion},
7722 @samp{sb1},
7723 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
7724 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
7725 The special value @samp{from-abi} selects the
7726 most compatible architecture for the selected ABI (that is,
7727 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7728
7729 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7730 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7731 @samp{vr} may be written @samp{r}.
7732
7733 GCC defines two macros based on the value of this option.  The first
7734 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7735 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7736 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7737 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7738 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7739
7740 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7741 above.  In other words, it will have the full prefix and will not
7742 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7743 the macro names the resolved architecture (either @samp{"mips1"} or
7744 @samp{"mips3"}).  It names the default architecture when no
7745 @option{-march} option is given.
7746
7747 @item -mtune=@var{arch}
7748 @opindex mtune
7749 Optimize for @var{arch}.  Among other things, this option controls
7750 the way instructions are scheduled, and the perceived cost of arithmetic
7751 operations.  The list of @var{arch} values is the same as for
7752 @option{-march}.
7753
7754 When this option is not used, GCC will optimize for the processor
7755 specified by @option{-march}.  By using @option{-march} and
7756 @option{-mtune} together, it is possible to generate code that will
7757 run on a family of processors, but optimize the code for one
7758 particular member of that family.
7759
7760 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7761 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7762 @samp{-march} ones described above.
7763
7764 @item -mips1
7765 @opindex mips1
7766 Equivalent to @samp{-march=mips1}.
7767
7768 @item -mips2
7769 @opindex mips2
7770 Equivalent to @samp{-march=mips2}.
7771
7772 @item -mips3
7773 @opindex mips3
7774 Equivalent to @samp{-march=mips3}.
7775
7776 @item -mips4
7777 @opindex mips4
7778 Equivalent to @samp{-march=mips4}.
7779
7780 @item -mips32
7781 @opindex mips32
7782 Equivalent to @samp{-march=mips32}.
7783
7784 @item -mips32r2
7785 @opindex mips32r2
7786 Equivalent to @samp{-march=mips32r2}.
7787
7788 @item -mips64
7789 @opindex mips64
7790 Equivalent to @samp{-march=mips64}.
7791
7792 @item -mips16
7793 @itemx -mno-mips16
7794 @opindex mips16
7795 @opindex mno-mips16
7796 Use (do not use) the MIPS16 ISA.
7797
7798 @item -mabi=32
7799 @itemx -mabi=o64
7800 @itemx -mabi=n32
7801 @itemx -mabi=64
7802 @itemx -mabi=eabi
7803 @opindex mabi=32
7804 @opindex mabi=o64
7805 @opindex mabi=n32
7806 @opindex mabi=64
7807 @opindex mabi=eabi
7808 Generate code for the given ABI@.
7809
7810 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
7811 generates 64-bit code when you select a 64-bit architecture, but you
7812 can use @option{-mgp32} to get 32-bit code instead.
7813
7814 @item -mabicalls
7815 @itemx -mno-abicalls
7816 @opindex mabicalls
7817 @opindex mno-abicalls
7818 Generate (do not generate) SVR4-style position-independent code.
7819 @option{-mabicalls} is the default for SVR4-based systems.
7820
7821 @item -mxgot
7822 @itemx -mno-xgot
7823 @opindex mxgot
7824 @opindex mno-xgot
7825 Lift (do not lift) the usual restrictions on the size of the global
7826 offset table.
7827
7828 GCC normally uses a single instruction to load values from the GOT.
7829 While this is relatively efficient, it will only work if the GOT
7830 is smaller than about 64k.  Anything larger will cause the linker
7831 to report an error such as:
7832
7833 @cindex relocation truncated to fit (MIPS)
7834 @smallexample
7835 relocation truncated to fit: R_MIPS_GOT16 foobar
7836 @end smallexample
7837
7838 If this happens, you should recompile your code with @option{-mxgot}.
7839 It should then work with very large GOTs, although it will also be
7840 less efficient, since it will take three instructions to fetch the
7841 value of a global symbol.
7842
7843 Note that some linkers can create multiple GOTs.  If you have such a
7844 linker, you should only need to use @option{-mxgot} when a single object
7845 file accesses more than 64k's worth of GOT entries.  Very few do.
7846
7847 These options have no effect unless GCC is generating position
7848 independent code.
7849
7850 @item -membedded-pic
7851 @itemx -mno-embedded-pic
7852 @opindex membedded-pic
7853 @opindex mno-embedded-pic
7854 Generate (do not generate) position-independent code suitable for some
7855 embedded systems.  All calls are made using PC relative addresses, and
7856 all data is addressed using the $gp register.  No more than 65536
7857 bytes of global data may be used.  This requires GNU as and GNU ld,
7858 which do most of the work.
7859
7860 @item -mgp32
7861 @opindex mgp32
7862 Assume that general-purpose registers are 32 bits wide.
7863
7864 @item -mgp64
7865 @opindex mgp64
7866 Assume that general-purpose registers are 64 bits wide.
7867
7868 @item -mfp32
7869 @opindex mfp32
7870 Assume that floating-point registers are 32 bits wide.
7871
7872 @item -mfp64
7873 @opindex mfp64
7874 Assume that floating-point registers are 64 bits wide.
7875
7876 @item -mhard-float
7877 @opindex mhard-float
7878 Use floating-point coprocessor instructions.
7879
7880 @item -msoft-float
7881 @opindex msoft-float
7882 Do not use floating-point coprocessor instructions.  Implement
7883 floating-point calculations using library calls instead.
7884
7885 @item -msingle-float
7886 @opindex msingle-float
7887 Assume that the floating-point coprocessor only supports single-precision
7888 operations.
7889
7890 @itemx -mdouble-float
7891 @opindex mdouble-float
7892 Assume that the floating-point coprocessor supports double-precision
7893 operations.  This is the default.
7894
7895 @item -mint64
7896 @opindex mint64
7897 Force @code{int} and @code{long} types to be 64 bits wide.  See
7898 @option{-mlong32} for an explanation of the default and the way
7899 that the pointer size is determined.
7900
7901 @item -mlong64
7902 @opindex mlong64
7903 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
7904 an explanation of the default and the way that the pointer size is
7905 determined.
7906
7907 @item -mlong32
7908 @opindex mlong32
7909 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
7910
7911 The default size of @code{int}s, @code{long}s and pointers depends on
7912 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
7913 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
7914 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
7915 or the same size as integer registers, whichever is smaller.
7916
7917 @item -G @var{num}
7918 @opindex G
7919 @cindex smaller data references (MIPS)
7920 @cindex gp-relative references (MIPS)
7921 Put global and static items less than or equal to @var{num} bytes into
7922 the small data or bss section instead of the normal data or bss section.
7923 This allows the data to be accessed using a single instruction.
7924
7925 All modules should be compiled with the same @option{-G @var{num}}
7926 value.
7927
7928 @item -membedded-data
7929 @itemx -mno-embedded-data
7930 @opindex membedded-data
7931 @opindex mno-embedded-data
7932 Allocate variables to the read-only data section first if possible, then
7933 next in the small data section if possible, otherwise in data.  This gives
7934 slightly slower code than the default, but reduces the amount of RAM required
7935 when executing, and thus may be preferred for some embedded systems.
7936
7937 @item -muninit-const-in-rodata
7938 @itemx -mno-uninit-const-in-rodata
7939 @opindex muninit-const-in-rodata
7940 @opindex mno-uninit-const-in-rodata
7941 Put uninitialized @code{const} variables in the read-only data section.
7942 This option is only meaningful in conjunction with @option{-membedded-data}.
7943
7944 @item -msplit-addresses
7945 @itemx -mno-split-addresses
7946 @opindex msplit-addresses
7947 @opindex mno-split-addresses
7948 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
7949 relocation operators.  This option has been superceded by
7950 @option{-mexplicit-relocs} but is retained for backwards compatibility.
7951
7952 @item -mexplicit-relocs
7953 @itemx -mno-explicit-relocs
7954 @opindex mexplicit-relocs
7955 @opindex mno-explicit-relocs
7956 Use (do not use) assembler relocation operators when dealing with symbolic
7957 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
7958 is to use assembler macros instead.
7959
7960 @option{-mexplicit-relocs} is usually the default if GCC was
7961 configured to use an assembler that supports relocation operators.
7962 However, there are two exceptions:
7963
7964 @itemize @bullet
7965 @item
7966 GCC is not yet able to generate explicit relocations for the combination
7967 of @option{-mabi=64} and @option{-mno-abicalls}.  This will be addressed
7968 in a future release.
7969
7970 @item
7971 The combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
7972 implies @option{-mno-explicit-relocs} unless explicitly overridden.
7973 This is because, when generating abicalls, the choice of relocation
7974 depends on whether a symbol is local or global.  In some rare cases,
7975 GCC will not be able to decide this until the whole compilation unit
7976 has been read.
7977 @end itemize
7978
7979 @item -mrnames
7980 @itemx -mno-rnames
7981 @opindex mrnames
7982 @opindex mno-rnames
7983 Generate (do not generate) code that refers to registers using their
7984 software names.  The default is @option{-mno-rnames}, which tells GCC
7985 to use hardware names like @samp{$4} instead of software names like
7986 @samp{a0}.  The only assembler known to support @option{-rnames} is
7987 the Algorithmics assembler.
7988
7989 @item -mcheck-zero-division
7990 @itemx -mno-check-zero-division
7991 @opindex mcheck-zero-division
7992 @opindex mno-check-zero-division
7993 Trap (do not trap) on integer division by zero.  The default is
7994 @option{-mcheck-zero-division}.
7995
7996 @item -mmemcpy
7997 @itemx -mno-memcpy
7998 @opindex mmemcpy
7999 @opindex mno-memcpy
8000 Force (do not force) the use of @code{memcpy()} for non-trivial block
8001 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
8002 most constant-sized copies.
8003
8004 @item -mlong-calls
8005 @itemx -mno-long-calls
8006 @opindex mlong-calls
8007 @opindex mno-long-calls
8008 Disable (do not disable) use of the @code{jal} instruction.  Calling
8009 functions using @code{jal} is more efficient but requires the caller
8010 and callee to be in the same 256 megabyte segment.
8011
8012 This option has no effect on abicalls code.  The default is
8013 @option{-mno-long-calls}.
8014
8015 @item -mmad
8016 @itemx -mno-mad
8017 @opindex mmad
8018 @opindex mno-mad
8019 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8020 instructions, as provided by the R4650 ISA.
8021
8022 @item -mfused-madd
8023 @itemx -mno-fused-madd
8024 @opindex mfused-madd
8025 @opindex mno-fused-madd
8026 Enable (disable) use of the floating point multiply-accumulate
8027 instructions, when they are available.  The default is
8028 @option{-mfused-madd}.
8029
8030 When multiply-accumulate instructions are used, the intermediate
8031 product is calculated to infinite precision and is not subject to
8032 the FCSR Flush to Zero bit.  This may be undesirable in some
8033 circumstances.
8034
8035 @item -nocpp
8036 @opindex nocpp
8037 Tell the MIPS assembler to not run its preprocessor over user
8038 assembler files (with a @samp{.s} suffix) when assembling them.
8039
8040 @item -mfix-sb1
8041 @itemx -mno-fix-sb1
8042 @opindex mfix-sb1
8043 Work around certain SB-1 CPU core errata.
8044 (This flag currently works around the SB-1 revision 2
8045 ``F1'' and ``F2'' floating point errata.)
8046
8047 @item -mflush-func=@var{func}
8048 @itemx -mno-flush-func
8049 @opindex mflush-func
8050 Specifies the function to call to flush the I and D caches, or to not
8051 call any such function.  If called, the function must take the same
8052 arguments as the common @code{_flush_func()}, that is, the address of the
8053 memory range for which the cache is being flushed, the size of the
8054 memory range, and the number 3 (to flush both caches).  The default
8055 depends on the target gcc was configured for, but commonly is either
8056 @samp{_flush_func} or @samp{__cpu_flush}.
8057
8058 @item -mbranch-likely
8059 @itemx -mno-branch-likely
8060 @opindex mbranch-likely
8061 @opindex mno-branch-likely
8062 Enable or disable use of Branch Likely instructions, regardless of the
8063 default for the selected architecture.  By default, Branch Likely
8064 instructions may be generated if they are supported by the selected
8065 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8066 and processors which implement those architectures; for those, Branch
8067 Likely instructions will not be generated by default because the MIPS32
8068 and MIPS64 architectures specifically deprecate their use.
8069 @end table
8070
8071 @node i386 and x86-64 Options
8072 @subsection Intel 386 and AMD x86-64 Options
8073 @cindex i386 Options
8074 @cindex x86-64 Options
8075 @cindex Intel 386 Options
8076 @cindex AMD x86-64 Options
8077
8078 These @samp{-m} options are defined for the i386 and x86-64 family of
8079 computers:
8080
8081 @table @gcctabopt
8082 @item -mtune=@var{cpu-type}
8083 @opindex mtune
8084 Tune to @var{cpu-type} everything applicable about the generated code, except
8085 for the ABI and the set of available instructions.  The choices for
8086 @var{cpu-type} are:
8087 @table @emph
8088 @item i386
8089 Original Intel's i386 CPU.
8090 @item i486
8091 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8092 @item i586, pentium
8093 Intel Pentium CPU with no MMX support.
8094 @item pentium-mmx
8095 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8096 @item i686, pentiumpro
8097 Intel PentiumPro CPU.
8098 @item pentium2
8099 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8100 @item pentium3
8101 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8102 support.
8103 @item pentium4
8104 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8105 @item k6
8106 AMD K6 CPU with MMX instruction set support.
8107 @item k6-2, k6-3
8108 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8109 @item athlon, athlon-tbird
8110 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8111 support.
8112 @item athlon-4, athlon-xp, athlon-mp
8113 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8114 instruction set support.
8115 @item k8, opteron, athlon64, athlon-fx
8116 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8117 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8118 @item winchip-c6
8119 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8120 set support.
8121 @item winchip2
8122 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8123 instruction set support.
8124 @item c3
8125 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8126 implemented for this chip.)
8127 @item c3-2
8128 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8129 implemented for this chip.)
8130 @end table
8131
8132 While picking a specific @var{cpu-type} will schedule things appropriately
8133 for that particular chip, the compiler will not generate any code that
8134 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8135 being used.
8136
8137 @item -march=@var{cpu-type}
8138 @opindex march
8139 Generate instructions for the machine type @var{cpu-type}.  The choices
8140 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8141 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8142
8143 @item -mcpu=@var{cpu-type}
8144 @opindex mcpu
8145 A deprecated synonym for @option{-mtune}.
8146
8147 @item -m386
8148 @itemx -m486
8149 @itemx -mpentium
8150 @itemx -mpentiumpro
8151 @opindex m386
8152 @opindex m486
8153 @opindex mpentium
8154 @opindex mpentiumpro
8155 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8156 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8157 These synonyms are deprecated.
8158
8159 @item -mfpmath=@var{unit}
8160 @opindex march
8161 generate floating point arithmetics for selected unit @var{unit}.  the choices
8162 for @var{unit} are:
8163
8164 @table @samp
8165 @item 387
8166 Use the standard 387 floating point coprocessor present majority of chips and
8167 emulated otherwise.  Code compiled with this option will run almost everywhere.
8168 The temporary results are computed in 80bit precision instead of precision
8169 specified by the type resulting in slightly different results compared to most
8170 of other chips. See @option{-ffloat-store} for more detailed description.
8171
8172 This is the default choice for i386 compiler.
8173
8174 @item sse
8175 Use scalar floating point instructions present in the SSE instruction set.
8176 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8177 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8178 instruction set supports only single precision arithmetics, thus the double and
8179 extended precision arithmetics is still done using 387.  Later version, present
8180 only in Pentium4 and the future AMD x86-64 chips supports double precision
8181 arithmetics too.
8182
8183 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8184 @option{-msse2} switches to enable SSE extensions and make this option
8185 effective.  For x86-64 compiler, these extensions are enabled by default.
8186
8187 The resulting code should be considerably faster in majority of cases and avoid
8188 the numerical instability problems of 387 code, but may break some existing
8189 code that expects temporaries to be 80bit.
8190
8191 This is the default choice for x86-64 compiler.
8192
8193 @item pni
8194 Use all SSE extensions enabled by @option{-msse2} as well as the new
8195 SSE extensions in Prescott New Instructions. @option{-mpni} also
8196 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8197 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8198 @code{mwait}.
8199
8200 @item sse,387
8201 Attempt to utilize both instruction sets at once.  This effectively double the
8202 amount of available registers and on chips with separate execution units for
8203 387 and SSE the execution resources too.  Use this option with care, as it is
8204 still experimental, because gcc register allocator does not model separate
8205 functional units well resulting in instable performance.
8206 @end table
8207
8208 @item -masm=@var{dialect}
8209 @opindex masm=@var{dialect}
8210 Output asm instructions using selected @var{dialect}. Supported choices are
8211 @samp{intel} or @samp{att} (the default one).
8212
8213 @item -mieee-fp
8214 @itemx -mno-ieee-fp
8215 @opindex mieee-fp
8216 @opindex mno-ieee-fp
8217 Control whether or not the compiler uses IEEE floating point
8218 comparisons.  These handle correctly the case where the result of a
8219 comparison is unordered.
8220
8221 @item -msoft-float
8222 @opindex msoft-float
8223 Generate output containing library calls for floating point.
8224 @strong{Warning:} the requisite libraries are not part of GCC@.
8225 Normally the facilities of the machine's usual C compiler are used, but
8226 this can't be done directly in cross-compilation.  You must make your
8227 own arrangements to provide suitable library functions for
8228 cross-compilation.
8229
8230 On machines where a function returns floating point results in the 80387
8231 register stack, some floating point opcodes may be emitted even if
8232 @option{-msoft-float} is used.
8233
8234 @item -mno-fp-ret-in-387
8235 @opindex mno-fp-ret-in-387
8236 Do not use the FPU registers for return values of functions.
8237
8238 The usual calling convention has functions return values of types
8239 @code{float} and @code{double} in an FPU register, even if there
8240 is no FPU@.  The idea is that the operating system should emulate
8241 an FPU@.
8242
8243 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8244 in ordinary CPU registers instead.
8245
8246 @item -mno-fancy-math-387
8247 @opindex mno-fancy-math-387
8248 Some 387 emulators do not support the @code{sin}, @code{cos} and
8249 @code{sqrt} instructions for the 387.  Specify this option to avoid
8250 generating those instructions.  This option is the default on FreeBSD,
8251 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8252 indicates that the target cpu will always have an FPU and so the
8253 instruction will not need emulation.  As of revision 2.6.1, these
8254 instructions are not generated unless you also use the
8255 @option{-funsafe-math-optimizations} switch.
8256
8257 @item -malign-double
8258 @itemx -mno-align-double
8259 @opindex malign-double
8260 @opindex mno-align-double
8261 Control whether GCC aligns @code{double}, @code{long double}, and
8262 @code{long long} variables on a two word boundary or a one word
8263 boundary.  Aligning @code{double} variables on a two word boundary will
8264 produce code that runs somewhat faster on a @samp{Pentium} at the
8265 expense of more memory.
8266
8267 @strong{Warning:} if you use the @option{-malign-double} switch,
8268 structures containing the above types will be aligned differently than
8269 the published application binary interface specifications for the 386
8270 and will not be binary compatible with structures in code compiled
8271 without that switch.
8272
8273 @item -m96bit-long-double
8274 @itemx -m128bit-long-double
8275 @opindex m96bit-long-double
8276 @opindex m128bit-long-double
8277 These switches control the size of @code{long double} type. The i386
8278 application binary interface specifies the size to be 96 bits,
8279 so @option{-m96bit-long-double} is the default in 32 bit mode.
8280
8281 Modern architectures (Pentium and newer) would prefer @code{long double}
8282 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8283 conforming to the ABI, this would not be possible.  So specifying a
8284 @option{-m128bit-long-double} will align @code{long double}
8285 to a 16 byte boundary by padding the @code{long double} with an additional
8286 32 bit zero.
8287
8288 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8289 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8290
8291 Notice that neither of these options enable any extra precision over the x87
8292 standard of 80 bits for a @code{long double}.
8293
8294 @strong{Warning:} if you override the default value for your target ABI, the
8295 structures and arrays containing @code{long double} will change their size as
8296 well as function calling convention for function taking @code{long double}
8297 will be modified.  Hence they will not be binary compatible with arrays or
8298 structures in code compiled without that switch.
8299
8300
8301 @item -msvr3-shlib
8302 @itemx -mno-svr3-shlib
8303 @opindex msvr3-shlib
8304 @opindex mno-svr3-shlib
8305 Control whether GCC places uninitialized local variables into the
8306 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8307 into @code{bss}.  These options are meaningful only on System V Release 3.
8308
8309 @item -mrtd
8310 @opindex mrtd
8311 Use a different function-calling convention, in which functions that
8312 take a fixed number of arguments return with the @code{ret} @var{num}
8313 instruction, which pops their arguments while returning.  This saves one
8314 instruction in the caller since there is no need to pop the arguments
8315 there.
8316
8317 You can specify that an individual function is called with this calling
8318 sequence with the function attribute @samp{stdcall}.  You can also
8319 override the @option{-mrtd} option by using the function attribute
8320 @samp{cdecl}.  @xref{Function Attributes}.
8321
8322 @strong{Warning:} this calling convention is incompatible with the one
8323 normally used on Unix, so you cannot use it if you need to call
8324 libraries compiled with the Unix compiler.
8325
8326 Also, you must provide function prototypes for all functions that
8327 take variable numbers of arguments (including @code{printf});
8328 otherwise incorrect code will be generated for calls to those
8329 functions.
8330
8331 In addition, seriously incorrect code will result if you call a
8332 function with too many arguments.  (Normally, extra arguments are
8333 harmlessly ignored.)
8334
8335 @item -mregparm=@var{num}
8336 @opindex mregparm
8337 Control how many registers are used to pass integer arguments.  By
8338 default, no registers are used to pass arguments, and at most 3
8339 registers can be used.  You can control this behavior for a specific
8340 function by using the function attribute @samp{regparm}.
8341 @xref{Function Attributes}.
8342
8343 @strong{Warning:} if you use this switch, and
8344 @var{num} is nonzero, then you must build all modules with the same
8345 value, including any libraries.  This includes the system libraries and
8346 startup modules.
8347
8348 @item -mpreferred-stack-boundary=@var{num}
8349 @opindex mpreferred-stack-boundary
8350 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8351 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8352 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8353 size (@option{-Os}), in which case the default is the minimum correct
8354 alignment (4 bytes for x86, and 8 bytes for x86-64).
8355
8356 On Pentium and PentiumPro, @code{double} and @code{long double} values
8357 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8358 suffer significant run time performance penalties.  On Pentium III, the
8359 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8360 penalties if it is not 16 byte aligned.
8361
8362 To ensure proper alignment of this values on the stack, the stack boundary
8363 must be as aligned as that required by any value stored on the stack.
8364 Further, every function must be generated such that it keeps the stack
8365 aligned.  Thus calling a function compiled with a higher preferred
8366 stack boundary from a function compiled with a lower preferred stack
8367 boundary will most likely misalign the stack.  It is recommended that
8368 libraries that use callbacks always use the default setting.
8369
8370 This extra alignment does consume extra stack space, and generally
8371 increases code size.  Code that is sensitive to stack space usage, such
8372 as embedded systems and operating system kernels, may want to reduce the
8373 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8374
8375 @item -mmmx
8376 @itemx -mno-mmx
8377 @item -msse
8378 @itemx -mno-sse
8379 @item -msse2
8380 @itemx -mno-sse2
8381 @item -mpni
8382 @itemx -mno-pni
8383 @item -m3dnow
8384 @itemx -mno-3dnow
8385 @opindex mmmx
8386 @opindex mno-mmx
8387 @opindex msse
8388 @opindex mno-sse
8389 @opindex m3dnow
8390 @opindex mno-3dnow
8391 These switches enable or disable the use of built-in functions that allow
8392 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8393
8394 @xref{X86 Built-in Functions}, for details of the functions enabled
8395 and disabled by these switches.
8396
8397 To have SSE/SSE2 instructions generated automatically from floating-point
8398 code, see @option{-mfpmath=sse}.
8399
8400 @item -mpush-args
8401 @itemx -mno-push-args
8402 @opindex mpush-args
8403 @opindex mno-push-args
8404 Use PUSH operations to store outgoing parameters.  This method is shorter
8405 and usually equally fast as method using SUB/MOV operations and is enabled
8406 by default.  In some cases disabling it may improve performance because of
8407 improved scheduling and reduced dependencies.
8408
8409 @item -maccumulate-outgoing-args
8410 @opindex maccumulate-outgoing-args
8411 If enabled, the maximum amount of space required for outgoing arguments will be
8412 computed in the function prologue.  This is faster on most modern CPUs
8413 because of reduced dependencies, improved scheduling and reduced stack usage
8414 when preferred stack boundary is not equal to 2.  The drawback is a notable
8415 increase in code size.  This switch implies @option{-mno-push-args}.
8416
8417 @item -mthreads
8418 @opindex mthreads
8419 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8420 on thread-safe exception handling must compile and link all code with the
8421 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8422 @option{-D_MT}; when linking, it links in a special thread helper library
8423 @option{-lmingwthrd} which cleans up per thread exception handling data.
8424
8425 @item -mno-align-stringops
8426 @opindex mno-align-stringops
8427 Do not align destination of inlined string operations.  This switch reduces
8428 code size and improves performance in case the destination is already aligned,
8429 but gcc don't know about it.
8430
8431 @item -minline-all-stringops
8432 @opindex minline-all-stringops
8433 By default GCC inlines string operations only when destination is known to be
8434 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8435 size, but may improve performance of code that depends on fast memcpy, strlen
8436 and memset for short lengths.
8437
8438 @item -momit-leaf-frame-pointer
8439 @opindex momit-leaf-frame-pointer
8440 Don't keep the frame pointer in a register for leaf functions.  This
8441 avoids the instructions to save, set up and restore frame pointers and
8442 makes an extra register available in leaf functions.  The option
8443 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8444 which might make debugging harder.
8445
8446 @item -mtls-direct-seg-refs
8447 @itemx -mno-tls-direct-seg-refs
8448 @opindex mtls-direct-seg-refs
8449 Controls whether TLS variables may be accessed with offsets from the
8450 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8451 or whether the thread base pointer must be added.  Whether or not this
8452 is legal depends on the operating system, and whether it maps the
8453 segment to cover the entire TLS area.
8454
8455 For systems that use GNU libc, the default is on.
8456 @end table
8457
8458 These @samp{-m} switches are supported in addition to the above
8459 on AMD x86-64 processors in 64-bit environments.
8460
8461 @table @gcctabopt
8462 @item -m32
8463 @itemx -m64
8464 @opindex m32
8465 @opindex m64
8466 Generate code for a 32-bit or 64-bit environment.
8467 The 32-bit environment sets int, long and pointer to 32 bits and
8468 generates code that runs on any i386 system.
8469 The 64-bit environment sets int to 32 bits and long and pointer
8470 to 64 bits and generates code for AMD's x86-64 architecture.
8471
8472 @item -mno-red-zone
8473 @opindex no-red-zone
8474 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8475 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8476 stack pointer that will not be modified by signal or interrupt handlers
8477 and therefore can be used for temporary data without adjusting the stack
8478 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8479
8480 @item -mcmodel=small
8481 @opindex mcmodel=small
8482 Generate code for the small code model: the program and its symbols must
8483 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8484 Programs can be statically or dynamically linked.  This is the default
8485 code model.
8486
8487 @item -mcmodel=kernel
8488 @opindex mcmodel=kernel
8489 Generate code for the kernel code model.  The kernel runs in the
8490 negative 2 GB of the address space.
8491 This model has to be used for Linux kernel code.
8492
8493 @item -mcmodel=medium
8494 @opindex mcmodel=medium
8495 Generate code for the medium model: The program is linked in the lower 2
8496 GB of the address space but symbols can be located anywhere in the
8497 address space.  Programs can be statically or dynamically linked, but
8498 building of shared libraries are not supported with the medium model.
8499
8500 @item -mcmodel=large
8501 @opindex mcmodel=large
8502 Generate code for the large model: This model makes no assumptions
8503 about addresses and sizes of sections.  Currently GCC does not implement
8504 this model.
8505 @end table
8506
8507 @node HPPA Options
8508 @subsection HPPA Options
8509 @cindex HPPA Options
8510
8511 These @samp{-m} options are defined for the HPPA family of computers:
8512
8513 @table @gcctabopt
8514 @item -march=@var{architecture-type}
8515 @opindex march
8516 Generate code for the specified architecture.  The choices for
8517 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8518 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8519 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8520 architecture option for your machine.  Code compiled for lower numbered
8521 architectures will run on higher numbered architectures, but not the
8522 other way around.
8523
8524 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8525 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8526 support.
8527
8528 @item -mpa-risc-1-0
8529 @itemx -mpa-risc-1-1
8530 @itemx -mpa-risc-2-0
8531 @opindex mpa-risc-1-0
8532 @opindex mpa-risc-1-1
8533 @opindex mpa-risc-2-0
8534 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8535
8536 @item -mbig-switch
8537 @opindex mbig-switch
8538 Generate code suitable for big switch tables.  Use this option only if
8539 the assembler/linker complain about out of range branches within a switch
8540 table.
8541
8542 @item -mjump-in-delay
8543 @opindex mjump-in-delay
8544 Fill delay slots of function calls with unconditional jump instructions
8545 by modifying the return pointer for the function call to be the target
8546 of the conditional jump.
8547
8548 @item -mdisable-fpregs
8549 @opindex mdisable-fpregs
8550 Prevent floating point registers from being used in any manner.  This is
8551 necessary for compiling kernels which perform lazy context switching of
8552 floating point registers.  If you use this option and attempt to perform
8553 floating point operations, the compiler will abort.
8554
8555 @item -mdisable-indexing
8556 @opindex mdisable-indexing
8557 Prevent the compiler from using indexing address modes.  This avoids some
8558 rather obscure problems when compiling MIG generated code under MACH@.
8559
8560 @item -mno-space-regs
8561 @opindex mno-space-regs
8562 Generate code that assumes the target has no space registers.  This allows
8563 GCC to generate faster indirect calls and use unscaled index address modes.
8564
8565 Such code is suitable for level 0 PA systems and kernels.
8566
8567 @item -mfast-indirect-calls
8568 @opindex mfast-indirect-calls
8569 Generate code that assumes calls never cross space boundaries.  This
8570 allows GCC to emit code which performs faster indirect calls.
8571
8572 This option will not work in the presence of shared libraries or nested
8573 functions.
8574
8575 @item -mlong-load-store
8576 @opindex mlong-load-store
8577 Generate 3-instruction load and store sequences as sometimes required by
8578 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8579 the HP compilers.
8580
8581 @item -mportable-runtime
8582 @opindex mportable-runtime
8583 Use the portable calling conventions proposed by HP for ELF systems.
8584
8585 @item -mgas
8586 @opindex mgas
8587 Enable the use of assembler directives only GAS understands.
8588
8589 @item -mschedule=@var{cpu-type}
8590 @opindex mschedule
8591 Schedule code according to the constraints for the machine type
8592 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8593 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8594 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8595 proper scheduling option for your machine.  The default scheduling is
8596 @samp{8000}.
8597
8598 @item -mlinker-opt
8599 @opindex mlinker-opt
8600 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8601 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8602 linkers in which they give bogus error messages when linking some programs.
8603
8604 @item -msoft-float
8605 @opindex msoft-float
8606 Generate output containing library calls for floating point.
8607 @strong{Warning:} the requisite libraries are not available for all HPPA
8608 targets.  Normally the facilities of the machine's usual C compiler are
8609 used, but this cannot be done directly in cross-compilation.  You must make
8610 your own arrangements to provide suitable library functions for
8611 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8612 does provide software floating point support.
8613
8614 @option{-msoft-float} changes the calling convention in the output file;
8615 therefore, it is only useful if you compile @emph{all} of a program with
8616 this option.  In particular, you need to compile @file{libgcc.a}, the
8617 library that comes with GCC, with @option{-msoft-float} in order for
8618 this to work.
8619
8620 @item -msio
8621 @opindex msio
8622 Generate the predefine, @code{_SIO}, for server IO.  The default is
8623 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8624 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8625 options are available under HP-UX and HI-UX.
8626
8627 @item -mgnu-ld
8628 @opindex gnu-ld
8629 Use GNU ld specific options.  This passes @option{-shared} to ld when
8630 building a shared library.  It is the default when GCC is configured,
8631 explicitly or implicitly, with the GNU linker.  This option does not
8632 have any affect on which ld is called, it only changes what parameters
8633 are passed to that ld.  The ld that is called is determined by the
8634 @option{--with-ld} configure option, gcc's program search path, and
8635 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8636 using @samp{which `gcc -print-prog-name=ld`}.
8637
8638 @item -mhp-ld
8639 @opindex hp-ld
8640 Use HP ld specific options.  This passes @option{-b} to ld when building
8641 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8642 links.  It is the default when GCC is configured, explicitly or
8643 implicitly, with the HP linker.  This option does not have any affect on
8644 which ld is called, it only changes what parameters are passed to that
8645 ld.  The ld that is called is determined by the @option{--with-ld}
8646 configure option, gcc's program search path, and finally by the user's
8647 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8648 `gcc -print-prog-name=ld`}.
8649
8650 @item -mlong-calls
8651 @opindex mno-long-calls
8652 Generate code that uses long call sequences.  This ensures that a call
8653 is always able to reach linker generated stubs.  The default is to generate
8654 long calls only when the distance from the call site to the beginning
8655 of the function or translation unit, as the case may be, exceeds a
8656 predefined limit set by the branch type being used.  The limits for
8657 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8658 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8659 240,000 bytes.
8660
8661 Distances are measured from the beginning of functions when using the
8662 @option{-ffunction-sections} option, or when using the @option{-mgas}
8663 and @option{-mno-portable-runtime} options together under HP-UX with
8664 the SOM linker.
8665
8666 It is normally not desirable to use this option as it will degrade
8667 performance.  However, it may be useful in large applications,
8668 particularly when partial linking is used to build the application.
8669
8670 The types of long calls used depends on the capabilities of the
8671 assembler and linker, and the type of code being generated.  The
8672 impact on systems that support long absolute calls, and long pic
8673 symbol-difference or pc-relative calls should be relatively small.
8674 However, an indirect call is used on 32-bit ELF systems in pic code
8675 and it is quite long.
8676
8677 @item -nolibdld
8678 @opindex nolibdld
8679 Suppress the generation of link options to search libdld.sl when the
8680 @option{-static} option is specified on HP-UX 10 and later.
8681
8682 @item -static
8683 @opindex static
8684 The HP-UX implementation of setlocale in libc has a dependency on
8685 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8686 when the @option{-static} option is specified, special link options
8687 are needed to resolve this dependency.
8688
8689 On HP-UX 10 and later, the GCC driver adds the necessary options to
8690 link with libdld.sl when the @option{-static} option is specified.
8691 This causes the resulting binary to be dynamic.  On the 64-bit port,
8692 the linkers generate dynamic binaries by default in any case.  The
8693 @option{-nolibdld} option can be used to prevent the GCC driver from
8694 adding these link options.
8695
8696 @item -threads
8697 @opindex threads
8698 Add support for multithreading with the @dfn{dce thread} library
8699 under HP-UX.  This option sets flags for both the preprocessor and
8700 linker.
8701 @end table
8702
8703 @node Intel 960 Options
8704 @subsection Intel 960 Options
8705
8706 These @samp{-m} options are defined for the Intel 960 implementations:
8707
8708 @table @gcctabopt
8709 @item -m@var{cpu-type}
8710 @opindex mka
8711 @opindex mkb
8712 @opindex mmc
8713 @opindex mca
8714 @opindex mcf
8715 @opindex msa
8716 @opindex msb
8717 Assume the defaults for the machine type @var{cpu-type} for some of
8718 the other options, including instruction scheduling, floating point
8719 support, and addressing modes.  The choices for @var{cpu-type} are
8720 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8721 @samp{sa}, and @samp{sb}.
8722 The default is
8723 @samp{kb}.
8724
8725 @item -mnumerics
8726 @itemx -msoft-float
8727 @opindex mnumerics
8728 @opindex msoft-float
8729 The @option{-mnumerics} option indicates that the processor does support
8730 floating-point instructions.  The @option{-msoft-float} option indicates
8731 that floating-point support should not be assumed.
8732
8733 @item -mleaf-procedures
8734 @itemx -mno-leaf-procedures
8735 @opindex mleaf-procedures
8736 @opindex mno-leaf-procedures
8737 Do (or do not) attempt to alter leaf procedures to be callable with the
8738 @code{bal} instruction as well as @code{call}.  This will result in more
8739 efficient code for explicit calls when the @code{bal} instruction can be
8740 substituted by the assembler or linker, but less efficient code in other
8741 cases, such as calls via function pointers, or using a linker that doesn't
8742 support this optimization.
8743
8744 @item -mtail-call
8745 @itemx -mno-tail-call
8746 @opindex mtail-call
8747 @opindex mno-tail-call
8748 Do (or do not) make additional attempts (beyond those of the
8749 machine-independent portions of the compiler) to optimize tail-recursive
8750 calls into branches.  You may not want to do this because the detection of
8751 cases where this is not valid is not totally complete.  The default is
8752 @option{-mno-tail-call}.
8753
8754 @item -mcomplex-addr
8755 @itemx -mno-complex-addr
8756 @opindex mcomplex-addr
8757 @opindex mno-complex-addr
8758 Assume (or do not assume) that the use of a complex addressing mode is a
8759 win on this implementation of the i960.  Complex addressing modes may not
8760 be worthwhile on the K-series, but they definitely are on the C-series.
8761 The default is currently @option{-mcomplex-addr} for all processors except
8762 the CB and CC@.
8763
8764 @item -mcode-align
8765 @itemx -mno-code-align
8766 @opindex mcode-align
8767 @opindex mno-code-align
8768 Align code to 8-byte boundaries for faster fetching (or don't bother).
8769 Currently turned on by default for C-series implementations only.
8770
8771 @ignore
8772 @item -mclean-linkage
8773 @itemx -mno-clean-linkage
8774 @opindex mclean-linkage
8775 @opindex mno-clean-linkage
8776 These options are not fully implemented.
8777 @end ignore
8778
8779 @item -mic-compat
8780 @itemx -mic2.0-compat
8781 @itemx -mic3.0-compat
8782 @opindex mic-compat
8783 @opindex mic2.0-compat
8784 @opindex mic3.0-compat
8785 Enable compatibility with iC960 v2.0 or v3.0.
8786
8787 @item -masm-compat
8788 @itemx -mintel-asm
8789 @opindex masm-compat
8790 @opindex mintel-asm
8791 Enable compatibility with the iC960 assembler.
8792
8793 @item -mstrict-align
8794 @itemx -mno-strict-align
8795 @opindex mstrict-align
8796 @opindex mno-strict-align
8797 Do not permit (do permit) unaligned accesses.
8798
8799 @item -mold-align
8800 @opindex mold-align
8801 Enable structure-alignment compatibility with Intel's gcc release version
8802 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8803
8804 @item -mlong-double-64
8805 @opindex mlong-double-64
8806 Implement type @samp{long double} as 64-bit floating point numbers.
8807 Without the option @samp{long double} is implemented by 80-bit
8808 floating point numbers.  The only reason we have it because there is
8809 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8810 is only useful for people using soft-float targets.  Otherwise, we
8811 should recommend against use of it.
8812
8813 @end table
8814
8815 @node DEC Alpha Options
8816 @subsection DEC Alpha Options
8817
8818 These @samp{-m} options are defined for the DEC Alpha implementations:
8819
8820 @table @gcctabopt
8821 @item -mno-soft-float
8822 @itemx -msoft-float
8823 @opindex mno-soft-float
8824 @opindex msoft-float
8825 Use (do not use) the hardware floating-point instructions for
8826 floating-point operations.  When @option{-msoft-float} is specified,
8827 functions in @file{libgcc.a} will be used to perform floating-point
8828 operations.  Unless they are replaced by routines that emulate the
8829 floating-point operations, or compiled in such a way as to call such
8830 emulations routines, these routines will issue floating-point
8831 operations.   If you are compiling for an Alpha without floating-point
8832 operations, you must ensure that the library is built so as not to call
8833 them.
8834
8835 Note that Alpha implementations without floating-point operations are
8836 required to have floating-point registers.
8837
8838 @item -mfp-reg
8839 @itemx -mno-fp-regs
8840 @opindex mfp-reg
8841 @opindex mno-fp-regs
8842 Generate code that uses (does not use) the floating-point register set.
8843 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8844 register set is not used, floating point operands are passed in integer
8845 registers as if they were integers and floating-point results are passed
8846 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8847 so any function with a floating-point argument or return value called by code
8848 compiled with @option{-mno-fp-regs} must also be compiled with that
8849 option.
8850
8851 A typical use of this option is building a kernel that does not use,
8852 and hence need not save and restore, any floating-point registers.
8853
8854 @item -mieee
8855 @opindex mieee
8856 The Alpha architecture implements floating-point hardware optimized for
8857 maximum performance.  It is mostly compliant with the IEEE floating
8858 point standard.  However, for full compliance, software assistance is
8859 required.  This option generates code fully IEEE compliant code
8860 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8861 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8862 defined during compilation.  The resulting code is less efficient but is
8863 able to correctly support denormalized numbers and exceptional IEEE
8864 values such as not-a-number and plus/minus infinity.  Other Alpha
8865 compilers call this option @option{-ieee_with_no_inexact}.
8866
8867 @item -mieee-with-inexact
8868 @opindex mieee-with-inexact
8869 This is like @option{-mieee} except the generated code also maintains
8870 the IEEE @var{inexact-flag}.  Turning on this option causes the
8871 generated code to implement fully-compliant IEEE math.  In addition to
8872 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8873 macro.  On some Alpha implementations the resulting code may execute
8874 significantly slower than the code generated by default.  Since there is
8875 very little code that depends on the @var{inexact-flag}, you should
8876 normally not specify this option.  Other Alpha compilers call this
8877 option @option{-ieee_with_inexact}.
8878
8879 @item -mfp-trap-mode=@var{trap-mode}
8880 @opindex mfp-trap-mode
8881 This option controls what floating-point related traps are enabled.
8882 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8883 The trap mode can be set to one of four values:
8884
8885 @table @samp
8886 @item n
8887 This is the default (normal) setting.  The only traps that are enabled
8888 are the ones that cannot be disabled in software (e.g., division by zero
8889 trap).
8890
8891 @item u
8892 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8893 as well.
8894
8895 @item su
8896 Like @samp{su}, but the instructions are marked to be safe for software
8897 completion (see Alpha architecture manual for details).
8898
8899 @item sui
8900 Like @samp{su}, but inexact traps are enabled as well.
8901 @end table
8902
8903 @item -mfp-rounding-mode=@var{rounding-mode}
8904 @opindex mfp-rounding-mode
8905 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8906 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8907 of:
8908
8909 @table @samp
8910 @item n
8911 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8912 the nearest machine number or towards the even machine number in case
8913 of a tie.
8914
8915 @item m
8916 Round towards minus infinity.
8917
8918 @item c
8919 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8920
8921 @item d
8922 Dynamic rounding mode.  A field in the floating point control register
8923 (@var{fpcr}, see Alpha architecture reference manual) controls the
8924 rounding mode in effect.  The C library initializes this register for
8925 rounding towards plus infinity.  Thus, unless your program modifies the
8926 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8927 @end table
8928
8929 @item -mtrap-precision=@var{trap-precision}
8930 @opindex mtrap-precision
8931 In the Alpha architecture, floating point traps are imprecise.  This
8932 means without software assistance it is impossible to recover from a
8933 floating trap and program execution normally needs to be terminated.
8934 GCC can generate code that can assist operating system trap handlers
8935 in determining the exact location that caused a floating point trap.
8936 Depending on the requirements of an application, different levels of
8937 precisions can be selected:
8938
8939 @table @samp
8940 @item p
8941 Program precision.  This option is the default and means a trap handler
8942 can only identify which program caused a floating point exception.
8943
8944 @item f
8945 Function precision.  The trap handler can determine the function that
8946 caused a floating point exception.
8947
8948 @item i
8949 Instruction precision.  The trap handler can determine the exact
8950 instruction that caused a floating point exception.
8951 @end table
8952
8953 Other Alpha compilers provide the equivalent options called
8954 @option{-scope_safe} and @option{-resumption_safe}.
8955
8956 @item -mieee-conformant
8957 @opindex mieee-conformant
8958 This option marks the generated code as IEEE conformant.  You must not
8959 use this option unless you also specify @option{-mtrap-precision=i} and either
8960 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8961 is to emit the line @samp{.eflag 48} in the function prologue of the
8962 generated assembly file.  Under DEC Unix, this has the effect that
8963 IEEE-conformant math library routines will be linked in.
8964
8965 @item -mbuild-constants
8966 @opindex mbuild-constants
8967 Normally GCC examines a 32- or 64-bit integer constant to
8968 see if it can construct it from smaller constants in two or three
8969 instructions.  If it cannot, it will output the constant as a literal and
8970 generate code to load it from the data segment at runtime.
8971
8972 Use this option to require GCC to construct @emph{all} integer constants
8973 using code, even if it takes more instructions (the maximum is six).
8974
8975 You would typically use this option to build a shared library dynamic
8976 loader.  Itself a shared library, it must relocate itself in memory
8977 before it can find the variables and constants in its own data segment.
8978
8979 @item -malpha-as
8980 @itemx -mgas
8981 @opindex malpha-as
8982 @opindex mgas
8983 Select whether to generate code to be assembled by the vendor-supplied
8984 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8985
8986 @item -mbwx
8987 @itemx -mno-bwx
8988 @itemx -mcix
8989 @itemx -mno-cix
8990 @itemx -mfix
8991 @itemx -mno-fix
8992 @itemx -mmax
8993 @itemx -mno-max
8994 @opindex mbwx
8995 @opindex mno-bwx
8996 @opindex mcix
8997 @opindex mno-cix
8998 @opindex mfix
8999 @opindex mno-fix
9000 @opindex mmax
9001 @opindex mno-max
9002 Indicate whether GCC should generate code to use the optional BWX,
9003 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9004 sets supported by the CPU type specified via @option{-mcpu=} option or that
9005 of the CPU on which GCC was built if none was specified.
9006
9007 @item -mfloat-vax
9008 @itemx -mfloat-ieee
9009 @opindex mfloat-vax
9010 @opindex mfloat-ieee
9011 Generate code that uses (does not use) VAX F and G floating point
9012 arithmetic instead of IEEE single and double precision.
9013
9014 @item -mexplicit-relocs
9015 @itemx -mno-explicit-relocs
9016 @opindex mexplicit-relocs
9017 @opindex mno-explicit-relocs
9018 Older Alpha assemblers provided no way to generate symbol relocations
9019 except via assembler macros.  Use of these macros does not allow
9020 optimal instruction scheduling.  GNU binutils as of version 2.12
9021 supports a new syntax that allows the compiler to explicitly mark
9022 which relocations should apply to which instructions.  This option
9023 is mostly useful for debugging, as GCC detects the capabilities of
9024 the assembler when it is built and sets the default accordingly.
9025
9026 @item -msmall-data
9027 @itemx -mlarge-data
9028 @opindex msmall-data
9029 @opindex mlarge-data
9030 When @option{-mexplicit-relocs} is in effect, static data is
9031 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9032 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9033 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9034 16-bit relocations off of the @code{$gp} register.  This limits the
9035 size of the small data area to 64KB, but allows the variables to be
9036 directly accessed via a single instruction.
9037
9038 The default is @option{-mlarge-data}.  With this option the data area
9039 is limited to just below 2GB.  Programs that require more than 2GB of
9040 data must use @code{malloc} or @code{mmap} to allocate the data in the
9041 heap instead of in the program's data segment.
9042
9043 When generating code for shared libraries, @option{-fpic} implies
9044 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9045
9046 @item -msmall-text
9047 @itemx -mlarge-text
9048 @opindex msmall-text
9049 @opindex mlarge-text
9050 When @option{-msmall-text} is used, the compiler assumes that the
9051 code of the entire program (or shared library) fits in 4MB, and is
9052 thus reachable with a branch instruction.  When @option{-msmall-data}
9053 is used, the compiler can assume that all local symbols share the
9054 same @code{$gp} value, and thus reduce the number of instructions
9055 required for a function call from 4 to 1.
9056
9057 The default is @option{-mlarge-text}.
9058
9059 @item -mcpu=@var{cpu_type}
9060 @opindex mcpu
9061 Set the instruction set and instruction scheduling parameters for
9062 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9063 style name or the corresponding chip number.  GCC supports scheduling
9064 parameters for the EV4, EV5 and EV6 family of processors and will
9065 choose the default values for the instruction set from the processor
9066 you specify.  If you do not specify a processor type, GCC will default
9067 to the processor on which the compiler was built.
9068
9069 Supported values for @var{cpu_type} are
9070
9071 @table @samp
9072 @item ev4
9073 @itemx ev45
9074 @itemx 21064
9075 Schedules as an EV4 and has no instruction set extensions.
9076
9077 @item ev5
9078 @itemx 21164
9079 Schedules as an EV5 and has no instruction set extensions.
9080
9081 @item ev56
9082 @itemx 21164a
9083 Schedules as an EV5 and supports the BWX extension.
9084
9085 @item pca56
9086 @itemx 21164pc
9087 @itemx 21164PC
9088 Schedules as an EV5 and supports the BWX and MAX extensions.
9089
9090 @item ev6
9091 @itemx 21264
9092 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9093
9094 @item ev67
9095 @itemx 21264a
9096 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9097 @end table
9098
9099 @item -mtune=@var{cpu_type}
9100 @opindex mtune
9101 Set only the instruction scheduling parameters for machine type
9102 @var{cpu_type}.  The instruction set is not changed.
9103
9104 @item -mmemory-latency=@var{time}
9105 @opindex mmemory-latency
9106 Sets the latency the scheduler should assume for typical memory
9107 references as seen by the application.  This number is highly
9108 dependent on the memory access patterns used by the application
9109 and the size of the external cache on the machine.
9110
9111 Valid options for @var{time} are
9112
9113 @table @samp
9114 @item @var{number}
9115 A decimal number representing clock cycles.
9116
9117 @item L1
9118 @itemx L2
9119 @itemx L3
9120 @itemx main
9121 The compiler contains estimates of the number of clock cycles for
9122 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9123 (also called Dcache, Scache, and Bcache), as well as to main memory.
9124 Note that L3 is only valid for EV5.
9125
9126 @end table
9127 @end table
9128
9129 @node DEC Alpha/VMS Options
9130 @subsection DEC Alpha/VMS Options
9131
9132 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9133
9134 @table @gcctabopt
9135 @item -mvms-return-codes
9136 @opindex mvms-return-codes
9137 Return VMS condition codes from main.  The default is to return POSIX
9138 style condition (e.g.@ error) codes.
9139 @end table
9140
9141 @node H8/300 Options
9142 @subsection H8/300 Options
9143
9144 These @samp{-m} options are defined for the H8/300 implementations:
9145
9146 @table @gcctabopt
9147 @item -mrelax
9148 @opindex mrelax
9149 Shorten some address references at link time, when possible; uses the
9150 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9151 ld, Using ld}, for a fuller description.
9152
9153 @item -mh
9154 @opindex mh
9155 Generate code for the H8/300H@.
9156
9157 @item -ms
9158 @opindex ms
9159 Generate code for the H8S@.
9160
9161 @item -mn
9162 @opindex mn
9163 Generate code for the H8S and H8/300H in the normal mode.  This switch
9164 must be used either with -mh or -ms.
9165
9166 @item -ms2600
9167 @opindex ms2600
9168 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9169
9170 @item -mint32
9171 @opindex mint32
9172 Make @code{int} data 32 bits by default.
9173
9174 @item -malign-300
9175 @opindex malign-300
9176 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9177 The default for the H8/300H and H8S is to align longs and floats on 4
9178 byte boundaries.
9179 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9180 This option has no effect on the H8/300.
9181 @end table
9182
9183 @node SH Options
9184 @subsection SH Options
9185
9186 These @samp{-m} options are defined for the SH implementations:
9187
9188 @table @gcctabopt
9189 @item -m1
9190 @opindex m1
9191 Generate code for the SH1.
9192
9193 @item -m2
9194 @opindex m2
9195 Generate code for the SH2.
9196
9197 @item -m2e
9198 Generate code for the SH2e.
9199
9200 @item -m3
9201 @opindex m3
9202 Generate code for the SH3.
9203
9204 @item -m3e
9205 @opindex m3e
9206 Generate code for the SH3e.
9207
9208 @item -m4-nofpu
9209 @opindex m4-nofpu
9210 Generate code for the SH4 without a floating-point unit.
9211
9212 @item -m4-single-only
9213 @opindex m4-single-only
9214 Generate code for the SH4 with a floating-point unit that only
9215 supports single-precision arithmetic.
9216
9217 @item -m4-single
9218 @opindex m4-single
9219 Generate code for the SH4 assuming the floating-point unit is in
9220 single-precision mode by default.
9221
9222 @item -m4
9223 @opindex m4
9224 Generate code for the SH4.
9225
9226 @item -mb
9227 @opindex mb
9228 Compile code for the processor in big endian mode.
9229
9230 @item -ml
9231 @opindex ml
9232 Compile code for the processor in little endian mode.
9233
9234 @item -mdalign
9235 @opindex mdalign
9236 Align doubles at 64-bit boundaries.  Note that this changes the calling
9237 conventions, and thus some functions from the standard C library will
9238 not work unless you recompile it first with @option{-mdalign}.
9239
9240 @item -mrelax
9241 @opindex mrelax
9242 Shorten some address references at link time, when possible; uses the
9243 linker option @option{-relax}.
9244
9245 @item -mbigtable
9246 @opindex mbigtable
9247 Use 32-bit offsets in @code{switch} tables.  The default is to use
9248 16-bit offsets.
9249
9250 @item -mfmovd
9251 @opindex mfmovd
9252 Enable the use of the instruction @code{fmovd}.
9253
9254 @item -mhitachi
9255 @opindex mhitachi
9256 Comply with the calling conventions defined by Renesas.
9257
9258 @item -mnomacsave
9259 @opindex mnomacsave
9260 Mark the @code{MAC} register as call-clobbered, even if
9261 @option{-mhitachi} is given.
9262
9263 @item -mieee
9264 @opindex mieee
9265 Increase IEEE-compliance of floating-point code.
9266
9267 @item -misize
9268 @opindex misize
9269 Dump instruction size and location in the assembly code.
9270
9271 @item -mpadstruct
9272 @opindex mpadstruct
9273 This option is deprecated.  It pads structures to multiple of 4 bytes,
9274 which is incompatible with the SH ABI@.
9275
9276 @item -mspace
9277 @opindex mspace
9278 Optimize for space instead of speed.  Implied by @option{-Os}.
9279
9280 @item -mprefergot
9281 @opindex mprefergot
9282 When generating position-independent code, emit function calls using
9283 the Global Offset Table instead of the Procedure Linkage Table.
9284
9285 @item -musermode
9286 @opindex musermode
9287 Generate a library function call to invalidate instruction cache
9288 entries, after fixing up a trampoline.  This library function call
9289 doesn't assume it can write to the whole memory address space.  This
9290 is the default when the target is @code{sh-*-linux*}.
9291 @end table
9292
9293 @node System V Options
9294 @subsection Options for System V
9295
9296 These additional options are available on System V Release 4 for
9297 compatibility with other compilers on those systems:
9298
9299 @table @gcctabopt
9300 @item -G
9301 @opindex G
9302 Create a shared object.
9303 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9304
9305 @item -Qy
9306 @opindex Qy
9307 Identify the versions of each tool used by the compiler, in a
9308 @code{.ident} assembler directive in the output.
9309
9310 @item -Qn
9311 @opindex Qn
9312 Refrain from adding @code{.ident} directives to the output file (this is
9313 the default).
9314
9315 @item -YP,@var{dirs}
9316 @opindex YP
9317 Search the directories @var{dirs}, and no others, for libraries
9318 specified with @option{-l}.
9319
9320 @item -Ym,@var{dir}
9321 @opindex Ym
9322 Look in the directory @var{dir} to find the M4 preprocessor.
9323 The assembler uses this option.
9324 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9325 @c the generic assembler that comes with Solaris takes just -Ym.
9326 @end table
9327
9328 @node TMS320C3x/C4x Options
9329 @subsection TMS320C3x/C4x Options
9330 @cindex TMS320C3x/C4x Options
9331
9332 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9333
9334 @table @gcctabopt
9335
9336 @item -mcpu=@var{cpu_type}
9337 @opindex mcpu
9338 Set the instruction set, register set, and instruction scheduling
9339 parameters for machine type @var{cpu_type}.  Supported values for
9340 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9341 @samp{c44}.  The default is @samp{c40} to generate code for the
9342 TMS320C40.
9343
9344 @item -mbig-memory
9345 @itemx -mbig
9346 @itemx -msmall-memory
9347 @itemx -msmall
9348 @opindex mbig-memory
9349 @opindex mbig
9350 @opindex msmall-memory
9351 @opindex msmall
9352 Generates code for the big or small memory model.  The small memory
9353 model assumed that all data fits into one 64K word page.  At run-time
9354 the data page (DP) register must be set to point to the 64K page
9355 containing the .bss and .data program sections.  The big memory model is
9356 the default and requires reloading of the DP register for every direct
9357 memory access.
9358
9359 @item -mbk
9360 @itemx -mno-bk
9361 @opindex mbk
9362 @opindex mno-bk
9363 Allow (disallow) allocation of general integer operands into the block
9364 count register BK@.
9365
9366 @item -mdb
9367 @itemx -mno-db
9368 @opindex mdb
9369 @opindex mno-db
9370 Enable (disable) generation of code using decrement and branch,
9371 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9372 on the safe side, this is disabled for the C3x, since the maximum
9373 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9374 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9375 that it can utilize the decrement and branch instruction, but will give
9376 up if there is more than one memory reference in the loop.  Thus a loop
9377 where the loop counter is decremented can generate slightly more
9378 efficient code, in cases where the RPTB instruction cannot be utilized.
9379
9380 @item -mdp-isr-reload
9381 @itemx -mparanoid
9382 @opindex mdp-isr-reload
9383 @opindex mparanoid
9384 Force the DP register to be saved on entry to an interrupt service
9385 routine (ISR), reloaded to point to the data section, and restored on
9386 exit from the ISR@.  This should not be required unless someone has
9387 violated the small memory model by modifying the DP register, say within
9388 an object library.
9389
9390 @item -mmpyi
9391 @itemx -mno-mpyi
9392 @opindex mmpyi
9393 @opindex mno-mpyi
9394 For the C3x use the 24-bit MPYI instruction for integer multiplies
9395 instead of a library call to guarantee 32-bit results.  Note that if one
9396 of the operands is a constant, then the multiplication will be performed
9397 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9398 then squaring operations are performed inline instead of a library call.
9399
9400 @item -mfast-fix
9401 @itemx -mno-fast-fix
9402 @opindex mfast-fix
9403 @opindex mno-fast-fix
9404 The C3x/C4x FIX instruction to convert a floating point value to an
9405 integer value chooses the nearest integer less than or equal to the
9406 floating point value rather than to the nearest integer.  Thus if the
9407 floating point number is negative, the result will be incorrectly
9408 truncated an additional code is necessary to detect and correct this
9409 case.  This option can be used to disable generation of the additional
9410 code required to correct the result.
9411
9412 @item -mrptb
9413 @itemx -mno-rptb
9414 @opindex mrptb
9415 @opindex mno-rptb
9416 Enable (disable) generation of repeat block sequences using the RPTB
9417 instruction for zero overhead looping.  The RPTB construct is only used
9418 for innermost loops that do not call functions or jump across the loop
9419 boundaries.  There is no advantage having nested RPTB loops due to the
9420 overhead required to save and restore the RC, RS, and RE registers.
9421 This is enabled by default with @option{-O2}.
9422
9423 @item -mrpts=@var{count}
9424 @itemx -mno-rpts
9425 @opindex mrpts
9426 @opindex mno-rpts
9427 Enable (disable) the use of the single instruction repeat instruction
9428 RPTS@.  If a repeat block contains a single instruction, and the loop
9429 count can be guaranteed to be less than the value @var{count}, GCC will
9430 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9431 then a RPTS will be emitted even if the loop count cannot be determined
9432 at compile time.  Note that the repeated instruction following RPTS does
9433 not have to be reloaded from memory each iteration, thus freeing up the
9434 CPU buses for operands.  However, since interrupts are blocked by this
9435 instruction, it is disabled by default.
9436
9437 @item -mloop-unsigned
9438 @itemx -mno-loop-unsigned
9439 @opindex mloop-unsigned
9440 @opindex mno-loop-unsigned
9441 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9442 is @math{2^{31} + 1} since these instructions test if the iteration count is
9443 negative to terminate the loop.  If the iteration count is unsigned
9444 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9445 exceeded.  This switch allows an unsigned iteration count.
9446
9447 @item -mti
9448 @opindex mti
9449 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9450 with.  This also enforces compatibility with the API employed by the TI
9451 C3x C compiler.  For example, long doubles are passed as structures
9452 rather than in floating point registers.
9453
9454 @item -mregparm
9455 @itemx -mmemparm
9456 @opindex mregparm
9457 @opindex mmemparm
9458 Generate code that uses registers (stack) for passing arguments to functions.
9459 By default, arguments are passed in registers where possible rather
9460 than by pushing arguments on to the stack.
9461
9462 @item -mparallel-insns
9463 @itemx -mno-parallel-insns
9464 @opindex mparallel-insns
9465 @opindex mno-parallel-insns
9466 Allow the generation of parallel instructions.  This is enabled by
9467 default with @option{-O2}.
9468
9469 @item -mparallel-mpy
9470 @itemx -mno-parallel-mpy
9471 @opindex mparallel-mpy
9472 @opindex mno-parallel-mpy
9473 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9474 provided @option{-mparallel-insns} is also specified.  These instructions have
9475 tight register constraints which can pessimize the code generation
9476 of large functions.
9477
9478 @end table
9479
9480 @node V850 Options
9481 @subsection V850 Options
9482 @cindex V850 Options
9483
9484 These @samp{-m} options are defined for V850 implementations:
9485
9486 @table @gcctabopt
9487 @item -mlong-calls
9488 @itemx -mno-long-calls
9489 @opindex mlong-calls
9490 @opindex mno-long-calls
9491 Treat all calls as being far away (near).  If calls are assumed to be
9492 far away, the compiler will always load the functions address up into a
9493 register, and call indirect through the pointer.
9494
9495 @item -mno-ep
9496 @itemx -mep
9497 @opindex mno-ep
9498 @opindex mep
9499 Do not optimize (do optimize) basic blocks that use the same index
9500 pointer 4 or more times to copy pointer into the @code{ep} register, and
9501 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9502 option is on by default if you optimize.
9503
9504 @item -mno-prolog-function
9505 @itemx -mprolog-function
9506 @opindex mno-prolog-function
9507 @opindex mprolog-function
9508 Do not use (do use) external functions to save and restore registers
9509 at the prologue and epilogue of a function.  The external functions
9510 are slower, but use less code space if more than one function saves
9511 the same number of registers.  The @option{-mprolog-function} option
9512 is on by default if you optimize.
9513
9514 @item -mspace
9515 @opindex mspace
9516 Try to make the code as small as possible.  At present, this just turns
9517 on the @option{-mep} and @option{-mprolog-function} options.
9518
9519 @item -mtda=@var{n}
9520 @opindex mtda
9521 Put static or global variables whose size is @var{n} bytes or less into
9522 the tiny data area that register @code{ep} points to.  The tiny data
9523 area can hold up to 256 bytes in total (128 bytes for byte references).
9524
9525 @item -msda=@var{n}
9526 @opindex msda
9527 Put static or global variables whose size is @var{n} bytes or less into
9528 the small data area that register @code{gp} points to.  The small data
9529 area can hold up to 64 kilobytes.
9530
9531 @item -mzda=@var{n}
9532 @opindex mzda
9533 Put static or global variables whose size is @var{n} bytes or less into
9534 the first 32 kilobytes of memory.
9535
9536 @item -mv850
9537 @opindex mv850
9538 Specify that the target processor is the V850.
9539
9540 @item -mbig-switch
9541 @opindex mbig-switch
9542 Generate code suitable for big switch tables.  Use this option only if
9543 the assembler/linker complain about out of range branches within a switch
9544 table.
9545
9546 @item -mapp-regs
9547 @opindex mapp-regs
9548 This option will cause r2 and r5 to be used in the code generated by
9549 the compiler.  This setting is the default.
9550
9551 @item -mno-app-regs
9552 @opindex mno-app-regs
9553 This option will cause r2 and r5 to be treated as fixed registers.
9554
9555 @item -mv850e1
9556 @opindex mv850e1
9557 Specify that the target processor is the V850E1.  The preprocessor
9558 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9559 this option is used.
9560
9561 @item -mv850e
9562 @opindex mv850e
9563 Specify that the target processor is the V850E.  The preprocessor
9564 constant @samp{__v850e__} will be defined if this option is used.
9565
9566 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9567 are defined then a default target processor will be chosen and the
9568 relevant @samp{__v850*__} preprocessor constant will be defined.
9569
9570 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9571 defined, regardless of which processor variant is the target.
9572
9573 @item -mdisable-callt
9574 @opindex mdisable-callt
9575 This option will suppress generation of the CALLT instruction for the
9576 v850e and v850e1 flavors of the v850 architecture.  The default is
9577 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9578
9579 @end table
9580
9581 @node ARC Options
9582 @subsection ARC Options
9583 @cindex ARC Options
9584
9585 These options are defined for ARC implementations:
9586
9587 @table @gcctabopt
9588 @item -EL
9589 @opindex EL
9590 Compile code for little endian mode.  This is the default.
9591
9592 @item -EB
9593 @opindex EB
9594 Compile code for big endian mode.
9595
9596 @item -mmangle-cpu
9597 @opindex mmangle-cpu
9598 Prepend the name of the cpu to all public symbol names.
9599 In multiple-processor systems, there are many ARC variants with different
9600 instruction and register set characteristics.  This flag prevents code
9601 compiled for one cpu to be linked with code compiled for another.
9602 No facility exists for handling variants that are ``almost identical''.
9603 This is an all or nothing option.
9604
9605 @item -mcpu=@var{cpu}
9606 @opindex mcpu
9607 Compile code for ARC variant @var{cpu}.
9608 Which variants are supported depend on the configuration.
9609 All variants support @option{-mcpu=base}, this is the default.
9610
9611 @item -mtext=@var{text-section}
9612 @itemx -mdata=@var{data-section}
9613 @itemx -mrodata=@var{readonly-data-section}
9614 @opindex mtext
9615 @opindex mdata
9616 @opindex mrodata
9617 Put functions, data, and readonly data in @var{text-section},
9618 @var{data-section}, and @var{readonly-data-section} respectively
9619 by default.  This can be overridden with the @code{section} attribute.
9620 @xref{Variable Attributes}.
9621
9622 @end table
9623
9624 @node NS32K Options
9625 @subsection NS32K Options
9626 @cindex NS32K options
9627
9628 These are the @samp{-m} options defined for the 32000 series.  The default
9629 values for these options depends on which style of 32000 was selected when
9630 the compiler was configured; the defaults for the most common choices are
9631 given below.
9632
9633 @table @gcctabopt
9634 @item -m32032
9635 @itemx -m32032
9636 @opindex m32032
9637 @opindex m32032
9638 Generate output for a 32032.  This is the default
9639 when the compiler is configured for 32032 and 32016 based systems.
9640
9641 @item -m32332
9642 @itemx -m32332
9643 @opindex m32332
9644 @opindex m32332
9645 Generate output for a 32332.  This is the default
9646 when the compiler is configured for 32332-based systems.
9647
9648 @item -m32532
9649 @itemx -m32532
9650 @opindex m32532
9651 @opindex m32532
9652 Generate output for a 32532.  This is the default
9653 when the compiler is configured for 32532-based systems.
9654
9655 @item -m32081
9656 @opindex m32081
9657 Generate output containing 32081 instructions for floating point.
9658 This is the default for all systems.
9659
9660 @item -m32381
9661 @opindex m32381
9662 Generate output containing 32381 instructions for floating point.  This
9663 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9664 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9665
9666 @item -mmulti-add
9667 @opindex mmulti-add
9668 Try and generate multiply-add floating point instructions @code{polyF}
9669 and @code{dotF}.  This option is only available if the @option{-m32381}
9670 option is in effect.  Using these instructions requires changes to
9671 register allocation which generally has a negative impact on
9672 performance.  This option should only be enabled when compiling code
9673 particularly likely to make heavy use of multiply-add instructions.
9674
9675 @item -mnomulti-add
9676 @opindex mnomulti-add
9677 Do not try and generate multiply-add floating point instructions
9678 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9679
9680 @item -msoft-float
9681 @opindex msoft-float
9682 Generate output containing library calls for floating point.
9683 @strong{Warning:} the requisite libraries may not be available.
9684
9685 @item -mieee-compare
9686 @itemx -mno-ieee-compare
9687 @opindex mieee-compare
9688 @opindex mno-ieee-compare
9689 Control whether or not the compiler uses IEEE floating point
9690 comparisons.  These handle correctly the case where the result of a
9691 comparison is unordered.
9692 @strong{Warning:} the requisite kernel support may not be available.
9693
9694 @item -mnobitfield
9695 @opindex mnobitfield
9696 Do not use the bit-field instructions.  On some machines it is faster to
9697 use shifting and masking operations.  This is the default for the pc532.
9698
9699 @item -mbitfield
9700 @opindex mbitfield
9701 Do use the bit-field instructions.  This is the default for all platforms
9702 except the pc532.
9703
9704 @item -mrtd
9705 @opindex mrtd
9706 Use a different function-calling convention, in which functions
9707 that take a fixed number of arguments return pop their
9708 arguments on return with the @code{ret} instruction.
9709
9710 This calling convention is incompatible with the one normally
9711 used on Unix, so you cannot use it if you need to call libraries
9712 compiled with the Unix compiler.
9713
9714 Also, you must provide function prototypes for all functions that
9715 take variable numbers of arguments (including @code{printf});
9716 otherwise incorrect code will be generated for calls to those
9717 functions.
9718
9719 In addition, seriously incorrect code will result if you call a
9720 function with too many arguments.  (Normally, extra arguments are
9721 harmlessly ignored.)
9722
9723 This option takes its name from the 680x0 @code{rtd} instruction.
9724
9725
9726 @item -mregparam
9727 @opindex mregparam
9728 Use a different function-calling convention where the first two arguments
9729 are passed in registers.
9730
9731 This calling convention is incompatible with the one normally
9732 used on Unix, so you cannot use it if you need to call libraries
9733 compiled with the Unix compiler.
9734
9735 @item -mnoregparam
9736 @opindex mnoregparam
9737 Do not pass any arguments in registers.  This is the default for all
9738 targets.
9739
9740 @item -msb
9741 @opindex msb
9742 It is OK to use the sb as an index register which is always loaded with
9743 zero.  This is the default for the pc532-netbsd target.
9744
9745 @item -mnosb
9746 @opindex mnosb
9747 The sb register is not available for use or has not been initialized to
9748 zero by the run time system.  This is the default for all targets except
9749 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9750 @option{-fpic} is set.
9751
9752 @item -mhimem
9753 @opindex mhimem
9754 Many ns32000 series addressing modes use displacements of up to 512MB@.
9755 If an address is above 512MB then displacements from zero can not be used.
9756 This option causes code to be generated which can be loaded above 512MB@.
9757 This may be useful for operating systems or ROM code.
9758
9759 @item -mnohimem
9760 @opindex mnohimem
9761 Assume code will be loaded in the first 512MB of virtual address space.
9762 This is the default for all platforms.
9763
9764
9765 @end table
9766
9767 @node AVR Options
9768 @subsection AVR Options
9769 @cindex AVR Options
9770
9771 These options are defined for AVR implementations:
9772
9773 @table @gcctabopt
9774 @item -mmcu=@var{mcu}
9775 @opindex mmcu
9776 Specify ATMEL AVR instruction set or MCU type.
9777
9778 Instruction set avr1 is for the minimal AVR core, not supported by the C
9779 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9780 attiny11, attiny12, attiny15, attiny28).
9781
9782 Instruction set avr2 (default) is for the classic AVR core with up to
9783 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9784 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9785 at90c8534, at90s8535).
9786
9787 Instruction set avr3 is for the classic AVR core with up to 128K program
9788 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9789
9790 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9791 memory space (MCU types: atmega8, atmega83, atmega85).
9792
9793 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9794 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9795 atmega64, atmega128, at43usb355, at94k).
9796
9797 @item -msize
9798 @opindex msize
9799 Output instruction sizes to the asm file.
9800
9801 @item -minit-stack=@var{N}
9802 @opindex minit-stack
9803 Specify the initial stack address, which may be a symbol or numeric value,
9804 @samp{__stack} is the default.
9805
9806 @item -mno-interrupts
9807 @opindex mno-interrupts
9808 Generated code is not compatible with hardware interrupts.
9809 Code size will be smaller.
9810
9811 @item -mcall-prologues
9812 @opindex mcall-prologues
9813 Functions prologues/epilogues expanded as call to appropriate
9814 subroutines.  Code size will be smaller.
9815
9816 @item -mno-tablejump
9817 @opindex mno-tablejump
9818 Do not generate tablejump insns which sometimes increase code size.
9819
9820 @item -mtiny-stack
9821 @opindex mtiny-stack
9822 Change only the low 8 bits of the stack pointer.
9823 @end table
9824
9825 @node MCore Options
9826 @subsection MCore Options
9827 @cindex MCore options
9828
9829 These are the @samp{-m} options defined for the Motorola M*Core
9830 processors.
9831
9832 @table @gcctabopt
9833
9834 @item -mhardlit
9835 @itemx -mno-hardlit
9836 @opindex mhardlit
9837 @opindex mno-hardlit
9838 Inline constants into the code stream if it can be done in two
9839 instructions or less.
9840
9841 @item -mdiv
9842 @itemx -mno-div
9843 @opindex mdiv
9844 @opindex mno-div
9845 Use the divide instruction.  (Enabled by default).
9846
9847 @item -mrelax-immediate
9848 @itemx -mno-relax-immediate
9849 @opindex mrelax-immediate
9850 @opindex mno-relax-immediate
9851 Allow arbitrary sized immediates in bit operations.
9852
9853 @item -mwide-bitfields
9854 @itemx -mno-wide-bitfields
9855 @opindex mwide-bitfields
9856 @opindex mno-wide-bitfields
9857 Always treat bit-fields as int-sized.
9858
9859 @item -m4byte-functions
9860 @itemx -mno-4byte-functions
9861 @opindex m4byte-functions
9862 @opindex mno-4byte-functions
9863 Force all functions to be aligned to a four byte boundary.
9864
9865 @item -mcallgraph-data
9866 @itemx -mno-callgraph-data
9867 @opindex mcallgraph-data
9868 @opindex mno-callgraph-data
9869 Emit callgraph information.
9870
9871 @item -mslow-bytes
9872 @itemx -mno-slow-bytes
9873 @opindex mslow-bytes
9874 @opindex mno-slow-bytes
9875 Prefer word access when reading byte quantities.
9876
9877 @item -mlittle-endian
9878 @itemx -mbig-endian
9879 @opindex mlittle-endian
9880 @opindex mbig-endian
9881 Generate code for a little endian target.
9882
9883 @item -m210
9884 @itemx -m340
9885 @opindex m210
9886 @opindex m340
9887 Generate code for the 210 processor.
9888 @end table
9889
9890 @node IA-64 Options
9891 @subsection IA-64 Options
9892 @cindex IA-64 Options
9893
9894 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9895
9896 @table @gcctabopt
9897 @item -mbig-endian
9898 @opindex mbig-endian
9899 Generate code for a big endian target.  This is the default for HP-UX@.
9900
9901 @item -mlittle-endian
9902 @opindex mlittle-endian
9903 Generate code for a little endian target.  This is the default for AIX5
9904 and GNU/Linux.
9905
9906 @item -mgnu-as
9907 @itemx -mno-gnu-as
9908 @opindex mgnu-as
9909 @opindex mno-gnu-as
9910 Generate (or don't) code for the GNU assembler.  This is the default.
9911 @c Also, this is the default if the configure option @option{--with-gnu-as}
9912 @c is used.
9913
9914 @item -mgnu-ld
9915 @itemx -mno-gnu-ld
9916 @opindex mgnu-ld
9917 @opindex mno-gnu-ld
9918 Generate (or don't) code for the GNU linker.  This is the default.
9919 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9920 @c is used.
9921
9922 @item -mno-pic
9923 @opindex mno-pic
9924 Generate code that does not use a global pointer register.  The result
9925 is not position independent code, and violates the IA-64 ABI@.
9926
9927 @item -mvolatile-asm-stop
9928 @itemx -mno-volatile-asm-stop
9929 @opindex mvolatile-asm-stop
9930 @opindex mno-volatile-asm-stop
9931 Generate (or don't) a stop bit immediately before and after volatile asm
9932 statements.
9933
9934 @item -mb-step
9935 @opindex mb-step
9936 Generate code that works around Itanium B step errata.
9937
9938 @item -mregister-names
9939 @itemx -mno-register-names
9940 @opindex mregister-names
9941 @opindex mno-register-names
9942 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9943 the stacked registers.  This may make assembler output more readable.
9944
9945 @item -mno-sdata
9946 @itemx -msdata
9947 @opindex mno-sdata
9948 @opindex msdata
9949 Disable (or enable) optimizations that use the small data section.  This may
9950 be useful for working around optimizer bugs.
9951
9952 @item -mconstant-gp
9953 @opindex mconstant-gp
9954 Generate code that uses a single constant global pointer value.  This is
9955 useful when compiling kernel code.
9956
9957 @item -mauto-pic
9958 @opindex mauto-pic
9959 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9960 This is useful when compiling firmware code.
9961
9962 @item -minline-float-divide-min-latency
9963 @opindex minline-float-divide-min-latency
9964 Generate code for inline divides of floating point values
9965 using the minimum latency algorithm.
9966
9967 @item -minline-float-divide-max-throughput
9968 @opindex minline-float-divide-max-throughput
9969 Generate code for inline divides of floating point values
9970 using the maximum throughput algorithm.
9971
9972 @item -minline-int-divide-min-latency
9973 @opindex minline-int-divide-min-latency
9974 Generate code for inline divides of integer values
9975 using the minimum latency algorithm.
9976
9977 @item -minline-int-divide-max-throughput
9978 @opindex minline-int-divide-max-throughput
9979 Generate code for inline divides of integer values
9980 using the maximum throughput algorithm.
9981
9982 @item -mno-dwarf2-asm
9983 @itemx -mdwarf2-asm
9984 @opindex mno-dwarf2-asm
9985 @opindex mdwarf2-asm
9986 Don't (or do) generate assembler code for the DWARF2 line number debugging
9987 info.  This may be useful when not using the GNU assembler.
9988
9989 @item -mfixed-range=@var{register-range}
9990 @opindex mfixed-range
9991 Generate code treating the given register range as fixed registers.
9992 A fixed register is one that the register allocator can not use.  This is
9993 useful when compiling kernel code.  A register range is specified as
9994 two registers separated by a dash.  Multiple register ranges can be
9995 specified separated by a comma.
9996
9997 @item -mearly-stop-bits
9998 @itemx -mno-early-stop-bits
9999 @opindex mearly-stop-bits
10000 @opindex mno-early-stop-bits
10001 Allow stop bits to be placed earlier than immediately preceding the
10002 instruction that triggered the stop bit.  This can improve instruction
10003 scheduling, but does not always do so.
10004 @end table
10005
10006 @node D30V Options
10007 @subsection D30V Options
10008 @cindex D30V Options
10009
10010 These @samp{-m} options are defined for D30V implementations:
10011
10012 @table @gcctabopt
10013 @item -mextmem
10014 @opindex mextmem
10015 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10016 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10017 memory, which starts at location @code{0x80000000}.
10018
10019 @item -mextmemory
10020 @opindex mextmemory
10021 Same as the @option{-mextmem} switch.
10022
10023 @item -monchip
10024 @opindex monchip
10025 Link the @samp{.text} section into onchip text memory, which starts at
10026 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10027 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10028 into onchip data memory, which starts at location @code{0x20000000}.
10029
10030 @item -mno-asm-optimize
10031 @itemx -masm-optimize
10032 @opindex mno-asm-optimize
10033 @opindex masm-optimize
10034 Disable (enable) passing @option{-O} to the assembler when optimizing.
10035 The assembler uses the @option{-O} option to automatically parallelize
10036 adjacent short instructions where possible.
10037
10038 @item -mbranch-cost=@var{n}
10039 @opindex mbranch-cost
10040 Increase the internal costs of branches to @var{n}.  Higher costs means
10041 that the compiler will issue more instructions to avoid doing a branch.
10042 The default is 2.
10043
10044 @item -mcond-exec=@var{n}
10045 @opindex mcond-exec
10046 Specify the maximum number of conditionally executed instructions that
10047 replace a branch.  The default is 4.
10048 @end table
10049
10050 @node S/390 and zSeries Options
10051 @subsection S/390 and zSeries Options
10052 @cindex S/390 and zSeries Options
10053
10054 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10055
10056 @table @gcctabopt
10057 @item -mhard-float
10058 @itemx -msoft-float
10059 @opindex mhard-float
10060 @opindex msoft-float
10061 Use (do not use) the hardware floating-point instructions and registers
10062 for floating-point operations.  When @option{-msoft-float} is specified,
10063 functions in @file{libgcc.a} will be used to perform floating-point
10064 operations.  When @option{-mhard-float} is specified, the compiler
10065 generates IEEE floating-point instructions.  This is the default.
10066
10067 @item -mbackchain
10068 @itemx -mno-backchain
10069 @opindex mbackchain
10070 @opindex mno-backchain
10071 Generate (or do not generate) code which maintains an explicit
10072 backchain within the stack frame that points to the caller's frame.
10073 This may be needed to allow debugging using tools that do not understand
10074 DWARF-2 call frame information.  The default is not to generate the
10075 backchain.
10076
10077 @item -msmall-exec
10078 @itemx -mno-small-exec
10079 @opindex msmall-exec
10080 @opindex mno-small-exec
10081 Generate (or do not generate) code using the @code{bras} instruction
10082 to do subroutine calls.
10083 This only works reliably if the total executable size does not
10084 exceed 64k.  The default is to use the @code{basr} instruction instead,
10085 which does not have this limitation.
10086
10087 @item -m64
10088 @itemx -m31
10089 @opindex m64
10090 @opindex m31
10091 When @option{-m31} is specified, generate code compliant to the
10092 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10093 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10094 particular to generate 64-bit instructions.  For the @samp{s390}
10095 targets, the default is @option{-m31}, while the @samp{s390x}
10096 targets default to @option{-m64}.
10097
10098 @item -mzarch
10099 @itemx -mesa
10100 @opindex mzarch
10101 @opindex mesa
10102 When @option{-mzarch} is specified, generate code using the
10103 instructions available on z/Architecture.
10104 When @option{-mesa} is specified, generate code using the
10105 instructions available on ESA/390. Note that @option{-mesa} is
10106 not possible with @option{-m64}.
10107 When generating code compliant to the GNU/Linux for S/390 ABI,
10108 the default is @option{-mesa}.  When generating code compliant
10109 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10110
10111 @item -mmvcle
10112 @itemx -mno-mvcle
10113 @opindex mmvcle
10114 @opindex mno-mvcle
10115 Generate (or do not generate) code using the @code{mvcle} instruction
10116 to perform block moves.  When @option{-mno-mvcle} is specified,
10117 use a @code{mvc} loop instead.  This is the default.
10118
10119 @item -mdebug
10120 @itemx -mno-debug
10121 @opindex mdebug
10122 @opindex mno-debug
10123 Print (or do not print) additional debug information when compiling.
10124 The default is to not print debug information.
10125
10126 @item -march=@var{cpu-type}
10127 @opindex march
10128 Generate code that will run on @var{cpu-type}, which is the name of a system
10129 representing a certain processor type. Possible values for
10130 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10131 When generating code using the instructions available on z/Architecture,
10132 the default is @option{-march=z900}.  Otherwise, the default is
10133 @option{-march=g5}.
10134
10135 @item -mtune=@var{cpu-type}
10136 @opindex mtune
10137 Tune to @var{cpu-type} everything applicable about the generated code,
10138 except for the ABI and the set of available instructions.
10139 The list of @var{cpu-type} values is the same as for @option{-march}.
10140 The default is the value used for @option{-march}.
10141
10142 @item -mfused-madd
10143 @itemx -mno-fused-madd
10144 @opindex mfused-madd
10145 @opindex mno-fused-madd
10146 Generate code that uses (does not use) the floating point multiply and
10147 accumulate instructions.  These instructions are generated by default if
10148 hardware floating point is used.
10149 @end table
10150
10151 @node CRIS Options
10152 @subsection CRIS Options
10153 @cindex CRIS Options
10154
10155 These options are defined specifically for the CRIS ports.
10156
10157 @table @gcctabopt
10158 @item -march=@var{architecture-type}
10159 @itemx -mcpu=@var{architecture-type}
10160 @opindex march
10161 @opindex mcpu
10162 Generate code for the specified architecture.  The choices for
10163 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10164 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10165 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10166 @samp{v10}.
10167
10168 @item -mtune=@var{architecture-type}
10169 @opindex mtune
10170 Tune to @var{architecture-type} everything applicable about the generated
10171 code, except for the ABI and the set of available instructions.  The
10172 choices for @var{architecture-type} are the same as for
10173 @option{-march=@var{architecture-type}}.
10174
10175 @item -mmax-stack-frame=@var{n}
10176 @opindex mmax-stack-frame
10177 Warn when the stack frame of a function exceeds @var{n} bytes.
10178
10179 @item -melinux-stacksize=@var{n}
10180 @opindex melinux-stacksize
10181 Only available with the @samp{cris-axis-aout} target.  Arranges for
10182 indications in the program to the kernel loader that the stack of the
10183 program should be set to @var{n} bytes.
10184
10185 @item -metrax4
10186 @itemx -metrax100
10187 @opindex metrax4
10188 @opindex metrax100
10189 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10190 @option{-march=v3} and @option{-march=v8} respectively.
10191
10192 @item -mpdebug
10193 @opindex mpdebug
10194 Enable CRIS-specific verbose debug-related information in the assembly
10195 code.  This option also has the effect to turn off the @samp{#NO_APP}
10196 formatted-code indicator to the assembler at the beginning of the
10197 assembly file.
10198
10199 @item -mcc-init
10200 @opindex mcc-init
10201 Do not use condition-code results from previous instruction; always emit
10202 compare and test instructions before use of condition codes.
10203
10204 @item -mno-side-effects
10205 @opindex mno-side-effects
10206 Do not emit instructions with side-effects in addressing modes other than
10207 post-increment.
10208
10209 @item -mstack-align
10210 @itemx -mno-stack-align
10211 @itemx -mdata-align
10212 @itemx -mno-data-align
10213 @itemx -mconst-align
10214 @itemx -mno-const-align
10215 @opindex mstack-align
10216 @opindex mno-stack-align
10217 @opindex mdata-align
10218 @opindex mno-data-align
10219 @opindex mconst-align
10220 @opindex mno-const-align
10221 These options (no-options) arranges (eliminate arrangements) for the
10222 stack-frame, individual data and constants to be aligned for the maximum
10223 single data access size for the chosen CPU model.  The default is to
10224 arrange for 32-bit alignment.  ABI details such as structure layout are
10225 not affected by these options.
10226
10227 @item -m32-bit
10228 @itemx -m16-bit
10229 @itemx -m8-bit
10230 @opindex m32-bit
10231 @opindex m16-bit
10232 @opindex m8-bit
10233 Similar to the stack- data- and const-align options above, these options
10234 arrange for stack-frame, writable data and constants to all be 32-bit,
10235 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10236
10237 @item -mno-prologue-epilogue
10238 @itemx -mprologue-epilogue
10239 @opindex mno-prologue-epilogue
10240 @opindex mprologue-epilogue
10241 With @option{-mno-prologue-epilogue}, the normal function prologue and
10242 epilogue that sets up the stack-frame are omitted and no return
10243 instructions or return sequences are generated in the code.  Use this
10244 option only together with visual inspection of the compiled code: no
10245 warnings or errors are generated when call-saved registers must be saved,
10246 or storage for local variable needs to be allocated.
10247
10248 @item -mno-gotplt
10249 @itemx -mgotplt
10250 @opindex mno-gotplt
10251 @opindex mgotplt
10252 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10253 instruction sequences that load addresses for functions from the PLT part
10254 of the GOT rather than (traditional on other architectures) calls to the
10255 PLT.  The default is @option{-mgotplt}.
10256
10257 @item -maout
10258 @opindex maout
10259 Legacy no-op option only recognized with the cris-axis-aout target.
10260
10261 @item -melf
10262 @opindex melf
10263 Legacy no-op option only recognized with the cris-axis-elf and
10264 cris-axis-linux-gnu targets.
10265
10266 @item -melinux
10267 @opindex melinux
10268 Only recognized with the cris-axis-aout target, where it selects a
10269 GNU/linux-like multilib, include files and instruction set for
10270 @option{-march=v8}.
10271
10272 @item -mlinux
10273 @opindex mlinux
10274 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10275
10276 @item -sim
10277 @opindex sim
10278 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10279 to link with input-output functions from a simulator library.  Code,
10280 initialized data and zero-initialized data are allocated consecutively.
10281
10282 @item -sim2
10283 @opindex sim2
10284 Like @option{-sim}, but pass linker options to locate initialized data at
10285 0x40000000 and zero-initialized data at 0x80000000.
10286 @end table
10287
10288 @node MMIX Options
10289 @subsection MMIX Options
10290 @cindex MMIX Options
10291
10292 These options are defined for the MMIX:
10293
10294 @table @gcctabopt
10295 @item -mlibfuncs
10296 @itemx -mno-libfuncs
10297 @opindex mlibfuncs
10298 @opindex mno-libfuncs
10299 Specify that intrinsic library functions are being compiled, passing all
10300 values in registers, no matter the size.
10301
10302 @item -mepsilon
10303 @itemx -mno-epsilon
10304 @opindex mepsilon
10305 @opindex mno-epsilon
10306 Generate floating-point comparison instructions that compare with respect
10307 to the @code{rE} epsilon register.
10308
10309 @item -mabi=mmixware
10310 @itemx -mabi=gnu
10311 @opindex mabi-mmixware
10312 @opindex mabi=gnu
10313 Generate code that passes function parameters and return values that (in
10314 the called function) are seen as registers @code{$0} and up, as opposed to
10315 the GNU ABI which uses global registers @code{$231} and up.
10316
10317 @item -mzero-extend
10318 @itemx -mno-zero-extend
10319 @opindex mzero-extend
10320 @opindex mno-zero-extend
10321 When reading data from memory in sizes shorter than 64 bits, use (do not
10322 use) zero-extending load instructions by default, rather than
10323 sign-extending ones.
10324
10325 @item -mknuthdiv
10326 @itemx -mno-knuthdiv
10327 @opindex mknuthdiv
10328 @opindex mno-knuthdiv
10329 Make the result of a division yielding a remainder have the same sign as
10330 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10331 remainder follows the sign of the dividend.  Both methods are
10332 arithmetically valid, the latter being almost exclusively used.
10333
10334 @item -mtoplevel-symbols
10335 @itemx -mno-toplevel-symbols
10336 @opindex mtoplevel-symbols
10337 @opindex mno-toplevel-symbols
10338 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10339 code can be used with the @code{PREFIX} assembly directive.
10340
10341 @item -melf
10342 @opindex melf
10343 Generate an executable in the ELF format, rather than the default
10344 @samp{mmo} format used by the @command{mmix} simulator.
10345
10346 @item -mbranch-predict
10347 @itemx -mno-branch-predict
10348 @opindex mbranch-predict
10349 @opindex mno-branch-predict
10350 Use (do not use) the probable-branch instructions, when static branch
10351 prediction indicates a probable branch.
10352
10353 @item -mbase-addresses
10354 @itemx -mno-base-addresses
10355 @opindex mbase-addresses
10356 @opindex mno-base-addresses
10357 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10358 base address automatically generates a request (handled by the assembler
10359 and the linker) for a constant to be set up in a global register.  The
10360 register is used for one or more base address requests within the range 0
10361 to 255 from the value held in the register.  The generally leads to short
10362 and fast code, but the number of different data items that can be
10363 addressed is limited.  This means that a program that uses lots of static
10364 data may require @option{-mno-base-addresses}.
10365
10366 @item -msingle-exit
10367 @itemx -mno-single-exit
10368 @opindex msingle-exit
10369 @opindex mno-single-exit
10370 Force (do not force) generated code to have a single exit point in each
10371 function.
10372 @end table
10373
10374 @node PDP-11 Options
10375 @subsection PDP-11 Options
10376 @cindex PDP-11 Options
10377
10378 These options are defined for the PDP-11:
10379
10380 @table @gcctabopt
10381 @item -mfpu
10382 @opindex mfpu
10383 Use hardware FPP floating point.  This is the default.  (FIS floating
10384 point on the PDP-11/40 is not supported.)
10385
10386 @item -msoft-float
10387 @opindex msoft-float
10388 Do not use hardware floating point.
10389
10390 @item -mac0
10391 @opindex mac0
10392 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10393
10394 @item -mno-ac0
10395 @opindex mno-ac0
10396 Return floating-point results in memory.  This is the default.
10397
10398 @item -m40
10399 @opindex m40
10400 Generate code for a PDP-11/40.
10401
10402 @item -m45
10403 @opindex m45
10404 Generate code for a PDP-11/45.  This is the default.
10405
10406 @item -m10
10407 @opindex m10
10408 Generate code for a PDP-11/10.
10409
10410 @item -mbcopy-builtin
10411 @opindex bcopy-builtin
10412 Use inline @code{movstrhi} patterns for copying memory.  This is the
10413 default.
10414
10415 @item -mbcopy
10416 @opindex mbcopy
10417 Do not use inline @code{movstrhi} patterns for copying memory.
10418
10419 @item -mint16
10420 @itemx -mno-int32
10421 @opindex mint16
10422 @opindex mno-int32
10423 Use 16-bit @code{int}.  This is the default.
10424
10425 @item -mint32
10426 @itemx -mno-int16
10427 @opindex mint32
10428 @opindex mno-int16
10429 Use 32-bit @code{int}.
10430
10431 @item -mfloat64
10432 @itemx -mno-float32
10433 @opindex mfloat64
10434 @opindex mno-float32
10435 Use 64-bit @code{float}.  This is the default.
10436
10437 @item -mfloat32
10438 @itemx -mno-float64
10439 @opindex mfloat32
10440 @opindex mno-float64
10441 Use 32-bit @code{float}.
10442
10443 @item -mabshi
10444 @opindex mabshi
10445 Use @code{abshi2} pattern.  This is the default.
10446
10447 @item -mno-abshi
10448 @opindex mno-abshi
10449 Do not use @code{abshi2} pattern.
10450
10451 @item -mbranch-expensive
10452 @opindex mbranch-expensive
10453 Pretend that branches are expensive.  This is for experimenting with
10454 code generation only.
10455
10456 @item -mbranch-cheap
10457 @opindex mbranch-cheap
10458 Do not pretend that branches are expensive.  This is the default.
10459
10460 @item -msplit
10461 @opindex msplit
10462 Generate code for a system with split I&D.
10463
10464 @item -mno-split
10465 @opindex mno-split
10466 Generate code for a system without split I&D.  This is the default.
10467
10468 @item -munix-asm
10469 @opindex munix-asm
10470 Use Unix assembler syntax.  This is the default when configured for
10471 @samp{pdp11-*-bsd}.
10472
10473 @item -mdec-asm
10474 @opindex mdec-asm
10475 Use DEC assembler syntax.  This is the default when configured for any
10476 PDP-11 target other than @samp{pdp11-*-bsd}.
10477 @end table
10478
10479 @node Xstormy16 Options
10480 @subsection Xstormy16 Options
10481 @cindex Xstormy16 Options
10482
10483 These options are defined for Xstormy16:
10484
10485 @table @gcctabopt
10486 @item -msim
10487 @opindex msim
10488 Choose startup files and linker script suitable for the simulator.
10489 @end table
10490
10491 @node FRV Options
10492 @subsection FRV Options
10493 @cindex FRV Options
10494
10495 @table @gcctabopt
10496 @item -mgpr-32
10497 @opindex mgpr-32
10498
10499 Only use the first 32 general purpose registers.
10500
10501 @item -mgpr-64
10502 @opindex mgpr-64
10503
10504 Use all 64 general purpose registers.
10505
10506 @item -mfpr-32
10507 @opindex mfpr-32
10508
10509 Use only the first 32 floating point registers.
10510
10511 @item -mfpr-64
10512 @opindex mfpr-64
10513
10514 Use all 64 floating point registers
10515
10516 @item -mhard-float
10517 @opindex mhard-float
10518
10519 Use hardware instructions for floating point operations.
10520
10521 @item -msoft-float
10522 @opindex msoft-float
10523
10524 Use library routines for floating point operations.
10525
10526 @item -malloc-cc
10527 @opindex malloc-cc
10528
10529 Dynamically allocate condition code registers.
10530
10531 @item -mfixed-cc
10532 @opindex mfixed-cc
10533
10534 Do not try to dynamically allocate condition code registers, only
10535 use @code{icc0} and @code{fcc0}.
10536
10537 @item -mdword
10538 @opindex mdword
10539
10540 Change ABI to use double word insns.
10541
10542 @item -mno-dword
10543 @opindex mno-dword
10544
10545 Do not use double word instructions.
10546
10547 @item -mdouble
10548 @opindex mdouble
10549
10550 Use floating point double instructions.
10551
10552 @item -mno-double
10553 @opindex mno-double
10554
10555 Do not use floating point double instructions.
10556
10557 @item -mmedia
10558 @opindex mmedia
10559
10560 Use media instructions.
10561
10562 @item -mno-media
10563 @opindex mno-media
10564
10565 Do not use media instructions.
10566
10567 @item -mmuladd
10568 @opindex mmuladd
10569
10570 Use multiply and add/subtract instructions.
10571
10572 @item -mno-muladd
10573 @opindex mno-muladd
10574
10575 Do not use multiply and add/subtract instructions.
10576
10577 @item -mlibrary-pic
10578 @opindex mlibrary-pic
10579
10580 Enable PIC support for building libraries
10581
10582 @item -macc-4
10583 @opindex macc-4
10584
10585 Use only the first four media accumulator registers.
10586
10587 @item -macc-8
10588 @opindex macc-8
10589
10590 Use all eight media accumulator registers.
10591
10592 @item -mpack
10593 @opindex mpack
10594
10595 Pack VLIW instructions.
10596
10597 @item -mno-pack
10598 @opindex mno-pack
10599
10600 Do not pack VLIW instructions.
10601
10602 @item -mno-eflags
10603 @opindex mno-eflags
10604
10605 Do not mark ABI switches in e_flags.
10606
10607 @item -mcond-move
10608 @opindex mcond-move
10609
10610 Enable the use of conditional-move instructions (default).
10611
10612 This switch is mainly for debugging the compiler and will likely be removed
10613 in a future version.
10614
10615 @item -mno-cond-move
10616 @opindex mno-cond-move
10617
10618 Disable the use of conditional-move instructions.
10619
10620 This switch is mainly for debugging the compiler and will likely be removed
10621 in a future version.
10622
10623 @item -mscc
10624 @opindex mscc
10625
10626 Enable the use of conditional set instructions (default).
10627
10628 This switch is mainly for debugging the compiler and will likely be removed
10629 in a future version.
10630
10631 @item -mno-scc
10632 @opindex mno-scc
10633
10634 Disable the use of conditional set instructions.
10635
10636 This switch is mainly for debugging the compiler and will likely be removed
10637 in a future version.
10638
10639 @item -mcond-exec
10640 @opindex mcond-exec
10641
10642 Enable the use of conditional execution (default).
10643
10644 This switch is mainly for debugging the compiler and will likely be removed
10645 in a future version.
10646
10647 @item -mno-cond-exec
10648 @opindex mno-cond-exec
10649
10650 Disable the use of conditional execution.
10651
10652 This switch is mainly for debugging the compiler and will likely be removed
10653 in a future version.
10654
10655 @item -mvliw-branch
10656 @opindex mvliw-branch
10657
10658 Run a pass to pack branches into VLIW instructions (default).
10659
10660 This switch is mainly for debugging the compiler and will likely be removed
10661 in a future version.
10662
10663 @item -mno-vliw-branch
10664 @opindex mno-vliw-branch
10665
10666 Do not run a pass to pack branches into VLIW instructions.
10667
10668 This switch is mainly for debugging the compiler and will likely be removed
10669 in a future version.
10670
10671 @item -mmulti-cond-exec
10672 @opindex mmulti-cond-exec
10673
10674 Enable optimization of @code{&&} and @code{||} in conditional execution
10675 (default).
10676
10677 This switch is mainly for debugging the compiler and will likely be removed
10678 in a future version.
10679
10680 @item -mno-multi-cond-exec
10681 @opindex mno-multi-cond-exec
10682
10683 Disable optimization of @code{&&} and @code{||} in conditional execution.
10684
10685 This switch is mainly for debugging the compiler and will likely be removed
10686 in a future version.
10687
10688 @item -mnested-cond-exec
10689 @opindex mnested-cond-exec
10690
10691 Enable nested conditional execution optimizations (default).
10692
10693 This switch is mainly for debugging the compiler and will likely be removed
10694 in a future version.
10695
10696 @item -mno-nested-cond-exec
10697 @opindex mno-nested-cond-exec
10698
10699 Disable nested conditional execution optimizations.
10700
10701 This switch is mainly for debugging the compiler and will likely be removed
10702 in a future version.
10703
10704 @item -mtomcat-stats
10705 @opindex mtomcat-stats
10706
10707 Cause gas to print out tomcat statistics.
10708
10709 @item -mcpu=@var{cpu}
10710 @opindex mcpu
10711
10712 Select the processor type for which to generate code.  Possible values are
10713 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10714 @samp{frv}.
10715
10716 @end table
10717
10718 @node Xtensa Options
10719 @subsection Xtensa Options
10720 @cindex Xtensa Options
10721
10722 These options are supported for Xtensa targets:
10723
10724 @table @gcctabopt
10725 @item -mconst16
10726 @itemx -mno-const16
10727 @opindex mconst16
10728 @opindex mno-const16
10729 Enable or disable use of @code{CONST16} instructions for loading
10730 constant values.  The @code{CONST16} instruction is currently not a
10731 standard option from Tensilica.  When enabled, @code{CONST16}
10732 instructions are always used in place of the standard @code{L32R}
10733 instructions.  The use of @code{CONST16} is enabled by default only if
10734 the @code{L32R} instruction is not available.
10735
10736 @item -mfused-madd
10737 @itemx -mno-fused-madd
10738 @opindex mfused-madd
10739 @opindex mno-fused-madd
10740 Enable or disable use of fused multiply/add and multiply/subtract
10741 instructions in the floating-point option.  This has no effect if the
10742 floating-point option is not also enabled.  Disabling fused multiply/add
10743 and multiply/subtract instructions forces the compiler to use separate
10744 instructions for the multiply and add/subtract operations.  This may be
10745 desirable in some cases where strict IEEE 754-compliant results are
10746 required: the fused multiply add/subtract instructions do not round the
10747 intermediate result, thereby producing results with @emph{more} bits of
10748 precision than specified by the IEEE standard.  Disabling fused multiply
10749 add/subtract instructions also ensures that the program output is not
10750 sensitive to the compiler's ability to combine multiply and add/subtract
10751 operations.
10752
10753 @item -mtext-section-literals
10754 @itemx -mno-text-section-literals
10755 @opindex mtext-section-literals
10756 @opindex mno-text-section-literals
10757 Control the treatment of literal pools.  The default is
10758 @option{-mno-text-section-literals}, which places literals in a separate
10759 section in the output file.  This allows the literal pool to be placed
10760 in a data RAM/ROM, and it also allows the linker to combine literal
10761 pools from separate object files to remove redundant literals and
10762 improve code size.  With @option{-mtext-section-literals}, the literals
10763 are interspersed in the text section in order to keep them as close as
10764 possible to their references.  This may be necessary for large assembly
10765 files.
10766
10767 @item -mtarget-align
10768 @itemx -mno-target-align
10769 @opindex mtarget-align
10770 @opindex mno-target-align
10771 When this option is enabled, GCC instructs the assembler to
10772 automatically align instructions to reduce branch penalties at the
10773 expense of some code density.  The assembler attempts to widen density
10774 instructions to align branch targets and the instructions following call
10775 instructions.  If there are not enough preceding safe density
10776 instructions to align a target, no widening will be performed.  The
10777 default is @option{-mtarget-align}.  These options do not affect the
10778 treatment of auto-aligned instructions like @code{LOOP}, which the
10779 assembler will always align, either by widening density instructions or
10780 by inserting no-op instructions.
10781
10782 @item -mlongcalls
10783 @itemx -mno-longcalls
10784 @opindex mlongcalls
10785 @opindex mno-longcalls
10786 When this option is enabled, GCC instructs the assembler to translate
10787 direct calls to indirect calls unless it can determine that the target
10788 of a direct call is in the range allowed by the call instruction.  This
10789 translation typically occurs for calls to functions in other source
10790 files.  Specifically, the assembler translates a direct @code{CALL}
10791 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10792 The default is @option{-mno-longcalls}.  This option should be used in
10793 programs where the call target can potentially be out of range.  This
10794 option is implemented in the assembler, not the compiler, so the
10795 assembly code generated by GCC will still show direct call
10796 instructions---look at the disassembled object code to see the actual
10797 instructions.  Note that the assembler will use an indirect call for
10798 every cross-file call, not just those that really will be out of range.
10799 @end table
10800
10801 @node Code Gen Options
10802 @section Options for Code Generation Conventions
10803 @cindex code generation conventions
10804 @cindex options, code generation
10805 @cindex run-time options
10806
10807 These machine-independent options control the interface conventions
10808 used in code generation.
10809
10810 Most of them have both positive and negative forms; the negative form
10811 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10812 one of the forms is listed---the one which is not the default.  You
10813 can figure out the other form by either removing @samp{no-} or adding
10814 it.
10815
10816 @table @gcctabopt
10817 @item -fbounds-check
10818 @opindex fbounds-check
10819 For front-ends that support it, generate additional code to check that
10820 indices used to access arrays are within the declared range.  This is
10821 currently only supported by the Java and Fortran 77 front-ends, where
10822 this option defaults to true and false respectively.
10823
10824 @item -ftrapv
10825 @opindex ftrapv
10826 This option generates traps for signed overflow on addition, subtraction,
10827 multiplication operations.
10828
10829 @item -fwrapv
10830 @opindex fwrapv
10831 This option instructs the compiler to assume that signed arithmetic
10832 overflow of addition, subtraction and multiplication wraps around
10833 using twos-complement representation.  This flag enables some optimizations
10834 and disables other.  This option is enabled by default for the Java
10835 front-end, as required by the Java language specification.
10836
10837 @item -fexceptions
10838 @opindex fexceptions
10839 Enable exception handling.  Generates extra code needed to propagate
10840 exceptions.  For some targets, this implies GCC will generate frame
10841 unwind information for all functions, which can produce significant data
10842 size overhead, although it does not affect execution.  If you do not
10843 specify this option, GCC will enable it by default for languages like
10844 C++ which normally require exception handling, and disable it for
10845 languages like C that do not normally require it.  However, you may need
10846 to enable this option when compiling C code that needs to interoperate
10847 properly with exception handlers written in C++.  You may also wish to
10848 disable this option if you are compiling older C++ programs that don't
10849 use exception handling.
10850
10851 @item -fnon-call-exceptions
10852 @opindex fnon-call-exceptions
10853 Generate code that allows trapping instructions to throw exceptions.
10854 Note that this requires platform-specific runtime support that does
10855 not exist everywhere.  Moreover, it only allows @emph{trapping}
10856 instructions to throw exceptions, i.e.@: memory references or floating
10857 point instructions.  It does not allow exceptions to be thrown from
10858 arbitrary signal handlers such as @code{SIGALRM}.
10859
10860 @item -funwind-tables
10861 @opindex funwind-tables
10862 Similar to @option{-fexceptions}, except that it will just generate any needed
10863 static data, but will not affect the generated code in any other way.
10864 You will normally not enable this option; instead, a language processor
10865 that needs this handling would enable it on your behalf.
10866
10867 @item -fasynchronous-unwind-tables
10868 @opindex funwind-tables
10869 Generate unwind table in dwarf2 format, if supported by target machine.  The
10870 table is exact at each instruction boundary, so it can be used for stack
10871 unwinding from asynchronous events (such as debugger or garbage collector).
10872
10873 @item -fpcc-struct-return
10874 @opindex fpcc-struct-return
10875 Return ``short'' @code{struct} and @code{union} values in memory like
10876 longer ones, rather than in registers.  This convention is less
10877 efficient, but it has the advantage of allowing intercallability between
10878 GCC-compiled files and files compiled with other compilers, particularly
10879 the Portable C Compiler (pcc).
10880
10881 The precise convention for returning structures in memory depends
10882 on the target configuration macros.
10883
10884 Short structures and unions are those whose size and alignment match
10885 that of some integer type.
10886
10887 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10888 switch is not binary compatible with code compiled with the
10889 @option{-freg-struct-return} switch.
10890 Use it to conform to a non-default application binary interface.
10891
10892 @item -freg-struct-return
10893 @opindex freg-struct-return
10894 Return @code{struct} and @code{union} values in registers when possible.
10895 This is more efficient for small structures than
10896 @option{-fpcc-struct-return}.
10897
10898 If you specify neither @option{-fpcc-struct-return} nor
10899 @option{-freg-struct-return}, GCC defaults to whichever convention is
10900 standard for the target.  If there is no standard convention, GCC
10901 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10902 the principal compiler.  In those cases, we can choose the standard, and
10903 we chose the more efficient register return alternative.
10904
10905 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10906 switch is not binary compatible with code compiled with the
10907 @option{-fpcc-struct-return} switch.
10908 Use it to conform to a non-default application binary interface.
10909
10910 @item -fshort-enums
10911 @opindex fshort-enums
10912 Allocate to an @code{enum} type only as many bytes as it needs for the
10913 declared range of possible values.  Specifically, the @code{enum} type
10914 will be equivalent to the smallest integer type which has enough room.
10915
10916 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10917 code that is not binary compatible with code generated without that switch.
10918 Use it to conform to a non-default application binary interface.
10919
10920 @item -fshort-double
10921 @opindex fshort-double
10922 Use the same size for @code{double} as for @code{float}.
10923
10924 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10925 code that is not binary compatible with code generated without that switch.
10926 Use it to conform to a non-default application binary interface.
10927
10928 @item -fshort-wchar
10929 @opindex fshort-wchar
10930 Override the underlying type for @samp{wchar_t} to be @samp{short
10931 unsigned int} instead of the default for the target.  This option is
10932 useful for building programs to run under WINE@.
10933
10934 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10935 code that is not binary compatible with code generated without that switch.
10936 Use it to conform to a non-default application binary interface.
10937
10938 @item -fshared-data
10939 @opindex fshared-data
10940 Requests that the data and non-@code{const} variables of this
10941 compilation be shared data rather than private data.  The distinction
10942 makes sense only on certain operating systems, where shared data is
10943 shared between processes running the same program, while private data
10944 exists in one copy per process.
10945
10946 @item -fno-common
10947 @opindex fno-common
10948 In C, allocate even uninitialized global variables in the data section of the
10949 object file, rather than generating them as common blocks.  This has the
10950 effect that if the same variable is declared (without @code{extern}) in
10951 two different compilations, you will get an error when you link them.
10952 The only reason this might be useful is if you wish to verify that the
10953 program will work on other systems which always work this way.
10954
10955 @item -fno-ident
10956 @opindex fno-ident
10957 Ignore the @samp{#ident} directive.
10958
10959 @item -finhibit-size-directive
10960 @opindex finhibit-size-directive
10961 Don't output a @code{.size} assembler directive, or anything else that
10962 would cause trouble if the function is split in the middle, and the
10963 two halves are placed at locations far apart in memory.  This option is
10964 used when compiling @file{crtstuff.c}; you should not need to use it
10965 for anything else.
10966
10967 @item -fverbose-asm
10968 @opindex fverbose-asm
10969 Put extra commentary information in the generated assembly code to
10970 make it more readable.  This option is generally only of use to those
10971 who actually need to read the generated assembly code (perhaps while
10972 debugging the compiler itself).
10973
10974 @option{-fno-verbose-asm}, the default, causes the
10975 extra information to be omitted and is useful when comparing two assembler
10976 files.
10977
10978 @item -fpic
10979 @opindex fpic
10980 @cindex global offset table
10981 @cindex PIC
10982 Generate position-independent code (PIC) suitable for use in a shared
10983 library, if supported for the target machine.  Such code accesses all
10984 constant addresses through a global offset table (GOT)@.  The dynamic
10985 loader resolves the GOT entries when the program starts (the dynamic
10986 loader is not part of GCC; it is part of the operating system).  If
10987 the GOT size for the linked executable exceeds a machine-specific
10988 maximum size, you get an error message from the linker indicating that
10989 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10990 instead.  (These maximums are 8k on the SPARC and 32k
10991 on the m68k and RS/6000.  The 386 has no such limit.)
10992
10993 Position-independent code requires special support, and therefore works
10994 only on certain machines.  For the 386, GCC supports PIC for System V
10995 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10996 position-independent.
10997
10998 @item -fPIC
10999 @opindex fPIC
11000 If supported for the target machine, emit position-independent code,
11001 suitable for dynamic linking and avoiding any limit on the size of the
11002 global offset table.  This option makes a difference on the m68k
11003 and the SPARC.
11004
11005 Position-independent code requires special support, and therefore works
11006 only on certain machines.
11007
11008 @item -fpie
11009 @itemx -fPIE
11010 @opindex fpie
11011 @opindex fPIE
11012 These options are similar to @option{-fpic} and @option{-fPIC}, but
11013 generated position independent code can be only linked into executables.
11014 Usually these options are used when @option{-pie} GCC option will be
11015 used during linking.
11016
11017 @item -ffixed-@var{reg}
11018 @opindex ffixed
11019 Treat the register named @var{reg} as a fixed register; generated code
11020 should never refer to it (except perhaps as a stack pointer, frame
11021 pointer or in some other fixed role).
11022
11023 @var{reg} must be the name of a register.  The register names accepted
11024 are machine-specific and are defined in the @code{REGISTER_NAMES}
11025 macro in the machine description macro file.
11026
11027 This flag does not have a negative form, because it specifies a
11028 three-way choice.
11029
11030 @item -fcall-used-@var{reg}
11031 @opindex fcall-used
11032 Treat the register named @var{reg} as an allocable register that is
11033 clobbered by function calls.  It may be allocated for temporaries or
11034 variables that do not live across a call.  Functions compiled this way
11035 will not save and restore the register @var{reg}.
11036
11037 It is an error to used this flag with the frame pointer or stack pointer.
11038 Use of this flag for other registers that have fixed pervasive roles in
11039 the machine's execution model will produce disastrous results.
11040
11041 This flag does not have a negative form, because it specifies a
11042 three-way choice.
11043
11044 @item -fcall-saved-@var{reg}
11045 @opindex fcall-saved
11046 Treat the register named @var{reg} as an allocable register saved by
11047 functions.  It may be allocated even for temporaries or variables that
11048 live across a call.  Functions compiled this way will save and restore
11049 the register @var{reg} if they use it.
11050
11051 It is an error to used this flag with the frame pointer or stack pointer.
11052 Use of this flag for other registers that have fixed pervasive roles in
11053 the machine's execution model will produce disastrous results.
11054
11055 A different sort of disaster will result from the use of this flag for
11056 a register in which function values may be returned.
11057
11058 This flag does not have a negative form, because it specifies a
11059 three-way choice.
11060
11061 @item -fpack-struct
11062 @opindex fpack-struct
11063 Pack all structure members together without holes.
11064
11065 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11066 code that is not binary compatible with code generated without that switch.
11067 Additionally, it makes the code suboptimal.
11068 Use it to conform to a non-default application binary interface.
11069
11070 @item -finstrument-functions
11071 @opindex finstrument-functions
11072 Generate instrumentation calls for entry and exit to functions.  Just
11073 after function entry and just before function exit, the following
11074 profiling functions will be called with the address of the current
11075 function and its call site.  (On some platforms,
11076 @code{__builtin_return_address} does not work beyond the current
11077 function, so the call site information may not be available to the
11078 profiling functions otherwise.)
11079
11080 @smallexample
11081 void __cyg_profile_func_enter (void *this_fn,
11082                                void *call_site);
11083 void __cyg_profile_func_exit  (void *this_fn,
11084                                void *call_site);
11085 @end smallexample
11086
11087 The first argument is the address of the start of the current function,
11088 which may be looked up exactly in the symbol table.
11089
11090 This instrumentation is also done for functions expanded inline in other
11091 functions.  The profiling calls will indicate where, conceptually, the
11092 inline function is entered and exited.  This means that addressable
11093 versions of such functions must be available.  If all your uses of a
11094 function are expanded inline, this may mean an additional expansion of
11095 code size.  If you use @samp{extern inline} in your C code, an
11096 addressable version of such functions must be provided.  (This is
11097 normally the case anyways, but if you get lucky and the optimizer always
11098 expands the functions inline, you might have gotten away without
11099 providing static copies.)
11100
11101 A function may be given the attribute @code{no_instrument_function}, in
11102 which case this instrumentation will not be done.  This can be used, for
11103 example, for the profiling functions listed above, high-priority
11104 interrupt routines, and any functions from which the profiling functions
11105 cannot safely be called (perhaps signal handlers, if the profiling
11106 routines generate output or allocate memory).
11107
11108 @item -fstack-check
11109 @opindex fstack-check
11110 Generate code to verify that you do not go beyond the boundary of the
11111 stack.  You should specify this flag if you are running in an
11112 environment with multiple threads, but only rarely need to specify it in
11113 a single-threaded environment since stack overflow is automatically
11114 detected on nearly all systems if there is only one stack.
11115
11116 Note that this switch does not actually cause checking to be done; the
11117 operating system must do that.  The switch causes generation of code
11118 to ensure that the operating system sees the stack being extended.
11119
11120 @item -fstack-limit-register=@var{reg}
11121 @itemx -fstack-limit-symbol=@var{sym}
11122 @itemx -fno-stack-limit
11123 @opindex fstack-limit-register
11124 @opindex fstack-limit-symbol
11125 @opindex fno-stack-limit
11126 Generate code to ensure that the stack does not grow beyond a certain value,
11127 either the value of a register or the address of a symbol.  If the stack
11128 would grow beyond the value, a signal is raised.  For most targets,
11129 the signal is raised before the stack overruns the boundary, so
11130 it is possible to catch the signal without taking special precautions.
11131
11132 For instance, if the stack starts at absolute address @samp{0x80000000}
11133 and grows downwards, you can use the flags
11134 @option{-fstack-limit-symbol=__stack_limit} and
11135 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11136 of 128KB@.  Note that this may only work with the GNU linker.
11137
11138 @cindex aliasing of parameters
11139 @cindex parameters, aliased
11140 @item -fargument-alias
11141 @itemx -fargument-noalias
11142 @itemx -fargument-noalias-global
11143 @opindex fargument-alias
11144 @opindex fargument-noalias
11145 @opindex fargument-noalias-global
11146 Specify the possible relationships among parameters and between
11147 parameters and global data.
11148
11149 @option{-fargument-alias} specifies that arguments (parameters) may
11150 alias each other and may alias global storage.@*
11151 @option{-fargument-noalias} specifies that arguments do not alias
11152 each other, but may alias global storage.@*
11153 @option{-fargument-noalias-global} specifies that arguments do not
11154 alias each other and do not alias global storage.
11155
11156 Each language will automatically use whatever option is required by
11157 the language standard.  You should not need to use these options yourself.
11158
11159 @item -fleading-underscore
11160 @opindex fleading-underscore
11161 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11162 change the way C symbols are represented in the object file.  One use
11163 is to help link with legacy assembly code.
11164
11165 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11166 generate code that is not binary compatible with code generated without that
11167 switch.  Use it to conform to a non-default application binary interface.
11168 Not all targets provide complete support for this switch.
11169
11170 @item -ftls-model=@var{model}
11171 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11172 The @var{model} argument should be one of @code{global-dynamic},
11173 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11174
11175 The default without @option{-fpic} is @code{initial-exec}; with
11176 @option{-fpic} the default is @code{global-dynamic}.
11177 @end table
11178
11179 @c man end
11180
11181 @node Environment Variables
11182 @section Environment Variables Affecting GCC
11183 @cindex environment variables
11184
11185 @c man begin ENVIRONMENT
11186 This section describes several environment variables that affect how GCC
11187 operates.  Some of them work by specifying directories or prefixes to use
11188 when searching for various kinds of files.  Some are used to specify other
11189 aspects of the compilation environment.
11190
11191 Note that you can also specify places to search using options such as
11192 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11193 take precedence over places specified using environment variables, which
11194 in turn take precedence over those specified by the configuration of GCC@.
11195 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11196 GNU Compiler Collection (GCC) Internals}.
11197
11198 @table @env
11199 @item LANG
11200 @itemx LC_CTYPE
11201 @c @itemx LC_COLLATE
11202 @itemx LC_MESSAGES
11203 @c @itemx LC_MONETARY
11204 @c @itemx LC_NUMERIC
11205 @c @itemx LC_TIME
11206 @itemx LC_ALL
11207 @findex LANG
11208 @findex LC_CTYPE
11209 @c @findex LC_COLLATE
11210 @findex LC_MESSAGES
11211 @c @findex LC_MONETARY
11212 @c @findex LC_NUMERIC
11213 @c @findex LC_TIME
11214 @findex LC_ALL
11215 @cindex locale
11216 These environment variables control the way that GCC uses
11217 localization information that allow GCC to work with different
11218 national conventions.  GCC inspects the locale categories
11219 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11220 so.  These locale categories can be set to any value supported by your
11221 installation.  A typical value is @samp{en_UK} for English in the United
11222 Kingdom.
11223
11224 The @env{LC_CTYPE} environment variable specifies character
11225 classification.  GCC uses it to determine the character boundaries in
11226 a string; this is needed for some multibyte encodings that contain quote
11227 and escape characters that would otherwise be interpreted as a string
11228 end or escape.
11229
11230 The @env{LC_MESSAGES} environment variable specifies the language to
11231 use in diagnostic messages.
11232
11233 If the @env{LC_ALL} environment variable is set, it overrides the value
11234 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11235 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11236 environment variable.  If none of these variables are set, GCC
11237 defaults to traditional C English behavior.
11238
11239 @item TMPDIR
11240 @findex TMPDIR
11241 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11242 files.  GCC uses temporary files to hold the output of one stage of
11243 compilation which is to be used as input to the next stage: for example,
11244 the output of the preprocessor, which is the input to the compiler
11245 proper.
11246
11247 @item GCC_EXEC_PREFIX
11248 @findex GCC_EXEC_PREFIX
11249 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11250 names of the subprograms executed by the compiler.  No slash is added
11251 when this prefix is combined with the name of a subprogram, but you can
11252 specify a prefix that ends with a slash if you wish.
11253
11254 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11255 an appropriate prefix to use based on the pathname it was invoked with.
11256
11257 If GCC cannot find the subprogram using the specified prefix, it
11258 tries looking in the usual places for the subprogram.
11259
11260 The default value of @env{GCC_EXEC_PREFIX} is
11261 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11262 of @code{prefix} when you ran the @file{configure} script.
11263
11264 Other prefixes specified with @option{-B} take precedence over this prefix.
11265
11266 This prefix is also used for finding files such as @file{crt0.o} that are
11267 used for linking.
11268
11269 In addition, the prefix is used in an unusual way in finding the
11270 directories to search for header files.  For each of the standard
11271 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11272 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11273 replacing that beginning with the specified prefix to produce an
11274 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11275 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11276 These alternate directories are searched first; the standard directories
11277 come next.
11278
11279 @item COMPILER_PATH
11280 @findex COMPILER_PATH
11281 The value of @env{COMPILER_PATH} is a colon-separated list of
11282 directories, much like @env{PATH}.  GCC tries the directories thus
11283 specified when searching for subprograms, if it can't find the
11284 subprograms using @env{GCC_EXEC_PREFIX}.
11285
11286 @item LIBRARY_PATH
11287 @findex LIBRARY_PATH
11288 The value of @env{LIBRARY_PATH} is a colon-separated list of
11289 directories, much like @env{PATH}.  When configured as a native compiler,
11290 GCC tries the directories thus specified when searching for special
11291 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11292 using GCC also uses these directories when searching for ordinary
11293 libraries for the @option{-l} option (but directories specified with
11294 @option{-L} come first).
11295
11296 @item LANG
11297 @findex LANG
11298 @cindex locale definition
11299 This variable is used to pass locale information to the compiler.  One way in
11300 which this information is used is to determine the character set to be used
11301 when character literals, string literals and comments are parsed in C and C++.
11302 When the compiler is configured to allow multibyte characters,
11303 the following values for @env{LANG} are recognized:
11304
11305 @table @samp
11306 @item C-JIS
11307 Recognize JIS characters.
11308 @item C-SJIS
11309 Recognize SJIS characters.
11310 @item C-EUCJP
11311 Recognize EUCJP characters.
11312 @end table
11313
11314 If @env{LANG} is not defined, or if it has some other value, then the
11315 compiler will use mblen and mbtowc as defined by the default locale to
11316 recognize and translate multibyte characters.
11317 @end table
11318
11319 @noindent
11320 Some additional environments variables affect the behavior of the
11321 preprocessor.
11322
11323 @include cppenv.texi
11324
11325 @c man end
11326
11327 @node Precompiled Headers
11328 @section Using Precompiled Headers
11329 @cindex precompiled headers
11330 @cindex speed of compilation
11331
11332 Often large projects have many header files that are included in every
11333 source file.  The time the compiler takes to process these header files
11334 over and over again can account for nearly all of the time required to
11335 build the project.  To make builds faster, GCC allows users to
11336 `precompile' a header file; then, if builds can use the precompiled
11337 header file they will be much faster.
11338
11339 To create a precompiled header file, simply compile it as you would any
11340 other file, if necessary using the @option{-x} option to make the driver
11341 treat it as a C or C++ header file.  You will probably want to use a
11342 tool like @command{make} to keep the precompiled header up-to-date when
11343 the headers it contains change.
11344
11345 A precompiled header file will be searched for when @code{#include} is
11346 seen in the compilation.  As it searches for the included file
11347 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11348 compiler looks for a precompiled header in each directory just before it
11349 looks for the include file in that directory.  The name searched for is
11350 the name specified in the @code{#include} with @samp{.gch} appended.  If
11351 the precompiled header file can't be used, it is ignored.
11352
11353 For instance, if you have @code{#include "all.h"}, and you have
11354 @file{all.h.gch} in the same directory as @file{all.h}, then the
11355 precompiled header file will be used if possible, and the original
11356 header will be used otherwise.
11357
11358 Alternatively, you might decide to put the precompiled header file in a
11359 directory and use @option{-I} to ensure that directory is searched
11360 before (or instead of) the directory containing the original header.
11361 Then, if you want to check that the precompiled header file is always
11362 used, you can put a file of the same name as the original header in this
11363 directory containing an @code{#error} command.
11364
11365 This also works with @option{-include}.  So yet another way to use
11366 precompiled headers, good for projects not designed with precompiled
11367 header files in mind, is to simply take most of the header files used by
11368 a project, include them from another header file, precompile that header
11369 file, and @option{-include} the precompiled header.  If the header files
11370 have guards against multiple inclusion, they will be skipped because
11371 they've already been included (in the precompiled header).
11372
11373 If you need to precompile the same header file for different
11374 languages, targets, or compiler options, you can instead make a
11375 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11376 header in the directory.  (It doesn't matter what you call the files
11377 in the directory, every precompiled header in the directory will be
11378 considered.)  The first precompiled header encountered in the
11379 directory that is valid for this compilation will be used; they're
11380 searched in no particular order.
11381
11382 There are many other possibilities, limited only by your imagination,
11383 good sense, and the constraints of your build system.
11384
11385 A precompiled header file can be used only when these conditions apply:
11386
11387 @itemize
11388 @item
11389 Only one precompiled header can be used in a particular compilation.
11390 @item
11391 A precompiled header can't be used once the first C token is seen.  You
11392 can have preprocessor directives before a precompiled header; you can
11393 even include a precompiled header from inside another header, so long as
11394 there are no C tokens before the @code{#include}.
11395 @item
11396 The precompiled header file must be produced for the same language as
11397 the current compilation.  You can't use a C precompiled header for a C++
11398 compilation.
11399 @item
11400 The precompiled header file must be produced by the same compiler
11401 version and configuration as the current compilation is using.
11402 The easiest way to guarantee this is to use the same compiler binary
11403 for creating and using precompiled headers.
11404 @item
11405 Any macros defined before the precompiled header (including with
11406 @option{-D}) must either be defined in the same way as when the
11407 precompiled header was generated, or must not affect the precompiled
11408 header, which usually means that the they don't appear in the
11409 precompiled header at all.
11410 @item
11411 Certain command-line options must be defined in the same way as when the
11412 precompiled header was generated.  At present, it's not clear which
11413 options are safe to change and which are not; the safest choice is to
11414 use exactly the same options when generating and using the precompiled
11415 header.
11416 @end itemize
11417
11418 For all of these but the last, the compiler will automatically ignore
11419 the precompiled header if the conditions aren't met.  For the last item,
11420 some option changes will cause the precompiled header to be rejected,
11421 but not all incompatible option combinations have yet been found.  If
11422 you find a new incompatible combination, please consider filing a bug
11423 report, see @ref{Bugs}.
11424
11425 @node Running Protoize
11426 @section Running Protoize
11427
11428 The program @code{protoize} is an optional part of GCC@.  You can use
11429 it to add prototypes to a program, thus converting the program to ISO
11430 C in one respect.  The companion program @code{unprotoize} does the
11431 reverse: it removes argument types from any prototypes that are found.
11432
11433 When you run these programs, you must specify a set of source files as
11434 command line arguments.  The conversion programs start out by compiling
11435 these files to see what functions they define.  The information gathered
11436 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11437
11438 After scanning comes actual conversion.  The specified files are all
11439 eligible to be converted; any files they include (whether sources or
11440 just headers) are eligible as well.
11441
11442 But not all the eligible files are converted.  By default,
11443 @code{protoize} and @code{unprotoize} convert only source and header
11444 files in the current directory.  You can specify additional directories
11445 whose files should be converted with the @option{-d @var{directory}}
11446 option.  You can also specify particular files to exclude with the
11447 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11448 directory name matches one of the specified directory names, and its
11449 name within the directory has not been excluded.
11450
11451 Basic conversion with @code{protoize} consists of rewriting most
11452 function definitions and function declarations to specify the types of
11453 the arguments.  The only ones not rewritten are those for varargs
11454 functions.
11455
11456 @code{protoize} optionally inserts prototype declarations at the
11457 beginning of the source file, to make them available for any calls that
11458 precede the function's definition.  Or it can insert prototype
11459 declarations with block scope in the blocks where undeclared functions
11460 are called.
11461
11462 Basic conversion with @code{unprotoize} consists of rewriting most
11463 function declarations to remove any argument types, and rewriting
11464 function definitions to the old-style pre-ISO form.
11465
11466 Both conversion programs print a warning for any function declaration or
11467 definition that they can't convert.  You can suppress these warnings
11468 with @option{-q}.
11469
11470 The output from @code{protoize} or @code{unprotoize} replaces the
11471 original source file.  The original file is renamed to a name ending
11472 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11473 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11474 for DOS) file already exists, then the source file is simply discarded.
11475
11476 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11477 scan the program and collect information about the functions it uses.
11478 So neither of these programs will work until GCC is installed.
11479
11480 Here is a table of the options you can use with @code{protoize} and
11481 @code{unprotoize}.  Each option works with both programs unless
11482 otherwise stated.
11483
11484 @table @code
11485 @item -B @var{directory}
11486 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11487 usual directory (normally @file{/usr/local/lib}).  This file contains
11488 prototype information about standard system functions.  This option
11489 applies only to @code{protoize}.
11490
11491 @item -c @var{compilation-options}
11492 Use @var{compilation-options} as the options when running @command{gcc} to
11493 produce the @samp{.X} files.  The special option @option{-aux-info} is
11494 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11495
11496 Note that the compilation options must be given as a single argument to
11497 @code{protoize} or @code{unprotoize}.  If you want to specify several
11498 @command{gcc} options, you must quote the entire set of compilation options
11499 to make them a single word in the shell.
11500
11501 There are certain @command{gcc} arguments that you cannot use, because they
11502 would produce the wrong kind of output.  These include @option{-g},
11503 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11504 the @var{compilation-options}, they are ignored.
11505
11506 @item -C
11507 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11508 systems) instead of @samp{.c}.  This is convenient if you are converting
11509 a C program to C++.  This option applies only to @code{protoize}.
11510
11511 @item -g
11512 Add explicit global declarations.  This means inserting explicit
11513 declarations at the beginning of each source file for each function
11514 that is called in the file and was not declared.  These declarations
11515 precede the first function definition that contains a call to an
11516 undeclared function.  This option applies only to @code{protoize}.
11517
11518 @item -i @var{string}
11519 Indent old-style parameter declarations with the string @var{string}.
11520 This option applies only to @code{protoize}.
11521
11522 @code{unprotoize} converts prototyped function definitions to old-style
11523 function definitions, where the arguments are declared between the
11524 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11525 uses five spaces as the indentation.  If you want to indent with just
11526 one space instead, use @option{-i " "}.
11527
11528 @item -k
11529 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11530 is finished.
11531
11532 @item -l
11533 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11534 a prototype declaration for each function in each block which calls the
11535 function without any declaration.  This option applies only to
11536 @code{protoize}.
11537
11538 @item -n
11539 Make no real changes.  This mode just prints information about the conversions
11540 that would have been done without @option{-n}.
11541
11542 @item -N
11543 Make no @samp{.save} files.  The original files are simply deleted.
11544 Use this option with caution.
11545
11546 @item -p @var{program}
11547 Use the program @var{program} as the compiler.  Normally, the name
11548 @file{gcc} is used.
11549
11550 @item -q
11551 Work quietly.  Most warnings are suppressed.
11552
11553 @item -v
11554 Print the version number, just like @option{-v} for @command{gcc}.
11555 @end table
11556
11557 If you need special compiler options to compile one of your program's
11558 source files, then you should generate that file's @samp{.X} file
11559 specially, by running @command{gcc} on that source file with the
11560 appropriate options and the option @option{-aux-info}.  Then run
11561 @code{protoize} on the entire set of files.  @code{protoize} will use
11562 the existing @samp{.X} file because it is newer than the source file.
11563 For example:
11564
11565 @smallexample
11566 gcc -Dfoo=bar file1.c -aux-info file1.X
11567 protoize *.c
11568 @end smallexample
11569
11570 @noindent
11571 You need to include the special files along with the rest in the
11572 @code{protoize} command, even though their @samp{.X} files already
11573 exist, because otherwise they won't get converted.
11574
11575 @xref{Protoize Caveats}, for more information on how to use
11576 @code{protoize} successfully.