* configure.in: Remove special pex-cygwin consideration.
[official-gcc.git] / gcc / doc / invoke.texi
blob1826df2d2d05ba21a2738071d8bce693b198503d
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.1 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), 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
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
68 @c man begin DESCRIPTION
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
81 @cindex C compilation options
82 Most of the command line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97 -r}}.
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several options
103 of the same kind; for example, if you specify @option{-L} more than once,
104 the directories are searched in the order specified.
106 Many options have long names starting with @samp{-f} or with
107 @samp{-W}---for example, @option{-fforce-mem},
108 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
109 these have both positive and negative forms; the negative form of
110 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
111 only one of these two forms, whichever one is not the default.
113 @c man end
115 @xref{Option Index}, for an index to GCC's options.
117 @menu
118 * Option Summary::      Brief list of all options, without explanations.
119 * Overall Options::     Controlling the kind of output:
120                         an executable, object files, assembler files,
121                         or preprocessed source.
122 * Invoking G++::        Compiling C++ programs.
123 * C Dialect Options::   Controlling the variant of C language compiled.
124 * C++ Dialect Options:: Variations on C++.
125 * Objective-C Dialect Options:: Variations on Objective-C.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
148 @c man begin OPTIONS
150 @node Option Summary
151 @section Option Summary
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{
160 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
161 -v  -###  --help  --target-help  --version}
163 @item C Language Options
164 @xref{C Dialect Options,,Options Controlling C Dialect}.
165 @gccoptlist{
166 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
167 -fno-asm  -fno-builtin -fno-builtin-@var{function} @gol
168 -fhosted  -ffreestanding  -fms-extensions @gol
169 -trigraphs  -traditional  -traditional-cpp @gol
170 -fallow-single-precision  -fcond-mismatch @gol
171 -fsigned-bitfields  -fsigned-char @gol
172 -funsigned-bitfields  -funsigned-char @gol
173 -fwritable-strings}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{
178 -fabi-version=@var{n} -fno-access-control  -fcheck-new @gol
179 -fconserve-space -fno-const-strings  -fdollars-in-identifiers @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs  -fexternal-templates @gol
182 -falt-external-templates @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
190 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
191 -fno-default-inline -Wabi -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor  -Wreorder @gol
193 -Weffc++  -Wno-deprecated @gol
194 -Wno-non-template-friend  -Wold-style-cast @gol
195 -Woverloaded-virtual  -Wno-pmf-conversions @gol
196 -Wsign-promo  -Wsynth}
198 @item Objective-C Language Options
199 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
203 -Wno-protocol  -Wselector -Wundeclared-selector}
205 @item Language Independent Options
206 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
207 @gccoptlist{
208 -fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{
214 -fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
219 -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wformat-nonliteral  -Wformat-security @gol
221 -Wimplicit  -Wimplicit-int  @gol
222 -Wimplicit-function-declaration @gol
223 -Werror-implicit-function-declaration @gol
224 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces @gol
227 -Wmissing-format-attribute  -Wmissing-noreturn @gol
228 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
229 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
230 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
231 -Wreturn-type  -Wsequence-point  -Wshadow @gol
232 -Wsign-compare  -Wstrict-aliasing @gol
233 -Wswitch  -Wswitch-default -Wswitch-enum @gol
234 -Wsystem-headers -Wtrigraphs  -Wundef  -Wuninitialized @gol
235 -Wunknown-pragmas  -Wunreachable-code @gol
236 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
237 -Wunused-value  -Wunused-variable  -Wwrite-strings}
239 @item C-only Warning Options
240 @gccoptlist{
241 -Wbad-function-cast  -Wmissing-declarations @gol
242 -Wmissing-prototypes  -Wnested-externs @gol
243 -Wstrict-prototypes  -Wtraditional}
245 @item Debugging Options
246 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
247 @gccoptlist{
248 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
249 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
250 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
253 -feliminate-dwarf2-dups  -fmem-report @gol
254 -fprofile-arcs  -fsched-verbose=@var{n} @gol
255 -ftest-coverage  -ftime-report @gol
256 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
257 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
258 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
259 -print-multi-directory  -print-multi-lib @gol
260 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
261 -save-temps  -time}
263 @item Optimization Options
264 @xref{Optimize Options,,Options that Control Optimization}.
265 @gccoptlist{
266 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
267 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
268 -fbounds-check @gol
269 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
270 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
271 -fdelayed-branch  -fdelete-null-pointer-checks @gol
272 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
273 -fforce-addr  -fforce-mem  -ffunction-sections @gol
274 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
275 -fif-conversion -fif-conversion2 @gol
276 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
277 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
278 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
279 -fno-default-inline  -fno-defer-pop @gol
280 -fno-function-cse  -fno-guess-branch-probability @gol
281 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
282 -funsafe-math-optimizations -ffinite-math-only @gol
283 -fno-trapping-math -fno-zero-initialized-in-bss @gol
284 -fomit-frame-pointer  -foptimize-register-move @gol
285 -foptimize-sibling-calls  -fprefetch-loop-arrays @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 -fschedule-insns  -fschedule-insns2 @gol
290 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
291 -fsched-spec-load-dangerous  -fsignaling-nans @gol
292 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
293 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
294 -ftrapv -funroll-all-loops  -funroll-loops  @gol
295 --param @var{name}=@var{value}
296 -O  -O0  -O1  -O2  -O3  -Os}
298 @item Preprocessor Options
299 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
300 @gccoptlist{
301 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
302 -C  -dD  -dI  -dM  -dN @gol
303 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
304 -idirafter @var{dir} @gol
305 -include @var{file}  -imacros @var{file} @gol
306 -iprefix @var{file}  -iwithprefix @var{dir} @gol
307 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
308 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
309 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
311 @item Assembler Option
312 @xref{Assembler Options,,Passing Options to the Assembler}.
313 @gccoptlist{
314 -Wa,@var{option} -Xassembler @var{option}}
316 @item Linker Options
317 @xref{Link Options,,Options for Linking}.
318 @gccoptlist{
319 @var{object-file-name}  -l@var{library} @gol
320 -nostartfiles  -nodefaultlibs  -nostdlib @gol
321 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
322 -Wl,@var{option}  -Xlinker @var{option} @gol
323 -u @var{symbol}}
325 @item Directory Options
326 @xref{Directory Options,,Options for Directory Search}.
327 @gccoptlist{
328 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
330 @item Target Options
331 @c I wrote this xref this way to avoid overfull hbox. -- rms
332 @xref{Target Options}.
333 @gccoptlist{
334 -V @var{version} -b @var{machine}}
336 @item Machine Dependent Options
337 @xref{Submodel Options,,Hardware Models and Configurations}.
339 @emph{M680x0 Options}
340 @gccoptlist{
341 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
342 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
343 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
344 -malign-int  -mstrict-align}
346 @emph{M68hc1x Options}
347 @gccoptlist{
348 -m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
349 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
350 -msoft-reg-count=@var{count}}
352 @emph{VAX Options}
353 @gccoptlist{
354 -mg  -mgnu  -munix}
356 @emph{SPARC Options}
357 @gccoptlist{
358 -mcpu=@var{cpu-type} @gol
359 -mtune=@var{cpu-type} @gol
360 -mcmodel=@var{code-model} @gol
361 -m32  -m64 @gol
362 -mapp-regs  -mbroken-saverestore  -mcypress @gol
363 -mfaster-structs  -mflat @gol
364 -mfpu  -mhard-float  -mhard-quad-float @gol
365 -mimpure-text  -mlive-g0  -mno-app-regs @gol
366 -mno-faster-structs  -mno-flat  -mno-fpu @gol
367 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
368 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
369 -msupersparc  -munaligned-doubles  -mv8}
371 @emph{ARM Options}
372 @gccoptlist{
373 -mapcs-frame  -mno-apcs-frame @gol
374 -mapcs-26  -mapcs-32 @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -malignment-traps  -mno-alignment-traps @gol
381 -msoft-float  -mhard-float  -mfpe @gol
382 -mthumb-interwork  -mno-thumb-interwork @gol
383 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
384 -mstructure-size-boundary=@var{n} @gol
385 -mabort-on-noreturn @gol
386 -mlong-calls  -mno-long-calls @gol
387 -msingle-pic-base  -mno-single-pic-base @gol
388 -mpic-register=@var{reg} @gol
389 -mnop-fun-dllimport @gol
390 -mpoke-function-name @gol
391 -mthumb  -marm @gol
392 -mtpcs-frame  -mtpcs-leaf-frame @gol
393 -mcaller-super-interworking  -mcallee-super-interworking }
395 @emph{MN10200 Options}
396 @gccoptlist{
397 -mrelax}
399 @emph{MN10300 Options}
400 @gccoptlist{
401 -mmult-bug  -mno-mult-bug @gol
402 -mam33  -mno-am33 @gol
403 -mno-crt0  -mrelax}
405 @emph{M32R/D Options}
406 @gccoptlist{
407 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
408 -G @var{num}}
410 @emph{M88K Options}
411 @gccoptlist{
412 -m88000  -m88100  -m88110  -mbig-pic @gol
413 -mcheck-zero-division  -mhandle-large-shift @gol
414 -midentify-revision  -mno-check-zero-division @gol
415 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
416 -mno-optimize-arg-area  -mno-serialize-volatile @gol
417 -mno-underscores  -mocs-debug-info @gol
418 -mocs-frame-position  -moptimize-arg-area @gol
419 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
420 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
421 -mversion-03.00  -mwarn-passed-structs}
423 @emph{RS/6000 and PowerPC Options}
424 @gccoptlist{
425 -mcpu=@var{cpu-type} @gol
426 -mtune=@var{cpu-type} @gol
427 -mpower  -mno-power  -mpower2  -mno-power2 @gol
428 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
429 -maltivec -mno-altivec @gol
430 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
431 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
432 -mnew-mnemonics  -mold-mnemonics @gol
433 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
434 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
435 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
436 -mstring  -mno-string  -mupdate  -mno-update @gol
437 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
438 -mstrict-align  -mno-strict-align  -mrelocatable @gol
439 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
440 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
441 -mcall-aix -mcall-sysv -mcall-netbsd @gol
442 -maix-struct-return -msvr4-struct-return @gol
443 -mabi=altivec -mabi=no-altivec @gol
444 -mabi=spe -mabi=no-spe @gol
445 -misel=yes -misel=no @gol
446 -mprototype  -mno-prototype @gol
447 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
448 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
450 @emph{Darwin Options}
451 @gccoptlist{
452 -all_load -allowable_client -arch -arch_errors_fatal @gol
453 -arch_only -bind_at_load -bundle -bundle_loader @gol
454 -client_name -compatibility_version -current_version @gol
455 -dependency-file -dylib_file -dylinker_install_name @gol
456 -dynamic -dynamiclib -exported_symbols_list @gol
457 -filelist -flat_namespace -force_cpusubtype_ALL @gol
458 -force_flat_namespace -headerpad_max_install_names @gol
459 -image_base -init -install_name -keep_private_externs @gol
460 -multi_module -multiply_defined -multiply_defined_unused @gol
461 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
462 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
463 -private_bundle -read_only_relocs -sectalign @gol
464 -sectobjectsymbols -whyload -seg1addr @gol
465 -sectcreate -sectobjectsymbols -sectorder @gol
466 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
467 -segprot -segs_read_only_addr -segs_read_write_addr @gol
468 -single_module -static -sub_library -sub_umbrella @gol
469 -twolevel_namespace -umbrella -undefined @gol
470 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
472 @emph{RT Options}
473 @gccoptlist{
474 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
475 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
476 -mminimum-fp-blocks  -mnohc-struct-return}
478 @emph{MIPS Options}
479 @gccoptlist{
480 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
481 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
482 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
483 -mgas  -mgp32  -mgp64 @gol
484 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
485 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
486 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
487 -mmips-as  -mmips-tfile  -mno-abicalls @gol
488 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
489 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
490 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
491 -mrnames  -msoft-float @gol
492 -m4650  -msingle-float  -mmad @gol
493 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
494 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
495 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
496 -mbranch-likely -mno-branch-likely}
498 @emph{i386 and x86-64 Options}
499 @gccoptlist{
500 -mcpu=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
501 -masm=@var{dialect}  -mno-fancy-math-387 @gol
502 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
503 -mno-wide-multiply  -mrtd  -malign-double @gol
504 -mpreferred-stack-boundary=@var{num} @gol
505 -mmmx  -msse -msse2 -m3dnow @gol
506 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
507 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
508 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
509 -mno-red-zone@gol
510 -mcmodel=@var{code-model} @gol
511 -m32 -m64}
513 @emph{HPPA Options}
514 @gccoptlist{
515 -march=@var{architecture-type} @gol
516 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
517 -mfast-indirect-calls  -mgas  -mgnu-ld -mhp-ld @gol
518 -mjump-in-delay -mlinker-opt -mlong-calls @gol
519 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
520 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
521 -mno-jump-in-delay  -mno-long-load-store @gol
522 -mno-portable-runtime  -mno-soft-float @gol
523 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
524 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
525 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
527 @emph{Intel 960 Options}
528 @gccoptlist{
529 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
530 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
531 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
532 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
533 -mno-complex-addr  -mno-leaf-procedures @gol
534 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
535 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
536 -mtail-call}
538 @emph{DEC Alpha Options}
539 @gccoptlist{
540 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
541 -mieee  -mieee-with-inexact  -mieee-conformant @gol
542 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
543 -mtrap-precision=@var{mode}  -mbuild-constants @gol
544 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
545 -mbwx  -mmax  -mfix  -mcix @gol
546 -mfloat-vax  -mfloat-ieee @gol
547 -mexplicit-relocs  -msmall-data  -mlarge-data -msmall-text -mlarge-text @gol
548 -mmemory-latency=@var{time}}
550 @emph{DEC Alpha/VMS Options}
551 @gccoptlist{
552 -mvms-return-codes}
554 @emph{H8/300 Options}
555 @gccoptlist{
556 -mrelax  -mh  -ms  -mn  -mint32  -malign-300}
558 @emph{SH Options}
559 @gccoptlist{
560 -m1  -m2  -m2e  -m3  -m3e @gol
561 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
562 -m5-64media -m5-64media-nofpu @gol
563 -m5-32media -m5-32media-nofpu @gol
564 -m5-compact -m5-compact-nofpu @gol
565 -mb  -ml  -mdalign  -mrelax @gol
566 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
567 -mieee  -misize  -mpadstruct  -mspace @gol
568 -mprefergot  -musermode}
570 @emph{System V Options}
571 @gccoptlist{
572 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
574 @emph{ARC Options}
575 @gccoptlist{
576 -EB  -EL @gol
577 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
578 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
580 @emph{TMS320C3x/C4x Options}
581 @gccoptlist{
582 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
583 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
584 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
585 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
587 @emph{V850 Options}
588 @gccoptlist{
589 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
590 -mprolog-function  -mno-prolog-function  -mspace @gol
591 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
592 -mapp-regs -mno-app-regs @gol
593 -mdisable-callt -mno-disable-callt @gol
594 -mv850e @gol
595 -mv850  -mbig-switch}
597 @emph{NS32K Options}
598 @gccoptlist{
599 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
600 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
601 -mregparam  -mnoregparam  -msb  -mnosb @gol
602 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
604 @emph{AVR Options}
605 @gccoptlist{
606 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
607 -mcall-prologues  -mno-tablejump  -mtiny-stack}
609 @emph{MCore Options}
610 @gccoptlist{
611 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
612 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
613 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
614 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
615 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
617 @emph{MMIX Options}
618 @gccoptlist{
619 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
620 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
621 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
622 -mno-base-addresses -msingle-exit -mno-single-exit}
624 @emph{IA-64 Options}
625 @gccoptlist{
626 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
627 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
628 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
629 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
630 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
631 -mfixed-range=@var{register-range}}
633 @emph{D30V Options}
634 @gccoptlist{
635 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
636 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
638 @emph{S/390 and zSeries Options}
639 @gccoptlist{
640 -mtune=@var{cpu-type} -march=@var{cpu-type} @gol
641 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
642 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
643 -m64 -m31 -mdebug -mno-debug -mesa -mzarch}
645 @emph{CRIS Options}
646 @gccoptlist{
647 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
648 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
649 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
650 -mstack-align -mdata-align -mconst-align @gol
651 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
652 -melf -maout -melinux -mlinux -sim -sim2}
654 @emph{PDP-11 Options}
655 @gccoptlist{
656 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
657 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
658 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
659 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
660 -mbranch-expensive  -mbranch-cheap @gol
661 -msplit  -mno-split  -munix-asm  -mdec-asm}
663 @emph{Xstormy16 Options}
664 @gccoptlist{
665 -msim}
667 @emph{Xtensa Options}
668 @gccoptlist{
669 -mbig-endian -mlittle-endian @gol
670 -mdensity -mno-density @gol
671 -mmac16 -mno-mac16 @gol
672 -mmul16 -mno-mul16 @gol
673 -mmul32 -mno-mul32 @gol
674 -mnsa -mno-nsa @gol
675 -mminmax -mno-minmax @gol
676 -msext -mno-sext @gol
677 -mbooleans -mno-booleans @gol
678 -mhard-float -msoft-float @gol
679 -mfused-madd -mno-fused-madd @gol
680 -mserialize-volatile -mno-serialize-volatile @gol
681 -mtext-section-literals -mno-text-section-literals @gol
682 -mtarget-align -mno-target-align @gol
683 -mlongcalls -mno-longcalls}
685 @emph{FRV Options}
686 @gccoptlist{
687 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
688 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
689 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
690 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
691 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
692 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
693 -mno-nested-cond-exec -mtomcat-stats @gol
694 -mcpu=@var{cpu}}
698 @item Code Generation Options
699 @xref{Code Gen Options,,Options for Code Generation Conventions}.
700 @gccoptlist{
701 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
702 -ffixed-@var{reg} -fexceptions @gol
703 -fnon-call-exceptions  -funwind-tables @gol
704 -fasynchronous-unwind-tables @gol
705 -finhibit-size-directive  -finstrument-functions @gol
706 -fno-common  -fno-ident  -fno-gnu-linker @gol
707 -fpcc-struct-return  -fpic  -fPIC @gol
708 -freg-struct-return  -fshared-data  -fshort-enums @gol
709 -fshort-double  -fshort-wchar -fvolatile @gol
710 -fvolatile-global  -fvolatile-static @gol
711 -fverbose-asm  -fpack-struct  -fstack-check @gol
712 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
713 -fargument-alias  -fargument-noalias @gol
714 -fargument-noalias-global  -fleading-underscore @gol
715 -ftls-model=@var{model}}
716 @end table
718 @menu
719 * Overall Options::     Controlling the kind of output:
720                         an executable, object files, assembler files,
721                         or preprocessed source.
722 * C Dialect Options::   Controlling the variant of C language compiled.
723 * C++ Dialect Options:: Variations on C++.
724 * Objective-C Dialect Options:: Variations on Objective-C.
725 * Language Independent Options:: Controlling how diagnostics should be
726                         formatted.
727 * Warning Options::     How picky should the compiler be?
728 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
729 * Optimize Options::    How much optimization?
730 * Preprocessor Options:: Controlling header files and macro definitions.
731                          Also, getting dependency information for Make.
732 * Assembler Options::   Passing options to the assembler.
733 * Link Options::        Specifying libraries and so on.
734 * Directory Options::   Where to find header files and libraries.
735                         Where to find the compiler executable files.
736 * Spec Files::          How to pass switches to sub-processes.
737 * Target Options::      Running a cross-compiler, or an old version of GCC.
738 @end menu
740 @node Overall Options
741 @section Options Controlling the Kind of Output
743 Compilation can involve up to four stages: preprocessing, compilation
744 proper, assembly and linking, always in that order.  The first three
745 stages apply to an individual source file, and end by producing an
746 object file; linking combines all the object files (those newly
747 compiled, and those specified as input) into an executable file.
749 @cindex file name suffix
750 For any given input file, the file name suffix determines what kind of
751 compilation is done:
753 @table @gcctabopt
754 @item @var{file}.c
755 C source code which must be preprocessed.
757 @item @var{file}.i
758 C source code which should not be preprocessed.
760 @item @var{file}.ii
761 C++ source code which should not be preprocessed.
763 @item @var{file}.m
764 Objective-C source code.  Note that you must link with the library
765 @file{libobjc.a} to make an Objective-C program work.
767 @item @var{file}.mi
768 Objective-C source code which should not be preprocessed.
770 @item @var{file}.h
771 C or C++ header file to be turned into a precompiled header.
773 @item @var{file}.cc
774 @itemx @var{file}.cp
775 @itemx @var{file}.cxx
776 @itemx @var{file}.cpp
777 @itemx @var{file}.CPP
778 @itemx @var{file}.c++
779 @itemx @var{file}.C
780 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
781 the last two letters must both be literally @samp{x}.  Likewise,
782 @samp{.C} refers to a literal capital C@.
784 @item @var{file}.hh
785 @itemx @var{file}.H
786 C++ header file to be turned into a precompiled header.
788 @item @var{file}.f
789 @itemx @var{file}.for
790 @itemx @var{file}.FOR
791 Fortran source code which should not be preprocessed.
793 @item @var{file}.F
794 @itemx @var{file}.fpp
795 @itemx @var{file}.FPP
796 Fortran source code which must be preprocessed (with the traditional
797 preprocessor).
799 @item @var{file}.r
800 Fortran source code which must be preprocessed with a RATFOR
801 preprocessor (not included with GCC)@.
803 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
804 Using and Porting GNU Fortran}, for more details of the handling of
805 Fortran input files.
807 @c FIXME: Descriptions of Java file types.
808 @c @var{file}.java
809 @c @var{file}.class
810 @c @var{file}.zip
811 @c @var{file}.jar
813 @item @var{file}.ads
814 Ada source code file which contains a library unit declaration (a
815 declaration of a package, subprogram, or generic, or a generic
816 instantiation), or a library unit renaming declaration (a package,
817 generic, or subprogram renaming declaration).  Such files are also
818 called @dfn{specs}.
820 @itemx @var{file}.adb
821 Ada source code file containing a library unit body (a subprogram or
822 package body).  Such files are also called @dfn{bodies}.
824 @c GCC also knows about some suffixes for languages not yet included:
825 @c Pascal:
826 @c @var{file}.p
827 @c @var{file}.pas
829 @item @var{file}.s
830 Assembler code.
832 @item @var{file}.S
833 Assembler code which must be preprocessed.
835 @item @var{other}
836 An object file to be fed straight into linking.
837 Any file name with no recognized suffix is treated this way.
838 @end table
840 @opindex x
841 You can specify the input language explicitly with the @option{-x} option:
843 @table @gcctabopt
844 @item -x @var{language}
845 Specify explicitly the @var{language} for the following input files
846 (rather than letting the compiler choose a default based on the file
847 name suffix).  This option applies to all following input files until
848 the next @option{-x} option.  Possible values for @var{language} are:
849 @example
850 c  c-header  cpp-output
851 c++  c++-header  c++-cpp-output
852 objective-c  objc-cpp-output
853 assembler  assembler-with-cpp
855 f77  f77-cpp-input  ratfor
856 java
857 treelang
858 @end example
860 @item -x none
861 Turn off any specification of a language, so that subsequent files are
862 handled according to their file name suffixes (as they are if @option{-x}
863 has not been used at all).
865 @item -pass-exit-codes
866 @opindex pass-exit-codes
867 Normally the @command{gcc} program will exit with the code of 1 if any
868 phase of the compiler returns a non-success return code.  If you specify
869 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
870 numerically highest error produced by any phase that returned an error
871 indication.
872 @end table
874 If you only want some of the stages of compilation, you can use
875 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
876 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
877 @command{gcc} is to stop.  Note that some combinations (for example,
878 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
880 @table @gcctabopt
881 @item -c
882 @opindex c
883 Compile or assemble the source files, but do not link.  The linking
884 stage simply is not done.  The ultimate output is in the form of an
885 object file for each source file.
887 By default, the object file name for a source file is made by replacing
888 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
890 Unrecognized input files, not requiring compilation or assembly, are
891 ignored.
893 @item -S
894 @opindex S
895 Stop after the stage of compilation proper; do not assemble.  The output
896 is in the form of an assembler code file for each non-assembler input
897 file specified.
899 By default, the assembler file name for a source file is made by
900 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
902 Input files that don't require compilation are ignored.
904 @item -E
905 @opindex E
906 Stop after the preprocessing stage; do not run the compiler proper.  The
907 output is in the form of preprocessed source code, which is sent to the
908 standard output.
910 Input files which don't require preprocessing are ignored.
912 @cindex output file option
913 @item -o @var{file}
914 @opindex o
915 Place output in file @var{file}.  This applies regardless to whatever
916 sort of output is being produced, whether it be an executable file,
917 an object file, an assembler file or preprocessed C code.
919 Since only one output file can be specified, it does not make sense to
920 use @option{-o} when compiling more than one input file, unless you are
921 producing an executable file as output.
923 If @option{-o} is not specified, the default is to put an executable file
924 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
925 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
926 all preprocessed C source on standard output.
928 @item -v
929 @opindex v
930 Print (on standard error output) the commands executed to run the stages
931 of compilation.  Also print the version number of the compiler driver
932 program and of the preprocessor and the compiler proper.
934 @item -###
935 @opindex ###
936 Like @option{-v} except the commands are not executed and all command
937 arguments are quoted.  This is useful for shell scripts to capture the
938 driver-generated command lines.
940 @item -pipe
941 @opindex pipe
942 Use pipes rather than temporary files for communication between the
943 various stages of compilation.  This fails to work on some systems where
944 the assembler is unable to read from a pipe; but the GNU assembler has
945 no trouble.
947 @item --help
948 @opindex help
949 Print (on the standard output) a description of the command line options
950 understood by @command{gcc}.  If the @option{-v} option is also specified
951 then @option{--help} will also be passed on to the various processes
952 invoked by @command{gcc}, so that they can display the command line options
953 they accept.  If the @option{-Wextra} option is also specified then command
954 line options which have no documentation associated with them will also
955 be displayed.
957 @item --target-help
958 @opindex target-help
959 Print (on the standard output) a description of target specific command
960 line options for each tool.
962 @item --version
963 @opindex version
964 Display the version number and copyrights of the invoked GCC.
965 @end table
967 @node Invoking G++
968 @section Compiling C++ Programs
970 @cindex suffixes for C++ source
971 @cindex C++ source file suffixes
972 C++ source files conventionally use one of the suffixes @samp{.C},
973 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
974 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
975 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
976 files with these names and compiles them as C++ programs even if you
977 call the compiler the same way as for compiling C programs (usually
978 with the name @command{gcc}).
980 @findex g++
981 @findex c++
982 However, C++ programs often require class libraries as well as a
983 compiler that understands the C++ language---and under some
984 circumstances, you might want to compile programs or header files from
985 standard input, or otherwise without a suffix that flags them as C++
986 programs.  You might also like to precompile a C header file with a
987 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
988 program that calls GCC with the default language set to C++, and
989 automatically specifies linking against the C++ library.  On many
990 systems, @command{g++} is also installed with the name @command{c++}.
992 @cindex invoking @command{g++}
993 When you compile C++ programs, you may specify many of the same
994 command-line options that you use for compiling programs in any
995 language; or command-line options meaningful for C and related
996 languages; or options that are meaningful only for C++ programs.
997 @xref{C Dialect Options,,Options Controlling C Dialect}, for
998 explanations of options for languages related to C@.
999 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1000 explanations of options that are meaningful only for C++ programs.
1002 @node C Dialect Options
1003 @section Options Controlling C Dialect
1004 @cindex dialect options
1005 @cindex language dialect options
1006 @cindex options, dialect
1008 The following options control the dialect of C (or languages derived
1009 from C, such as C++ and Objective-C) that the compiler accepts:
1011 @table @gcctabopt
1012 @cindex ANSI support
1013 @cindex ISO support
1014 @item -ansi
1015 @opindex ansi
1016 In C mode, support all ISO C90 programs.  In C++ mode,
1017 remove GNU extensions that conflict with ISO C++.
1019 This turns off certain features of GCC that are incompatible with ISO
1020 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1021 such as the @code{asm} and @code{typeof} keywords, and
1022 predefined macros such as @code{unix} and @code{vax} that identify the
1023 type of system you are using.  It also enables the undesirable and
1024 rarely used ISO trigraph feature.  For the C compiler,
1025 it disables recognition of C++ style @samp{//} comments as well as
1026 the @code{inline} keyword.
1028 The alternate keywords @code{__asm__}, @code{__extension__},
1029 @code{__inline__} and @code{__typeof__} continue to work despite
1030 @option{-ansi}.  You would not want to use them in an ISO C program, of
1031 course, but it is useful to put them in header files that might be included
1032 in compilations done with @option{-ansi}.  Alternate predefined macros
1033 such as @code{__unix__} and @code{__vax__} are also available, with or
1034 without @option{-ansi}.
1036 The @option{-ansi} option does not cause non-ISO programs to be
1037 rejected gratuitously.  For that, @option{-pedantic} is required in
1038 addition to @option{-ansi}.  @xref{Warning Options}.
1040 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1041 option is used.  Some header files may notice this macro and refrain
1042 from declaring certain functions or defining certain macros that the
1043 ISO standard doesn't call for; this is to avoid interfering with any
1044 programs that might use these names for other things.
1046 Functions which would normally be built in but do not have semantics
1047 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1048 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1049 built-in functions provided by GCC}, for details of the functions
1050 affected.
1052 @item -std=
1053 @opindex std
1054 Determine the language standard.  This option is currently only
1055 supported when compiling C or C++.  A value for this option must be
1056 provided; possible values are
1058 @table @samp
1059 @item c89
1060 @itemx iso9899:1990
1061 ISO C90 (same as @option{-ansi}).
1063 @item iso9899:199409
1064 ISO C90 as modified in amendment 1.
1066 @item c99
1067 @itemx c9x
1068 @itemx iso9899:1999
1069 @itemx iso9899:199x
1070 ISO C99.  Note that this standard is not yet fully supported; see
1071 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1072 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1074 @item gnu89
1075 Default, ISO C90 plus GNU extensions (including some C99 features).
1077 @item gnu99
1078 @item gnu9x
1079 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1080 this will become the default.  The name @samp{gnu9x} is deprecated.
1082 @item c++98
1083 The 1998 ISO C++ standard plus amendments.
1085 @item gnu++98
1086 The same as @option{-std=c++98} plus GNU extensions.  This is the
1087 default for C++ code.
1088 @end table
1090 Even when this option is not specified, you can still use some of the
1091 features of newer standards in so far as they do not conflict with
1092 previous C standards.  For example, you may use @code{__restrict__} even
1093 when @option{-std=c99} is not specified.
1095 The @option{-std} options specifying some version of ISO C have the same
1096 effects as @option{-ansi}, except that features that were not in ISO C90
1097 but are in the specified version (for example, @samp{//} comments and
1098 the @code{inline} keyword in ISO C99) are not disabled.
1100 @xref{Standards,,Language Standards Supported by GCC}, for details of
1101 these standard versions.
1103 @item -aux-info @var{filename}
1104 @opindex aux-info
1105 Output to the given filename prototyped declarations for all functions
1106 declared and/or defined in a translation unit, including those in header
1107 files.  This option is silently ignored in any language other than C@.
1109 Besides declarations, the file indicates, in comments, the origin of
1110 each declaration (source file and line), whether the declaration was
1111 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1112 @samp{O} for old, respectively, in the first character after the line
1113 number and the colon), and whether it came from a declaration or a
1114 definition (@samp{C} or @samp{F}, respectively, in the following
1115 character).  In the case of function definitions, a K&R-style list of
1116 arguments followed by their declarations is also provided, inside
1117 comments, after the declaration.
1119 @item -fno-asm
1120 @opindex fno-asm
1121 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1122 keyword, so that code can use these words as identifiers.  You can use
1123 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1124 instead.  @option{-ansi} implies @option{-fno-asm}.
1126 In C++, this switch only affects the @code{typeof} keyword, since
1127 @code{asm} and @code{inline} are standard keywords.  You may want to
1128 use the @option{-fno-gnu-keywords} flag instead, which has the same
1129 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1130 switch only affects the @code{asm} and @code{typeof} keywords, since
1131 @code{inline} is a standard keyword in ISO C99.
1133 @item -fno-builtin
1134 @itemx -fno-builtin-@var{function}
1135 @opindex fno-builtin
1136 @cindex built-in functions
1137 Don't recognize built-in functions that do not begin with
1138 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1139 functions provided by GCC}, for details of the functions affected,
1140 including those which are not built-in functions when @option{-ansi} or
1141 @option{-std} options for strict ISO C conformance are used because they
1142 do not have an ISO standard meaning.
1144 GCC normally generates special code to handle certain built-in functions
1145 more efficiently; for instance, calls to @code{alloca} may become single
1146 instructions that adjust the stack directly, and calls to @code{memcpy}
1147 may become inline copy loops.  The resulting code is often both smaller
1148 and faster, but since the function calls no longer appear as such, you
1149 cannot set a breakpoint on those calls, nor can you change the behavior
1150 of the functions by linking with a different library.
1152 With the @option{-fno-builtin-@var{function}} option
1153 only the built-in function @var{function} is
1154 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1155 function is named this is not built-in in this version of GCC, this
1156 option is ignored.  There is no corresponding
1157 @option{-fbuiltin-@var{function}} option; if you wish to enable
1158 built-in functions selectively when using @option{-fno-builtin} or
1159 @option{-ffreestanding}, you may define macros such as:
1161 @smallexample
1162 #define abs(n)          __builtin_abs ((n))
1163 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1164 @end smallexample
1166 @item -fhosted
1167 @opindex fhosted
1168 @cindex hosted environment
1170 Assert that compilation takes place in a hosted environment.  This implies
1171 @option{-fbuiltin}.  A hosted environment is one in which the
1172 entire standard library is available, and in which @code{main} has a return
1173 type of @code{int}.  Examples are nearly everything except a kernel.
1174 This is equivalent to @option{-fno-freestanding}.
1176 @item -ffreestanding
1177 @opindex ffreestanding
1178 @cindex hosted environment
1180 Assert that compilation takes place in a freestanding environment.  This
1181 implies @option{-fno-builtin}.  A freestanding environment
1182 is one in which the standard library may not exist, and program startup may
1183 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1184 This is equivalent to @option{-fno-hosted}.
1186 @xref{Standards,,Language Standards Supported by GCC}, for details of
1187 freestanding and hosted environments.
1189 @item -fms-extensions
1190 @opindex fms-extensions
1191 Accept some non-standard constructs used in Microsoft header files.
1193 @item -trigraphs
1194 @opindex trigraphs
1195 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1196 options for strict ISO C conformance) implies @option{-trigraphs}.
1198 @cindex traditional C language
1199 @cindex C language, traditional
1200 @item -traditional
1201 @itemx -traditional-cpp
1202 @opindex traditional-cpp
1203 @opindex traditional
1204 Formerly, these options caused GCC to attempt to emulate a pre-standard
1205 C compiler.  They are now only supported with the @option{-E} switch.
1206 The preprocessor continues to support a pre-standard mode.  See the GNU
1207 CPP manual for details.
1209 @item -fcond-mismatch
1210 @opindex fcond-mismatch
1211 Allow conditional expressions with mismatched types in the second and
1212 third arguments.  The value of such an expression is void.  This option
1213 is not supported for C++.
1215 @item -funsigned-char
1216 @opindex funsigned-char
1217 Let the type @code{char} be unsigned, like @code{unsigned char}.
1219 Each kind of machine has a default for what @code{char} should
1220 be.  It is either like @code{unsigned char} by default or like
1221 @code{signed char} by default.
1223 Ideally, a portable program should always use @code{signed char} or
1224 @code{unsigned char} when it depends on the signedness of an object.
1225 But many programs have been written to use plain @code{char} and
1226 expect it to be signed, or expect it to be unsigned, depending on the
1227 machines they were written for.  This option, and its inverse, let you
1228 make such a program work with the opposite default.
1230 The type @code{char} is always a distinct type from each of
1231 @code{signed char} or @code{unsigned char}, even though its behavior
1232 is always just like one of those two.
1234 @item -fsigned-char
1235 @opindex fsigned-char
1236 Let the type @code{char} be signed, like @code{signed char}.
1238 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1239 the negative form of @option{-funsigned-char}.  Likewise, the option
1240 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1242 @item -fsigned-bitfields
1243 @itemx -funsigned-bitfields
1244 @itemx -fno-signed-bitfields
1245 @itemx -fno-unsigned-bitfields
1246 @opindex fsigned-bitfields
1247 @opindex funsigned-bitfields
1248 @opindex fno-signed-bitfields
1249 @opindex fno-unsigned-bitfields
1250 These options control whether a bit-field is signed or unsigned, when the
1251 declaration does not use either @code{signed} or @code{unsigned}.  By
1252 default, such a bit-field is signed, because this is consistent: the
1253 basic integer types such as @code{int} are signed types.
1255 @item -fwritable-strings
1256 @opindex fwritable-strings
1257 Store string constants in the writable data segment and don't uniquize
1258 them.  This is for compatibility with old programs which assume they can
1259 write into string constants.
1261 Writing into string constants is a very bad idea; ``constants'' should
1262 be constant.
1263 @end table
1265 @node C++ Dialect Options
1266 @section Options Controlling C++ Dialect
1268 @cindex compiler options, C++
1269 @cindex C++ options, command line
1270 @cindex options, C++
1271 This section describes the command-line options that are only meaningful
1272 for C++ programs; but you can also use most of the GNU compiler options
1273 regardless of what language your program is in.  For example, you
1274 might compile a file @code{firstClass.C} like this:
1276 @example
1277 g++ -g -frepo -O -c firstClass.C
1278 @end example
1280 @noindent
1281 In this example, only @option{-frepo} is an option meant
1282 only for C++ programs; you can use the other options with any
1283 language supported by GCC@.
1285 Here is a list of options that are @emph{only} for compiling C++ programs:
1287 @table @gcctabopt
1289 @item -fabi-version=@var{n}
1290 @opindex fabi-version
1291 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1292 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1293 version that conforms most closely to the C++ ABI specification.
1294 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1295 fixed.
1297 The default is version 1.
1299 @item -fno-access-control
1300 @opindex fno-access-control
1301 Turn off all access checking.  This switch is mainly useful for working
1302 around bugs in the access control code.
1304 @item -fcheck-new
1305 @opindex fcheck-new
1306 Check that the pointer returned by @code{operator new} is non-null
1307 before attempting to modify the storage allocated.  The current Working
1308 Paper requires that @code{operator new} never return a null pointer, so
1309 this check is normally unnecessary.
1311 An alternative to using this option is to specify that your
1312 @code{operator new} does not throw any exceptions; if you declare it
1313 @samp{throw()}, G++ will check the return value.  See also @samp{new
1314 (nothrow)}.
1316 @item -fconserve-space
1317 @opindex fconserve-space
1318 Put uninitialized or runtime-initialized global variables into the
1319 common segment, as C does.  This saves space in the executable at the
1320 cost of not diagnosing duplicate definitions.  If you compile with this
1321 flag and your program mysteriously crashes after @code{main()} has
1322 completed, you may have an object that is being destroyed twice because
1323 two definitions were merged.
1325 This option is no longer useful on most targets, now that support has
1326 been added for putting variables into BSS without making them common.
1328 @item -fno-const-strings
1329 @opindex fno-const-strings
1330 Give string constants type @code{char *} instead of type @code{const
1331 char *}.  By default, G++ uses type @code{const char *} as required by
1332 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1333 actually modify the value of a string constant, unless you also use
1334 @option{-fwritable-strings}.
1336 This option might be removed in a future release of G++.  For maximum
1337 portability, you should structure your code so that it works with
1338 string constants that have type @code{const char *}.
1340 @item -fdollars-in-identifiers
1341 @opindex fdollars-in-identifiers
1342 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1343 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1344 @samp{$} by default on most target systems, but there are a few exceptions.)
1345 Traditional C allowed the character @samp{$} to form part of
1346 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1348 @item -fno-elide-constructors
1349 @opindex fno-elide-constructors
1350 The C++ standard allows an implementation to omit creating a temporary
1351 which is only used to initialize another object of the same type.
1352 Specifying this option disables that optimization, and forces G++ to
1353 call the copy constructor in all cases.
1355 @item -fno-enforce-eh-specs
1356 @opindex fno-enforce-eh-specs
1357 Don't check for violation of exception specifications at runtime.  This
1358 option violates the C++ standard, but may be useful for reducing code
1359 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1360 will still optimize based on the exception specifications.
1362 @item -fexternal-templates
1363 @opindex fexternal-templates
1365 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1366 template instantiation; template instances are emitted or not according
1367 to the location of the template definition.  @xref{Template
1368 Instantiation}, for more information.
1370 This option is deprecated.
1372 @item -falt-external-templates
1373 @opindex falt-external-templates
1374 Similar to @option{-fexternal-templates}, but template instances are
1375 emitted or not according to the place where they are first instantiated.
1376 @xref{Template Instantiation}, for more information.
1378 This option is deprecated.
1380 @item -ffor-scope
1381 @itemx -fno-for-scope
1382 @opindex ffor-scope
1383 @opindex fno-for-scope
1384 If @option{-ffor-scope} is specified, the scope of variables declared in
1385 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1386 as specified by the C++ standard.
1387 If @option{-fno-for-scope} is specified, the scope of variables declared in
1388 a @i{for-init-statement} extends to the end of the enclosing scope,
1389 as was the case in old versions of G++, and other (traditional)
1390 implementations of C++.
1392 The default if neither flag is given to follow the standard,
1393 but to allow and give a warning for old-style code that would
1394 otherwise be invalid, or have different behavior.
1396 @item -fno-gnu-keywords
1397 @opindex fno-gnu-keywords
1398 Do not recognize @code{typeof} as a keyword, so that code can use this
1399 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1400 @option{-ansi} implies @option{-fno-gnu-keywords}.
1402 @item -fno-implicit-templates
1403 @opindex fno-implicit-templates
1404 Never emit code for non-inline templates which are instantiated
1405 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1406 @xref{Template Instantiation}, for more information.
1408 @item -fno-implicit-inline-templates
1409 @opindex fno-implicit-inline-templates
1410 Don't emit code for implicit instantiations of inline templates, either.
1411 The default is to handle inlines differently so that compiles with and
1412 without optimization will need the same set of explicit instantiations.
1414 @item -fno-implement-inlines
1415 @opindex fno-implement-inlines
1416 To save space, do not emit out-of-line copies of inline functions
1417 controlled by @samp{#pragma implementation}.  This will cause linker
1418 errors if these functions are not inlined everywhere they are called.
1420 @item -fms-extensions
1421 @opindex fms-extensions
1422 Disable pedantic warnings about constructs used in MFC, such as implicit
1423 int and getting a pointer to member function via non-standard syntax.
1425 @item -fno-nonansi-builtins
1426 @opindex fno-nonansi-builtins
1427 Disable built-in declarations of functions that are not mandated by
1428 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1429 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1431 @item -fno-operator-names
1432 @opindex fno-operator-names
1433 Do not treat the operator name keywords @code{and}, @code{bitand},
1434 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1435 synonyms as keywords.
1437 @item -fno-optional-diags
1438 @opindex fno-optional-diags
1439 Disable diagnostics that the standard says a compiler does not need to
1440 issue.  Currently, the only such diagnostic issued by G++ is the one for
1441 a name having multiple meanings within a class.
1443 @item -fpermissive
1444 @opindex fpermissive
1445 Downgrade messages about nonconformant code from errors to warnings.  By
1446 default, G++ effectively sets @option{-pedantic-errors} without
1447 @option{-pedantic}; this option reverses that.  This behavior and this
1448 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1450 @item -frepo
1451 @opindex frepo
1452 Enable automatic template instantiation at link time.  This option also
1453 implies @option{-fno-implicit-templates}.  @xref{Template
1454 Instantiation}, for more information.
1456 @item -fno-rtti
1457 @opindex fno-rtti
1458 Disable generation of information about every class with virtual
1459 functions for use by the C++ runtime type identification features
1460 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1461 of the language, you can save some space by using this flag.  Note that
1462 exception handling uses the same information, but it will generate it as
1463 needed.
1465 @item -fstats
1466 @opindex fstats
1467 Emit statistics about front-end processing at the end of the compilation.
1468 This information is generally only useful to the G++ development team.
1470 @item -ftemplate-depth-@var{n}
1471 @opindex ftemplate-depth
1472 Set the maximum instantiation depth for template classes to @var{n}.
1473 A limit on the template instantiation depth is needed to detect
1474 endless recursions during template class instantiation.  ANSI/ISO C++
1475 conforming programs must not rely on a maximum depth greater than 17.
1477 @item -fuse-cxa-atexit
1478 @opindex fuse-cxa-atexit
1479 Register destructors for objects with static storage duration with the
1480 @code{__cxa_atexit} function rather than the @code{atexit} function.
1481 This option is required for fully standards-compliant handling of static
1482 destructors, but will only work if your C library supports
1483 @code{__cxa_atexit}.
1485 @item -fvtable-gc
1486 @opindex fvtable-gc
1487 Emit special relocations for vtables and virtual function references
1488 so that the linker can identify unused virtual functions and zero out
1489 vtable slots that refer to them.  This is most useful with
1490 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1491 also discard the functions themselves.
1493 This optimization requires GNU as and GNU ld.  Not all systems support
1494 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1496 @item -fno-weak
1497 @opindex fno-weak
1498 Do not use weak symbol support, even if it is provided by the linker.
1499 By default, G++ will use weak symbols if they are available.  This
1500 option exists only for testing, and should not be used by end-users;
1501 it will result in inferior code and has no benefits.  This option may
1502 be removed in a future release of G++.
1504 @item -nostdinc++
1505 @opindex nostdinc++
1506 Do not search for header files in the standard directories specific to
1507 C++, but do still search the other standard directories.  (This option
1508 is used when building the C++ library.)
1509 @end table
1511 In addition, these optimization, warning, and code generation options
1512 have meanings only for C++ programs:
1514 @table @gcctabopt
1515 @item -fno-default-inline
1516 @opindex fno-default-inline
1517 Do not assume @samp{inline} for functions defined inside a class scope.
1518 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1519 functions will have linkage like inline functions; they just won't be
1520 inlined by default.
1522 @item -Wabi @r{(C++ only)}
1523 @opindex Wabi
1524 Warn when G++ generates code that is probably not compatible with the
1525 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1526 all such cases, there are probably some cases that are not warned about, 
1527 even though G++ is generating incompatible code.  There may also be
1528 cases where warnings are emitted even though the code that is generated
1529 will be compatible.
1531 You should rewrite your code to avoid these warnings if you are
1532 concerned about the fact that code generated by G++ may not be binary
1533 compatible with code generated by other compilers.
1535 The known incompatibilities at this point include:
1537 @itemize @bullet
1539 @item
1540 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1541 pack data into the same byte as a base class.  For example:
1543 @smallexample
1544 struct A @{ virtual void f(); int f1 : 1; @};
1545 struct B : public A @{ int f2 : 1; @};
1546 @end smallexample
1548 @noindent
1549 In this case, G++ will place @code{B::f2} into the same byte
1550 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1551 by explicitly padding @code{A} so that its size is a multiple of the
1552 byte size on your platform; that will cause G++ and other compilers to
1553 layout @code{B} identically.
1555 @item
1556 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1557 tail padding when laying out virtual bases.  For example:
1559 @smallexample
1560 struct A @{ virtual void f(); char c1; @};
1561 struct B @{ B(); char c2; @};
1562 struct C : public A, public virtual B @{@};
1563 @end smallexample
1565 @noindent
1566 In this case, G++ will not place @code{B} into the tail-padding for
1567 @code{A}; other compilers will.  You can avoid this problem by
1568 explicitly padding @code{A} so that its size is a multiple of its
1569 alignment (ignoring virtual base classes); that will cause G++ and other
1570 compilers to layout @code{C} identically.
1572 @item
1573 Incorrect handling of bit-fields with declared widths greater than that
1574 of their underlying types, when the bit-fields appear in a union.  For
1575 example:
1577 @smallexample
1578 union U @{ int i : 4096; @};
1579 @end smallexample
1581 @noindent
1582 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1583 union too small by the number of bits in an @code{int}.
1585 @item
1586 Empty classes can be placed at incorrect offsets.  For example:
1588 @smallexample
1589 struct A @{@};
1591 struct B @{
1592   A a;
1593   virtual void f ();
1596 struct C : public B, public A @{@};
1597 @end smallexample
1599 @noindent
1600 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1601 it should be placed at offset zero.  G++ mistakenly believes that the
1602 @code{A} data member of @code{B} is already at offset zero.
1604 @item
1605 Names of template functions whose types involve @code{typename} or
1606 template template parameters can be mangled incorrectly.
1608 @smallexample
1609 template <typename Q>
1610 void f(typename Q::X) @{@}
1612 template <template <typename> class Q>
1613 void f(typename Q<int>::X) @{@}
1614 @end smallexample
1616 @noindent
1617 Instantiations of these templates may be mangled incorrectly.
1619 @end itemize
1621 @item -Wctor-dtor-privacy @r{(C++ only)}
1622 @opindex Wctor-dtor-privacy
1623 Warn when a class seems unusable, because all the constructors or
1624 destructors in a class are private and the class has no friends or
1625 public static member functions.  This warning is enabled by default.
1627 @item -Wnon-virtual-dtor @r{(C++ only)}
1628 @opindex Wnon-virtual-dtor
1629 Warn when a class declares a non-virtual destructor that should probably
1630 be virtual, because it looks like the class will be used polymorphically.
1631 This warning is enabled by @option{-Wall}.
1633 @item -Wreorder @r{(C++ only)}
1634 @opindex Wreorder
1635 @cindex reordering, warning
1636 @cindex warning for reordering of member initializers
1637 Warn when the order of member initializers given in the code does not
1638 match the order in which they must be executed.  For instance:
1640 @smallexample
1641 struct A @{
1642   int i;
1643   int j;
1644   A(): j (0), i (1) @{ @}
1646 @end smallexample
1648 Here the compiler will warn that the member initializers for @samp{i}
1649 and @samp{j} will be rearranged to match the declaration order of the
1650 members.  This warning is enabled by @option{-Wall}.
1651 @end table
1653 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1655 @table @gcctabopt
1656 @item -Weffc++ @r{(C++ only)}
1657 @opindex Weffc++
1658 Warn about violations of the following style guidelines from Scott Meyers'
1659 @cite{Effective C++} book:
1661 @itemize @bullet
1662 @item
1663 Item 11:  Define a copy constructor and an assignment operator for classes
1664 with dynamically allocated memory.
1666 @item
1667 Item 12:  Prefer initialization to assignment in constructors.
1669 @item
1670 Item 14:  Make destructors virtual in base classes.
1672 @item
1673 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1675 @item
1676 Item 23:  Don't try to return a reference when you must return an object.
1678 @end itemize
1680 and about violations of the following style guidelines from Scott Meyers'
1681 @cite{More Effective C++} book:
1683 @itemize @bullet
1684 @item
1685 Item 6:  Distinguish between prefix and postfix forms of increment and
1686 decrement operators.
1688 @item
1689 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1691 @end itemize
1693 If you use this option, you should be aware that the standard library
1694 headers do not obey all of these guidelines; you can use @samp{grep -v}
1695 to filter out those warnings.
1697 @item -Wno-deprecated @r{(C++ only)}
1698 @opindex Wno-deprecated
1699 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1701 @item -Wno-non-template-friend @r{(C++ only)}
1702 @opindex Wno-non-template-friend
1703 Disable warnings when non-templatized friend functions are declared
1704 within a template.  With the advent of explicit template specification
1705 support in G++, if the name of the friend is an unqualified-id (i.e.,
1706 @samp{friend foo(int)}), the C++ language specification demands that the
1707 friend declare or define an ordinary, nontemplate function.  (Section
1708 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1709 could be interpreted as a particular specialization of a templatized
1710 function.  Because this non-conforming behavior is no longer the default
1711 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1712 check existing code for potential trouble spots, and is on by default.
1713 This new compiler behavior can be turned off with
1714 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1715 but disables the helpful warning.
1717 @item -Wold-style-cast @r{(C++ only)}
1718 @opindex Wold-style-cast
1719 Warn if an old-style (C-style) cast to a non-void type is used within
1720 a C++ program.  The new-style casts (@samp{static_cast},
1721 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1722 unintended effects, and much easier to grep for.
1724 @item -Woverloaded-virtual @r{(C++ only)}
1725 @opindex Woverloaded-virtual
1726 @cindex overloaded virtual fn, warning
1727 @cindex warning for overloaded virtual fn
1728 Warn when a function declaration hides virtual functions from a
1729 base class.  For example, in:
1731 @smallexample
1732 struct A @{
1733   virtual void f();
1736 struct B: public A @{
1737   void f(int);
1739 @end smallexample
1741 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1742 like this:
1744 @smallexample
1745 B* b;
1746 b->f();
1747 @end smallexample
1749 will fail to compile.
1751 @item -Wno-pmf-conversions @r{(C++ only)}
1752 @opindex Wno-pmf-conversions
1753 Disable the diagnostic for converting a bound pointer to member function
1754 to a plain pointer.
1756 @item -Wsign-promo @r{(C++ only)}
1757 @opindex Wsign-promo
1758 Warn when overload resolution chooses a promotion from unsigned or
1759 enumeral type to a signed type over a conversion to an unsigned type of
1760 the same size.  Previous versions of G++ would try to preserve
1761 unsignedness, but the standard mandates the current behavior.
1763 @item -Wsynth @r{(C++ only)}
1764 @opindex Wsynth
1765 @cindex warning for synthesized methods
1766 @cindex synthesized methods, warning
1767 Warn when G++'s synthesis behavior does not match that of cfront.  For
1768 instance:
1770 @smallexample
1771 struct A @{
1772   operator int ();
1773   A& operator = (int);
1776 main ()
1778   A a,b;
1779   a = b;
1781 @end smallexample
1783 In this example, G++ will synthesize a default @samp{A& operator =
1784 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1785 @end table
1787 @node Objective-C Dialect Options
1788 @section Options Controlling Objective-C Dialect
1790 @cindex compiler options, Objective-C
1791 @cindex Objective-C options, command line
1792 @cindex options, Objective-C
1793 This section describes the command-line options that are only meaningful
1794 for Objective-C programs; but you can also use most of the GNU compiler
1795 options regardless of what language your program is in.  For example,
1796 you might compile a file @code{some_class.m} like this:
1798 @example
1799 gcc -g -fgnu-runtime -O -c some_class.m
1800 @end example
1802 @noindent
1803 In this example, only @option{-fgnu-runtime} is an option meant only for
1804 Objective-C programs; you can use the other options with any language
1805 supported by GCC@.
1807 Here is a list of options that are @emph{only} for compiling Objective-C
1808 programs:
1810 @table @gcctabopt
1811 @item -fconstant-string-class=@var{class-name}
1812 @opindex fconstant-string-class
1813 Use @var{class-name} as the name of the class to instantiate for each
1814 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1815 class name is @code{NXConstantString}.
1817 @item -fgnu-runtime
1818 @opindex fgnu-runtime
1819 Generate object code compatible with the standard GNU Objective-C
1820 runtime.  This is the default for most types of systems.
1822 @item -fnext-runtime
1823 @opindex fnext-runtime
1824 Generate output compatible with the NeXT runtime.  This is the default
1825 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1826 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1827 used.
1829 @item -gen-decls
1830 @opindex gen-decls
1831 Dump interface declarations for all classes seen in the source file to a
1832 file named @file{@var{sourcename}.decl}.
1834 @item -Wno-protocol
1835 @opindex Wno-protocol
1836 If a class is declared to implement a protocol, a warning is issued for
1837 every method in the protocol that is not implemented by the class.  The
1838 default behavior is to issue a warning for every method not explicitly
1839 implemented in the class, even if a method implementation is inherited
1840 from the superclass.  If you use the @code{-Wno-protocol} option, then
1841 methods inherited from the superclass are considered to be implemented,
1842 and no warning is issued for them.
1844 @item -Wselector
1845 @opindex Wselector
1846 Warn if multiple methods of different types for the same selector are
1847 found during compilation.  The check is performed on the list of methods
1848 in the final stage of compilation.  Additionally, a check is performed
1849 that for each selector appearing in a @code{@@selector(@dots{})}
1850 expression, a corresponding method with that selector has been found
1851 during compilation.  Because these checks scan the method table only at
1852 the end of compilation, these warnings are not produced if the final
1853 stage of compilation is not reached, for example because an error is
1854 found during compilation, or because the @code{-fsyntax-only} option is
1855 being used.
1857 @item -Wundeclared-selector
1858 @opindex Wundeclared-selector
1859 Warn if a @code{@@selector(@dots{})} expression referring to an
1860 undeclared selector is found.  A selector is considered undeclared if no
1861 method with that name has been declared (explicitly, in an
1862 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1863 an @code{@@implementation} section) before the
1864 @code{@@selector(@dots{})} expression.  This option always performs its
1865 checks as soon as a @code{@@selector(@dots{})} expression is found
1866 (while @code{-Wselector} only performs its checks in the final stage of
1867 compilation), and so additionally enforces the coding style convention
1868 that methods and selectors must be declared before being used.
1870 @c not documented because only avail via -Wp
1871 @c @item -print-objc-runtime-info
1873 @end table
1875 @node Language Independent Options
1876 @section Options to Control Diagnostic Messages Formatting
1877 @cindex options to control diagnostics formatting
1878 @cindex diagnostic messages
1879 @cindex message formatting
1881 Traditionally, diagnostic messages have been formatted irrespective of
1882 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1883 below can be used to control the diagnostic messages formatting
1884 algorithm, e.g.@: how many characters per line, how often source location
1885 information should be reported.  Right now, only the C++ front end can
1886 honor these options.  However it is expected, in the near future, that
1887 the remaining front ends would be able to digest them correctly.
1889 @table @gcctabopt
1890 @item -fmessage-length=@var{n}
1891 @opindex fmessage-length
1892 Try to format error messages so that they fit on lines of about @var{n}
1893 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1894 the front ends supported by GCC@.  If @var{n} is zero, then no
1895 line-wrapping will be done; each error message will appear on a single
1896 line.
1898 @opindex fdiagnostics-show-location
1899 @item -fdiagnostics-show-location=once
1900 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1901 reporter to emit @emph{once} source location information; that is, in
1902 case the message is too long to fit on a single physical line and has to
1903 be wrapped, the source location won't be emitted (as prefix) again,
1904 over and over, in subsequent continuation lines.  This is the default
1905 behavior.
1907 @item -fdiagnostics-show-location=every-line
1908 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1909 messages reporter to emit the same source location information (as
1910 prefix) for physical lines that result from the process of breaking
1911 a message which is too long to fit on a single line.
1913 @end table
1915 @node Warning Options
1916 @section Options to Request or Suppress Warnings
1917 @cindex options to control warnings
1918 @cindex warning messages
1919 @cindex messages, warning
1920 @cindex suppressing warnings
1922 Warnings are diagnostic messages that report constructions which
1923 are not inherently erroneous but which are risky or suggest there
1924 may have been an error.
1926 You can request many specific warnings with options beginning @samp{-W},
1927 for example @option{-Wimplicit} to request warnings on implicit
1928 declarations.  Each of these specific warning options also has a
1929 negative form beginning @samp{-Wno-} to turn off warnings;
1930 for example, @option{-Wno-implicit}.  This manual lists only one of the
1931 two forms, whichever is not the default.
1933 The following options control the amount and kinds of warnings produced
1934 by GCC; for further, language-specific options also refer to
1935 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1937 @table @gcctabopt
1938 @cindex syntax checking
1939 @item -fsyntax-only
1940 @opindex fsyntax-only
1941 Check the code for syntax errors, but don't do anything beyond that.
1943 @item -pedantic
1944 @opindex pedantic
1945 Issue all the warnings demanded by strict ISO C and ISO C++;
1946 reject all programs that use forbidden extensions, and some other
1947 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1948 version of the ISO C standard specified by any @option{-std} option used.
1950 Valid ISO C and ISO C++ programs should compile properly with or without
1951 this option (though a rare few will require @option{-ansi} or a
1952 @option{-std} option specifying the required version of ISO C)@.  However,
1953 without this option, certain GNU extensions and traditional C and C++
1954 features are supported as well.  With this option, they are rejected.
1956 @option{-pedantic} does not cause warning messages for use of the
1957 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1958 warnings are also disabled in the expression that follows
1959 @code{__extension__}.  However, only system header files should use
1960 these escape routes; application programs should avoid them.
1961 @xref{Alternate Keywords}.
1963 Some users try to use @option{-pedantic} to check programs for strict ISO
1964 C conformance.  They soon find that it does not do quite what they want:
1965 it finds some non-ISO practices, but not all---only those for which
1966 ISO C @emph{requires} a diagnostic, and some others for which
1967 diagnostics have been added.
1969 A feature to report any failure to conform to ISO C might be useful in
1970 some instances, but would require considerable additional work and would
1971 be quite different from @option{-pedantic}.  We don't have plans to
1972 support such a feature in the near future.
1974 Where the standard specified with @option{-std} represents a GNU
1975 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1976 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1977 extended dialect is based.  Warnings from @option{-pedantic} are given
1978 where they are required by the base standard.  (It would not make sense
1979 for such warnings to be given only for features not in the specified GNU
1980 C dialect, since by definition the GNU dialects of C include all
1981 features the compiler supports with the given option, and there would be
1982 nothing to warn about.)
1984 @item -pedantic-errors
1985 @opindex pedantic-errors
1986 Like @option{-pedantic}, except that errors are produced rather than
1987 warnings.
1989 @item -w
1990 @opindex w
1991 Inhibit all warning messages.
1993 @item -Wno-import
1994 @opindex Wno-import
1995 Inhibit warning messages about the use of @samp{#import}.
1997 @item -Wchar-subscripts
1998 @opindex Wchar-subscripts
1999 Warn if an array subscript has type @code{char}.  This is a common cause
2000 of error, as programmers often forget that this type is signed on some
2001 machines.
2003 @item -Wcomment
2004 @opindex Wcomment
2005 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2006 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2008 @item -Wformat
2009 @opindex Wformat
2010 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2011 the arguments supplied have types appropriate to the format string
2012 specified, and that the conversions specified in the format string make
2013 sense.  This includes standard functions, and others specified by format
2014 attributes (@pxref{Function Attributes}), in the @code{printf},
2015 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2016 not in the C standard) families.
2018 The formats are checked against the format features supported by GNU
2019 libc version 2.2.  These include all ISO C90 and C99 features, as well
2020 as features from the Single Unix Specification and some BSD and GNU
2021 extensions.  Other library implementations may not support all these
2022 features; GCC does not support warning about features that go beyond a
2023 particular library's limitations.  However, if @option{-pedantic} is used
2024 with @option{-Wformat}, warnings will be given about format features not
2025 in the selected standard version (but not for @code{strfmon} formats,
2026 since those are not in any version of the C standard).  @xref{C Dialect
2027 Options,,Options Controlling C Dialect}.
2029 Since @option{-Wformat} also checks for null format arguments for
2030 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2032 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2033 aspects of format checking, the options @option{-Wno-format-y2k},
2034 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2035 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2036 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2038 @item -Wno-format-y2k
2039 @opindex Wno-format-y2k
2040 If @option{-Wformat} is specified, do not warn about @code{strftime}
2041 formats which may yield only a two-digit year.
2043 @item -Wno-format-extra-args
2044 @opindex Wno-format-extra-args
2045 If @option{-Wformat} is specified, do not warn about excess arguments to a
2046 @code{printf} or @code{scanf} format function.  The C standard specifies
2047 that such arguments are ignored.
2049 Where the unused arguments lie between used arguments that are
2050 specified with @samp{$} operand number specifications, normally
2051 warnings are still given, since the implementation could not know what
2052 type to pass to @code{va_arg} to skip the unused arguments.  However,
2053 in the case of @code{scanf} formats, this option will suppress the
2054 warning if the unused arguments are all pointers, since the Single
2055 Unix Specification says that such unused arguments are allowed.
2057 @item -Wno-format-zero-length
2058 @opindex Wno-format-zero-length
2059 If @option{-Wformat} is specified, do not warn about zero-length formats.
2060 The C standard specifies that zero-length formats are allowed.
2062 @item -Wformat-nonliteral
2063 @opindex Wformat-nonliteral
2064 If @option{-Wformat} is specified, also warn if the format string is not a
2065 string literal and so cannot be checked, unless the format function
2066 takes its format arguments as a @code{va_list}.
2068 @item -Wformat-security
2069 @opindex Wformat-security
2070 If @option{-Wformat} is specified, also warn about uses of format
2071 functions that represent possible security problems.  At present, this
2072 warns about calls to @code{printf} and @code{scanf} functions where the
2073 format string is not a string literal and there are no format arguments,
2074 as in @code{printf (foo);}.  This may be a security hole if the format
2075 string came from untrusted input and contains @samp{%n}.  (This is
2076 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2077 in future warnings may be added to @option{-Wformat-security} that are not
2078 included in @option{-Wformat-nonliteral}.)
2080 @item -Wformat=2
2081 @opindex Wformat=2
2082 Enable @option{-Wformat} plus format checks not included in
2083 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2084 -Wformat-nonliteral -Wformat-security}.
2086 @item -Wnonnull
2087 @opindex Wnonnull
2088 Enable warning about passing a null pointer for arguments marked as
2089 requiring a non-null value by the @code{nonnull} function attribute.
2091 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2092 can be disabled with the @option{-Wno-nonnull} option.
2094 @item -Wimplicit-int
2095 @opindex Wimplicit-int
2096 Warn when a declaration does not specify a type.
2098 @item -Wimplicit-function-declaration
2099 @itemx -Werror-implicit-function-declaration
2100 @opindex Wimplicit-function-declaration
2101 @opindex Werror-implicit-function-declaration
2102 Give a warning (or error) whenever a function is used before being
2103 declared.
2105 @item -Wimplicit
2106 @opindex Wimplicit
2107 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2109 @item -Wmain
2110 @opindex Wmain
2111 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2112 function with external linkage, returning int, taking either zero
2113 arguments, two, or three arguments of appropriate types.
2115 @item -Wmissing-braces
2116 @opindex Wmissing-braces
2117 Warn if an aggregate or union initializer is not fully bracketed.  In
2118 the following example, the initializer for @samp{a} is not fully
2119 bracketed, but that for @samp{b} is fully bracketed.
2121 @smallexample
2122 int a[2][2] = @{ 0, 1, 2, 3 @};
2123 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2124 @end smallexample
2126 @item -Wparentheses
2127 @opindex Wparentheses
2128 Warn if parentheses are omitted in certain contexts, such
2129 as when there is an assignment in a context where a truth value
2130 is expected, or when operators are nested whose precedence people
2131 often get confused about.
2133 Also warn about constructions where there may be confusion to which
2134 @code{if} statement an @code{else} branch belongs.  Here is an example of
2135 such a case:
2137 @smallexample
2138 @group
2140   if (a)
2141     if (b)
2142       foo ();
2143   else
2144     bar ();
2146 @end group
2147 @end smallexample
2149 In C, every @code{else} branch belongs to the innermost possible @code{if}
2150 statement, which in this example is @code{if (b)}.  This is often not
2151 what the programmer expected, as illustrated in the above example by
2152 indentation the programmer chose.  When there is the potential for this
2153 confusion, GCC will issue a warning when this flag is specified.
2154 To eliminate the warning, add explicit braces around the innermost
2155 @code{if} statement so there is no way the @code{else} could belong to
2156 the enclosing @code{if}.  The resulting code would look like this:
2158 @smallexample
2159 @group
2161   if (a)
2162     @{
2163       if (b)
2164         foo ();
2165       else
2166         bar ();
2167     @}
2169 @end group
2170 @end smallexample
2172 @item -Wsequence-point
2173 @opindex Wsequence-point
2174 Warn about code that may have undefined semantics because of violations
2175 of sequence point rules in the C standard.
2177 The C standard defines the order in which expressions in a C program are
2178 evaluated in terms of @dfn{sequence points}, which represent a partial
2179 ordering between the execution of parts of the program: those executed
2180 before the sequence point, and those executed after it.  These occur
2181 after the evaluation of a full expression (one which is not part of a
2182 larger expression), after the evaluation of the first operand of a
2183 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2184 function is called (but after the evaluation of its arguments and the
2185 expression denoting the called function), and in certain other places.
2186 Other than as expressed by the sequence point rules, the order of
2187 evaluation of subexpressions of an expression is not specified.  All
2188 these rules describe only a partial order rather than a total order,
2189 since, for example, if two functions are called within one expression
2190 with no sequence point between them, the order in which the functions
2191 are called is not specified.  However, the standards committee have
2192 ruled that function calls do not overlap.
2194 It is not specified when between sequence points modifications to the
2195 values of objects take effect.  Programs whose behavior depends on this
2196 have undefined behavior; the C standard specifies that ``Between the
2197 previous and next sequence point an object shall have its stored value
2198 modified at most once by the evaluation of an expression.  Furthermore,
2199 the prior value shall be read only to determine the value to be
2200 stored.''.  If a program breaks these rules, the results on any
2201 particular implementation are entirely unpredictable.
2203 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2204 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2205 diagnosed by this option, and it may give an occasional false positive
2206 result, but in general it has been found fairly effective at detecting
2207 this sort of problem in programs.
2209 The present implementation of this option only works for C programs.  A
2210 future implementation may also work for C++ programs.
2212 The C standard is worded confusingly, therefore there is some debate
2213 over the precise meaning of the sequence point rules in subtle cases.
2214 Links to discussions of the problem, including proposed formal
2215 definitions, may be found on our readings page, at
2216 @w{@uref{http://gcc.gnu.org/readings.html}}.
2218 @item -Wreturn-type
2219 @opindex Wreturn-type
2220 Warn whenever a function is defined with a return-type that defaults to
2221 @code{int}.  Also warn about any @code{return} statement with no
2222 return-value in a function whose return-type is not @code{void}.
2224 For C++, a function without return type always produces a diagnostic
2225 message, even when @option{-Wno-return-type} is specified.  The only
2226 exceptions are @samp{main} and functions defined in system headers.
2228 @item -Wswitch
2229 @opindex Wswitch
2230 Warn whenever a @code{switch} statement has an index of enumeral type
2231 and lacks a @code{case} for one or more of the named codes of that
2232 enumeration.  (The presence of a @code{default} label prevents this
2233 warning.)  @code{case} labels outside the enumeration range also
2234 provoke warnings when this option is used.
2236 @item -Wswitch-default
2237 @opindex Wswitch-switch
2238 Warn whenever a @code{switch} statement does not have a @code{default}
2239 case.
2241 @item -Wswitch-enum
2242 @opindex Wswitch-enum
2243 Warn whenever a @code{switch} statement has an index of enumeral type
2244 and lacks a @code{case} for one or more of the named codes of that
2245 enumeration.  @code{case} labels outside the enumeration range also
2246 provoke warnings when this option is used.
2248 @item -Wtrigraphs
2249 @opindex Wtrigraphs
2250 Warn if any trigraphs are encountered that might change the meaning of
2251 the program (trigraphs within comments are not warned about).
2253 @item -Wunused-function
2254 @opindex Wunused-function
2255 Warn whenever a static function is declared but not defined or a
2256 non\-inline static function is unused.
2258 @item -Wunused-label
2259 @opindex Wunused-label
2260 Warn whenever a label is declared but not used.
2262 To suppress this warning use the @samp{unused} attribute
2263 (@pxref{Variable Attributes}).
2265 @item -Wunused-parameter
2266 @opindex Wunused-parameter
2267 Warn whenever a function parameter is unused aside from its declaration.
2269 To suppress this warning use the @samp{unused} attribute
2270 (@pxref{Variable Attributes}).
2272 @item -Wunused-variable
2273 @opindex Wunused-variable
2274 Warn whenever a local variable or non-constant static variable is unused
2275 aside from its declaration
2277 To suppress this warning use the @samp{unused} attribute
2278 (@pxref{Variable Attributes}).
2280 @item -Wunused-value
2281 @opindex Wunused-value
2282 Warn whenever a statement computes a result that is explicitly not used.
2284 To suppress this warning cast the expression to @samp{void}.
2286 @item -Wunused
2287 @opindex Wunused
2288 All the above @option{-Wunused} options combined.
2290 In order to get a warning about an unused function parameter, you must
2291 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2292 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2294 @item -Wuninitialized
2295 @opindex Wuninitialized
2296 Warn if an automatic variable is used without first being initialized or
2297 if a variable may be clobbered by a @code{setjmp} call.
2299 These warnings are possible only in optimizing compilation,
2300 because they require data flow information that is computed only
2301 when optimizing.  If you don't specify @option{-O}, you simply won't
2302 get these warnings.
2304 These warnings occur only for variables that are candidates for
2305 register allocation.  Therefore, they do not occur for a variable that
2306 is declared @code{volatile}, or whose address is taken, or whose size
2307 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2308 structures, unions or arrays, even when they are in registers.
2310 Note that there may be no warning about a variable that is used only
2311 to compute a value that itself is never used, because such
2312 computations may be deleted by data flow analysis before the warnings
2313 are printed.
2315 These warnings are made optional because GCC is not smart
2316 enough to see all the reasons why the code might be correct
2317 despite appearing to have an error.  Here is one example of how
2318 this can happen:
2320 @smallexample
2321 @group
2323   int x;
2324   switch (y)
2325     @{
2326     case 1: x = 1;
2327       break;
2328     case 2: x = 4;
2329       break;
2330     case 3: x = 5;
2331     @}
2332   foo (x);
2334 @end group
2335 @end smallexample
2337 @noindent
2338 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2339 always initialized, but GCC doesn't know this.  Here is
2340 another common case:
2342 @smallexample
2344   int save_y;
2345   if (change_y) save_y = y, y = new_y;
2346   @dots{}
2347   if (change_y) y = save_y;
2349 @end smallexample
2351 @noindent
2352 This has no bug because @code{save_y} is used only if it is set.
2354 @cindex @code{longjmp} warnings
2355 This option also warns when a non-volatile automatic variable might be
2356 changed by a call to @code{longjmp}.  These warnings as well are possible
2357 only in optimizing compilation.
2359 The compiler sees only the calls to @code{setjmp}.  It cannot know
2360 where @code{longjmp} will be called; in fact, a signal handler could
2361 call it at any point in the code.  As a result, you may get a warning
2362 even when there is in fact no problem because @code{longjmp} cannot
2363 in fact be called at the place which would cause a problem.
2365 Some spurious warnings can be avoided if you declare all the functions
2366 you use that never return as @code{noreturn}.  @xref{Function
2367 Attributes}.
2369 @item -Wunknown-pragmas
2370 @opindex Wunknown-pragmas
2371 @cindex warning for unknown pragmas
2372 @cindex unknown pragmas, warning
2373 @cindex pragmas, warning of unknown
2374 Warn when a #pragma directive is encountered which is not understood by
2375 GCC@.  If this command line option is used, warnings will even be issued
2376 for unknown pragmas in system header files.  This is not the case if
2377 the warnings were only enabled by the @option{-Wall} command line option.
2379 @item -Wstrict-aliasing
2380 @opindex Wstrict-aliasing
2381 This option is only active when @option{-fstrict-aliasing} is active.
2382 It warns about code which might break the strict aliasing rules that the
2383 compiler is using for optimization. The warning does not catch all
2384 cases, but does attempt to catch the more common pitfalls. It is
2385 included in @option{-Wall}.
2387 @item -Wall
2388 @opindex Wall
2389 All of the above @samp{-W} options combined.  This enables all the
2390 warnings about constructions that some users consider questionable, and
2391 that are easy to avoid (or modify to prevent the warning), even in
2392 conjunction with macros.  This also enables some language-specific
2393 warnings described in @ref{C++ Dialect Options} and
2394 @ref{Objective-C Dialect Options}.
2395 @end table
2397 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2398 Some of them warn about constructions that users generally do not
2399 consider questionable, but which occasionally you might wish to check
2400 for; others warn about constructions that are necessary or hard to avoid
2401 in some cases, and there is no simple way to modify the code to suppress
2402 the warning.
2404 @table @gcctabopt
2405 @item -Wextra
2406 @opindex W
2407 @opindex Wextra
2408 (This option used to be called @option{-W}.  The older name is still
2409 supported, but the newer name is more descriptive.)  Print extra warning
2410 messages for these events:
2412 @itemize @bullet
2413 @item
2414 A function can return either with or without a value.  (Falling
2415 off the end of the function body is considered returning without
2416 a value.)  For example, this function would evoke such a
2417 warning:
2419 @smallexample
2420 @group
2421 foo (a)
2423   if (a > 0)
2424     return a;
2426 @end group
2427 @end smallexample
2429 @item
2430 An expression-statement or the left-hand side of a comma expression
2431 contains no side effects.
2432 To suppress the warning, cast the unused expression to void.
2433 For example, an expression such as @samp{x[i,j]} will cause a warning,
2434 but @samp{x[(void)i,j]} will not.
2436 @item
2437 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2439 @item
2440 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2441 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2442 that of ordinary mathematical notation.
2444 @item
2445 Storage-class specifiers like @code{static} are not the first things in
2446 a declaration.  According to the C Standard, this usage is obsolescent.
2448 @item
2449 The return type of a function has a type qualifier such as @code{const}.
2450 Such a type qualifier has no effect, since the value returned by a
2451 function is not an lvalue.  (But don't warn about the GNU extension of
2452 @code{volatile void} return types.  That extension will be warned about
2453 if @option{-pedantic} is specified.)
2455 @item
2456 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2457 arguments.
2459 @item
2460 A comparison between signed and unsigned values could produce an
2461 incorrect result when the signed value is converted to unsigned.
2462 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2464 @item
2465 An aggregate has an initializer which does not initialize all members.
2466 For example, the following code would cause such a warning, because
2467 @code{x.h} would be implicitly initialized to zero:
2469 @smallexample
2470 struct s @{ int f, g, h; @};
2471 struct s x = @{ 3, 4 @};
2472 @end smallexample
2474 @item
2475 A function parameter is declared without a type specifier in K&R-style
2476 functions:
2478 @smallexample
2479 void foo(bar) @{ @}
2480 @end smallexample
2482 @item
2483 An empty body occurs in an @samp{if} or @samp{else} statement.
2485 @item
2486 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2487 @samp{>}, or @samp{>=}.
2489 @item
2490 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2492 @item
2493 Any of several floating-point events that often indicate errors, such as
2494 overflow, underflow, loss of precision, etc.
2496 @item @r{(C++ only)}
2497 An enumerator and a non-enumerator both appear in a conditional expression.
2499 @item @r{(C++ only)}
2500 A non-static reference or non-static @samp{const} member appears in a
2501 class without constructors.
2503 @item @r{(C++ only)}
2504 Ambiguous virtual bases.
2506 @item @r{(C++ only)}
2507 Subscripting an array which has been declared @samp{register}.
2509 @item @r{(C++ only)}
2510 Taking the address of a variable which has been declared @samp{register}.
2512 @item @r{(C++ only)}
2513 A base class is not initialized in a derived class' copy constrcutor.
2514 @end itemize
2516 @item -Wno-div-by-zero
2517 @opindex Wno-div-by-zero
2518 @opindex Wdiv-by-zero
2519 Do not warn about compile-time integer division by zero.  Floating point
2520 division by zero is not warned about, as it can be a legitimate way of
2521 obtaining infinities and NaNs.
2523 @item -Wsystem-headers
2524 @opindex Wsystem-headers
2525 @cindex warnings from system headers
2526 @cindex system headers, warnings from
2527 Print warning messages for constructs found in system header files.
2528 Warnings from system headers are normally suppressed, on the assumption
2529 that they usually do not indicate real problems and would only make the
2530 compiler output harder to read.  Using this command line option tells
2531 GCC to emit warnings from system headers as if they occurred in user
2532 code.  However, note that using @option{-Wall} in conjunction with this
2533 option will @emph{not} warn about unknown pragmas in system
2534 headers---for that, @option{-Wunknown-pragmas} must also be used.
2536 @item -Wfloat-equal
2537 @opindex Wfloat-equal
2538 Warn if floating point values are used in equality comparisons.
2540 The idea behind this is that sometimes it is convenient (for the
2541 programmer) to consider floating-point values as approximations to
2542 infinitely precise real numbers.  If you are doing this, then you need
2543 to compute (by analyzing the code, or in some other way) the maximum or
2544 likely maximum error that the computation introduces, and allow for it
2545 when performing comparisons (and when producing output, but that's a
2546 different problem).  In particular, instead of testing for equality, you
2547 would check to see whether the two values have ranges that overlap; and
2548 this is done with the relational operators, so equality comparisons are
2549 probably mistaken.
2551 @item -Wtraditional @r{(C only)}
2552 @opindex Wtraditional
2553 Warn about certain constructs that behave differently in traditional and
2554 ISO C@.  Also warn about ISO C constructs that have no traditional C
2555 equivalent, and/or problematic constructs which should be avoided.
2557 @itemize @bullet
2558 @item
2559 Macro parameters that appear within string literals in the macro body.
2560 In traditional C macro replacement takes place within string literals,
2561 but does not in ISO C@.
2563 @item
2564 In traditional C, some preprocessor directives did not exist.
2565 Traditional preprocessors would only consider a line to be a directive
2566 if the @samp{#} appeared in column 1 on the line.  Therefore
2567 @option{-Wtraditional} warns about directives that traditional C
2568 understands but would ignore because the @samp{#} does not appear as the
2569 first character on the line.  It also suggests you hide directives like
2570 @samp{#pragma} not understood by traditional C by indenting them.  Some
2571 traditional implementations would not recognize @samp{#elif}, so it
2572 suggests avoiding it altogether.
2574 @item
2575 A function-like macro that appears without arguments.
2577 @item
2578 The unary plus operator.
2580 @item
2581 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2582 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2583 constants.)  Note, these suffixes appear in macros defined in the system
2584 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2585 Use of these macros in user code might normally lead to spurious
2586 warnings, however gcc's integrated preprocessor has enough context to
2587 avoid warning in these cases.
2589 @item
2590 A function declared external in one block and then used after the end of
2591 the block.
2593 @item
2594 A @code{switch} statement has an operand of type @code{long}.
2596 @item
2597 A non-@code{static} function declaration follows a @code{static} one.
2598 This construct is not accepted by some traditional C compilers.
2600 @item
2601 The ISO type of an integer constant has a different width or
2602 signedness from its traditional type.  This warning is only issued if
2603 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2604 typically represent bit patterns, are not warned about.
2606 @item
2607 Usage of ISO string concatenation is detected.
2609 @item
2610 Initialization of automatic aggregates.
2612 @item
2613 Identifier conflicts with labels.  Traditional C lacks a separate
2614 namespace for labels.
2616 @item
2617 Initialization of unions.  If the initializer is zero, the warning is
2618 omitted.  This is done under the assumption that the zero initializer in
2619 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2620 initializer warnings and relies on default initialization to zero in the
2621 traditional C case.
2623 @item
2624 Conversions by prototypes between fixed/floating point values and vice
2625 versa.  The absence of these prototypes when compiling with traditional
2626 C would cause serious problems.  This is a subset of the possible
2627 conversion warnings, for the full set use @option{-Wconversion}.
2629 @item
2630 Use of ISO C style function definitions.  This warning intentionally is
2631 @emph{not} issued for prototype declarations or variadic functions
2632 because these ISO C features will appear in your code when using
2633 libiberty's traditional C compatibility macros, @code{PARAMS} and
2634 @code{VPARAMS}.  This warning is also bypassed for nested functions
2635 because that feature is already a gcc extension and thus not relevant to
2636 traditional C compatibility.
2637 @end itemize
2639 @item -Wundef
2640 @opindex Wundef
2641 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2643 @item -Wendif-labels
2644 @opindex Wendif-labels
2645 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2647 @item -Wshadow
2648 @opindex Wshadow
2649 Warn whenever a local variable shadows another local variable, parameter or
2650 global variable or whenever a built-in function is shadowed.
2652 @item -Wlarger-than-@var{len}
2653 @opindex Wlarger-than
2654 Warn whenever an object of larger than @var{len} bytes is defined.
2656 @item -Wpointer-arith
2657 @opindex Wpointer-arith
2658 Warn about anything that depends on the ``size of'' a function type or
2659 of @code{void}.  GNU C assigns these types a size of 1, for
2660 convenience in calculations with @code{void *} pointers and pointers
2661 to functions.
2663 @item -Wbad-function-cast @r{(C only)}
2664 @opindex Wbad-function-cast
2665 Warn whenever a function call is cast to a non-matching type.
2666 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2668 @item -Wcast-qual
2669 @opindex Wcast-qual
2670 Warn whenever a pointer is cast so as to remove a type qualifier from
2671 the target type.  For example, warn if a @code{const char *} is cast
2672 to an ordinary @code{char *}.
2674 @item -Wcast-align
2675 @opindex Wcast-align
2676 Warn whenever a pointer is cast such that the required alignment of the
2677 target is increased.  For example, warn if a @code{char *} is cast to
2678 an @code{int *} on machines where integers can only be accessed at
2679 two- or four-byte boundaries.
2681 @item -Wwrite-strings
2682 @opindex Wwrite-strings
2683 When compiling C, give string constants the type @code{const
2684 char[@var{length}]} so that
2685 copying the address of one into a non-@code{const} @code{char *}
2686 pointer will get a warning; when compiling C++, warn about the
2687 deprecated conversion from string constants to @code{char *}.
2688 These warnings will help you find at
2689 compile time code that can try to write into a string constant, but
2690 only if you have been very careful about using @code{const} in
2691 declarations and prototypes.  Otherwise, it will just be a nuisance;
2692 this is why we did not make @option{-Wall} request these warnings.
2694 @item -Wconversion
2695 @opindex Wconversion
2696 Warn if a prototype causes a type conversion that is different from what
2697 would happen to the same argument in the absence of a prototype.  This
2698 includes conversions of fixed point to floating and vice versa, and
2699 conversions changing the width or signedness of a fixed point argument
2700 except when the same as the default promotion.
2702 Also, warn if a negative integer constant expression is implicitly
2703 converted to an unsigned type.  For example, warn about the assignment
2704 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2705 casts like @code{(unsigned) -1}.
2707 @item -Wsign-compare
2708 @opindex Wsign-compare
2709 @cindex warning for comparison of signed and unsigned values
2710 @cindex comparison of signed and unsigned values, warning
2711 @cindex signed and unsigned values, comparison warning
2712 Warn when a comparison between signed and unsigned values could produce
2713 an incorrect result when the signed value is converted to unsigned.
2714 This warning is also enabled by @option{-Wextra}; to get the other warnings
2715 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2717 @item -Waggregate-return
2718 @opindex Waggregate-return
2719 Warn if any functions that return structures or unions are defined or
2720 called.  (In languages where you can return an array, this also elicits
2721 a warning.)
2723 @item -Wstrict-prototypes @r{(C only)}
2724 @opindex Wstrict-prototypes
2725 Warn if a function is declared or defined without specifying the
2726 argument types.  (An old-style function definition is permitted without
2727 a warning if preceded by a declaration which specifies the argument
2728 types.)
2730 @item -Wmissing-prototypes @r{(C only)}
2731 @opindex Wmissing-prototypes
2732 Warn if a global function is defined without a previous prototype
2733 declaration.  This warning is issued even if the definition itself
2734 provides a prototype.  The aim is to detect global functions that fail
2735 to be declared in header files.
2737 @item -Wmissing-declarations
2738 @opindex Wmissing-declarations
2739 Warn if a global function is defined without a previous declaration.
2740 Do so even if the definition itself provides a prototype.
2741 Use this option to detect global functions that are not declared in
2742 header files.
2744 @item -Wmissing-noreturn
2745 @opindex Wmissing-noreturn
2746 Warn about functions which might be candidates for attribute @code{noreturn}.
2747 Note these are only possible candidates, not absolute ones.  Care should
2748 be taken to manually verify functions actually do not ever return before
2749 adding the @code{noreturn} attribute, otherwise subtle code generation
2750 bugs could be introduced.  You will not get a warning for @code{main} in
2751 hosted C environments.
2753 @item -Wmissing-format-attribute
2754 @opindex Wmissing-format-attribute
2755 @opindex Wformat
2756 If @option{-Wformat} is enabled, also warn about functions which might be
2757 candidates for @code{format} attributes.  Note these are only possible
2758 candidates, not absolute ones.  GCC will guess that @code{format}
2759 attributes might be appropriate for any function that calls a function
2760 like @code{vprintf} or @code{vscanf}, but this might not always be the
2761 case, and some functions for which @code{format} attributes are
2762 appropriate may not be detected.  This option has no effect unless
2763 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2765 @item -Wno-multichar
2766 @opindex Wno-multichar
2767 @opindex Wmultichar
2768 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2769 Usually they indicate a typo in the user's code, as they have
2770 implementation-defined values, and should not be used in portable code.
2772 @item -Wno-deprecated-declarations
2773 @opindex Wno-deprecated-declarations
2774 Do not warn about uses of functions, variables, and types marked as
2775 deprecated by using the @code{deprecated} attribute.
2776 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2777 @pxref{Type Attributes}.)
2779 @item -Wpacked
2780 @opindex Wpacked
2781 Warn if a structure is given the packed attribute, but the packed
2782 attribute has no effect on the layout or size of the structure.
2783 Such structures may be mis-aligned for little benefit.  For
2784 instance, in this code, the variable @code{f.x} in @code{struct bar}
2785 will be misaligned even though @code{struct bar} does not itself
2786 have the packed attribute:
2788 @smallexample
2789 @group
2790 struct foo @{
2791   int x;
2792   char a, b, c, d;
2793 @} __attribute__((packed));
2794 struct bar @{
2795   char z;
2796   struct foo f;
2798 @end group
2799 @end smallexample
2801 @item -Wpadded
2802 @opindex Wpadded
2803 Warn if padding is included in a structure, either to align an element
2804 of the structure or to align the whole structure.  Sometimes when this
2805 happens it is possible to rearrange the fields of the structure to
2806 reduce the padding and so make the structure smaller.
2808 @item -Wredundant-decls
2809 @opindex Wredundant-decls
2810 Warn if anything is declared more than once in the same scope, even in
2811 cases where multiple declaration is valid and changes nothing.
2813 @item -Wnested-externs @r{(C only)}
2814 @opindex Wnested-externs
2815 Warn if an @code{extern} declaration is encountered within a function.
2817 @item -Wunreachable-code
2818 @opindex Wunreachable-code
2819 Warn if the compiler detects that code will never be executed.
2821 This option is intended to warn when the compiler detects that at
2822 least a whole line of source code will never be executed, because
2823 some condition is never satisfied or because it is after a
2824 procedure that never returns.
2826 It is possible for this option to produce a warning even though there
2827 are circumstances under which part of the affected line can be executed,
2828 so care should be taken when removing apparently-unreachable code.
2830 For instance, when a function is inlined, a warning may mean that the
2831 line is unreachable in only one inlined copy of the function.
2833 This option is not made part of @option{-Wall} because in a debugging
2834 version of a program there is often substantial code which checks
2835 correct functioning of the program and is, hopefully, unreachable
2836 because the program does work.  Another common use of unreachable
2837 code is to provide behavior which is selectable at compile-time.
2839 @item -Winline
2840 @opindex Winline
2841 Warn if a function can not be inlined and it was declared as inline.
2843 @item -Winvalid-pch
2844 @opindex Winvalid-pch
2845 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2846 the search path but can't be used.
2848 @item -Wlong-long
2849 @opindex Wlong-long
2850 @opindex Wno-long-long
2851 Warn if @samp{long long} type is used.  This is default.  To inhibit
2852 the warning messages, use @option{-Wno-long-long}.  Flags
2853 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2854 only when @option{-pedantic} flag is used.
2856 @item -Wdisabled-optimization
2857 @opindex Wdisabled-optimization
2858 Warn if a requested optimization pass is disabled.  This warning does
2859 not generally indicate that there is anything wrong with your code; it
2860 merely indicates that GCC's optimizers were unable to handle the code
2861 effectively.  Often, the problem is that your code is too big or too
2862 complex; GCC will refuse to optimize programs when the optimization
2863 itself is likely to take inordinate amounts of time.
2865 @item -Werror
2866 @opindex Werror
2867 Make all warnings into errors.
2868 @end table
2870 @node Debugging Options
2871 @section Options for Debugging Your Program or GCC
2872 @cindex options, debugging
2873 @cindex debugging information options
2875 GCC has various special options that are used for debugging
2876 either your program or GCC:
2878 @table @gcctabopt
2879 @item -g
2880 @opindex g
2881 Produce debugging information in the operating system's native format
2882 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2883 information.
2885 On most systems that use stabs format, @option{-g} enables use of extra
2886 debugging information that only GDB can use; this extra information
2887 makes debugging work better in GDB but will probably make other debuggers
2888 crash or
2889 refuse to read the program.  If you want to control for certain whether
2890 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2891 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2892 or @option{-gvms} (see below).
2894 Unlike most other C compilers, GCC allows you to use @option{-g} with
2895 @option{-O}.  The shortcuts taken by optimized code may occasionally
2896 produce surprising results: some variables you declared may not exist
2897 at all; flow of control may briefly move where you did not expect it;
2898 some statements may not be executed because they compute constant
2899 results or their values were already at hand; some statements may
2900 execute in different places because they were moved out of loops.
2902 Nevertheless it proves possible to debug optimized output.  This makes
2903 it reasonable to use the optimizer for programs that might have bugs.
2905 The following options are useful when GCC is generated with the
2906 capability for more than one debugging format.
2908 @item -ggdb
2909 @opindex ggdb
2910 Produce debugging information for use by GDB@.  This means to use the
2911 most expressive format available (DWARF 2, stabs, or the native format
2912 if neither of those are supported), including GDB extensions if at all
2913 possible.
2915 @item -gstabs
2916 @opindex gstabs
2917 Produce debugging information in stabs format (if that is supported),
2918 without GDB extensions.  This is the format used by DBX on most BSD
2919 systems.  On MIPS, Alpha and System V Release 4 systems this option
2920 produces stabs debugging output which is not understood by DBX or SDB@.
2921 On System V Release 4 systems this option requires the GNU assembler.
2923 @item -gstabs+
2924 @opindex gstabs+
2925 Produce debugging information in stabs format (if that is supported),
2926 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2927 use of these extensions is likely to make other debuggers crash or
2928 refuse to read the program.
2930 @item -gcoff
2931 @opindex gcoff
2932 Produce debugging information in COFF format (if that is supported).
2933 This is the format used by SDB on most System V systems prior to
2934 System V Release 4.
2936 @item -gxcoff
2937 @opindex gxcoff
2938 Produce debugging information in XCOFF format (if that is supported).
2939 This is the format used by the DBX debugger on IBM RS/6000 systems.
2941 @item -gxcoff+
2942 @opindex gxcoff+
2943 Produce debugging information in XCOFF format (if that is supported),
2944 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2945 use of these extensions is likely to make other debuggers crash or
2946 refuse to read the program, and may cause assemblers other than the GNU
2947 assembler (GAS) to fail with an error.
2949 @item -gdwarf
2950 @opindex gdwarf
2951 Produce debugging information in DWARF version 1 format (if that is
2952 supported).  This is the format used by SDB on most System V Release 4
2953 systems.
2955 This option is deprecated.
2957 @item -gdwarf+
2958 @opindex gdwarf+
2959 Produce debugging information in DWARF version 1 format (if that is
2960 supported), using GNU extensions understood only by the GNU debugger
2961 (GDB)@.  The use of these extensions is likely to make other debuggers
2962 crash or refuse to read the program.
2964 This option is deprecated.
2966 @item -gdwarf-2
2967 @opindex gdwarf-2
2968 Produce debugging information in DWARF version 2 format (if that is
2969 supported).  This is the format used by DBX on IRIX 6.
2971 @item -gvms
2972 @opindex gvms
2973 Produce debugging information in VMS debug format (if that is
2974 supported).  This is the format used by DEBUG on VMS systems.
2976 @item -g@var{level}
2977 @itemx -ggdb@var{level}
2978 @itemx -gstabs@var{level}
2979 @itemx -gcoff@var{level}
2980 @itemx -gxcoff@var{level}
2981 @itemx -gvms@var{level}
2982 Request debugging information and also use @var{level} to specify how
2983 much information.  The default level is 2.
2985 Level 1 produces minimal information, enough for making backtraces in
2986 parts of the program that you don't plan to debug.  This includes
2987 descriptions of functions and external variables, but no information
2988 about local variables and no line numbers.
2990 Level 3 includes extra information, such as all the macro definitions
2991 present in the program.  Some debuggers support macro expansion when
2992 you use @option{-g3}.
2994 Note that in order to avoid confusion between DWARF1 debug level 2,
2995 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2996 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2997 option to change the debug level for DWARF1 or DWARF2.
2999 @item -feliminate-dwarf2-dups
3000 @opindex feliminate-dwarf2-dups
3001 Compress DWARF2 debugging information by eliminating duplicated
3002 information about each symbol.  This option only makes sense when
3003 generating DWARF2 debugging information with @option{-gdwarf-2}.
3005 @cindex @command{prof}
3006 @item -p
3007 @opindex p
3008 Generate extra code to write profile information suitable for the
3009 analysis program @command{prof}.  You must use this option when compiling
3010 the source files you want data about, and you must also use it when
3011 linking.
3013 @cindex @command{gprof}
3014 @item -pg
3015 @opindex pg
3016 Generate extra code to write profile information suitable for the
3017 analysis program @command{gprof}.  You must use this option when compiling
3018 the source files you want data about, and you must also use it when
3019 linking.
3021 @item -Q
3022 @opindex Q
3023 Makes the compiler print out each function name as it is compiled, and
3024 print some statistics about each pass when it finishes.
3026 @item -ftime-report
3027 @opindex ftime-report
3028 Makes the compiler print some statistics about the time consumed by each
3029 pass when it finishes.
3031 @item -fmem-report
3032 @opindex fmem-report
3033 Makes the compiler print some statistics about permanent memory
3034 allocation when it finishes.
3036 @item -fprofile-arcs
3037 @opindex fprofile-arcs
3038 Instrument @dfn{arcs} during compilation to generate coverage data or
3039 for profile-directed block ordering.  During execution the program
3040 records how many times each branch is executed and how many times it is
3041 taken.  When the compiled program exits it saves this data to a file
3042 called @file{@var{auxname}.da} for each source file.  @var{auxname} is
3043 generated from the name of the output file, if explicitly specified and
3044 it is not the final executable, otherwise it is the basename of the
3045 source file. In both cases any suffix is removed (e.g.  @file{foo.da}
3046 for input file @file{dir/foo.c}, or @file{dir/foo.da} for output file
3047 specified as @option{-o dir/foo.o}).
3049 For profile-directed block ordering, compile the program with
3050 @option{-fprofile-arcs} plus optimization and code generation options,
3051 generate the arc profile information by running the program on a
3052 selected workload, and then compile the program again with the same
3053 optimization and code generation options plus
3054 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3055 Control Optimization}).
3057 The other use of @option{-fprofile-arcs} is for use with @command{gcov},
3058 when it is used with the @option{-ftest-coverage} option.
3060 With @option{-fprofile-arcs}, for each function of your program GCC
3061 creates a program flow graph, then finds a spanning tree for the graph.
3062 Only arcs that are not on the spanning tree have to be instrumented: the
3063 compiler adds code to count the number of times that these arcs are
3064 executed.  When an arc is the only exit or only entrance to a block, the
3065 instrumentation code can be added to the block; otherwise, a new basic
3066 block must be created to hold the instrumentation code.
3068 @need 2000
3069 @item -ftest-coverage
3070 @opindex ftest-coverage
3071 Create data files for the @command{gcov} code-coverage utility
3072 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}).  See
3073 @option{-fprofile-arcs} option above for a description of @var{auxname}.
3075 @table @gcctabopt
3076 @item @var{auxname}.bb
3077 A mapping from basic blocks to line numbers, which @command{gcov} uses to
3078 associate basic block execution counts with line numbers.
3080 @item @var{auxname}.bbg
3081 A list of all arcs in the program flow graph.  This allows @command{gcov}
3082 to reconstruct the program flow graph, so that it can compute all basic
3083 block and arc execution counts from the information in the
3084 @file{@var{auxname}.da} file.
3085 @end table
3087 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
3088 option adds instrumentation to the program, which then writes
3089 execution counts to another data file:
3091 @table @gcctabopt
3092 @item @var{auxname}.da
3093 Runtime arc execution counts, used in conjunction with the arc
3094 information in the file @file{@var{auxname}.bbg}.
3095 @end table
3097 Coverage data will map better to the source files if
3098 @option{-ftest-coverage} is used without optimization.
3100 @item -d@var{letters}
3101 @opindex d
3102 Says to make debugging dumps during compilation at times specified by
3103 @var{letters}.  This is used for debugging the compiler.  The file names
3104 for most of the dumps are made by appending a pass number and a word to
3105 the @var{dumpname}. @var{dumpname} is generated from the name of the
3106 output file, if explicitly specified and it is not an executable,
3107 otherwise it is the basename of the source file. In both cases any
3108 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3109 Here are the possible letters for use in @var{letters}, and their
3110 meanings:
3112 @table @samp
3113 @item A
3114 @opindex dA
3115 Annotate the assembler output with miscellaneous debugging information.
3116 @item b
3117 @opindex db
3118 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3119 @item B
3120 @opindex dB
3121 Dump after block reordering, to @file{@var{file}.32.bbro}.
3122 @item c
3123 @opindex dc
3124 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3125 @item C
3126 @opindex dC
3127 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3128 @item d
3129 @opindex dd
3130 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3131 @item D
3132 @opindex dD
3133 Dump all macro definitions, at the end of preprocessing, in addition to
3134 normal output.
3135 @item e
3136 @opindex de
3137 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3138 @file{@var{file}.07.ussa}.
3139 @item E
3140 @opindex dE
3141 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3142 @item f
3143 @opindex df
3144 Dump after life analysis, to @file{@var{file}.18.life}.
3145 @item F
3146 @opindex dF
3147 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3148 @item g
3149 @opindex dg
3150 Dump after global register allocation, to @file{@var{file}.24.greg}.
3151 @item h
3152 @opindex dh
3153 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3154 @item k
3155 @opindex dk
3156 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3157 @item o
3158 @opindex do
3159 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3160 @item G
3161 @opindex dG
3162 Dump after GCSE, to @file{@var{file}.11.gcse}.
3163 @item i
3164 @opindex di
3165 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3166 @item j
3167 @opindex dj
3168 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3169 @item k
3170 @opindex dk
3171 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3172 @item l
3173 @opindex dl
3174 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3175 @item L
3176 @opindex dL
3177 Dump after loop optimization, to @file{@var{file}.12.loop}.
3178 @item M
3179 @opindex dM
3180 Dump after performing the machine dependent reorganization pass, to
3181 @file{@var{file}.33.mach}.
3182 @item n
3183 @opindex dn
3184 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3185 @item N
3186 @opindex dN
3187 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3188 @item r
3189 @opindex dr
3190 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3191 @item R
3192 @opindex dR
3193 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3194 @item s
3195 @opindex ds
3196 Dump after CSE (including the jump optimization that sometimes follows
3197 CSE), to @file{@var{file}.09.cse}.
3198 @item S
3199 @opindex dS
3200 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3201 @item t
3202 @opindex dt
3203 Dump after the second CSE pass (including the jump optimization that
3204 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3205 @item u
3206 @opindex du
3207 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3208 @item w
3209 @opindex dw
3210 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3211 @item X
3212 @opindex dX
3213 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3214 @item z
3215 @opindex dz
3216 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3217 @item a
3218 @opindex da
3219 Produce all the dumps listed above.
3220 @item m
3221 @opindex dm
3222 Print statistics on memory usage, at the end of the run, to
3223 standard error.
3224 @item p
3225 @opindex dp
3226 Annotate the assembler output with a comment indicating which
3227 pattern and alternative was used.  The length of each instruction is
3228 also printed.
3229 @item P
3230 @opindex dP
3231 Dump the RTL in the assembler output as a comment before each instruction.
3232 Also turns on @option{-dp} annotation.
3233 @item v
3234 @opindex dv
3235 For each of the other indicated dump files (except for
3236 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3237 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3238 @item x
3239 @opindex dx
3240 Just generate RTL for a function instead of compiling it.  Usually used
3241 with @samp{r}.
3242 @item y
3243 @opindex dy
3244 Dump debugging information during parsing, to standard error.
3245 @end table
3247 @item -fdump-unnumbered
3248 @opindex fdump-unnumbered
3249 When doing debugging dumps (see @option{-d} option above), suppress instruction
3250 numbers and line number note output.  This makes it more feasible to
3251 use diff on debugging dumps for compiler invocations with different
3252 options, in particular with and without @option{-g}.
3254 @item -fdump-translation-unit @r{(C and C++ only)}
3255 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3256 @opindex fdump-translation-unit
3257 Dump a representation of the tree structure for the entire translation
3258 unit to a file.  The file name is made by appending @file{.tu} to the
3259 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3260 controls the details of the dump as described for the
3261 @option{-fdump-tree} options.
3263 @item -fdump-class-hierarchy @r{(C++ only)}
3264 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3265 @opindex fdump-class-hierarchy
3266 Dump a representation of each class's hierarchy and virtual function
3267 table layout to a file.  The file name is made by appending @file{.class}
3268 to the source file name.  If the @samp{-@var{options}} form is used,
3269 @var{options} controls the details of the dump as described for the
3270 @option{-fdump-tree} options.
3272 @item -fdump-tree-@var{switch} @r{(C++ only)}
3273 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3274 @opindex fdump-tree
3275 Control the dumping at various stages of processing the intermediate
3276 language tree to a file.  The file name is generated by appending a switch
3277 specific suffix to the source file name.  If the @samp{-@var{options}}
3278 form is used, @var{options} is a list of @samp{-} separated options that
3279 control the details of the dump. Not all options are applicable to all
3280 dumps, those which are not meaningful will be ignored. The following
3281 options are available
3283 @table @samp
3284 @item address
3285 Print the address of each node.  Usually this is not meaningful as it
3286 changes according to the environment and source file. Its primary use
3287 is for tying up a dump file with a debug environment.
3288 @item slim
3289 Inhibit dumping of members of a scope or body of a function merely
3290 because that scope has been reached. Only dump such items when they
3291 are directly reachable by some other path.
3292 @item all
3293 Turn on all options.
3294 @end table
3296 The following tree dumps are possible:
3297 @table @samp
3298 @item original
3299 Dump before any tree based optimization, to @file{@var{file}.original}.
3300 @item optimized
3301 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3302 @item inlined
3303 Dump after function inlining, to @file{@var{file}.inlined}.
3304 @end table
3306 @item -fsched-verbose=@var{n}
3307 @opindex fsched-verbose
3308 On targets that use instruction scheduling, this option controls the
3309 amount of debugging output the scheduler prints.  This information is
3310 written to standard error, unless @option{-dS} or @option{-dR} is
3311 specified, in which case it is output to the usual dump
3312 listing file, @file{.sched} or @file{.sched2} respectively.  However
3313 for @var{n} greater than nine, the output is always printed to standard
3314 error.
3316 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3317 same information as @option{-dRS}.  For @var{n} greater than one, it
3318 also output basic block probabilities, detailed ready list information
3319 and unit/insn info.  For @var{n} greater than two, it includes RTL
3320 at abort point, control-flow and regions info.  And for @var{n} over
3321 four, @option{-fsched-verbose} also includes dependence info.
3323 @item -save-temps
3324 @opindex save-temps
3325 Store the usual ``temporary'' intermediate files permanently; place them
3326 in the current directory and name them based on the source file.  Thus,
3327 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3328 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3329 preprocessed @file{foo.i} output file even though the compiler now
3330 normally uses an integrated preprocessor.
3332 @item -time
3333 @opindex time
3334 Report the CPU time taken by each subprocess in the compilation
3335 sequence.  For C source files, this is the compiler proper and assembler
3336 (plus the linker if linking is done).  The output looks like this:
3338 @smallexample
3339 # cc1 0.12 0.01
3340 # as 0.00 0.01
3341 @end smallexample
3343 The first number on each line is the ``user time,'' that is time spent
3344 executing the program itself.  The second number is ``system time,''
3345 time spent executing operating system routines on behalf of the program.
3346 Both numbers are in seconds.
3348 @item -print-file-name=@var{library}
3349 @opindex print-file-name
3350 Print the full absolute name of the library file @var{library} that
3351 would be used when linking---and don't do anything else.  With this
3352 option, GCC does not compile or link anything; it just prints the
3353 file name.
3355 @item -print-multi-directory
3356 @opindex print-multi-directory
3357 Print the directory name corresponding to the multilib selected by any
3358 other switches present in the command line.  This directory is supposed
3359 to exist in @env{GCC_EXEC_PREFIX}.
3361 @item -print-multi-lib
3362 @opindex print-multi-lib
3363 Print the mapping from multilib directory names to compiler switches
3364 that enable them.  The directory name is separated from the switches by
3365 @samp{;}, and each switch starts with an @samp{@@} instead of the
3366 @samp{-}, without spaces between multiple switches.  This is supposed to
3367 ease shell-processing.
3369 @item -print-prog-name=@var{program}
3370 @opindex print-prog-name
3371 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3373 @item -print-libgcc-file-name
3374 @opindex print-libgcc-file-name
3375 Same as @option{-print-file-name=libgcc.a}.
3377 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3378 but you do want to link with @file{libgcc.a}.  You can do
3380 @example
3381 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3382 @end example
3384 @item -print-search-dirs
3385 @opindex print-search-dirs
3386 Print the name of the configured installation directory and a list of
3387 program and library directories gcc will search---and don't do anything else.
3389 This is useful when gcc prints the error message
3390 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3391 To resolve this you either need to put @file{cpp0} and the other compiler
3392 components where gcc expects to find them, or you can set the environment
3393 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3394 Don't forget the trailing '/'.
3395 @xref{Environment Variables}.
3397 @item -dumpmachine
3398 @opindex dumpmachine
3399 Print the compiler's target machine (for example,
3400 @samp{i686-pc-linux-gnu})---and don't do anything else.
3402 @item -dumpversion
3403 @opindex dumpversion
3404 Print the compiler version (for example, @samp{3.0})---and don't do
3405 anything else.
3407 @item -dumpspecs
3408 @opindex dumpspecs
3409 Print the compiler's built-in specs---and don't do anything else.  (This
3410 is used when GCC itself is being built.)  @xref{Spec Files}.
3411 @end table
3413 @node Optimize Options
3414 @section Options That Control Optimization
3415 @cindex optimize options
3416 @cindex options, optimization
3418 These options control various sorts of optimizations.
3420 Without any optimization option, the compiler's goal is to reduce the
3421 cost of compilation and to make debugging produce the expected
3422 results.  Statements are independent: if you stop the program with a
3423 breakpoint between statements, you can then assign a new value to any
3424 variable or change the program counter to any other statement in the
3425 function and get exactly the results you would expect from the source
3426 code.
3428 Turning on optimization flags makes the compiler attempt to improve
3429 the performance and/or code size at the expense of compilation time
3430 and possibly the ability to debug the program.
3432 Not all optimizations are controlled directly by a flag.  Only
3433 optimizations that have a flag are listed.
3435 @table @gcctabopt
3436 @item -O
3437 @itemx -O1
3438 @opindex O
3439 @opindex O1
3440 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3441 more memory for a large function.
3443 With @option{-O}, the compiler tries to reduce code size and execution
3444 time, without performing any optimizations that take a great deal of
3445 compilation time.
3447 @option{-O} turns on the following optimization flags: 
3448 @gccoptlist{-fdefer-pop 
3449 -fmerge-constants
3450 -fthread-jumps
3451 -floop-optimize
3452 -fcrossjumping
3453 -fif-conversion
3454 -fif-conversion2
3455 -fdelayed-branch
3456 -fguess-branch-probability
3457 -fcprop-registers}
3459 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3460 where doing so does not interfere with debugging.
3462 @item -O2
3463 @opindex O2
3464 Optimize even more.  GCC performs nearly all supported optimizations
3465 that do not involve a space-speed tradeoff.  The compiler does not
3466 perform loop unrolling or function inlining when you specify @option{-O2}.
3467 As compared to @option{-O}, this option increases both compilation time
3468 and the performance of the generated code.
3470 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3471 also turns on the following optimization flags:
3472 @gccoptlist{-fforce-mem
3473 -foptimize-sibling-calls
3474 -fstrength-reduce
3475 -fcse-follow-jumps  -fcse-skip-blocks
3476 -frerun-cse-after-loop  -frerun-loop-opt
3477 -fgcse   -fgcse-lm   -fgcse-sm
3478 -fdelete-null-pointer-checks
3479 -fexpensive-optimizations
3480 -fregmove
3481 -fschedule-insns  -fschedule-insns2
3482 -fsched-interblock -fsched-spec
3483 -fcaller-saves
3484 -fpeephole2
3485 -freorder-blocks  -freorder-functions
3486 -fstrict-aliasing
3487 -falign-functions  -falign-jumps
3488 -falign-loops  -falign-labels}
3490 Please note the warning under @option{-fgcse} about
3491 invoking @option{-O2} on programs that use computed gotos.
3493 @item -O3
3494 @opindex O3
3495 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3496 @option{-O2} and also turns on the @option{-finline-functions} and
3497 @option{-frename-registers} options.
3499 @item -O0
3500 @opindex O0
3501 Do not optimize.  This is the default.
3503 @item -Os
3504 @opindex Os
3505 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3506 do not typically increase code size.  It also performs further
3507 optimizations designed to reduce code size.
3509 @option{-Os} disables the following optimization flags:
3510 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops
3511 -falign-labels  -freorder-blocks -fprefetch-loop-arrays}
3513 If you use multiple @option{-O} options, with or without level numbers,
3514 the last such option is the one that is effective.
3515 @end table
3517 Options of the form @option{-f@var{flag}} specify machine-independent
3518 flags.  Most flags have both positive and negative forms; the negative
3519 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3520 below, only one of the forms is listed---the one you typically will
3521 use.  You can figure out the other form by either removing @samp{no-}
3522 or adding it.
3524 The following options control specific optimizations.  They are either
3525 activated by @option{-O} options or are related to ones that are.  You
3526 can use the following flags in the rare cases when ``fine-tuning'' of
3527 optimizations to be performed is desired.
3529 @table @gcctabopt
3530 @item -ffloat-store
3531 @opindex ffloat-store
3532 Do not store floating point variables in registers, and inhibit other
3533 options that might change whether a floating point value is taken from a
3534 register or memory.
3536 @cindex floating point precision
3537 This option prevents undesirable excess precision on machines such as
3538 the 68000 where the floating registers (of the 68881) keep more
3539 precision than a @code{double} is supposed to have.  Similarly for the
3540 x86 architecture.  For most programs, the excess precision does only
3541 good, but a few programs rely on the precise definition of IEEE floating
3542 point.  Use @option{-ffloat-store} for such programs, after modifying
3543 them to store all pertinent intermediate computations into variables.
3545 @item -fno-default-inline
3546 @opindex fno-default-inline
3547 Do not make member functions inline by default merely because they are
3548 defined inside the class scope (C++ only).  Otherwise, when you specify
3549 @w{@option{-O}}, member functions defined inside class scope are compiled
3550 inline by default; i.e., you don't need to add @samp{inline} in front of
3551 the member function name.
3553 @item -fno-defer-pop
3554 @opindex fno-defer-pop
3555 Always pop the arguments to each function call as soon as that function
3556 returns.  For machines which must pop arguments after a function call,
3557 the compiler normally lets arguments accumulate on the stack for several
3558 function calls and pops them all at once.
3560 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3562 @item -fforce-mem
3563 @opindex fforce-mem
3564 Force memory operands to be copied into registers before doing
3565 arithmetic on them.  This produces better code by making all memory
3566 references potential common subexpressions.  When they are not common
3567 subexpressions, instruction combination should eliminate the separate
3568 register-load.
3570 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3572 @item -fforce-addr
3573 @opindex fforce-addr
3574 Force memory address constants to be copied into registers before
3575 doing arithmetic on them.  This may produce better code just as
3576 @option{-fforce-mem} may.
3578 @item -fomit-frame-pointer
3579 @opindex fomit-frame-pointer
3580 Don't keep the frame pointer in a register for functions that
3581 don't need one.  This avoids the instructions to save, set up and
3582 restore frame pointers; it also makes an extra register available
3583 in many functions.  @strong{It also makes debugging impossible on
3584 some machines.}
3586 On some machines, such as the VAX, this flag has no effect, because
3587 the standard calling sequence automatically handles the frame pointer
3588 and nothing is saved by pretending it doesn't exist.  The
3589 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3590 whether a target machine supports this flag.  @xref{Registers,,Register
3591 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3593 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3595 @item -foptimize-sibling-calls
3596 @opindex foptimize-sibling-calls
3597 Optimize sibling and tail recursive calls.
3599 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3601 @item -ftrapv
3602 @opindex ftrapv
3603 This option generates traps for signed overflow on addition, subtraction,
3604 multiplication operations.
3606 @item -fno-inline
3607 @opindex fno-inline
3608 Don't pay attention to the @code{inline} keyword.  Normally this option
3609 is used to keep the compiler from expanding any functions inline.
3610 Note that if you are not optimizing, no functions can be expanded inline.
3612 @item -finline-functions
3613 @opindex finline-functions
3614 Integrate all simple functions into their callers.  The compiler
3615 heuristically decides which functions are simple enough to be worth
3616 integrating in this way.
3618 If all calls to a given function are integrated, and the function is
3619 declared @code{static}, then the function is normally not output as
3620 assembler code in its own right.
3622 Enabled at level @option{-O3}.
3624 @item -finline-limit=@var{n}
3625 @opindex finline-limit
3626 By default, gcc limits the size of functions that can be inlined.  This flag
3627 allows the control of this limit for functions that are explicitly marked as
3628 inline (i.e., marked with the inline keyword or defined within the class
3629 definition in c++).  @var{n} is the size of functions that can be inlined in
3630 number of pseudo instructions (not counting parameter handling).  The default
3631 value of @var{n} is 600.
3632 Increasing this value can result in more inlined code at
3633 the cost of compilation time and memory consumption.  Decreasing usually makes
3634 the compilation faster and less code will be inlined (which presumably
3635 means slower programs).  This option is particularly useful for programs that
3636 use inlining heavily such as those based on recursive templates with C++.
3638 @emph{Note:} pseudo instruction represents, in this particular context, an
3639 abstract measurement of function's size.  In no way, it represents a count
3640 of assembly instructions and as such its exact meaning might change from one
3641 release to an another.
3643 @item -fkeep-inline-functions
3644 @opindex fkeep-inline-functions
3645 Even if all calls to a given function are integrated, and the function
3646 is declared @code{static}, nevertheless output a separate run-time
3647 callable version of the function.  This switch does not affect
3648 @code{extern inline} functions.
3650 @item -fkeep-static-consts
3651 @opindex fkeep-static-consts
3652 Emit variables declared @code{static const} when optimization isn't turned
3653 on, even if the variables aren't referenced.
3655 GCC enables this option by default.  If you want to force the compiler to
3656 check if the variable was referenced, regardless of whether or not
3657 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3659 @item -fmerge-constants
3660 Attempt to merge identical constants (string constants and floating point
3661 constants) across compilation units.
3663 This option is the default for optimized compilation if the assembler and
3664 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3665 behavior.
3667 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3669 @item -fmerge-all-constants
3670 Attempt to merge identical constants and identical variables.
3672 This option implies @option{-fmerge-constants}.  In addition to
3673 @option{-fmerge-constants} this considers e.g. even constant initialized
3674 arrays or initialized constant variables with integral or floating point
3675 types.  Languages like C or C++ require each non-automatic variable to
3676 have distinct location, so using this option will result in non-conforming
3677 behavior.
3679 @item -fnew-ra
3680 @opindex fnew-ra
3681 Use a graph coloring register allocator.  Currently this option is meant
3682 for testing, so we are interested to hear about miscompilations with
3683 @option{-fnew-ra}.
3685 @item -fno-branch-count-reg
3686 @opindex fno-branch-count-reg
3687 Do not use ``decrement and branch'' instructions on a count register,
3688 but instead generate a sequence of instructions that decrement a
3689 register, compare it against zero, then branch based upon the result.
3690 This option is only meaningful on architectures that support such
3691 instructions, which include x86, PowerPC, IA-64 and S/390.
3693 The default is @option{-fbranch-count-reg}, enabled when
3694 @option{-fstrength-reduce} is enabled.
3696 @item -fno-function-cse
3697 @opindex fno-function-cse
3698 Do not put function addresses in registers; make each instruction that
3699 calls a constant function contain the function's address explicitly.
3701 This option results in less efficient code, but some strange hacks
3702 that alter the assembler output may be confused by the optimizations
3703 performed when this option is not used.
3705 The default is @option{-ffunction-cse}
3707 @item -ffast-math
3708 @opindex ffast-math
3709 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
3710 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
3711 @option{-fno-signaling-nans}.
3713 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3715 This option should never be turned on by any @option{-O} option since
3716 it can result in incorrect output for programs which depend on
3717 an exact implementation of IEEE or ISO rules/specifications for
3718 math functions.
3720 @item -fno-math-errno
3721 @opindex fno-math-errno
3722 Do not set ERRNO after calling math functions that are executed
3723 with a single instruction, e.g., sqrt.  A program that relies on
3724 IEEE exceptions for math error handling may want to use this flag
3725 for speed while maintaining IEEE arithmetic compatibility.
3727 This option should never be turned on by any @option{-O} option since
3728 it can result in incorrect output for programs which depend on
3729 an exact implementation of IEEE or ISO rules/specifications for
3730 math functions.
3732 The default is @option{-fmath-errno}.
3734 @item -funsafe-math-optimizations
3735 @opindex funsafe-math-optimizations
3736 Allow optimizations for floating-point arithmetic that (a) assume
3737 that arguments and results are valid and (b) may violate IEEE or
3738 ANSI standards.  When used at link-time, it may include libraries
3739 or startup files that change the default FPU control word or other
3740 similar optimizations.
3742 This option should never be turned on by any @option{-O} option since
3743 it can result in incorrect output for programs which depend on
3744 an exact implementation of IEEE or ISO rules/specifications for
3745 math functions.
3747 The default is @option{-fno-unsafe-math-optimizations}.
3749 @item -ffinite-math-only
3750 @opindex ffinite-math-only
3751 Allow optimizations for floating-point arithmetic that assume
3752 that arguments and results are not NaNs or +-Infs.
3754 This option should never be turned on by any @option{-O} option since
3755 it can result in incorrect output for programs which depend on
3756 an exact implementation of IEEE or ISO rules/specifications.
3758 The default is @option{-fno-finite-math-only}.
3760 @item -fno-trapping-math
3761 @opindex fno-trapping-math
3762 Compile code assuming that floating-point operations cannot generate
3763 user-visible traps.  These traps include division by zero, overflow,
3764 underflow, inexact result and invalid operation.  This option implies
3765 @option{-fno-signaling-nans}.  Setting this option may allow faster
3766 code if one relies on ``non-stop'' IEEE arithmetic, for example.
3768 This option should never be turned on by any @option{-O} option since
3769 it can result in incorrect output for programs which depend on
3770 an exact implementation of IEEE or ISO rules/specifications for
3771 math functions.
3773 The default is @option{-ftrapping-math}.
3775 @item -fsignaling-nans
3776 @opindex fsignaling-nans
3777 Compile code assuming that IEEE signaling NaNs may generate user-visible
3778 traps during floating-point operations.  Setting this option disables
3779 optimizations that may change the number of exceptions visible with
3780 signaling NaNs.  This option implies @option{-ftrapping-math}.
3782 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
3783 be defined.
3785 The default is @option{-fno-signaling-nans}.
3787 This option is experimental and does not currently guarantee to
3788 disable all GCC optimizations that affect signaling NaN behavior.
3790 @item -fno-zero-initialized-in-bss
3791 @opindex fno-zero-initialized-in-bss
3792 If the target supports a BSS section, GCC by default puts variables that
3793 are initialized to zero into BSS@.  This can save space in the resulting
3794 code.
3796 This option turns off this behavior because some programs explicitly
3797 rely on variables going to the data section.  E.g., so that the
3798 resulting executable can find the beginning of that section and/or make
3799 assumptions based on that.
3801 The default is @option{-fzero-initialized-in-bss}.
3803 @item -fbounds-check
3804 @opindex fbounds-check
3805 For front-ends that support it, generate additional code to check that
3806 indices used to access arrays are within the declared range.  This is
3807 currently only supported by the Java and Fortran 77 front-ends, where
3808 this option defaults to true and false respectively.
3810 @item -fstrength-reduce
3811 @opindex fstrength-reduce
3812 Perform the optimizations of loop strength reduction and
3813 elimination of iteration variables.
3815 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3817 @item -fthread-jumps
3818 @opindex fthread-jumps
3819 Perform optimizations where we check to see if a jump branches to a
3820 location where another comparison subsumed by the first is found.  If
3821 so, the first branch is redirected to either the destination of the
3822 second branch or a point immediately following it, depending on whether
3823 the condition is known to be true or false.
3825 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3827 @item -fcse-follow-jumps
3828 @opindex fcse-follow-jumps
3829 In common subexpression elimination, scan through jump instructions
3830 when the target of the jump is not reached by any other path.  For
3831 example, when CSE encounters an @code{if} statement with an
3832 @code{else} clause, CSE will follow the jump when the condition
3833 tested is false.
3835 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3837 @item -fcse-skip-blocks
3838 @opindex fcse-skip-blocks
3839 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3840 follow jumps which conditionally skip over blocks.  When CSE
3841 encounters a simple @code{if} statement with no else clause,
3842 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3843 body of the @code{if}.
3845 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3847 @item -frerun-cse-after-loop
3848 @opindex frerun-cse-after-loop
3849 Re-run common subexpression elimination after loop optimizations has been
3850 performed.
3852 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3854 @item -frerun-loop-opt
3855 @opindex frerun-loop-opt
3856 Run the loop optimizer twice.
3858 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3860 @item -fgcse
3861 @opindex fgcse
3862 Perform a global common subexpression elimination pass.
3863 This pass also performs global constant and copy propagation.
3865 @emph{Note:} When compiling a program using computed gotos, a GCC
3866 extension, you may get better runtime performance if you disable
3867 the global common subexpression elimination pass by adding
3868 @option{-fno-gcse} to the command line.
3870 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3872 @item -fgcse-lm
3873 @opindex fgcse-lm
3874 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3875 attempt to move loads which are only killed by stores into themselves.  This
3876 allows a loop containing a load/store sequence to be changed to a load outside
3877 the loop, and a copy/store within the loop.
3879 Enabled by default when gcse is enabled.
3881 @item -fgcse-sm
3882 @opindex fgcse-sm
3883 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3884 subexpression elimination.  This pass will attempt to move stores out of loops.
3885 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3886 can be changed to a load before the loop and a store after the loop.
3888 Enabled by default when gcse is enabled.
3890 @item -floop-optimize
3891 @opindex floop-optimize
3892 Perform loop optimizations: move constant expressions out of loops, simplify
3893 exit test conditions and optionally do strength-reduction and loop unrolling as
3894 well.
3896 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3898 @item -fcrossjumping
3899 @opindex crossjumping
3900 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3901 resulting code may or may not perform better than without cross-jumping.
3903 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3905 @item -fif-conversion
3906 @opindex if-conversion
3907 Attempt to transform conditional jumps into branch-less equivalents.  This
3908 include use of conditional moves, min, max, set flags and abs instructions, and
3909 some tricks doable by standard arithmetics.  The use of conditional execution
3910 on chips where it is available is controlled by @code{if-conversion2}.
3912 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3914 @item -fif-conversion2
3915 @opindex if-conversion2
3916 Use conditional execution (where available) to transform conditional jumps into
3917 branch-less equivalents.
3919 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3921 @item -fdelete-null-pointer-checks
3922 @opindex fdelete-null-pointer-checks
3923 Use global dataflow analysis to identify and eliminate useless checks
3924 for null pointers.  The compiler assumes that dereferencing a null
3925 pointer would have halted the program.  If a pointer is checked after
3926 it has already been dereferenced, it cannot be null.
3928 In some environments, this assumption is not true, and programs can
3929 safely dereference null pointers.  Use
3930 @option{-fno-delete-null-pointer-checks} to disable this optimization
3931 for programs which depend on that behavior.
3933 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3935 @item -fexpensive-optimizations
3936 @opindex fexpensive-optimizations
3937 Perform a number of minor optimizations that are relatively expensive.
3939 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3941 @item -foptimize-register-move
3942 @itemx -fregmove
3943 @opindex foptimize-register-move
3944 @opindex fregmove
3945 Attempt to reassign register numbers in move instructions and as
3946 operands of other simple instructions in order to maximize the amount of
3947 register tying.  This is especially helpful on machines with two-operand
3948 instructions.
3950 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3951 optimization.
3953 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3955 @item -fdelayed-branch
3956 @opindex fdelayed-branch
3957 If supported for the target machine, attempt to reorder instructions
3958 to exploit instruction slots available after delayed branch
3959 instructions.
3961 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3963 @item -fschedule-insns
3964 @opindex fschedule-insns
3965 If supported for the target machine, attempt to reorder instructions to
3966 eliminate execution stalls due to required data being unavailable.  This
3967 helps machines that have slow floating point or memory load instructions
3968 by allowing other instructions to be issued until the result of the load
3969 or floating point instruction is required.
3971 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3973 @item -fschedule-insns2
3974 @opindex fschedule-insns2
3975 Similar to @option{-fschedule-insns}, but requests an additional pass of
3976 instruction scheduling after register allocation has been done.  This is
3977 especially useful on machines with a relatively small number of
3978 registers and where memory load instructions take more than one cycle.
3980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3982 @item -fno-sched-interblock
3983 @opindex fno-sched-interblock
3984 Don't schedule instructions across basic blocks.  This is normally
3985 enabled by default when scheduling before register allocation, i.e.@:
3986 with @option{-fschedule-insns} or at @option{-O2} or higher.
3988 @item -fno-sched-spec
3989 @opindex fno-sched-spec
3990 Don't allow speculative motion of non-load instructions.  This is normally
3991 enabled by default when scheduling before register allocation, i.e.@:
3992 with @option{-fschedule-insns} or at @option{-O2} or higher.
3994 @item -fsched-spec-load
3995 @opindex fsched-spec-load
3996 Allow speculative motion of some load instructions.  This only makes
3997 sense when scheduling before register allocation, i.e.@: with
3998 @option{-fschedule-insns} or at @option{-O2} or higher.
4000 @item -fsched-spec-load-dangerous
4001 @opindex fsched-spec-load-dangerous
4002 Allow speculative motion of more load instructions.  This only makes
4003 sense when scheduling before register allocation, i.e.@: with
4004 @option{-fschedule-insns} or at @option{-O2} or higher.
4006 @item -ffunction-sections
4007 @itemx -fdata-sections
4008 @opindex ffunction-sections
4009 @opindex fdata-sections
4010 Place each function or data item into its own section in the output
4011 file if the target supports arbitrary sections.  The name of the
4012 function or the name of the data item determines the section's name
4013 in the output file.
4015 Use these options on systems where the linker can perform optimizations
4016 to improve locality of reference in the instruction space.  HPPA
4017 processors running HP-UX and SPARC processors running Solaris 2 have
4018 linkers with such optimizations.  Other systems using the ELF object format
4019 as well as AIX may have these optimizations in the future.
4021 Only use these options when there are significant benefits from doing
4022 so.  When you specify these options, the assembler and linker will
4023 create larger object and executable files and will also be slower.
4024 You will not be able to use @command{gprof} on all systems if you
4025 specify this option and you may have problems with debugging if
4026 you specify both this option and @option{-g}.
4028 @item -fcaller-saves
4029 @opindex fcaller-saves
4030 Enable values to be allocated in registers that will be clobbered by
4031 function calls, by emitting extra instructions to save and restore the
4032 registers around such calls.  Such allocation is done only when it
4033 seems to result in better code than would otherwise be produced.
4035 This option is always enabled by default on certain machines, usually
4036 those which have no call-preserved registers to use instead.
4038 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4040 @item -ftracer
4041 @opindex ftracer
4042 Perform tail duplication to enlarge superblock size. This transformation
4043 simplifies the control flow of the function allowing other optimizations to do
4044 better job.
4046 @item -funroll-loops
4047 @opindex funroll-loops
4048 Unroll loops whose number of iterations can be determined at compile
4049 time or upon entry to the loop.  @option{-funroll-loops} implies both
4050 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4051 option makes code larger, and may or may not make it run faster.
4053 @item -funroll-all-loops
4054 @opindex funroll-all-loops
4055 Unroll all loops, even if their number of iterations is uncertain when
4056 the loop is entered.  This usually makes programs run more slowly.
4057 @option{-funroll-all-loops} implies the same options as
4058 @option{-funroll-loops},
4060 @item -fprefetch-loop-arrays
4061 @opindex fprefetch-loop-arrays
4062 If supported by the target machine, generate instructions to prefetch
4063 memory to improve the performance of loops that access large arrays.
4065 Disabled at level @option{-Os}.
4067 @item -fmove-all-movables
4068 @opindex fmove-all-movables
4069 Forces all invariant computations in loops to be moved
4070 outside the loop.
4072 @item -freduce-all-givs
4073 @opindex freduce-all-givs
4074 Forces all general-induction variables in loops to be
4075 strength-reduced.
4077 @emph{Note:} When compiling programs written in Fortran,
4078 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4079 by default when you use the optimizer.
4081 These options may generate better or worse code; results are highly
4082 dependent on the structure of loops within the source code.
4084 These two options are intended to be removed someday, once
4085 they have helped determine the efficacy of various
4086 approaches to improving loop optimizations.
4088 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4089 know how use of these options affects
4090 the performance of your production code.
4091 We're very interested in code that runs @emph{slower}
4092 when these options are @emph{enabled}.
4094 @item -fno-peephole
4095 @itemx -fno-peephole2
4096 @opindex fno-peephole
4097 @opindex fno-peephole2
4098 Disable any machine-specific peephole optimizations.  The difference
4099 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4100 are implemented in the compiler; some targets use one, some use the
4101 other, a few use both.
4103 @option{-fpeephole} is enabled by default.
4104 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4106 @item -fbranch-probabilities
4107 @opindex fbranch-probabilities
4108 After running a program compiled with @option{-fprofile-arcs}
4109 (@pxref{Debugging Options,, Options for Debugging Your Program or
4110 @command{gcc}}), you can compile it a second time using
4111 @option{-fbranch-probabilities}, to improve optimizations based on
4112 the number of times each branch was taken.  When the program
4113 compiled with @option{-fprofile-arcs} exits it saves arc execution
4114 counts to a file called @file{@var{sourcename}.da} for each source
4115 file  The information in this data file is very dependent on the
4116 structure of the generated code, so you must use the same source code
4117 and the same optimization options for both compilations.
4119 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
4120 note on the first instruction of each basic block, and a
4121 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4122 These can be used to improve optimization.  Currently, they are only
4123 used in one place: in @file{reorg.c}, instead of guessing which path a
4124 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4125 exactly determine which path is taken more often.
4127 @item -fno-guess-branch-probability
4128 @opindex fno-guess-branch-probability
4129 Do not guess branch probabilities using a randomized model.
4131 Sometimes gcc will opt to use a randomized model to guess branch
4132 probabilities, when none are available from either profiling feedback
4133 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4134 different runs of the compiler on the same program may produce different
4135 object code.
4137 In a hard real-time system, people don't want different runs of the
4138 compiler to produce code that has different behavior; minimizing
4139 non-determinism is of paramount import.  This switch allows users to
4140 reduce non-determinism, possibly at the expense of inferior
4141 optimization.
4143 The default is @option{-fguess-branch-probability} at levels
4144 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4146 @item -freorder-blocks
4147 @opindex freorder-blocks
4148 Reorder basic blocks in the compiled function in order to reduce number of
4149 taken branches and improve code locality.
4151 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4153 @item -freorder-functions
4154 @opindex freorder-functions
4155 Reorder basic blocks in the compiled function in order to reduce number of
4156 taken branches and improve code locality. This is implemented by using special
4157 subsections @code{text.hot} for most frequently executed functions and
4158 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4159 the linker so object file format must support named sections and linker must
4160 place them in a reasonable way.
4162 Also profile feedback must be available in to make this option effective.  See
4163 @option{-fprofile-arcs} for details.
4165 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4167 @item -fstrict-aliasing
4168 @opindex fstrict-aliasing
4169 Allows the compiler to assume the strictest aliasing rules applicable to
4170 the language being compiled.  For C (and C++), this activates
4171 optimizations based on the type of expressions.  In particular, an
4172 object of one type is assumed never to reside at the same address as an
4173 object of a different type, unless the types are almost the same.  For
4174 example, an @code{unsigned int} can alias an @code{int}, but not a
4175 @code{void*} or a @code{double}.  A character type may alias any other
4176 type.
4178 Pay special attention to code like this:
4179 @example
4180 union a_union @{
4181   int i;
4182   double d;
4185 int f() @{
4186   a_union t;
4187   t.d = 3.0;
4188   return t.i;
4190 @end example
4191 The practice of reading from a different union member than the one most
4192 recently written to (called ``type-punning'') is common.  Even with
4193 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4194 is accessed through the union type.  So, the code above will work as
4195 expected.  However, this code might not:
4196 @example
4197 int f() @{
4198   a_union t;
4199   int* ip;
4200   t.d = 3.0;
4201   ip = &t.i;
4202   return *ip;
4204 @end example
4206 Every language that wishes to perform language-specific alias analysis
4207 should define a function that computes, given an @code{tree}
4208 node, an alias set for the node.  Nodes in different alias sets are not
4209 allowed to alias.  For an example, see the C front-end function
4210 @code{c_get_alias_set}.
4212 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4214 @item -falign-functions
4215 @itemx -falign-functions=@var{n}
4216 @opindex falign-functions
4217 Align the start of functions to the next power-of-two greater than
4218 @var{n}, skipping up to @var{n} bytes.  For instance,
4219 @option{-falign-functions=32} aligns functions to the next 32-byte
4220 boundary, but @option{-falign-functions=24} would align to the next
4221 32-byte boundary only if this can be done by skipping 23 bytes or less.
4223 @option{-fno-align-functions} and @option{-falign-functions=1} are
4224 equivalent and mean that functions will not be aligned.
4226 Some assemblers only support this flag when @var{n} is a power of two;
4227 in that case, it is rounded up.
4229 If @var{n} is not specified, use a machine-dependent default.
4231 Enabled at levels @option{-O2}, @option{-O3}.
4233 @item -falign-labels
4234 @itemx -falign-labels=@var{n}
4235 @opindex falign-labels
4236 Align all branch targets to a power-of-two boundary, skipping up to
4237 @var{n} bytes like @option{-falign-functions}.  This option can easily
4238 make code slower, because it must insert dummy operations for when the
4239 branch target is reached in the usual flow of the code.
4241 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4242 are greater than this value, then their values are used instead.
4244 If @var{n} is not specified, use a machine-dependent default which is
4245 very likely to be @samp{1}, meaning no alignment.
4247 Enabled at levels @option{-O2}, @option{-O3}.
4249 @item -falign-loops
4250 @itemx -falign-loops=@var{n}
4251 @opindex falign-loops
4252 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4253 like @option{-falign-functions}.  The hope is that the loop will be
4254 executed many times, which will make up for any execution of the dummy
4255 operations.
4257 If @var{n} is not specified, use a machine-dependent default.
4259 Enabled at levels @option{-O2}, @option{-O3}.
4261 @item -falign-jumps
4262 @itemx -falign-jumps=@var{n}
4263 @opindex falign-jumps
4264 Align branch targets to a power-of-two boundary, for branch targets
4265 where the targets can only be reached by jumping, skipping up to @var{n}
4266 bytes like @option{-falign-functions}.  In this case, no dummy operations
4267 need be executed.
4269 If @var{n} is not specified, use a machine-dependent default.
4271 Enabled at levels @option{-O2}, @option{-O3}.
4273 @item -fssa
4274 @opindex fssa
4275 Perform optimizations in static single assignment form.  Each function's
4276 flow graph is translated into SSA form, optimizations are performed, and
4277 the flow graph is translated back from SSA form.  Users should not
4278 specify this option, since it is not yet ready for production use.
4280 @item -fssa-ccp
4281 @opindex fssa-ccp
4282 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4283 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4285 @item -fssa-dce
4286 @opindex fssa-dce
4287 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4288 Like @option{-fssa}, this is an experimental feature.
4290 @item -fsingle-precision-constant
4291 @opindex fsingle-precision-constant
4292 Treat floating point constant as single precision constant instead of
4293 implicitly converting it to double precision constant.
4295 @item -frename-registers
4296 @opindex frename-registers
4297 Attempt to avoid false dependencies in scheduled code by making use
4298 of registers left over after register allocation.  This optimization
4299 will most benefit processors with lots of registers.  It can, however,
4300 make debugging impossible, since variables will no longer stay in
4301 a ``home register''.
4303 Enabled at levels @option{-O3}.
4305 @item -fno-cprop-registers
4306 @opindex fno-cprop-registers
4307 After register allocation and post-register allocation instruction splitting,
4308 we perform a copy-propagation pass to try to reduce scheduling dependencies
4309 and occasionally eliminate the copy.
4311 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4313 @item --param @var{name}=@var{value}
4314 @opindex param
4315 In some places, GCC uses various constants to control the amount of
4316 optimization that is done.  For example, GCC will not inline functions
4317 that contain more that a certain number of instructions.  You can
4318 control some of these constants on the command-line using the
4319 @option{--param} option.
4321 In each case, the @var{value} is an integer.  The allowable choices for
4322 @var{name} are given in the following table:
4324 @table @gcctabopt
4325 @item max-delay-slot-insn-search
4326 The maximum number of instructions to consider when looking for an
4327 instruction to fill a delay slot.  If more than this arbitrary number of
4328 instructions is searched, the time savings from filling the delay slot
4329 will be minimal so stop searching.  Increasing values mean more
4330 aggressive optimization, making the compile time increase with probably
4331 small improvement in executable run time.
4333 @item max-delay-slot-live-search
4334 When trying to fill delay slots, the maximum number of instructions to
4335 consider when searching for a block with valid live register
4336 information.  Increasing this arbitrarily chosen value means more
4337 aggressive optimization, increasing the compile time.  This parameter
4338 should be removed when the delay slot code is rewritten to maintain the
4339 control-flow graph.
4341 @item max-gcse-memory
4342 The approximate maximum amount of memory that will be allocated in
4343 order to perform the global common subexpression elimination
4344 optimization.  If more memory than specified is required, the
4345 optimization will not be done.
4347 @item max-gcse-passes
4348 The maximum number of passes of GCSE to run.
4350 @item max-pending-list-length
4351 The maximum number of pending dependencies scheduling will allow
4352 before flushing the current state and starting over.  Large functions
4353 with few branches or calls can create excessively large lists which
4354 needlessly consume memory and resources.
4356 @item max-inline-insns
4357 If an function contains more than this many instructions, it
4358 will not be inlined.  This option is precisely equivalent to
4359 @option{-finline-limit}.
4361 @item max-unrolled-insns
4362 The maximum number of instructions that a loop should have if that loop
4363 is unrolled, and if the loop is unrolled, it determines how many times
4364 the loop code is unrolled.
4366 @item hot-bb-count-fraction
4367 Select fraction of the maximal count of repetitions of basic block in program
4368 given basic block needs to have to be considered hot.
4370 @item hot-bb-frequency-fraction
4371 Select fraction of the maximal frequency of executions of basic block in
4372 function given basic block needs to have to be considered hot
4374 @item tracer-dynamic-coverage
4375 @itemx tracer-dynamic-coverage-feedback
4377 This value is used to limit superblock formation once the given percentage of
4378 executed instructions is covered.  This limits unnecessary code size
4379 expansion.
4381 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4382 feedback is available.  The real profiles (as opposed to statically estimated
4383 ones) are much less balanced allowing the threshold to be larger value.
4385 @item tracer-max-code-growth
4386 Stop tail duplication once code growth has reached given percentage.  This is
4387 rather hokey argument, as most of the duplicates will be eliminated later in
4388 cross jumping, so it may be set to much higher values than is the desired code
4389 growth.
4391 @item tracer-min-branch-ratio
4393 Stop reverse growth when the reverse probability of best edge is less than this
4394 threshold (in percent).
4396 @item tracer-min-branch-ratio
4397 @itemx tracer-min-branch-ratio-feedback
4399 Stop forward growth if the best edge do have probability lower than this
4400 threshold.
4402 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4403 compilation for profile feedback and one for compilation without.  The value
4404 for compilation with profile feedback needs to be more conservative (higher) in
4405 order to make tracer effective.
4407 @item ggc-min-expand
4409 GCC uses a garbage collector to manage its own memory allocation.  This
4410 parameter specifies the minimum percentage by which the garbage
4411 collector's heap should be allowed to expand between collections.
4412 Tuning this may improve compilation speed; it has no effect on code
4413 generation.
4415 The default is 30%.  Setting this parameter and
4416 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4417 every opportunity.  This is extremely slow, but can be useful for
4418 debugging.
4420 @item ggc-min-heapsize
4422 Minimum size of the garbage collector's heap before it begins bothering
4423 to collect garbage.  The first collection occurs after the heap expands
4424 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4425 tuning this may improve compilation speed, and has no effect on code
4426 generation.
4428 The default is 4096 (four megabytes).  Setting this parameter very large
4429 effectively disables garbage collection.  Setting this parameter and
4430 @option{ggc-min-expand} to zero causes a full collection to occur at
4431 every opportunity.  
4433 @end table
4434 @end table
4436 @node Preprocessor Options
4437 @section Options Controlling the Preprocessor
4438 @cindex preprocessor options
4439 @cindex options, preprocessor
4441 These options control the C preprocessor, which is run on each C source
4442 file before actual compilation.
4444 If you use the @option{-E} option, nothing is done except preprocessing.
4445 Some of these options make sense only together with @option{-E} because
4446 they cause the preprocessor output to be unsuitable for actual
4447 compilation.
4449 @table @gcctabopt
4450 @opindex Wp
4451 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4452 and pass @var{option} directly through to the preprocessor.  If
4453 @var{option} contains commas, it is split into multiple options at the
4454 commas.  However, many options are modified, translated or interpreted
4455 by the compiler driver before being passed to the preprocessor, and
4456 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4457 interface is undocumented and subject to change, so whenever possible
4458 you should avoid using @option{-Wp} and let the driver handle the
4459 options instead.
4461 @item -Xpreprocessor @var{option}
4462 @opindex preprocessor
4463 Pass @var{option} as an option to the preprocessor.  You can use this to
4464 supply system-specific preprocessor options which GCC does not know how to
4465 recognize.
4467 If you want to pass an option that takes an argument, you must use
4468 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4469 @end table
4471 @include cppopts.texi
4473 @node Assembler Options
4474 @section Passing Options to the Assembler
4476 @c prevent bad page break with this line
4477 You can pass options to the assembler.
4479 @table @gcctabopt
4480 @item -Wa,@var{option}
4481 @opindex Wa
4482 Pass @var{option} as an option to the assembler.  If @var{option}
4483 contains commas, it is split into multiple options at the commas.
4485 @item -Xassembler @var{option}
4486 @opindex Xassembler
4487 Pass @var{option} as an option to the assembler.  You can use this to
4488 supply system-specific assembler options which GCC does not know how to
4489 recognize.
4491 If you want to pass an option that takes an argument, you must use
4492 @option{-Xassembler} twice, once for the option and once for the argument.
4494 @end table
4496 @node Link Options
4497 @section Options for Linking
4498 @cindex link options
4499 @cindex options, linking
4501 These options come into play when the compiler links object files into
4502 an executable output file.  They are meaningless if the compiler is
4503 not doing a link step.
4505 @table @gcctabopt
4506 @cindex file names
4507 @item @var{object-file-name}
4508 A file name that does not end in a special recognized suffix is
4509 considered to name an object file or library.  (Object files are
4510 distinguished from libraries by the linker according to the file
4511 contents.)  If linking is done, these object files are used as input
4512 to the linker.
4514 @item -c
4515 @itemx -S
4516 @itemx -E
4517 @opindex c
4518 @opindex S
4519 @opindex E
4520 If any of these options is used, then the linker is not run, and
4521 object file names should not be used as arguments.  @xref{Overall
4522 Options}.
4524 @cindex Libraries
4525 @item -l@var{library}
4526 @itemx -l @var{library}
4527 @opindex l
4528 Search the library named @var{library} when linking.  (The second
4529 alternative with the library as a separate argument is only for
4530 POSIX compliance and is not recommended.)
4532 It makes a difference where in the command you write this option; the
4533 linker searches and processes libraries and object files in the order they
4534 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4535 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4536 to functions in @samp{z}, those functions may not be loaded.
4538 The linker searches a standard list of directories for the library,
4539 which is actually a file named @file{lib@var{library}.a}.  The linker
4540 then uses this file as if it had been specified precisely by name.
4542 The directories searched include several standard system directories
4543 plus any that you specify with @option{-L}.
4545 Normally the files found this way are library files---archive files
4546 whose members are object files.  The linker handles an archive file by
4547 scanning through it for members which define symbols that have so far
4548 been referenced but not defined.  But if the file that is found is an
4549 ordinary object file, it is linked in the usual fashion.  The only
4550 difference between using an @option{-l} option and specifying a file name
4551 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4552 and searches several directories.
4554 @item -lobjc
4555 @opindex lobjc
4556 You need this special case of the @option{-l} option in order to
4557 link an Objective-C program.
4559 @item -nostartfiles
4560 @opindex nostartfiles
4561 Do not use the standard system startup files when linking.
4562 The standard system libraries are used normally, unless @option{-nostdlib}
4563 or @option{-nodefaultlibs} is used.
4565 @item -nodefaultlibs
4566 @opindex nodefaultlibs
4567 Do not use the standard system libraries when linking.
4568 Only the libraries you specify will be passed to the linker.
4569 The standard startup files are used normally, unless @option{-nostartfiles}
4570 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4571 for System V (and ISO C) environments or to bcopy and bzero for
4572 BSD environments.  These entries are usually resolved by entries in
4573 libc.  These entry points should be supplied through some other
4574 mechanism when this option is specified.
4576 @item -nostdlib
4577 @opindex nostdlib
4578 Do not use the standard system startup files or libraries when linking.
4579 No startup files and only the libraries you specify will be passed to
4580 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4581 for System V (and ISO C) environments or to bcopy and bzero for
4582 BSD environments.  These entries are usually resolved by entries in
4583 libc.  These entry points should be supplied through some other
4584 mechanism when this option is specified.
4586 @cindex @option{-lgcc}, use with @option{-nostdlib}
4587 @cindex @option{-nostdlib} and unresolved references
4588 @cindex unresolved references and @option{-nostdlib}
4589 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4590 @cindex @option{-nodefaultlibs} and unresolved references
4591 @cindex unresolved references and @option{-nodefaultlibs}
4592 One of the standard libraries bypassed by @option{-nostdlib} and
4593 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4594 that GCC uses to overcome shortcomings of particular machines, or special
4595 needs for some languages.
4596 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4597 Collection (GCC) Internals},
4598 for more discussion of @file{libgcc.a}.)
4599 In most cases, you need @file{libgcc.a} even when you want to avoid
4600 other standard libraries.  In other words, when you specify @option{-nostdlib}
4601 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4602 This ensures that you have no unresolved references to internal GCC
4603 library subroutines.  (For example, @samp{__main}, used to ensure C++
4604 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4605 GNU Compiler Collection (GCC) Internals}.)
4607 @item -s
4608 @opindex s
4609 Remove all symbol table and relocation information from the executable.
4611 @item -static
4612 @opindex static
4613 On systems that support dynamic linking, this prevents linking with the shared
4614 libraries.  On other systems, this option has no effect.
4616 @item -shared
4617 @opindex shared
4618 Produce a shared object which can then be linked with other objects to
4619 form an executable.  Not all systems support this option.  For predictable
4620 results, you must also specify the same set of options that were used to
4621 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4622 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4623 needs to build supplementary stub code for constructors to work.  On
4624 multi-libbed systems, @samp{gcc -shared} must select the correct support
4625 libraries to link against.  Failing to supply the correct flags may lead
4626 to subtle defects.  Supplying them in cases where they are not necessary
4627 is innocuous.}
4629 @item -shared-libgcc
4630 @itemx -static-libgcc
4631 @opindex shared-libgcc
4632 @opindex static-libgcc
4633 On systems that provide @file{libgcc} as a shared library, these options
4634 force the use of either the shared or static version respectively.
4635 If no shared version of @file{libgcc} was built when the compiler was
4636 configured, these options have no effect.
4638 There are several situations in which an application should use the
4639 shared @file{libgcc} instead of the static version.  The most common
4640 of these is when the application wishes to throw and catch exceptions
4641 across different shared libraries.  In that case, each of the libraries
4642 as well as the application itself should use the shared @file{libgcc}.
4644 Therefore, the G++ and GCJ drivers automatically add
4645 @option{-shared-libgcc} whenever you build a shared library or a main
4646 executable, because C++ and Java programs typically use exceptions, so
4647 this is the right thing to do.
4649 If, instead, you use the GCC driver to create shared libraries, you may
4650 find that they will not always be linked with the shared @file{libgcc}.
4651 If GCC finds, at its configuration time, that you have a GNU linker that
4652 does not support option @option{--eh-frame-hdr}, it will link the shared
4653 version of @file{libgcc} into shared libraries by default.  Otherwise,
4654 it will take advantage of the linker and optimize away the linking with
4655 the shared version of @file{libgcc}, linking with the static version of
4656 libgcc by default.  This allows exceptions to propagate through such
4657 shared libraries, without incurring relocation costs at library load
4658 time.
4660 However, if a library or main executable is supposed to throw or catch
4661 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4662 for the languages used in the program, or using the option
4663 @option{-shared-libgcc}, such that it is linked with the shared
4664 @file{libgcc}.
4666 @item -symbolic
4667 @opindex symbolic
4668 Bind references to global symbols when building a shared object.  Warn
4669 about any unresolved references (unless overridden by the link editor
4670 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4671 this option.
4673 @item -Xlinker @var{option}
4674 @opindex Xlinker
4675 Pass @var{option} as an option to the linker.  You can use this to
4676 supply system-specific linker options which GCC does not know how to
4677 recognize.
4679 If you want to pass an option that takes an argument, you must use
4680 @option{-Xlinker} twice, once for the option and once for the argument.
4681 For example, to pass @option{-assert definitions}, you must write
4682 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4683 @option{-Xlinker "-assert definitions"}, because this passes the entire
4684 string as a single argument, which is not what the linker expects.
4686 @item -Wl,@var{option}
4687 @opindex Wl
4688 Pass @var{option} as an option to the linker.  If @var{option} contains
4689 commas, it is split into multiple options at the commas.
4691 @item -u @var{symbol}
4692 @opindex u
4693 Pretend the symbol @var{symbol} is undefined, to force linking of
4694 library modules to define it.  You can use @option{-u} multiple times with
4695 different symbols to force loading of additional library modules.
4696 @end table
4698 @node Directory Options
4699 @section Options for Directory Search
4700 @cindex directory options
4701 @cindex options, directory search
4702 @cindex search path
4704 These options specify directories to search for header files, for
4705 libraries and for parts of the compiler:
4707 @table @gcctabopt
4708 @item -I@var{dir}
4709 @opindex I
4710 Add the directory @var{dir} to the head of the list of directories to be
4711 searched for header files.  This can be used to override a system header
4712 file, substituting your own version, since these directories are
4713 searched before the system header file directories.  However, you should
4714 not use this option to add directories that contain vendor-supplied
4715 system header files (use @option{-isystem} for that).  If you use more than
4716 one @option{-I} option, the directories are scanned in left-to-right
4717 order; the standard system directories come after.
4719 If a standard system include directory, or a directory specified with
4720 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4721 option will be ignored.  The directory will still be searched but as a
4722 system directory at its normal position in the system include chain.
4723 This is to ensure that GCC's procedure to fix buggy system headers and
4724 the ordering for the include_next directive are not inadvertently changed.
4725 If you really need to change the search order for system directories,
4726 use the @option{-nostdinc} and/or @option{-isystem} options.
4728 @item -I-
4729 @opindex I-
4730 Any directories you specify with @option{-I} options before the @option{-I-}
4731 option are searched only for the case of @samp{#include "@var{file}"};
4732 they are not searched for @samp{#include <@var{file}>}.
4734 If additional directories are specified with @option{-I} options after
4735 the @option{-I-}, these directories are searched for all @samp{#include}
4736 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4737 this way.)
4739 In addition, the @option{-I-} option inhibits the use of the current
4740 directory (where the current input file came from) as the first search
4741 directory for @samp{#include "@var{file}"}.  There is no way to
4742 override this effect of @option{-I-}.  With @option{-I.} you can specify
4743 searching the directory which was current when the compiler was
4744 invoked.  That is not exactly the same as what the preprocessor does
4745 by default, but it is often satisfactory.
4747 @option{-I-} does not inhibit the use of the standard system directories
4748 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4749 independent.
4751 @item -L@var{dir}
4752 @opindex L
4753 Add directory @var{dir} to the list of directories to be searched
4754 for @option{-l}.
4756 @item -B@var{prefix}
4757 @opindex B
4758 This option specifies where to find the executables, libraries,
4759 include files, and data files of the compiler itself.
4761 The compiler driver program runs one or more of the subprograms
4762 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4763 @var{prefix} as a prefix for each program it tries to run, both with and
4764 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4766 For each subprogram to be run, the compiler driver first tries the
4767 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4768 was not specified, the driver tries two standard prefixes, which are
4769 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4770 those results in a file name that is found, the unmodified program
4771 name is searched for using the directories specified in your
4772 @env{PATH} environment variable.
4774 The compiler will check to see if the path provided by the @option{-B}
4775 refers to a directory, and if necessary it will add a directory
4776 separator character at the end of the path.
4778 @option{-B} prefixes that effectively specify directory names also apply
4779 to libraries in the linker, because the compiler translates these
4780 options into @option{-L} options for the linker.  They also apply to
4781 includes files in the preprocessor, because the compiler translates these
4782 options into @option{-isystem} options for the preprocessor.  In this case,
4783 the compiler appends @samp{include} to the prefix.
4785 The run-time support file @file{libgcc.a} can also be searched for using
4786 the @option{-B} prefix, if needed.  If it is not found there, the two
4787 standard prefixes above are tried, and that is all.  The file is left
4788 out of the link if it is not found by those means.
4790 Another way to specify a prefix much like the @option{-B} prefix is to use
4791 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4792 Variables}.
4794 As a special kludge, if the path provided by @option{-B} is
4795 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4796 9, then it will be replaced by @file{[dir/]include}.  This is to help
4797 with boot-strapping the compiler.
4799 @item -specs=@var{file}
4800 @opindex specs
4801 Process @var{file} after the compiler reads in the standard @file{specs}
4802 file, in order to override the defaults that the @file{gcc} driver
4803 program uses when determining what switches to pass to @file{cc1},
4804 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4805 @option{-specs=@var{file}} can be specified on the command line, and they
4806 are processed in order, from left to right.
4807 @end table
4809 @c man end
4811 @node Spec Files
4812 @section Specifying subprocesses and the switches to pass to them
4813 @cindex Spec Files
4814 @command{gcc} is a driver program.  It performs its job by invoking a
4815 sequence of other programs to do the work of compiling, assembling and
4816 linking.  GCC interprets its command-line parameters and uses these to
4817 deduce which programs it should invoke, and which command-line options
4818 it ought to place on their command lines.  This behavior is controlled
4819 by @dfn{spec strings}.  In most cases there is one spec string for each
4820 program that GCC can invoke, but a few programs have multiple spec
4821 strings to control their behavior.  The spec strings built into GCC can
4822 be overridden by using the @option{-specs=} command-line switch to specify
4823 a spec file.
4825 @dfn{Spec files} are plaintext files that are used to construct spec
4826 strings.  They consist of a sequence of directives separated by blank
4827 lines.  The type of directive is determined by the first non-whitespace
4828 character on the line and it can be one of the following:
4830 @table @code
4831 @item %@var{command}
4832 Issues a @var{command} to the spec file processor.  The commands that can
4833 appear here are:
4835 @table @code
4836 @item %include <@var{file}>
4837 @cindex %include
4838 Search for @var{file} and insert its text at the current point in the
4839 specs file.
4841 @item %include_noerr <@var{file}>
4842 @cindex %include_noerr
4843 Just like @samp{%include}, but do not generate an error message if the include
4844 file cannot be found.
4846 @item %rename @var{old_name} @var{new_name}
4847 @cindex %rename
4848 Rename the spec string @var{old_name} to @var{new_name}.
4850 @end table
4852 @item *[@var{spec_name}]:
4853 This tells the compiler to create, override or delete the named spec
4854 string.  All lines after this directive up to the next directive or
4855 blank line are considered to be the text for the spec string.  If this
4856 results in an empty string then the spec will be deleted.  (Or, if the
4857 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4858 does not currently exist a new spec will be created.  If the spec does
4859 exist then its contents will be overridden by the text of this
4860 directive, unless the first character of that text is the @samp{+}
4861 character, in which case the text will be appended to the spec.
4863 @item [@var{suffix}]:
4864 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4865 and up to the next directive or blank line are considered to make up the
4866 spec string for the indicated suffix.  When the compiler encounters an
4867 input file with the named suffix, it will processes the spec string in
4868 order to work out how to compile that file.  For example:
4870 @smallexample
4871 .ZZ:
4872 z-compile -input %i
4873 @end smallexample
4875 This says that any input file whose name ends in @samp{.ZZ} should be
4876 passed to the program @samp{z-compile}, which should be invoked with the
4877 command-line switch @option{-input} and with the result of performing the
4878 @samp{%i} substitution.  (See below.)
4880 As an alternative to providing a spec string, the text that follows a
4881 suffix directive can be one of the following:
4883 @table @code
4884 @item @@@var{language}
4885 This says that the suffix is an alias for a known @var{language}.  This is
4886 similar to using the @option{-x} command-line switch to GCC to specify a
4887 language explicitly.  For example:
4889 @smallexample
4890 .ZZ:
4891 @@c++
4892 @end smallexample
4894 Says that .ZZ files are, in fact, C++ source files.
4896 @item #@var{name}
4897 This causes an error messages saying:
4899 @smallexample
4900 @var{name} compiler not installed on this system.
4901 @end smallexample
4902 @end table
4904 GCC already has an extensive list of suffixes built into it.
4905 This directive will add an entry to the end of the list of suffixes, but
4906 since the list is searched from the end backwards, it is effectively
4907 possible to override earlier entries using this technique.
4909 @end table
4911 GCC has the following spec strings built into it.  Spec files can
4912 override these strings or create their own.  Note that individual
4913 targets can also add their own spec strings to this list.
4915 @smallexample
4916 asm          Options to pass to the assembler
4917 asm_final    Options to pass to the assembler post-processor
4918 cpp          Options to pass to the C preprocessor
4919 cc1          Options to pass to the C compiler
4920 cc1plus      Options to pass to the C++ compiler
4921 endfile      Object files to include at the end of the link
4922 link         Options to pass to the linker
4923 lib          Libraries to include on the command line to the linker
4924 libgcc       Decides which GCC support library to pass to the linker
4925 linker       Sets the name of the linker
4926 predefines   Defines to be passed to the C preprocessor
4927 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4928              by default
4929 startfile    Object files to include at the start of the link
4930 @end smallexample
4932 Here is a small example of a spec file:
4934 @smallexample
4935 %rename lib                 old_lib
4937 *lib:
4938 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4939 @end smallexample
4941 This example renames the spec called @samp{lib} to @samp{old_lib} and
4942 then overrides the previous definition of @samp{lib} with a new one.
4943 The new definition adds in some extra command-line options before
4944 including the text of the old definition.
4946 @dfn{Spec strings} are a list of command-line options to be passed to their
4947 corresponding program.  In addition, the spec strings can contain
4948 @samp{%}-prefixed sequences to substitute variable text or to
4949 conditionally insert text into the command line.  Using these constructs
4950 it is possible to generate quite complex command lines.
4952 Here is a table of all defined @samp{%}-sequences for spec
4953 strings.  Note that spaces are not generated automatically around the
4954 results of expanding these sequences.  Therefore you can concatenate them
4955 together or combine them with constant text in a single argument.
4957 @table @code
4958 @item %%
4959 Substitute one @samp{%} into the program name or argument.
4961 @item %i
4962 Substitute the name of the input file being processed.
4964 @item %b
4965 Substitute the basename of the input file being processed.
4966 This is the substring up to (and not including) the last period
4967 and not including the directory.
4969 @item %B
4970 This is the same as @samp{%b}, but include the file suffix (text after
4971 the last period).
4973 @item %d
4974 Marks the argument containing or following the @samp{%d} as a
4975 temporary file name, so that that file will be deleted if GCC exits
4976 successfully.  Unlike @samp{%g}, this contributes no text to the
4977 argument.
4979 @item %g@var{suffix}
4980 Substitute a file name that has suffix @var{suffix} and is chosen
4981 once per compilation, and mark the argument in the same way as
4982 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4983 name is now chosen in a way that is hard to predict even when previously
4984 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4985 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4986 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4987 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4988 was simply substituted with a file name chosen once per compilation,
4989 without regard to any appended suffix (which was therefore treated
4990 just like ordinary text), making such attacks more likely to succeed.
4992 @item %u@var{suffix}
4993 Like @samp{%g}, but generates a new temporary file name even if
4994 @samp{%u@var{suffix}} was already seen.
4996 @item %U@var{suffix}
4997 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4998 new one if there is no such last file name.  In the absence of any
4999 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5000 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5001 would involve the generation of two distinct file names, one
5002 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5003 simply substituted with a file name chosen for the previous @samp{%u},
5004 without regard to any appended suffix.
5006 @item %j@var{suffix}
5007 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5008 writable, and if save-temps is off; otherwise, substitute the name
5009 of a temporary file, just like @samp{%u}.  This temporary file is not
5010 meant for communication between processes, but rather as a junk
5011 disposal mechanism.
5013 @item %|@var{suffix}
5014 @itemx %m@var{suffix}
5015 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5016 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5017 all.  These are the two most common ways to instruct a program that it
5018 should read from standard input or write to standard output.  If you
5019 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5020 construct: see for example @file{f/lang-specs.h}.
5022 @item %.@var{SUFFIX}
5023 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5024 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5025 terminated by the next space or %.
5027 @item %w
5028 Marks the argument containing or following the @samp{%w} as the
5029 designated output file of this compilation.  This puts the argument
5030 into the sequence of arguments that @samp{%o} will substitute later.
5032 @item %o
5033 Substitutes the names of all the output files, with spaces
5034 automatically placed around them.  You should write spaces
5035 around the @samp{%o} as well or the results are undefined.
5036 @samp{%o} is for use in the specs for running the linker.
5037 Input files whose names have no recognized suffix are not compiled
5038 at all, but they are included among the output files, so they will
5039 be linked.
5041 @item %O
5042 Substitutes the suffix for object files.  Note that this is
5043 handled specially when it immediately follows @samp{%g, %u, or %U},
5044 because of the need for those to form complete file names.  The
5045 handling is such that @samp{%O} is treated exactly as if it had already
5046 been substituted, except that @samp{%g, %u, and %U} do not currently
5047 support additional @var{suffix} characters following @samp{%O} as they would
5048 following, for example, @samp{.o}.
5050 @item %p
5051 Substitutes the standard macro predefinitions for the
5052 current target machine.  Use this when running @code{cpp}.
5054 @item %P
5055 Like @samp{%p}, but puts @samp{__} before and after the name of each
5056 predefined macro, except for macros that start with @samp{__} or with
5057 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5060 @item %I
5061 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
5063 @item %s
5064 Current argument is the name of a library or startup file of some sort.
5065 Search for that file in a standard list of directories and substitute
5066 the full name found.
5068 @item %e@var{str}
5069 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5070 Use this when inconsistent options are detected.
5072 @item %(@var{name})
5073 Substitute the contents of spec string @var{name} at this point.
5075 @item %[@var{name}]
5076 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5078 @item %x@{@var{option}@}
5079 Accumulate an option for @samp{%X}.
5081 @item %X
5082 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5083 spec string.
5085 @item %Y
5086 Output the accumulated assembler options specified by @option{-Wa}.
5088 @item %Z
5089 Output the accumulated preprocessor options specified by @option{-Wp}.
5091 @item %v1
5092 Substitute the major version number of GCC@.
5093 (For version 2.9.5, this is 2.)
5095 @item %v2
5096 Substitute the minor version number of GCC@.
5097 (For version 2.9.5, this is 9.)
5099 @item %v3
5100 Substitute the patch level number of GCC@.
5101 (For version 2.9.5, this is 5.)
5103 @item %a
5104 Process the @code{asm} spec.  This is used to compute the
5105 switches to be passed to the assembler.
5107 @item %A
5108 Process the @code{asm_final} spec.  This is a spec string for
5109 passing switches to an assembler post-processor, if such a program is
5110 needed.
5112 @item %l
5113 Process the @code{link} spec.  This is the spec for computing the
5114 command line passed to the linker.  Typically it will make use of the
5115 @samp{%L %G %S %D and %E} sequences.
5117 @item %D
5118 Dump out a @option{-L} option for each directory that GCC believes might
5119 contain startup files.  If the target supports multilibs then the
5120 current multilib directory will be prepended to each of these paths.
5122 @item %M
5123 Output the multilib directory with directory separators replaced with
5124 @samp{_}.  If multilib directories are not set, or the multilib directory is
5125 @file{.} then this option emits nothing.
5127 @item %L
5128 Process the @code{lib} spec.  This is a spec string for deciding which
5129 libraries should be included on the command line to the linker.
5131 @item %G
5132 Process the @code{libgcc} spec.  This is a spec string for deciding
5133 which GCC support library should be included on the command line to the linker.
5135 @item %S
5136 Process the @code{startfile} spec.  This is a spec for deciding which
5137 object files should be the first ones passed to the linker.  Typically
5138 this might be a file named @file{crt0.o}.
5140 @item %E
5141 Process the @code{endfile} spec.  This is a spec string that specifies
5142 the last object files that will be passed to the linker.
5144 @item %C
5145 Process the @code{cpp} spec.  This is used to construct the arguments
5146 to be passed to the C preprocessor.
5148 @item %c
5149 Process the @code{signed_char} spec.  This is intended to be used
5150 to tell cpp whether a char is signed.  It typically has the definition:
5151 @smallexample
5152 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5153 @end smallexample
5155 @item %1
5156 Process the @code{cc1} spec.  This is used to construct the options to be
5157 passed to the actual C compiler (@samp{cc1}).
5159 @item %2
5160 Process the @code{cc1plus} spec.  This is used to construct the options to be
5161 passed to the actual C++ compiler (@samp{cc1plus}).
5163 @item %*
5164 Substitute the variable part of a matched option.  See below.
5165 Note that each comma in the substituted string is replaced by
5166 a single space.
5168 @item %<@code{S}
5169 Remove all occurrences of @code{-S} from the command line.  Note---this
5170 command is position dependent.  @samp{%} commands in the spec string
5171 before this one will see @code{-S}, @samp{%} commands in the spec string
5172 after this one will not.
5174 @item %:@var{function}(@var{args})
5175 Call the named function @var{function}, passing it @var{args}.
5176 @var{args} is first processed as a nested spec string, then split
5177 into an argument vector in the usual fashion.  The function returns
5178 a string which is processed as if it had appeared literally as part
5179 of the current spec.
5181 The following built-in spec functions are provided:
5183 @table @code
5184 @item @code{if-exists}
5185 The @code{if-exists} spec function takes one argument, an absolute
5186 pathname to a file.  If the file exists, @code{if-exists} returns the
5187 pathname.  Here is a small example of its usage:
5189 @smallexample
5190 *startfile:
5191 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5192 @end smallexample
5194 @item @code{if-exists-else}
5195 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5196 spec function, except that it takes two arguments.  The first argument is
5197 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5198 returns the pathname.  If it does not exist, it returns the second argument.
5199 This way, @code{if-exists-else} can be used to select one file or another,
5200 based on the existence of the first.  Here is a small example of its usage:
5202 @smallexample 
5203 *startfile:
5204 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5205 @end smallexample
5206 @end table 
5208 @item %@{@code{S}@}
5209 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5210 If that switch was not specified, this substitutes nothing.  Note that
5211 the leading dash is omitted when specifying this option, and it is
5212 automatically inserted if the substitution is performed.  Thus the spec
5213 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5214 and would output the command line option @option{-foo}.
5216 @item %W@{@code{S}@}
5217 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5218 deleted on failure.
5220 @item %@{@code{S}*@}
5221 Substitutes all the switches specified to GCC whose names start
5222 with @code{-S}, but which also take an argument.  This is used for
5223 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5224 GCC considers @option{-o foo} as being
5225 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5226 text, including the space.  Thus two arguments would be generated.
5228 @item %@{@code{S}*&@code{T}*@}
5229 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5230 (the order of @code{S} and @code{T} in the spec is not significant).
5231 There can be any number of ampersand-separated variables; for each the
5232 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5234 @item %@{@code{S}:@code{X}@}
5235 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5237 @item %@{!@code{S}:@code{X}@}
5238 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5240 @item %@{@code{S}*:@code{X}@}
5241 Substitutes @code{X} if one or more switches whose names start with
5242 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5243 once, no matter how many such switches appeared.  However, if @code{%*}
5244 appears somewhere in @code{X}, then @code{X} will be substituted once
5245 for each matching switch, with the @code{%*} replaced by the part of
5246 that switch that matched the @code{*}.
5248 @item %@{.@code{S}:@code{X}@}
5249 Substitutes @code{X}, if processing a file with suffix @code{S}.
5251 @item %@{!.@code{S}:@code{X}@}
5252 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5254 @item %@{@code{S}|@code{P}:@code{X}@}
5255 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5256 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5257 although they have a stronger binding than the @samp{|}.  If @code{%*}
5258 appears in @code{X}, all of the alternatives must be starred, and only
5259 the first matching alternative is substituted.
5261 For example, a spec string like this:
5263 @smallexample
5264 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5265 @end smallexample
5267 will output the following command-line options from the following input
5268 command-line options:
5270 @smallexample
5271 fred.c        -foo -baz
5272 jim.d         -bar -boggle
5273 -d fred.c     -foo -baz -boggle
5274 -d jim.d      -bar -baz -boggle
5275 @end smallexample
5277 @item %@{S:X; T:Y; :D@}
5279 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5280 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5281 be as many clauses as you need.  This may be combined with @code{.}, 
5282 @code{!}, @code{|}, and @code{*} as needed.
5285 @end table
5287 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5288 construct may contain other nested @samp{%} constructs or spaces, or
5289 even newlines.  They are processed as usual, as described above.
5290 Trailing white space in @code{X} is ignored.  White space may also
5291 appear anywhere on the left side of the colon in these constructs,
5292 except between @code{.} or @code{*} and the corresponding word.
5294 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5295 handled specifically in these constructs.  If another value of
5296 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5297 @option{-W} switch is found later in the command line, the earlier
5298 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5299 just one letter, which passes all matching options.
5301 The character @samp{|} at the beginning of the predicate text is used to
5302 indicate that a command should be piped to the following command, but
5303 only if @option{-pipe} is specified.
5305 It is built into GCC which switches take arguments and which do not.
5306 (You might think it would be useful to generalize this to allow each
5307 compiler's spec to say which switches take arguments.  But this cannot
5308 be done in a consistent fashion.  GCC cannot even decide which input
5309 files have been specified without knowing which switches take arguments,
5310 and it must know which input files to compile in order to tell which
5311 compilers to run).
5313 GCC also knows implicitly that arguments starting in @option{-l} are to be
5314 treated as compiler output files, and passed to the linker in their
5315 proper position among the other output files.
5317 @c man begin OPTIONS
5319 @node Target Options
5320 @section Specifying Target Machine and Compiler Version
5321 @cindex target options
5322 @cindex cross compiling
5323 @cindex specifying machine version
5324 @cindex specifying compiler version and target machine
5325 @cindex compiler version, specifying
5326 @cindex target machine, specifying
5328 The usual way to run GCC is to run the executable called @file{gcc}, or
5329 @file{<machine>-gcc} when cross-compiling, or
5330 @file{<machine>-gcc-<version>} to run a version other than the one that
5331 was installed last.  Sometimes this is inconvenient, so GCC provides
5332 options that will switch to another cross-compiler or version.
5334 @table @gcctabopt
5335 @item -b @var{machine}
5336 @opindex b
5337 The argument @var{machine} specifies the target machine for compilation.
5339 The value to use for @var{machine} is the same as was specified as the
5340 machine type when configuring GCC as a cross-compiler.  For
5341 example, if a cross-compiler was configured with @samp{configure
5342 i386v}, meaning to compile for an 80386 running System V, then you
5343 would specify @option{-b i386v} to run that cross compiler.
5345 @item -V @var{version}
5346 @opindex V
5347 The argument @var{version} specifies which version of GCC to run.
5348 This is useful when multiple versions are installed.  For example,
5349 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5350 @end table
5352 The @option{-V} and @option{-b} options work by running the
5353 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5354 use them if you can just run that directly.
5356 @node Submodel Options
5357 @section Hardware Models and Configurations
5358 @cindex submodel options
5359 @cindex specifying hardware config
5360 @cindex hardware models and configurations, specifying
5361 @cindex machine dependent options
5363 Earlier we discussed the standard option @option{-b} which chooses among
5364 different installed compilers for completely different target
5365 machines, such as VAX vs.@: 68000 vs.@: 80386.
5367 In addition, each of these target machine types can have its own
5368 special options, starting with @samp{-m}, to choose among various
5369 hardware models or configurations---for example, 68010 vs 68020,
5370 floating coprocessor or none.  A single installed version of the
5371 compiler can compile for any model or configuration, according to the
5372 options specified.
5374 Some configurations of the compiler also support additional special
5375 options, usually for compatibility with other compilers on the same
5376 platform.
5378 These options are defined by the macro @code{TARGET_SWITCHES} in the
5379 machine description.  The default for the options is also defined by
5380 that macro, which enables you to change the defaults.
5382 @menu
5383 * M680x0 Options::
5384 * M68hc1x Options::
5385 * VAX Options::
5386 * SPARC Options::
5387 * ARM Options::
5388 * MN10200 Options::
5389 * MN10300 Options::
5390 * M32R/D Options::
5391 * M88K Options::
5392 * RS/6000 and PowerPC Options::
5393 * Darwin Options::
5394 * RT Options::
5395 * MIPS Options::
5396 * i386 and x86-64 Options::
5397 * HPPA Options::
5398 * Intel 960 Options::
5399 * DEC Alpha Options::
5400 * DEC Alpha/VMS Options::
5401 * H8/300 Options::
5402 * SH Options::
5403 * System V Options::
5404 * TMS320C3x/C4x Options::
5405 * V850 Options::
5406 * ARC Options::
5407 * NS32K Options::
5408 * AVR Options::
5409 * MCore Options::
5410 * IA-64 Options::
5411 * D30V Options::
5412 * S/390 and zSeries Options::
5413 * CRIS Options::
5414 * MMIX Options::
5415 * PDP-11 Options::
5416 * Xstormy16 Options::
5417 * Xtensa Options::
5418 * FRV Options::
5419 @end menu
5421 @node M680x0 Options
5422 @subsection M680x0 Options
5423 @cindex M680x0 options
5425 These are the @samp{-m} options defined for the 68000 series.  The default
5426 values for these options depends on which style of 68000 was selected when
5427 the compiler was configured; the defaults for the most common choices are
5428 given below.
5430 @table @gcctabopt
5431 @item -m68000
5432 @itemx -mc68000
5433 @opindex m68000
5434 @opindex mc68000
5435 Generate output for a 68000.  This is the default
5436 when the compiler is configured for 68000-based systems.
5438 Use this option for microcontrollers with a 68000 or EC000 core,
5439 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5441 @item -m68020
5442 @itemx -mc68020
5443 @opindex m68020
5444 @opindex mc68020
5445 Generate output for a 68020.  This is the default
5446 when the compiler is configured for 68020-based systems.
5448 @item -m68881
5449 @opindex m68881
5450 Generate output containing 68881 instructions for floating point.
5451 This is the default for most 68020 systems unless @option{--nfp} was
5452 specified when the compiler was configured.
5454 @item -m68030
5455 @opindex m68030
5456 Generate output for a 68030.  This is the default when the compiler is
5457 configured for 68030-based systems.
5459 @item -m68040
5460 @opindex m68040
5461 Generate output for a 68040.  This is the default when the compiler is
5462 configured for 68040-based systems.
5464 This option inhibits the use of 68881/68882 instructions that have to be
5465 emulated by software on the 68040.  Use this option if your 68040 does not
5466 have code to emulate those instructions.
5468 @item -m68060
5469 @opindex m68060
5470 Generate output for a 68060.  This is the default when the compiler is
5471 configured for 68060-based systems.
5473 This option inhibits the use of 68020 and 68881/68882 instructions that
5474 have to be emulated by software on the 68060.  Use this option if your 68060
5475 does not have code to emulate those instructions.
5477 @item -mcpu32
5478 @opindex mcpu32
5479 Generate output for a CPU32.  This is the default
5480 when the compiler is configured for CPU32-based systems.
5482 Use this option for microcontrollers with a
5483 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5484 68336, 68340, 68341, 68349 and 68360.
5486 @item -m5200
5487 @opindex m5200
5488 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5489 when the compiler is configured for 520X-based systems.
5491 Use this option for microcontroller with a 5200 core, including
5492 the MCF5202, MCF5203, MCF5204 and MCF5202.
5495 @item -m68020-40
5496 @opindex m68020-40
5497 Generate output for a 68040, without using any of the new instructions.
5498 This results in code which can run relatively efficiently on either a
5499 68020/68881 or a 68030 or a 68040.  The generated code does use the
5500 68881 instructions that are emulated on the 68040.
5502 @item -m68020-60
5503 @opindex m68020-60
5504 Generate output for a 68060, without using any of the new instructions.
5505 This results in code which can run relatively efficiently on either a
5506 68020/68881 or a 68030 or a 68040.  The generated code does use the
5507 68881 instructions that are emulated on the 68060.
5509 @item -mfpa
5510 @opindex mfpa
5511 Generate output containing Sun FPA instructions for floating point.
5513 @item -msoft-float
5514 @opindex msoft-float
5515 Generate output containing library calls for floating point.
5516 @strong{Warning:} the requisite libraries are not available for all m68k
5517 targets.  Normally the facilities of the machine's usual C compiler are
5518 used, but this can't be done directly in cross-compilation.  You must
5519 make your own arrangements to provide suitable library functions for
5520 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5521 @samp{m68k-*-coff} do provide software floating point support.
5523 @item -mshort
5524 @opindex mshort
5525 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5527 @item -mnobitfield
5528 @opindex mnobitfield
5529 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5530 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5532 @item -mbitfield
5533 @opindex mbitfield
5534 Do use the bit-field instructions.  The @option{-m68020} option implies
5535 @option{-mbitfield}.  This is the default if you use a configuration
5536 designed for a 68020.
5538 @item -mrtd
5539 @opindex mrtd
5540 Use a different function-calling convention, in which functions
5541 that take a fixed number of arguments return with the @code{rtd}
5542 instruction, which pops their arguments while returning.  This
5543 saves one instruction in the caller since there is no need to pop
5544 the arguments there.
5546 This calling convention is incompatible with the one normally
5547 used on Unix, so you cannot use it if you need to call libraries
5548 compiled with the Unix compiler.
5550 Also, you must provide function prototypes for all functions that
5551 take variable numbers of arguments (including @code{printf});
5552 otherwise incorrect code will be generated for calls to those
5553 functions.
5555 In addition, seriously incorrect code will result if you call a
5556 function with too many arguments.  (Normally, extra arguments are
5557 harmlessly ignored.)
5559 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5560 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5562 @item -malign-int
5563 @itemx -mno-align-int
5564 @opindex malign-int
5565 @opindex mno-align-int
5566 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5567 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5568 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5569 Aligning variables on 32-bit boundaries produces code that runs somewhat
5570 faster on processors with 32-bit busses at the expense of more memory.
5572 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5573 align structures containing the above types  differently than
5574 most published application binary interface specifications for the m68k.
5576 @item -mpcrel
5577 @opindex mpcrel
5578 Use the pc-relative addressing mode of the 68000 directly, instead of
5579 using a global offset table.  At present, this option implies @option{-fpic},
5580 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5581 not presently supported with @option{-mpcrel}, though this could be supported for
5582 68020 and higher processors.
5584 @item -mno-strict-align
5585 @itemx -mstrict-align
5586 @opindex mno-strict-align
5587 @opindex mstrict-align
5588 Do not (do) assume that unaligned memory references will be handled by
5589 the system.
5591 @end table
5593 @node M68hc1x Options
5594 @subsection M68hc1x Options
5595 @cindex M68hc1x options
5597 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5598 microcontrollers.  The default values for these options depends on
5599 which style of microcontroller was selected when the compiler was configured;
5600 the defaults for the most common choices are given below.
5602 @table @gcctabopt
5603 @item -m6811
5604 @itemx -m68hc11
5605 @opindex m6811
5606 @opindex m68hc11
5607 Generate output for a 68HC11.  This is the default
5608 when the compiler is configured for 68HC11-based systems.
5610 @item -m6812
5611 @itemx -m68hc12
5612 @opindex m6812
5613 @opindex m68hc12
5614 Generate output for a 68HC12.  This is the default
5615 when the compiler is configured for 68HC12-based systems.
5617 @item -m68S12
5618 @itemx -m68hcs12
5619 @opindex m68S12
5620 @opindex m68hcs12
5621 Generate output for a 68HCS12.  
5623 @item -mauto-incdec
5624 @opindex mauto-incdec
5625 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5626 addressing modes.
5628 @item -minmax
5629 @itemx -nominmax
5630 @opindex minmax
5631 @opindex mnominmax
5632 Enable the use of 68HC12 min and max instructions.
5634 @item -mlong-calls
5635 @itemx -mno-long-calls
5636 @opindex mlong-calls
5637 @opindex mno-long-calls
5638 Treat all calls as being far away (near).  If calls are assumed to be
5639 far away, the compiler will use the @code{call} instruction to
5640 call a function and the @code{rtc} instruction for returning.
5642 @item -mshort
5643 @opindex mshort
5644 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5646 @item -msoft-reg-count=@var{count}
5647 @opindex msoft-reg-count
5648 Specify the number of pseudo-soft registers which are used for the
5649 code generation.  The maximum number is 32.  Using more pseudo-soft
5650 register may or may not result in better code depending on the program.
5651 The default is 4 for 68HC11 and 2 for 68HC12.
5653 @end table
5655 @node VAX Options
5656 @subsection VAX Options
5657 @cindex VAX options
5659 These @samp{-m} options are defined for the VAX:
5661 @table @gcctabopt
5662 @item -munix
5663 @opindex munix
5664 Do not output certain jump instructions (@code{aobleq} and so on)
5665 that the Unix assembler for the VAX cannot handle across long
5666 ranges.
5668 @item -mgnu
5669 @opindex mgnu
5670 Do output those jump instructions, on the assumption that you
5671 will assemble with the GNU assembler.
5673 @item -mg
5674 @opindex mg
5675 Output code for g-format floating point numbers instead of d-format.
5676 @end table
5678 @node SPARC Options
5679 @subsection SPARC Options
5680 @cindex SPARC options
5682 These @samp{-m} switches are supported on the SPARC:
5684 @table @gcctabopt
5685 @item -mno-app-regs
5686 @itemx -mapp-regs
5687 @opindex mno-app-regs
5688 @opindex mapp-regs
5689 Specify @option{-mapp-regs} to generate output using the global registers
5690 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5691 is the default.
5693 To be fully SVR4 ABI compliant at the cost of some performance loss,
5694 specify @option{-mno-app-regs}.  You should compile libraries and system
5695 software with this option.
5697 @item -mfpu
5698 @itemx -mhard-float
5699 @opindex mfpu
5700 @opindex mhard-float
5701 Generate output containing floating point instructions.  This is the
5702 default.
5704 @item -mno-fpu
5705 @itemx -msoft-float
5706 @opindex mno-fpu
5707 @opindex msoft-float
5708 Generate output containing library calls for floating point.
5709 @strong{Warning:} the requisite libraries are not available for all SPARC
5710 targets.  Normally the facilities of the machine's usual C compiler are
5711 used, but this cannot be done directly in cross-compilation.  You must make
5712 your own arrangements to provide suitable library functions for
5713 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5714 @samp{sparclite-*-*} do provide software floating point support.
5716 @option{-msoft-float} changes the calling convention in the output file;
5717 therefore, it is only useful if you compile @emph{all} of a program with
5718 this option.  In particular, you need to compile @file{libgcc.a}, the
5719 library that comes with GCC, with @option{-msoft-float} in order for
5720 this to work.
5722 @item -mhard-quad-float
5723 @opindex mhard-quad-float
5724 Generate output containing quad-word (long double) floating point
5725 instructions.
5727 @item -msoft-quad-float
5728 @opindex msoft-quad-float
5729 Generate output containing library calls for quad-word (long double)
5730 floating point instructions.  The functions called are those specified
5731 in the SPARC ABI@.  This is the default.
5733 As of this writing, there are no sparc implementations that have hardware
5734 support for the quad-word floating point instructions.  They all invoke
5735 a trap handler for one of these instructions, and then the trap handler
5736 emulates the effect of the instruction.  Because of the trap handler overhead,
5737 this is much slower than calling the ABI library routines.  Thus the
5738 @option{-msoft-quad-float} option is the default.
5740 @item -mno-flat
5741 @itemx -mflat
5742 @opindex mno-flat
5743 @opindex mflat
5744 With @option{-mflat}, the compiler does not generate save/restore instructions
5745 and will use a ``flat'' or single register window calling convention.
5746 This model uses %i7 as the frame pointer and is compatible with the normal
5747 register window model.  Code from either may be intermixed.
5748 The local registers and the input registers (0--5) are still treated as
5749 ``call saved'' registers and will be saved on the stack as necessary.
5751 With @option{-mno-flat} (the default), the compiler emits save/restore
5752 instructions (except for leaf functions) and is the normal mode of operation.
5754 @item -mno-unaligned-doubles
5755 @itemx -munaligned-doubles
5756 @opindex mno-unaligned-doubles
5757 @opindex munaligned-doubles
5758 Assume that doubles have 8 byte alignment.  This is the default.
5760 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5761 alignment only if they are contained in another type, or if they have an
5762 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5763 Specifying this option avoids some rare compatibility problems with code
5764 generated by other compilers.  It is not the default because it results
5765 in a performance loss, especially for floating point code.
5767 @item -mno-faster-structs
5768 @itemx -mfaster-structs
5769 @opindex mno-faster-structs
5770 @opindex mfaster-structs
5771 With @option{-mfaster-structs}, the compiler assumes that structures
5772 should have 8 byte alignment.  This enables the use of pairs of
5773 @code{ldd} and @code{std} instructions for copies in structure
5774 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5775 However, the use of this changed alignment directly violates the SPARC
5776 ABI@.  Thus, it's intended only for use on targets where the developer
5777 acknowledges that their resulting code will not be directly in line with
5778 the rules of the ABI@.
5780 @item -mv8
5781 @itemx -msparclite
5782 @opindex mv8
5783 @opindex msparclite
5784 These two options select variations on the SPARC architecture.
5786 By default (unless specifically configured for the Fujitsu SPARClite),
5787 GCC generates code for the v7 variant of the SPARC architecture.
5789 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5790 code is that the compiler emits the integer multiply and integer
5791 divide instructions which exist in SPARC v8 but not in SPARC v7.
5793 @option{-msparclite} will give you SPARClite code.  This adds the integer
5794 multiply, integer divide step and scan (@code{ffs}) instructions which
5795 exist in SPARClite but not in SPARC v7.
5797 These options are deprecated and will be deleted in a future GCC release.
5798 They have been replaced with @option{-mcpu=xxx}.
5800 @item -mcypress
5801 @itemx -msupersparc
5802 @opindex mcypress
5803 @opindex msupersparc
5804 These two options select the processor for which the code is optimized.
5806 With @option{-mcypress} (the default), the compiler optimizes code for the
5807 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5808 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5810 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5811 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5812 of the full SPARC v8 instruction set.
5814 These options are deprecated and will be deleted in a future GCC release.
5815 They have been replaced with @option{-mcpu=xxx}.
5817 @item -mcpu=@var{cpu_type}
5818 @opindex mcpu
5819 Set the instruction set, register set, and instruction scheduling parameters
5820 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5821 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5822 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5823 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5824 @samp{ultrasparc3}.
5826 Default instruction scheduling parameters are used for values that select
5827 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5828 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5830 Here is a list of each supported architecture and their supported
5831 implementations.
5833 @smallexample
5834     v7:             cypress
5835     v8:             supersparc, hypersparc
5836     sparclite:      f930, f934, sparclite86x
5837     sparclet:       tsc701
5838     v9:             ultrasparc, ultrasparc3
5839 @end smallexample
5841 @item -mtune=@var{cpu_type}
5842 @opindex mtune
5843 Set the instruction scheduling parameters for machine type
5844 @var{cpu_type}, but do not set the instruction set or register set that the
5845 option @option{-mcpu=@var{cpu_type}} would.
5847 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5848 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5849 that select a particular cpu implementation.  Those are @samp{cypress},
5850 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5851 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5852 @samp{ultrasparc3}.
5854 @end table
5856 These @samp{-m} switches are supported in addition to the above
5857 on the SPARCLET processor.
5859 @table @gcctabopt
5860 @item -mlittle-endian
5861 @opindex mlittle-endian
5862 Generate code for a processor running in little-endian mode.
5864 @item -mlive-g0
5865 @opindex mlive-g0
5866 Treat register @code{%g0} as a normal register.
5867 GCC will continue to clobber it as necessary but will not assume
5868 it always reads as 0.
5870 @item -mbroken-saverestore
5871 @opindex mbroken-saverestore
5872 Generate code that does not use non-trivial forms of the @code{save} and
5873 @code{restore} instructions.  Early versions of the SPARCLET processor do
5874 not correctly handle @code{save} and @code{restore} instructions used with
5875 arguments.  They correctly handle them used without arguments.  A @code{save}
5876 instruction used without arguments increments the current window pointer
5877 but does not allocate a new stack frame.  It is assumed that the window
5878 overflow trap handler will properly handle this case as will interrupt
5879 handlers.
5880 @end table
5882 These @samp{-m} switches are supported in addition to the above
5883 on SPARC V9 processors in 64-bit environments.
5885 @table @gcctabopt
5886 @item -mlittle-endian
5887 @opindex mlittle-endian
5888 Generate code for a processor running in little-endian mode.
5890 @item -m32
5891 @itemx -m64
5892 @opindex m32
5893 @opindex m64
5894 Generate code for a 32-bit or 64-bit environment.
5895 The 32-bit environment sets int, long and pointer to 32 bits.
5896 The 64-bit environment sets int to 32 bits and long and pointer
5897 to 64 bits.
5899 @item -mcmodel=medlow
5900 @opindex mcmodel=medlow
5901 Generate code for the Medium/Low code model: the program must be linked
5902 in the low 32 bits of the address space.  Pointers are 64 bits.
5903 Programs can be statically or dynamically linked.
5905 @item -mcmodel=medmid
5906 @opindex mcmodel=medmid
5907 Generate code for the Medium/Middle code model: the program must be linked
5908 in the low 44 bits of the address space, the text segment must be less than
5909 2G bytes, and data segment must be within 2G of the text segment.
5910 Pointers are 64 bits.
5912 @item -mcmodel=medany
5913 @opindex mcmodel=medany
5914 Generate code for the Medium/Anywhere code model: the program may be linked
5915 anywhere in the address space, the text segment must be less than
5916 2G bytes, and data segment must be within 2G of the text segment.
5917 Pointers are 64 bits.
5919 @item -mcmodel=embmedany
5920 @opindex mcmodel=embmedany
5921 Generate code for the Medium/Anywhere code model for embedded systems:
5922 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5923 (determined at link time).  Register %g4 points to the base of the
5924 data segment.  Pointers are still 64 bits.
5925 Programs are statically linked, PIC is not supported.
5927 @item -mstack-bias
5928 @itemx -mno-stack-bias
5929 @opindex mstack-bias
5930 @opindex mno-stack-bias
5931 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5932 frame pointer if present, are offset by @minus{}2047 which must be added back
5933 when making stack frame references.
5934 Otherwise, assume no such offset is present.
5935 @end table
5937 @node ARM Options
5938 @subsection ARM Options
5939 @cindex ARM options
5941 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5942 architectures:
5944 @table @gcctabopt
5945 @item -mapcs-frame
5946 @opindex mapcs-frame
5947 Generate a stack frame that is compliant with the ARM Procedure Call
5948 Standard for all functions, even if this is not strictly necessary for
5949 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5950 with this option will cause the stack frames not to be generated for
5951 leaf functions.  The default is @option{-mno-apcs-frame}.
5953 @item -mapcs
5954 @opindex mapcs
5955 This is a synonym for @option{-mapcs-frame}.
5957 @item -mapcs-26
5958 @opindex mapcs-26
5959 Generate code for a processor running with a 26-bit program counter,
5960 and conforming to the function calling standards for the APCS 26-bit
5961 option.  This option replaces the @option{-m2} and @option{-m3} options
5962 of previous releases of the compiler.
5964 @item -mapcs-32
5965 @opindex mapcs-32
5966 Generate code for a processor running with a 32-bit program counter,
5967 and conforming to the function calling standards for the APCS 32-bit
5968 option.  This option replaces the @option{-m6} option of previous releases
5969 of the compiler.
5971 @ignore
5972 @c not currently implemented
5973 @item -mapcs-stack-check
5974 @opindex mapcs-stack-check
5975 Generate code to check the amount of stack space available upon entry to
5976 every function (that actually uses some stack space).  If there is
5977 insufficient space available then either the function
5978 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5979 called, depending upon the amount of stack space required.  The run time
5980 system is required to provide these functions.  The default is
5981 @option{-mno-apcs-stack-check}, since this produces smaller code.
5983 @c not currently implemented
5984 @item -mapcs-float
5985 @opindex mapcs-float
5986 Pass floating point arguments using the float point registers.  This is
5987 one of the variants of the APCS@.  This option is recommended if the
5988 target hardware has a floating point unit or if a lot of floating point
5989 arithmetic is going to be performed by the code.  The default is
5990 @option{-mno-apcs-float}, since integer only code is slightly increased in
5991 size if @option{-mapcs-float} is used.
5993 @c not currently implemented
5994 @item -mapcs-reentrant
5995 @opindex mapcs-reentrant
5996 Generate reentrant, position independent code.  The default is
5997 @option{-mno-apcs-reentrant}.
5998 @end ignore
6000 @item -mthumb-interwork
6001 @opindex mthumb-interwork
6002 Generate code which supports calling between the ARM and Thumb
6003 instruction sets.  Without this option the two instruction sets cannot
6004 be reliably used inside one program.  The default is
6005 @option{-mno-thumb-interwork}, since slightly larger code is generated
6006 when @option{-mthumb-interwork} is specified.
6008 @item -mno-sched-prolog
6009 @opindex mno-sched-prolog
6010 Prevent the reordering of instructions in the function prolog, or the
6011 merging of those instruction with the instructions in the function's
6012 body.  This means that all functions will start with a recognizable set
6013 of instructions (or in fact one of a choice from a small set of
6014 different function prologues), and this information can be used to
6015 locate the start if functions inside an executable piece of code.  The
6016 default is @option{-msched-prolog}.
6018 @item -mhard-float
6019 @opindex mhard-float
6020 Generate output containing floating point instructions.  This is the
6021 default.
6023 @item -msoft-float
6024 @opindex msoft-float
6025 Generate output containing library calls for floating point.
6026 @strong{Warning:} the requisite libraries are not available for all ARM
6027 targets.  Normally the facilities of the machine's usual C compiler are
6028 used, but this cannot be done directly in cross-compilation.  You must make
6029 your own arrangements to provide suitable library functions for
6030 cross-compilation.
6032 @option{-msoft-float} changes the calling convention in the output file;
6033 therefore, it is only useful if you compile @emph{all} of a program with
6034 this option.  In particular, you need to compile @file{libgcc.a}, the
6035 library that comes with GCC, with @option{-msoft-float} in order for
6036 this to work.
6038 @item -mlittle-endian
6039 @opindex mlittle-endian
6040 Generate code for a processor running in little-endian mode.  This is
6041 the default for all standard configurations.
6043 @item -mbig-endian
6044 @opindex mbig-endian
6045 Generate code for a processor running in big-endian mode; the default is
6046 to compile code for a little-endian processor.
6048 @item -mwords-little-endian
6049 @opindex mwords-little-endian
6050 This option only applies when generating code for big-endian processors.
6051 Generate code for a little-endian word order but a big-endian byte
6052 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6053 option should only be used if you require compatibility with code for
6054 big-endian ARM processors generated by versions of the compiler prior to
6055 2.8.
6057 @item -malignment-traps
6058 @opindex malignment-traps
6059 Generate code that will not trap if the MMU has alignment traps enabled.
6060 On ARM architectures prior to ARMv4, there were no instructions to
6061 access half-word objects stored in memory.  However, when reading from
6062 memory a feature of the ARM architecture allows a word load to be used,
6063 even if the address is unaligned, and the processor core will rotate the
6064 data as it is being loaded.  This option tells the compiler that such
6065 misaligned accesses will cause a MMU trap and that it should instead
6066 synthesize the access as a series of byte accesses.  The compiler can
6067 still use word accesses to load half-word data if it knows that the
6068 address is aligned to a word boundary.
6070 This option is ignored when compiling for ARM architecture 4 or later,
6071 since these processors have instructions to directly access half-word
6072 objects in memory.
6074 @item -mno-alignment-traps
6075 @opindex mno-alignment-traps
6076 Generate code that assumes that the MMU will not trap unaligned
6077 accesses.  This produces better code when the target instruction set
6078 does not have half-word memory operations (i.e.@: implementations prior to
6079 ARMv4).
6081 Note that you cannot use this option to access unaligned word objects,
6082 since the processor will only fetch one 32-bit aligned object from
6083 memory.
6085 The default setting for most targets is @option{-mno-alignment-traps}, since
6086 this produces better code when there are no half-word memory
6087 instructions available.
6089 @item -mshort-load-bytes
6090 @itemx -mno-short-load-words
6091 @opindex mshort-load-bytes
6092 @opindex mno-short-load-words
6093 These are deprecated aliases for @option{-malignment-traps}.
6095 @item -mno-short-load-bytes
6096 @itemx -mshort-load-words
6097 @opindex mno-short-load-bytes
6098 @opindex mshort-load-words
6099 This are deprecated aliases for @option{-mno-alignment-traps}.
6101 @item -mcpu=@var{name}
6102 @opindex mcpu
6103 This specifies the name of the target ARM processor.  GCC uses this name
6104 to determine what kind of instructions it can emit when generating
6105 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6106 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6107 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6108 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6109 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6110 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6111 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6112 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6113 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6114 @samp{arm1020t}, @samp{xscale}.
6116 @itemx -mtune=@var{name}
6117 @opindex mtune
6118 This option is very similar to the @option{-mcpu=} option, except that
6119 instead of specifying the actual target processor type, and hence
6120 restricting which instructions can be used, it specifies that GCC should
6121 tune the performance of the code as if the target were of the type
6122 specified in this option, but still choosing the instructions that it
6123 will generate based on the cpu specified by a @option{-mcpu=} option.
6124 For some ARM implementations better performance can be obtained by using
6125 this option.
6127 @item -march=@var{name}
6128 @opindex march
6129 This specifies the name of the target ARM architecture.  GCC uses this
6130 name to determine what kind of instructions it can emit when generating
6131 assembly code.  This option can be used in conjunction with or instead
6132 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6133 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6134 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
6136 @item -mfpe=@var{number}
6137 @itemx -mfp=@var{number}
6138 @opindex mfpe
6139 @opindex mfp
6140 This specifies the version of the floating point emulation available on
6141 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6142 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6144 @item -mstructure-size-boundary=@var{n}
6145 @opindex mstructure-size-boundary
6146 The size of all structures and unions will be rounded up to a multiple
6147 of the number of bits set by this option.  Permissible values are 8 and
6148 32.  The default value varies for different toolchains.  For the COFF
6149 targeted toolchain the default value is 8.  Specifying the larger number
6150 can produce faster, more efficient code, but can also increase the size
6151 of the program.  The two values are potentially incompatible.  Code
6152 compiled with one value cannot necessarily expect to work with code or
6153 libraries compiled with the other value, if they exchange information
6154 using structures or unions.
6156 @item -mabort-on-noreturn
6157 @opindex mabort-on-noreturn
6158 Generate a call to the function @code{abort} at the end of a
6159 @code{noreturn} function.  It will be executed if the function tries to
6160 return.
6162 @item -mlong-calls
6163 @itemx -mno-long-calls
6164 @opindex mlong-calls
6165 @opindex mno-long-calls
6166 Tells the compiler to perform function calls by first loading the
6167 address of the function into a register and then performing a subroutine
6168 call on this register.  This switch is needed if the target function
6169 will lie outside of the 64 megabyte addressing range of the offset based
6170 version of subroutine call instruction.
6172 Even if this switch is enabled, not all function calls will be turned
6173 into long calls.  The heuristic is that static functions, functions
6174 which have the @samp{short-call} attribute, functions that are inside
6175 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6176 definitions have already been compiled within the current compilation
6177 unit, will not be turned into long calls.  The exception to this rule is
6178 that weak function definitions, functions with the @samp{long-call}
6179 attribute or the @samp{section} attribute, and functions that are within
6180 the scope of a @samp{#pragma long_calls} directive, will always be
6181 turned into long calls.
6183 This feature is not enabled by default.  Specifying
6184 @option{-mno-long-calls} will restore the default behavior, as will
6185 placing the function calls within the scope of a @samp{#pragma
6186 long_calls_off} directive.  Note these switches have no effect on how
6187 the compiler generates code to handle function calls via function
6188 pointers.
6190 @item -mnop-fun-dllimport
6191 @opindex mnop-fun-dllimport
6192 Disable support for the @code{dllimport} attribute.
6194 @item -msingle-pic-base
6195 @opindex msingle-pic-base
6196 Treat the register used for PIC addressing as read-only, rather than
6197 loading it in the prologue for each function.  The run-time system is
6198 responsible for initializing this register with an appropriate value
6199 before execution begins.
6201 @item -mpic-register=@var{reg}
6202 @opindex mpic-register
6203 Specify the register to be used for PIC addressing.  The default is R10
6204 unless stack-checking is enabled, when R9 is used.
6206 @item -mpoke-function-name
6207 @opindex mpoke-function-name
6208 Write the name of each function into the text section, directly
6209 preceding the function prologue.  The generated code is similar to this:
6211 @smallexample
6212      t0
6213          .ascii "arm_poke_function_name", 0
6214          .align
6215      t1
6216          .word 0xff000000 + (t1 - t0)
6217      arm_poke_function_name
6218          mov     ip, sp
6219          stmfd   sp!, @{fp, ip, lr, pc@}
6220          sub     fp, ip, #4
6221 @end smallexample
6223 When performing a stack backtrace, code can inspect the value of
6224 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6225 location @code{pc - 12} and the top 8 bits are set, then we know that
6226 there is a function name embedded immediately preceding this location
6227 and has length @code{((pc[-3]) & 0xff000000)}.
6229 @item -mthumb
6230 @opindex mthumb
6231 Generate code for the 16-bit Thumb instruction set.  The default is to
6232 use the 32-bit ARM instruction set.
6234 @item -mtpcs-frame
6235 @opindex mtpcs-frame
6236 Generate a stack frame that is compliant with the Thumb Procedure Call
6237 Standard for all non-leaf functions.  (A leaf function is one that does
6238 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6240 @item -mtpcs-leaf-frame
6241 @opindex mtpcs-leaf-frame
6242 Generate a stack frame that is compliant with the Thumb Procedure Call
6243 Standard for all leaf functions.  (A leaf function is one that does
6244 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6246 @item -mcallee-super-interworking
6247 @opindex mcallee-super-interworking
6248 Gives all externally visible functions in the file being compiled an ARM
6249 instruction set header which switches to Thumb mode before executing the
6250 rest of the function.  This allows these functions to be called from
6251 non-interworking code.
6253 @item -mcaller-super-interworking
6254 @opindex mcaller-super-interworking
6255 Allows calls via function pointers (including virtual functions) to
6256 execute correctly regardless of whether the target code has been
6257 compiled for interworking or not.  There is a small overhead in the cost
6258 of executing a function pointer if this option is enabled.
6260 @end table
6262 @node MN10200 Options
6263 @subsection MN10200 Options
6264 @cindex MN10200 options
6265 These @option{-m} options are defined for Matsushita MN10200 architectures:
6266 @table @gcctabopt
6268 @item -mrelax
6269 @opindex mrelax
6270 Indicate to the linker that it should perform a relaxation optimization pass
6271 to shorten branches, calls and absolute memory addresses.  This option only
6272 has an effect when used on the command line for the final link step.
6274 This option makes symbolic debugging impossible.
6275 @end table
6277 @node MN10300 Options
6278 @subsection MN10300 Options
6279 @cindex MN10300 options
6280 These @option{-m} options are defined for Matsushita MN10300 architectures:
6282 @table @gcctabopt
6283 @item -mmult-bug
6284 @opindex mmult-bug
6285 Generate code to avoid bugs in the multiply instructions for the MN10300
6286 processors.  This is the default.
6288 @item -mno-mult-bug
6289 @opindex mno-mult-bug
6290 Do not generate code to avoid bugs in the multiply instructions for the
6291 MN10300 processors.
6293 @item -mam33
6294 @opindex mam33
6295 Generate code which uses features specific to the AM33 processor.
6297 @item -mno-am33
6298 @opindex mno-am33
6299 Do not generate code which uses features specific to the AM33 processor.  This
6300 is the default.
6302 @item -mno-crt0
6303 @opindex mno-crt0
6304 Do not link in the C run-time initialization object file.
6306 @item -mrelax
6307 @opindex mrelax
6308 Indicate to the linker that it should perform a relaxation optimization pass
6309 to shorten branches, calls and absolute memory addresses.  This option only
6310 has an effect when used on the command line for the final link step.
6312 This option makes symbolic debugging impossible.
6313 @end table
6316 @node M32R/D Options
6317 @subsection M32R/D Options
6318 @cindex M32R/D options
6320 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6322 @table @gcctabopt
6323 @item -m32rx
6324 @opindex m32rx
6325 Generate code for the M32R/X@.
6327 @item -m32r
6328 @opindex m32r
6329 Generate code for the M32R@.  This is the default.
6331 @item -mcode-model=small
6332 @opindex mcode-model=small
6333 Assume all objects live in the lower 16MB of memory (so that their addresses
6334 can be loaded with the @code{ld24} instruction), and assume all subroutines
6335 are reachable with the @code{bl} instruction.
6336 This is the default.
6338 The addressability of a particular object can be set with the
6339 @code{model} attribute.
6341 @item -mcode-model=medium
6342 @opindex mcode-model=medium
6343 Assume objects may be anywhere in the 32-bit address space (the compiler
6344 will generate @code{seth/add3} instructions to load their addresses), and
6345 assume all subroutines are reachable with the @code{bl} instruction.
6347 @item -mcode-model=large
6348 @opindex mcode-model=large
6349 Assume objects may be anywhere in the 32-bit address space (the compiler
6350 will generate @code{seth/add3} instructions to load their addresses), and
6351 assume subroutines may not be reachable with the @code{bl} instruction
6352 (the compiler will generate the much slower @code{seth/add3/jl}
6353 instruction sequence).
6355 @item -msdata=none
6356 @opindex msdata=none
6357 Disable use of the small data area.  Variables will be put into
6358 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6359 @code{section} attribute has been specified).
6360 This is the default.
6362 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6363 Objects may be explicitly put in the small data area with the
6364 @code{section} attribute using one of these sections.
6366 @item -msdata=sdata
6367 @opindex msdata=sdata
6368 Put small global and static data in the small data area, but do not
6369 generate special code to reference them.
6371 @item -msdata=use
6372 @opindex msdata=use
6373 Put small global and static data in the small data area, and generate
6374 special instructions to reference them.
6376 @item -G @var{num}
6377 @opindex G
6378 @cindex smaller data references
6379 Put global and static objects less than or equal to @var{num} bytes
6380 into the small data or bss sections instead of the normal data or bss
6381 sections.  The default value of @var{num} is 8.
6382 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6383 for this option to have any effect.
6385 All modules should be compiled with the same @option{-G @var{num}} value.
6386 Compiling with different values of @var{num} may or may not work; if it
6387 doesn't the linker will give an error message---incorrect code will not be
6388 generated.
6390 @end table
6392 @node M88K Options
6393 @subsection M88K Options
6394 @cindex M88k options
6396 These @samp{-m} options are defined for Motorola 88k architectures:
6398 @table @gcctabopt
6399 @item -m88000
6400 @opindex m88000
6401 Generate code that works well on both the m88100 and the
6402 m88110.
6404 @item -m88100
6405 @opindex m88100
6406 Generate code that works best for the m88100, but that also
6407 runs on the m88110.
6409 @item -m88110
6410 @opindex m88110
6411 Generate code that works best for the m88110, and may not run
6412 on the m88100.
6414 @item -mbig-pic
6415 @opindex mbig-pic
6416 Obsolete option to be removed from the next revision.
6417 Use @option{-fPIC}.
6419 @item -midentify-revision
6420 @opindex midentify-revision
6421 @cindex identifying source, compiler (88k)
6422 Include an @code{ident} directive in the assembler output recording the
6423 source file name, compiler name and version, timestamp, and compilation
6424 flags used.
6426 @item -mno-underscores
6427 @opindex mno-underscores
6428 @cindex underscores, avoiding (88k)
6429 In assembler output, emit symbol names without adding an underscore
6430 character at the beginning of each name.  The default is to use an
6431 underscore as prefix on each name.
6433 @item -mocs-debug-info
6434 @itemx -mno-ocs-debug-info
6435 @opindex mocs-debug-info
6436 @opindex mno-ocs-debug-info
6437 @cindex OCS (88k)
6438 @cindex debugging, 88k OCS
6439 Include (or omit) additional debugging information (about registers used
6440 in each stack frame) as specified in the 88open Object Compatibility
6441 Standard, ``OCS''@.  This extra information allows debugging of code that
6442 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6443 SVr3.2 is to include this information; other 88k configurations omit this
6444 information by default.
6446 @item -mocs-frame-position
6447 @opindex mocs-frame-position
6448 @cindex register positions in frame (88k)
6449 When emitting COFF debugging information for automatic variables and
6450 parameters stored on the stack, use the offset from the canonical frame
6451 address, which is the stack pointer (register 31) on entry to the
6452 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6453 @option{-mocs-frame-position}; other 88k configurations have the default
6454 @option{-mno-ocs-frame-position}.
6456 @item -mno-ocs-frame-position
6457 @opindex mno-ocs-frame-position
6458 @cindex register positions in frame (88k)
6459 When emitting COFF debugging information for automatic variables and
6460 parameters stored on the stack, use the offset from the frame pointer
6461 register (register 30).  When this option is in effect, the frame
6462 pointer is not eliminated when debugging information is selected by the
6463 -g switch.
6465 @item -moptimize-arg-area
6466 @opindex moptimize-arg-area
6467 @cindex arguments in frame (88k)
6468 Save space by reorganizing the stack frame.  This option generates code
6469 that does not agree with the 88open specifications, but uses less
6470 memory.
6472 @itemx -mno-optimize-arg-area
6473 @opindex mno-optimize-arg-area
6474 Do not reorganize the stack frame to save space.  This is the default.
6475 The generated conforms to the specification, but uses more memory.
6477 @item -mshort-data-@var{num}
6478 @opindex mshort-data
6479 @cindex smaller data references (88k)
6480 @cindex r0-relative references (88k)
6481 Generate smaller data references by making them relative to @code{r0},
6482 which allows loading a value using a single instruction (rather than the
6483 usual two).  You control which data references are affected by
6484 specifying @var{num} with this option.  For example, if you specify
6485 @option{-mshort-data-512}, then the data references affected are those
6486 involving displacements of less than 512 bytes.
6487 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6488 than 64k.
6490 @item -mserialize-volatile
6491 @opindex mserialize-volatile
6492 @itemx -mno-serialize-volatile
6493 @opindex mno-serialize-volatile
6494 @cindex sequential consistency on 88k
6495 Do, or don't, generate code to guarantee sequential consistency
6496 of volatile memory references.  By default, consistency is
6497 guaranteed.
6499 The order of memory references made by the MC88110 processor does
6500 not always match the order of the instructions requesting those
6501 references.  In particular, a load instruction may execute before
6502 a preceding store instruction.  Such reordering violates
6503 sequential consistency of volatile memory references, when there
6504 are multiple processors.   When consistency must be guaranteed,
6505 GCC generates special instructions, as needed, to force
6506 execution in the proper order.
6508 The MC88100 processor does not reorder memory references and so
6509 always provides sequential consistency.  However, by default, GCC
6510 generates the special instructions to guarantee consistency
6511 even when you use @option{-m88100}, so that the code may be run on an
6512 MC88110 processor.  If you intend to run your code only on the
6513 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6515 The extra code generated to guarantee consistency may affect the
6516 performance of your application.  If you know that you can safely
6517 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6519 @item -msvr4
6520 @itemx -msvr3
6521 @opindex msvr4
6522 @opindex msvr3
6523 @cindex assembler syntax, 88k
6524 @cindex SVr4
6525 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6526 related to System V release 4 (SVr4).  This controls the following:
6528 @enumerate
6529 @item
6530 Which variant of the assembler syntax to emit.
6531 @item
6532 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6533 that is used on System V release 4.
6534 @item
6535 @option{-msvr4} makes GCC issue additional declaration directives used in
6536 SVr4.
6537 @end enumerate
6539 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6540 @option{-msvr3} is the default for all other m88k configurations.
6542 @item -mversion-03.00
6543 @opindex mversion-03.00
6544 This option is obsolete, and is ignored.
6545 @c ??? which asm syntax better for GAS?  option there too?
6547 @item -mno-check-zero-division
6548 @itemx -mcheck-zero-division
6549 @opindex mno-check-zero-division
6550 @opindex mcheck-zero-division
6551 @cindex zero division on 88k
6552 Do, or don't, generate code to guarantee that integer division by
6553 zero will be detected.  By default, detection is guaranteed.
6555 Some models of the MC88100 processor fail to trap upon integer
6556 division by zero under certain conditions.  By default, when
6557 compiling code that might be run on such a processor, GCC
6558 generates code that explicitly checks for zero-valued divisors
6559 and traps with exception number 503 when one is detected.  Use of
6560 @option{-mno-check-zero-division} suppresses such checking for code
6561 generated to run on an MC88100 processor.
6563 GCC assumes that the MC88110 processor correctly detects all instances
6564 of integer division by zero.  When @option{-m88110} is specified, no
6565 explicit checks for zero-valued divisors are generated, and both
6566 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6567 ignored.
6569 @item -muse-div-instruction
6570 @opindex muse-div-instruction
6571 @cindex divide instruction, 88k
6572 Use the div instruction for signed integer division on the
6573 MC88100 processor.  By default, the div instruction is not used.
6575 On the MC88100 processor the signed integer division instruction
6576 div) traps to the operating system on a negative operand.  The
6577 operating system transparently completes the operation, but at a
6578 large cost in execution time.  By default, when compiling code
6579 that might be run on an MC88100 processor, GCC emulates signed
6580 integer division using the unsigned integer division instruction
6581 divu), thereby avoiding the large penalty of a trap to the
6582 operating system.  Such emulation has its own, smaller, execution
6583 cost in both time and space.  To the extent that your code's
6584 important signed integer division operations are performed on two
6585 nonnegative operands, it may be desirable to use the div
6586 instruction directly.
6588 On the MC88110 processor the div instruction (also known as the
6589 divs instruction) processes negative operands without trapping to
6590 the operating system.  When @option{-m88110} is specified,
6591 @option{-muse-div-instruction} is ignored, and the div instruction is used
6592 for signed integer division.
6594 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6595 particular, the behavior of such a division with and without
6596 @option{-muse-div-instruction} may differ.
6598 @item -mtrap-large-shift
6599 @itemx -mhandle-large-shift
6600 @opindex mtrap-large-shift
6601 @opindex mhandle-large-shift
6602 @cindex bit shift overflow (88k)
6603 @cindex large bit shifts (88k)
6604 Include code to detect bit-shifts of more than 31 bits; respectively,
6605 trap such shifts or emit code to handle them properly.  By default GCC
6606 makes no special provision for large bit shifts.
6608 @item -mwarn-passed-structs
6609 @opindex mwarn-passed-structs
6610 @cindex structure passing (88k)
6611 Warn when a function passes a struct as an argument or result.
6612 Structure-passing conventions have changed during the evolution of the C
6613 language, and are often the source of portability problems.  By default,
6614 GCC issues no such warning.
6615 @end table
6617 @c break page here to avoid unsightly interparagraph stretch.
6618 @c -zw, 2001-8-17
6619 @page
6621 @node RS/6000 and PowerPC Options
6622 @subsection IBM RS/6000 and PowerPC Options
6623 @cindex RS/6000 and PowerPC Options
6624 @cindex IBM RS/6000 and PowerPC Options
6626 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6627 @table @gcctabopt
6628 @item -mpower
6629 @itemx -mno-power
6630 @itemx -mpower2
6631 @itemx -mno-power2
6632 @itemx -mpowerpc
6633 @itemx -mno-powerpc
6634 @itemx -mpowerpc-gpopt
6635 @itemx -mno-powerpc-gpopt
6636 @itemx -mpowerpc-gfxopt
6637 @itemx -mno-powerpc-gfxopt
6638 @itemx -mpowerpc64
6639 @itemx -mno-powerpc64
6640 @opindex mpower
6641 @opindex mno-power
6642 @opindex mpower2
6643 @opindex mno-power2
6644 @opindex mpowerpc
6645 @opindex mno-powerpc
6646 @opindex mpowerpc-gpopt
6647 @opindex mno-powerpc-gpopt
6648 @opindex mpowerpc-gfxopt
6649 @opindex mno-powerpc-gfxopt
6650 @opindex mpowerpc64
6651 @opindex mno-powerpc64
6652 GCC supports two related instruction set architectures for the
6653 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6654 instructions supported by the @samp{rios} chip set used in the original
6655 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6656 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6657 the IBM 4xx microprocessors.
6659 Neither architecture is a subset of the other.  However there is a
6660 large common subset of instructions supported by both.  An MQ
6661 register is included in processors supporting the POWER architecture.
6663 You use these options to specify which instructions are available on the
6664 processor you are using.  The default value of these options is
6665 determined when configuring GCC@.  Specifying the
6666 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6667 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6668 rather than the options listed above.
6670 The @option{-mpower} option allows GCC to generate instructions that
6671 are found only in the POWER architecture and to use the MQ register.
6672 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6673 to generate instructions that are present in the POWER2 architecture but
6674 not the original POWER architecture.
6676 The @option{-mpowerpc} option allows GCC to generate instructions that
6677 are found only in the 32-bit subset of the PowerPC architecture.
6678 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6679 GCC to use the optional PowerPC architecture instructions in the
6680 General Purpose group, including floating-point square root.  Specifying
6681 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6682 use the optional PowerPC architecture instructions in the Graphics
6683 group, including floating-point select.
6685 The @option{-mpowerpc64} option allows GCC to generate the additional
6686 64-bit instructions that are found in the full PowerPC64 architecture
6687 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6688 @option{-mno-powerpc64}.
6690 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6691 will use only the instructions in the common subset of both
6692 architectures plus some special AIX common-mode calls, and will not use
6693 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6694 permits GCC to use any instruction from either architecture and to
6695 allow use of the MQ register; specify this for the Motorola MPC601.
6697 @item -mnew-mnemonics
6698 @itemx -mold-mnemonics
6699 @opindex mnew-mnemonics
6700 @opindex mold-mnemonics
6701 Select which mnemonics to use in the generated assembler code.  With
6702 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6703 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6704 assembler mnemonics defined for the POWER architecture.  Instructions
6705 defined in only one architecture have only one mnemonic; GCC uses that
6706 mnemonic irrespective of which of these options is specified.
6708 GCC defaults to the mnemonics appropriate for the architecture in
6709 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6710 value of these option.  Unless you are building a cross-compiler, you
6711 should normally not specify either @option{-mnew-mnemonics} or
6712 @option{-mold-mnemonics}, but should instead accept the default.
6714 @item -mcpu=@var{cpu_type}
6715 @opindex mcpu
6716 Set architecture type, register usage, choice of mnemonics, and
6717 instruction scheduling parameters for machine type @var{cpu_type}.
6718 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6719 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6720 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6721 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6722 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6723 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6725 @option{-mcpu=common} selects a completely generic processor.  Code
6726 generated under this option will run on any POWER or PowerPC processor.
6727 GCC will use only the instructions in the common subset of both
6728 architectures, and will not use the MQ register.  GCC assumes a generic
6729 processor model for scheduling purposes.
6731 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6732 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6733 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6734 types, with an appropriate, generic processor model assumed for
6735 scheduling purposes.
6737 The other options specify a specific processor.  Code generated under
6738 those options will run best on that processor, and may not run at all on
6739 others.
6741 The @option{-mcpu} options automatically enable or disable other
6742 @option{-m} options as follows:
6744 @table @samp
6745 @item common
6746 @option{-mno-power}, @option{-mno-powerpc}
6748 @item power
6749 @itemx power2
6750 @itemx rios1
6751 @itemx rios2
6752 @itemx rsc
6753 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6755 @item powerpc
6756 @itemx rs64a
6757 @itemx 602
6758 @itemx 603
6759 @itemx 603e
6760 @itemx 604
6761 @itemx 620
6762 @itemx 630
6763 @itemx 740
6764 @itemx 7400
6765 @itemx 7450
6766 @itemx 750
6767 @itemx 505
6768 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6770 @item 601
6771 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6773 @item 403
6774 @itemx 821
6775 @itemx 860
6776 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6777 @end table
6779 @item -mtune=@var{cpu_type}
6780 @opindex mtune
6781 Set the instruction scheduling parameters for machine type
6782 @var{cpu_type}, but do not set the architecture type, register usage, or
6783 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6784 values for @var{cpu_type} are used for @option{-mtune} as for
6785 @option{-mcpu}.  If both are specified, the code generated will use the
6786 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6787 scheduling parameters set by @option{-mtune}.
6789 @item -maltivec
6790 @itemx -mno-altivec
6791 @opindex maltivec
6792 @opindex mno-altivec
6793 These switches enable or disable the use of built-in functions that
6794 allow access to the AltiVec instruction set.  You may also need to set
6795 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6796 enhancements.
6798 @item -mabi=spe
6799 @opindex mabi=spe
6800 Extend the current ABI with SPE ABI extensions.  This does not change
6801 the default ABI, instead it adds the SPE ABI extensions to the current
6802 ABI@.
6804 @item -mabi=no-spe
6805 @opindex mabi=no-spe
6806 Disable Booke SPE ABI extensions for the current ABI.
6808 @item -misel=@var{yes/no}
6809 @itemx -misel
6810 @opindex misel
6811 This switch enables or disables the generation of ISEL instructions.
6813 @item -mfull-toc
6814 @itemx -mno-fp-in-toc
6815 @itemx -mno-sum-in-toc
6816 @itemx -mminimal-toc
6817 @opindex mfull-toc
6818 @opindex mno-fp-in-toc
6819 @opindex mno-sum-in-toc
6820 @opindex mminimal-toc
6821 Modify generation of the TOC (Table Of Contents), which is created for
6822 every executable file.  The @option{-mfull-toc} option is selected by
6823 default.  In that case, GCC will allocate at least one TOC entry for
6824 each unique non-automatic variable reference in your program.  GCC
6825 will also place floating-point constants in the TOC@.  However, only
6826 16,384 entries are available in the TOC@.
6828 If you receive a linker error message that saying you have overflowed
6829 the available TOC space, you can reduce the amount of TOC space used
6830 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6831 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6832 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6833 generate code to calculate the sum of an address and a constant at
6834 run-time instead of putting that sum into the TOC@.  You may specify one
6835 or both of these options.  Each causes GCC to produce very slightly
6836 slower and larger code at the expense of conserving TOC space.
6838 If you still run out of space in the TOC even when you specify both of
6839 these options, specify @option{-mminimal-toc} instead.  This option causes
6840 GCC to make only one TOC entry for every file.  When you specify this
6841 option, GCC will produce code that is slower and larger but which
6842 uses extremely little TOC space.  You may wish to use this option
6843 only on files that contain less frequently executed code.
6845 @item -maix64
6846 @itemx -maix32
6847 @opindex maix64
6848 @opindex maix32
6849 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6850 @code{long} type, and the infrastructure needed to support them.
6851 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6852 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6853 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6855 @item -mxl-call
6856 @itemx -mno-xl-call
6857 @opindex mxl-call
6858 @opindex mno-xl-call
6859 On AIX, pass floating-point arguments to prototyped functions beyond the
6860 register save area (RSA) on the stack in addition to argument FPRs.  The
6861 AIX calling convention was extended but not initially documented to
6862 handle an obscure K&R C case of calling a function that takes the
6863 address of its arguments with fewer arguments than declared.  AIX XL
6864 compilers access floating point arguments which do not fit in the
6865 RSA from the stack when a subroutine is compiled without
6866 optimization.  Because always storing floating-point arguments on the
6867 stack is inefficient and rarely needed, this option is not enabled by
6868 default and only is necessary when calling subroutines compiled by AIX
6869 XL compilers without optimization.
6871 @item -mpe
6872 @opindex mpe
6873 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6874 application written to use message passing with special startup code to
6875 enable the application to run.  The system must have PE installed in the
6876 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6877 must be overridden with the @option{-specs=} option to specify the
6878 appropriate directory location.  The Parallel Environment does not
6879 support threads, so the @option{-mpe} option and the @option{-pthread}
6880 option are incompatible.
6882 @item -msoft-float
6883 @itemx -mhard-float
6884 @opindex msoft-float
6885 @opindex mhard-float
6886 Generate code that does not use (uses) the floating-point register set.
6887 Software floating point emulation is provided if you use the
6888 @option{-msoft-float} option, and pass the option to GCC when linking.
6890 @item -mmultiple
6891 @itemx -mno-multiple
6892 @opindex mmultiple
6893 @opindex mno-multiple
6894 Generate code that uses (does not use) the load multiple word
6895 instructions and the store multiple word instructions.  These
6896 instructions are generated by default on POWER systems, and not
6897 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6898 endian PowerPC systems, since those instructions do not work when the
6899 processor is in little endian mode.  The exceptions are PPC740 and
6900 PPC750 which permit the instructions usage in little endian mode.
6902 @item -mstring
6903 @itemx -mno-string
6904 @opindex mstring
6905 @opindex mno-string
6906 Generate code that uses (does not use) the load string instructions
6907 and the store string word instructions to save multiple registers and
6908 do small block moves.  These instructions are generated by default on
6909 POWER systems, and not generated on PowerPC systems.  Do not use
6910 @option{-mstring} on little endian PowerPC systems, since those
6911 instructions do not work when the processor is in little endian mode.
6912 The exceptions are PPC740 and PPC750 which permit the instructions
6913 usage in little endian mode.
6915 @item -mupdate
6916 @itemx -mno-update
6917 @opindex mupdate
6918 @opindex mno-update
6919 Generate code that uses (does not use) the load or store instructions
6920 that update the base register to the address of the calculated memory
6921 location.  These instructions are generated by default.  If you use
6922 @option{-mno-update}, there is a small window between the time that the
6923 stack pointer is updated and the address of the previous frame is
6924 stored, which means code that walks the stack frame across interrupts or
6925 signals may get corrupted data.
6927 @item -mfused-madd
6928 @itemx -mno-fused-madd
6929 @opindex mfused-madd
6930 @opindex mno-fused-madd
6931 Generate code that uses (does not use) the floating point multiply and
6932 accumulate instructions.  These instructions are generated by default if
6933 hardware floating is used.
6935 @item -mno-bit-align
6936 @itemx -mbit-align
6937 @opindex mno-bit-align
6938 @opindex mbit-align
6939 On System V.4 and embedded PowerPC systems do not (do) force structures
6940 and unions that contain bit-fields to be aligned to the base type of the
6941 bit-field.
6943 For example, by default a structure containing nothing but 8
6944 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6945 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6946 the structure would be aligned to a 1 byte boundary and be one byte in
6947 size.
6949 @item -mno-strict-align
6950 @itemx -mstrict-align
6951 @opindex mno-strict-align
6952 @opindex mstrict-align
6953 On System V.4 and embedded PowerPC systems do not (do) assume that
6954 unaligned memory references will be handled by the system.
6956 @item -mrelocatable
6957 @itemx -mno-relocatable
6958 @opindex mrelocatable
6959 @opindex mno-relocatable
6960 On embedded PowerPC systems generate code that allows (does not allow)
6961 the program to be relocated to a different address at runtime.  If you
6962 use @option{-mrelocatable} on any module, all objects linked together must
6963 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6965 @item -mrelocatable-lib
6966 @itemx -mno-relocatable-lib
6967 @opindex mrelocatable-lib
6968 @opindex mno-relocatable-lib
6969 On embedded PowerPC systems generate code that allows (does not allow)
6970 the program to be relocated to a different address at runtime.  Modules
6971 compiled with @option{-mrelocatable-lib} can be linked with either modules
6972 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6973 with modules compiled with the @option{-mrelocatable} options.
6975 @item -mno-toc
6976 @itemx -mtoc
6977 @opindex mno-toc
6978 @opindex mtoc
6979 On System V.4 and embedded PowerPC systems do not (do) assume that
6980 register 2 contains a pointer to a global area pointing to the addresses
6981 used in the program.
6983 @item -mlittle
6984 @itemx -mlittle-endian
6985 @opindex mlittle
6986 @opindex mlittle-endian
6987 On System V.4 and embedded PowerPC systems compile code for the
6988 processor in little endian mode.  The @option{-mlittle-endian} option is
6989 the same as @option{-mlittle}.
6991 @item -mbig
6992 @itemx -mbig-endian
6993 @opindex mbig
6994 @opindex mbig-endian
6995 On System V.4 and embedded PowerPC systems compile code for the
6996 processor in big endian mode.  The @option{-mbig-endian} option is
6997 the same as @option{-mbig}.
6999 @item -mcall-sysv
7000 @opindex mcall-sysv
7001 On System V.4 and embedded PowerPC systems compile code using calling
7002 conventions that adheres to the March 1995 draft of the System V
7003 Application Binary Interface, PowerPC processor supplement.  This is the
7004 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7006 @item -mcall-sysv-eabi
7007 @opindex mcall-sysv-eabi
7008 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7010 @item -mcall-sysv-noeabi
7011 @opindex mcall-sysv-noeabi
7012 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7014 @item -mcall-aix
7015 @opindex mcall-aix
7016 On System V.4 and embedded PowerPC systems compile code using calling
7017 conventions that are similar to those used on AIX@.  This is the
7018 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7020 @item -mcall-solaris
7021 @opindex mcall-solaris
7022 On System V.4 and embedded PowerPC systems compile code for the Solaris
7023 operating system.
7025 @item -mcall-linux
7026 @opindex mcall-linux
7027 On System V.4 and embedded PowerPC systems compile code for the
7028 Linux-based GNU system.
7030 @item -mcall-gnu
7031 @opindex mcall-gnu
7032 On System V.4 and embedded PowerPC systems compile code for the
7033 Hurd-based GNU system.
7035 @item -mcall-netbsd
7036 @opindex mcall-netbsd
7037 On System V.4 and embedded PowerPC systems compile code for the
7038 NetBSD operating system.
7040 @item -maix-struct-return
7041 @opindex maix-struct-return
7042 Return all structures in memory (as specified by the AIX ABI)@.
7044 @item -msvr4-struct-return
7045 @opindex msvr4-struct-return
7046 Return structures smaller than 8 bytes in registers (as specified by the
7047 SVR4 ABI)@.
7049 @item -mabi=altivec
7050 @opindex mabi=altivec
7051 Extend the current ABI with AltiVec ABI extensions.  This does not
7052 change the default ABI, instead it adds the AltiVec ABI extensions to
7053 the current ABI@.
7055 @item -mabi=no-altivec
7056 @opindex mabi=no-altivec
7057 Disable AltiVec ABI extensions for the current ABI.
7059 @item -mprototype
7060 @itemx -mno-prototype
7061 @opindex mprototype
7062 @opindex mno-prototype
7063 On System V.4 and embedded PowerPC systems assume that all calls to
7064 variable argument functions are properly prototyped.  Otherwise, the
7065 compiler must insert an instruction before every non prototyped call to
7066 set or clear bit 6 of the condition code register (@var{CR}) to
7067 indicate whether floating point values were passed in the floating point
7068 registers in case the function takes a variable arguments.  With
7069 @option{-mprototype}, only calls to prototyped variable argument functions
7070 will set or clear the bit.
7072 @item -msim
7073 @opindex msim
7074 On embedded PowerPC systems, assume that the startup module is called
7075 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7076 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7077 configurations.
7079 @item -mmvme
7080 @opindex mmvme
7081 On embedded PowerPC systems, assume that the startup module is called
7082 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7083 @file{libc.a}.
7085 @item -mads
7086 @opindex mads
7087 On embedded PowerPC systems, assume that the startup module is called
7088 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7089 @file{libc.a}.
7091 @item -myellowknife
7092 @opindex myellowknife
7093 On embedded PowerPC systems, assume that the startup module is called
7094 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7095 @file{libc.a}.
7097 @item -mvxworks
7098 @opindex mvxworks
7099 On System V.4 and embedded PowerPC systems, specify that you are
7100 compiling for a VxWorks system.
7102 @item -mwindiss
7103 @opindex mwindiss
7104 Specify that you are compiling for the WindISS simulation environment.
7106 @item -memb
7107 @opindex memb
7108 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7109 header to indicate that @samp{eabi} extended relocations are used.
7111 @item -meabi
7112 @itemx -mno-eabi
7113 @opindex meabi
7114 @opindex mno-eabi
7115 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7116 Embedded Applications Binary Interface (eabi) which is a set of
7117 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7118 means that the stack is aligned to an 8 byte boundary, a function
7119 @code{__eabi} is called to from @code{main} to set up the eabi
7120 environment, and the @option{-msdata} option can use both @code{r2} and
7121 @code{r13} to point to two separate small data areas.  Selecting
7122 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7123 do not call an initialization function from @code{main}, and the
7124 @option{-msdata} option will only use @code{r13} to point to a single
7125 small data area.  The @option{-meabi} option is on by default if you
7126 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7128 @item -msdata=eabi
7129 @opindex msdata=eabi
7130 On System V.4 and embedded PowerPC systems, put small initialized
7131 @code{const} global and static data in the @samp{.sdata2} section, which
7132 is pointed to by register @code{r2}.  Put small initialized
7133 non-@code{const} global and static data in the @samp{.sdata} section,
7134 which is pointed to by register @code{r13}.  Put small uninitialized
7135 global and static data in the @samp{.sbss} section, which is adjacent to
7136 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7137 incompatible with the @option{-mrelocatable} option.  The
7138 @option{-msdata=eabi} option also sets the @option{-memb} option.
7140 @item -msdata=sysv
7141 @opindex msdata=sysv
7142 On System V.4 and embedded PowerPC systems, put small global and static
7143 data in the @samp{.sdata} section, which is pointed to by register
7144 @code{r13}.  Put small uninitialized global and static data in the
7145 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7146 The @option{-msdata=sysv} option is incompatible with the
7147 @option{-mrelocatable} option.
7149 @item -msdata=default
7150 @itemx -msdata
7151 @opindex msdata=default
7152 @opindex msdata
7153 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7154 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7155 same as @option{-msdata=sysv}.
7157 @item -msdata-data
7158 @opindex msdata-data
7159 On System V.4 and embedded PowerPC systems, put small global and static
7160 data in the @samp{.sdata} section.  Put small uninitialized global and
7161 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7162 to address small data however.  This is the default behavior unless
7163 other @option{-msdata} options are used.
7165 @item -msdata=none
7166 @itemx -mno-sdata
7167 @opindex msdata=none
7168 @opindex mno-sdata
7169 On embedded PowerPC systems, put all initialized global and static data
7170 in the @samp{.data} section, and all uninitialized data in the
7171 @samp{.bss} section.
7173 @item -G @var{num}
7174 @opindex G
7175 @cindex smaller data references (PowerPC)
7176 @cindex .sdata/.sdata2 references (PowerPC)
7177 On embedded PowerPC systems, put global and static items less than or
7178 equal to @var{num} bytes into the small data or bss sections instead of
7179 the normal data or bss section.  By default, @var{num} is 8.  The
7180 @option{-G @var{num}} switch is also passed to the linker.
7181 All modules should be compiled with the same @option{-G @var{num}} value.
7183 @item -mregnames
7184 @itemx -mno-regnames
7185 @opindex mregnames
7186 @opindex mno-regnames
7187 On System V.4 and embedded PowerPC systems do (do not) emit register
7188 names in the assembly language output using symbolic forms.
7190 @item -mlongcall
7191 @itemx -mno-longcall
7192 @opindex mlongcall
7193 @opindex mno-longcall
7194 Default to making all function calls via pointers, so that functions
7195 which reside further than 64 megabytes (67,108,864 bytes) from the
7196 current location can be called.  This setting can be overridden by the
7197 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7199 Some linkers are capable of detecting out-of-range calls and generating
7200 glue code on the fly.  On these systems, long calls are unnecessary and
7201 generate slower code.  As of this writing, the AIX linker can do this,
7202 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7203 to the GNU linker for 32-bit PowerPC systems as well.
7205 In the future, we may cause GCC to ignore all longcall specifications
7206 when the linker is known to generate glue.
7208 @item -pthread
7209 @opindex pthread
7210 Adds support for multithreading with the @dfn{pthreads} library.
7211 This option sets flags for both the preprocessor and linker.
7213 @end table
7215 @node Darwin Options
7216 @subsection Darwin Options
7217 @cindex Darwin options
7218 @table @gcctabopt
7219 @item -all_load    
7220 @opindex all_load   
7221 Loads all members of static archive libraries.
7222 See man ld(1) for more information.
7224 @item -arch_errors_fatal
7225 @opindex arch_errors_fatal
7226 Cause the errors having to do with files that have the wrong architecture
7227 to be fatal.
7229 @item -bind_at_load
7230 @opindex bind_at_load
7231 Causes the output file to be marked such that the dynamic linker will
7232 bind all undefined references when the file is loaded or launched.
7234 @item -bundle     
7235 @opindex bundle
7236 Produce a Mach-o bundle format file.
7237 See man ld(1) for more information.
7239 @item -bundle_loader @var{executable}
7240 @opindex bundle_loader
7241 This specifies the @var{executable} that will be loading the build
7242 output file being linked. See man ld(1) for more information.
7244 @item -allowable_client  @var{client_name}
7245 @item -arch_only
7247 @item -client_name       
7248 @item -compatibility_version
7249 @item -current_version    
7250 @item -dependency-file
7251 @item -dylib_file    
7252 @item -dylinker_install_name
7253 @item -dynamic
7254 @item -dynamiclib   
7255 @item -exported_symbols_list  
7256 @item -filelist
7257 @item -flat_namespace   
7258 @item -force_cpusubtype_ALL
7259 @item -force_flat_namespace   
7260 @item -headerpad_max_install_names
7261 @item -image_base  
7262 @item -init
7263 @item -install_name
7264 @item -keep_private_externs
7265 @item -multi_module
7266 @item -multiply_defined      
7267 @item -multiply_defined_unused      
7268 @item -noall_load  
7269 @item -nomultidefs
7270 @item -noprebind     
7271 @item -noseglinkedit
7272 @item -pagezero_size    
7273 @item -prebind
7274 @item -prebind_all_twolevel_modules
7275 @item -private_bundle
7276 @item -read_only_relocs
7277 @item -sectalign  
7278 @item -sectobjectsymbols    
7279 @item -whyload
7280 @item -seg1addr 
7281 @item -sectcreate
7282 @item -sectobjectsymbols
7283 @item -sectorder
7284 @item -seg_addr_table
7285 @item -seg_addr_table_filename
7286 @item -seglinkedit
7287 @item -segprot   
7288 @item -segs_read_only_addr
7289 @item -segs_read_write_addr
7290 @item -single_module   
7291 @item -static
7292 @item -sub_library
7293 @item -sub_umbrella 
7294 @item -twolevel_namespace
7295 @item -umbrella
7296 @item -undefined
7297 @item -unexported_symbols_list
7298 @item -weak_reference_mismatches
7299 @item -whatsloaded  
7301 @opindex allowable_client
7302 @opindex arch_only    
7303 @opindex client_name
7304 @opindex compatibility_version
7305 @opindex current_version
7306 @opindex dependency-file
7307 @opindex dylib_file
7308 @opindex dylinker_install_name
7309 @opindex dynamic
7310 @opindex dynamiclib
7311 @opindex exported_symbols_list
7312 @opindex filelist  
7313 @opindex flat_namespace    
7314 @opindex force_cpusubtype_ALL
7315 @opindex force_flat_namespace
7316 @opindex headerpad_max_install_names
7317 @opindex image_base
7318 @opindex init     
7319 @opindex install_name
7320 @opindex keep_private_externs
7321 @opindex multi_module   
7322 @opindex multiply_defined
7323 @opindex multiply_defined_unused   
7324 @opindex noall_load  
7325 @opindex nomultidefs   
7326 @opindex noprebind
7327 @opindex noseglinkedit      
7328 @opindex pagezero_size
7329 @opindex prebind
7330 @opindex prebind_all_twolevel_modules
7331 @opindex private_bundle 
7332 @opindex read_only_relocs
7333 @opindex sectalign   
7334 @opindex sectobjectsymbols    
7335 @opindex whyload  
7336 @opindex seg1addr
7337 @opindex sectcreate       
7338 @opindex sectobjectsymbols 
7339 @opindex sectorder     
7340 @opindex seg_addr_table
7341 @opindex seg_addr_table_filename
7342 @opindex seglinkedit
7343 @opindex segprot
7344 @opindex segs_read_only_addr
7345 @opindex segs_read_write_addr
7346 @opindex single_module
7347 @opindex static
7348 @opindex sub_library
7349 @opindex sub_umbrella
7350 @opindex twolevel_namespace
7351 @opindex umbrella
7352 @opindex undefined
7353 @opindex unexported_symbols_list
7354 @opindex weak_reference_mismatches
7355 @opindex whatsloaded
7357 This options are available for Darwin linker. Darwin linker man page
7358 describes them in detail.
7359 @end table
7362 @node RT Options
7363 @subsection IBM RT Options
7364 @cindex RT options
7365 @cindex IBM RT options
7367 These @samp{-m} options are defined for the IBM RT PC:
7369 @table @gcctabopt
7370 @item -min-line-mul
7371 @opindex min-line-mul
7372 Use an in-line code sequence for integer multiplies.  This is the
7373 default.
7375 @item -mcall-lib-mul
7376 @opindex mcall-lib-mul
7377 Call @code{lmul$$} for integer multiples.
7379 @item -mfull-fp-blocks
7380 @opindex mfull-fp-blocks
7381 Generate full-size floating point data blocks, including the minimum
7382 amount of scratch space recommended by IBM@.  This is the default.
7384 @item -mminimum-fp-blocks
7385 @opindex mminimum-fp-blocks
7386 Do not include extra scratch space in floating point data blocks.  This
7387 results in smaller code, but slower execution, since scratch space must
7388 be allocated dynamically.
7390 @cindex @file{stdarg.h} and RT PC
7391 @item -mfp-arg-in-fpregs
7392 @opindex mfp-arg-in-fpregs
7393 Use a calling sequence incompatible with the IBM calling convention in
7394 which floating point arguments are passed in floating point registers.
7395 Note that @code{stdarg.h} will not work with floating point operands
7396 if this option is specified.
7398 @item -mfp-arg-in-gregs
7399 @opindex mfp-arg-in-gregs
7400 Use the normal calling convention for floating point arguments.  This is
7401 the default.
7403 @item -mhc-struct-return
7404 @opindex mhc-struct-return
7405 Return structures of more than one word in memory, rather than in a
7406 register.  This provides compatibility with the MetaWare HighC (hc)
7407 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7408 with the Portable C Compiler (pcc).
7410 @item -mnohc-struct-return
7411 @opindex mnohc-struct-return
7412 Return some structures of more than one word in registers, when
7413 convenient.  This is the default.  For compatibility with the
7414 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7415 option @option{-mhc-struct-return}.
7416 @end table
7418 @node MIPS Options
7419 @subsection MIPS Options
7420 @cindex MIPS options
7422 These @samp{-m} options are defined for the MIPS family of computers:
7424 @table @gcctabopt
7426 @item -march=@var{arch}
7427 @opindex march
7428 Generate code that will run on @var{arch}, which can be the name of a
7429 generic MIPS ISA, or the name of a particular processor.
7430 The ISA names are:
7431 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7432 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7433 The processor names are:
7434 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7435 @samp{m4k},
7436 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7437 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7438 @samp{orion},
7439 @samp{sb1},
7440 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7441 The special value @samp{from-abi} selects the
7442 most compatible architecture for the selected ABI (that is,
7443 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7445 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7446 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7447 @samp{vr} may be written @samp{r}.
7449 GCC defines two macros based on the value of this option.  The first
7450 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7451 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7452 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7453 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7454 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7456 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7457 above.  In other words, it will have the full prefix and will not
7458 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7459 the macro names the resolved architecture (either @samp{"mips1"} or
7460 @samp{"mips3"}).  It names the default architecture when no
7461 @option{-march} option is given.
7463 @item -mtune=@var{arch}
7464 @opindex mtune
7465 Optimize for @var{arch}.  Among other things, this option controls
7466 the way instructions are scheduled, and the perceived cost of arithmetic
7467 operations.  The list of @var{arch} values is the same as for
7468 @option{-march}.
7470 When this option is not used, GCC will optimize for the processor
7471 specified by @option{-march}.  By using @option{-march} and
7472 @option{-mtune} together, it is possible to generate code that will
7473 run on a family of processors, but optimize the code for one
7474 particular member of that family.
7476 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7477 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7478 @samp{-march} ones described above.
7480 @item -mips1
7481 @opindex mips1
7482 Equivalent to @samp{-march=mips1}.
7484 @item -mips2
7485 @opindex mips2
7486 Equivalent to @samp{-march=mips2}.
7488 @item -mips3
7489 @opindex mips3
7490 Equivalent to @samp{-march=mips3}.
7492 @item -mips4
7493 @opindex mips4
7494 Equivalent to @samp{-march=mips4}.
7496 @item -mips32
7497 @opindex mips32
7498 Equivalent to @samp{-march=mips32}.
7500 @item -mips32r2
7501 @opindex mips32r2
7502 Equivalent to @samp{-march=mips32r2}.
7504 @item -mips64
7505 @opindex mips64
7506 Equivalent to @samp{-march=mips64}.
7508 @item -mfused-madd
7509 @itemx -mno-fused-madd
7510 @opindex mfused-madd
7511 @opindex mno-fused-madd
7512 Generate code that uses (does not use) the floating point multiply and
7513 accumulate instructions, when they are available.  These instructions
7514 are generated by default if they are available, but this may be
7515 undesirable if the extra precision causes problems or on certain chips
7516 in the mode where denormals are rounded to zero where denormals
7517 generated by multiply and accumulate instructions cause exceptions
7518 anyway.
7520 @item -mfp32
7521 @opindex mfp32
7522 Assume that floating point registers are 32 bits wide.
7524 @item -mfp64
7525 @opindex mfp64
7526 Assume that floating point registers are 64 bits wide.
7528 @item -mgp32
7529 @opindex mgp32
7530 Assume that general purpose registers are 32 bits wide.
7532 @item -mgp64
7533 @opindex mgp64
7534 Assume that general purpose registers are 64 bits wide.
7536 @item -mint64
7537 @opindex mint64
7538 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7539 explanation of the default, and the width of pointers.
7541 @item -mlong64
7542 @opindex mlong64
7543 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7544 explanation of the default, and the width of pointers.
7546 @item -mlong32
7547 @opindex mlong32
7548 Force long, int, and pointer types to be 32 bits wide.
7550 The default size of ints, longs and pointers depends on the ABI@.  All
7551 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7552 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7553 are the same size as longs, or the same size as integer registers,
7554 whichever is smaller.
7556 @item -mabi=32
7557 @itemx -mabi=o64
7558 @itemx -mabi=n32
7559 @itemx -mabi=64
7560 @itemx -mabi=eabi
7561 @itemx -mabi=meabi
7562 @opindex mabi=32
7563 @opindex mabi=o64
7564 @opindex mabi=n32
7565 @opindex mabi=64
7566 @opindex mabi=eabi
7567 @opindex mabi=meabi
7568 Generate code for the given ABI@.
7570 Note that there are two embedded ABIs: @option{-mabi=eabi}
7571 selects the one defined by Cygnus while @option{-meabi=meabi}
7572 selects the one defined by MIPS@.  Both these ABIs have
7573 32-bit and 64-bit variants.  Normally, GCC will generate
7574 64-bit code when you select a 64-bit architecture, but you
7575 can use @option{-mgp32} to get 32-bit code instead.
7577 @item -mabi-fake-default
7578 @opindex mabi-fake-default
7579 You don't want to know what this option does.  No, really.  I mean
7580 it.  Move on to the next option.
7582 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7583 wants the default set of options to get the root of the multilib tree,
7584 and the shared library SONAMEs without any multilib-indicating
7585 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7586 we want to default to the N32 ABI, while still being binary-compatible
7587 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7588 binary-compatible means shared libraries should have the same SONAMEs,
7589 and libraries should live in the same location.  Having O32 libraries
7590 in a sub-directory named say @file{o32} is not acceptable.
7592 So we trick GCC into believing that O32 is the default ABI, except
7593 that we override the default with some internal command-line
7594 processing magic.  Problem is, if we stopped at that, and you then
7595 created a multilib-aware package that used the output of @command{gcc
7596 -print-multi-lib} to decide which multilibs to build, and how, and
7597 you'd find yourself in an awkward situation when you found out that
7598 some of the options listed ended up mapping to the same multilib, and
7599 none of your libraries was actually built for the multilib that
7600 @option{-print-multi-lib} claims to be the default.  So we added this
7601 option that disables the default switcher, falling back to GCC's
7602 original notion of the default library.  Confused yet?
7604 For short: don't ever use this option, unless you find it in the list
7605 of additional options to be used when building for multilibs, in the
7606 output of @option{gcc -print-multi-lib}.
7608 @item -mmips-as
7609 @opindex mmips-as
7610 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7611 add normal debug information.  This is the default for all
7612 platforms except for the OSF/1 reference platform, using the OSF/rose
7613 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7614 switches are used, the @file{mips-tfile} program will encapsulate the
7615 stabs within MIPS ECOFF@.
7617 @item -mgas
7618 @opindex mgas
7619 Generate code for the GNU assembler.  This is the default on the OSF/1
7620 reference platform, using the OSF/rose object format.  Also, this is
7621 the default if the configure option @option{--with-gnu-as} is used.
7623 @item -msplit-addresses
7624 @itemx -mno-split-addresses
7625 @opindex msplit-addresses
7626 @opindex mno-split-addresses
7627 Generate code to load the high and low parts of address constants separately.
7628 This allows GCC to optimize away redundant loads of the high order
7629 bits of addresses.  This optimization requires GNU as and GNU ld.
7630 This optimization is enabled by default for some embedded targets where
7631 GNU as and GNU ld are standard.
7633 @item -mrnames
7634 @itemx -mno-rnames
7635 @opindex mrnames
7636 @opindex mno-rnames
7637 The @option{-mrnames} switch says to output code using the MIPS software
7638 names for the registers, instead of the hardware names (ie, @var{a0}
7639 instead of @var{$4}).  The only known assembler that supports this option
7640 is the Algorithmics assembler.
7642 @item -mgpopt
7643 @itemx -mno-gpopt
7644 @opindex mgpopt
7645 @opindex mno-gpopt
7646 The @option{-mgpopt} switch says to write all of the data declarations
7647 before the instructions in the text section, this allows the MIPS
7648 assembler to generate one word memory references instead of using two
7649 words for short global or static data items.  This is on by default if
7650 optimization is selected.
7652 @item -mstats
7653 @itemx -mno-stats
7654 @opindex mstats
7655 @opindex mno-stats
7656 For each non-inline function processed, the @option{-mstats} switch
7657 causes the compiler to emit one line to the standard error file to
7658 print statistics about the program (number of registers saved, stack
7659 size, etc.).
7661 @item -mmemcpy
7662 @itemx -mno-memcpy
7663 @opindex mmemcpy
7664 @opindex mno-memcpy
7665 The @option{-mmemcpy} switch makes all block moves call the appropriate
7666 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7667 generating inline code.
7669 @item -mmips-tfile
7670 @itemx -mno-mips-tfile
7671 @opindex mmips-tfile
7672 @opindex mno-mips-tfile
7673 The @option{-mno-mips-tfile} switch causes the compiler not
7674 postprocess the object file with the @file{mips-tfile} program,
7675 after the MIPS assembler has generated it to add debug support.  If
7676 @file{mips-tfile} is not run, then no local variables will be
7677 available to the debugger.  In addition, @file{stage2} and
7678 @file{stage3} objects will have the temporary file names passed to the
7679 assembler embedded in the object file, which means the objects will
7680 not compare the same.  The @option{-mno-mips-tfile} switch should only
7681 be used when there are bugs in the @file{mips-tfile} program that
7682 prevents compilation.
7684 @item -msoft-float
7685 @opindex msoft-float
7686 Generate output containing library calls for floating point.
7687 @strong{Warning:} the requisite libraries are not part of GCC@.
7688 Normally the facilities of the machine's usual C compiler are used, but
7689 this can't be done directly in cross-compilation.  You must make your
7690 own arrangements to provide suitable library functions for
7691 cross-compilation.
7693 @item -mhard-float
7694 @opindex mhard-float
7695 Generate output containing floating point instructions.  This is the
7696 default if you use the unmodified sources.
7698 @item -mabicalls
7699 @itemx -mno-abicalls
7700 @opindex mabicalls
7701 @opindex mno-abicalls
7702 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7703 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7704 position independent code.
7706 @item -mlong-calls
7707 @itemx -mno-long-calls
7708 @opindex mlong-calls
7709 @opindex mno-long-calls
7710 Do all calls with the @samp{JALR} instruction, which requires
7711 loading up a function's address into a register before the call.
7712 You need to use this switch, if you call outside of the current
7713 512 megabyte segment to functions that are not through pointers.
7715 @item -mhalf-pic
7716 @itemx -mno-half-pic
7717 @opindex mhalf-pic
7718 @opindex mno-half-pic
7719 Put pointers to extern references into the data section and load them
7720 up, rather than put the references in the text section.
7722 @item -membedded-pic
7723 @itemx -mno-embedded-pic
7724 @opindex membedded-pic
7725 @opindex mno-embedded-pic
7726 Generate PIC code suitable for some embedded systems.  All calls are
7727 made using PC relative address, and all data is addressed using the $gp
7728 register.  No more than 65536 bytes of global data may be used.  This
7729 requires GNU as and GNU ld which do most of the work.  This currently
7730 only works on targets which use ECOFF; it does not work with ELF@.
7732 @item -membedded-data
7733 @itemx -mno-embedded-data
7734 @opindex membedded-data
7735 @opindex mno-embedded-data
7736 Allocate variables to the read-only data section first if possible, then
7737 next in the small data section if possible, otherwise in data.  This gives
7738 slightly slower code than the default, but reduces the amount of RAM required
7739 when executing, and thus may be preferred for some embedded systems.
7741 @item -muninit-const-in-rodata
7742 @itemx -mno-uninit-const-in-rodata
7743 @opindex muninit-const-in-rodata
7744 @opindex mno-uninit-const-in-rodata
7745 When used together with @option{-membedded-data}, it will always store uninitialized
7746 const variables in the read-only data section.
7748 @item -msingle-float
7749 @itemx -mdouble-float
7750 @opindex msingle-float
7751 @opindex mdouble-float
7752 The @option{-msingle-float} switch tells gcc to assume that the floating
7753 point coprocessor only supports single precision operations, as on the
7754 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7755 double precision operations.  This is the default.
7757 @item -mmad
7758 @itemx -mno-mad
7759 @opindex mmad
7760 @opindex mno-mad
7761 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7762 as on the @samp{r4650} chip.
7764 @item -m4650
7765 @opindex m4650
7766 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7767 @option{-mcpu=r4650}.
7769 @item -mips16
7770 @itemx -mno-mips16
7771 @opindex mips16
7772 @opindex mno-mips16
7773 Enable 16-bit instructions.
7775 @item -mentry
7776 @opindex mentry
7777 Use the entry and exit pseudo ops.  This option can only be used with
7778 @option{-mips16}.
7780 @item -EL
7781 @opindex EL
7782 Compile code for the processor in little endian mode.
7783 The requisite libraries are assumed to exist.
7785 @item -EB
7786 @opindex EB
7787 Compile code for the processor in big endian mode.
7788 The requisite libraries are assumed to exist.
7790 @item -G @var{num}
7791 @opindex G
7792 @cindex smaller data references (MIPS)
7793 @cindex gp-relative references (MIPS)
7794 Put global and static items less than or equal to @var{num} bytes into
7795 the small data or bss sections instead of the normal data or bss
7796 section.  This allows the assembler to emit one word memory reference
7797 instructions based on the global pointer (@var{gp} or @var{$28}),
7798 instead of the normal two words used.  By default, @var{num} is 8 when
7799 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7800 @option{-G @var{num}} switch is also passed to the assembler and linker.
7801 All modules should be compiled with the same @option{-G @var{num}}
7802 value.
7804 @item -nocpp
7805 @opindex nocpp
7806 Tell the MIPS assembler to not run its preprocessor over user
7807 assembler files (with a @samp{.s} suffix) when assembling them.
7809 @item -mfix7000
7810 @opindex mfix7000
7811 Pass an option to gas which will cause nops to be inserted if
7812 the read of the destination register of an mfhi or mflo instruction
7813 occurs in the following two instructions.
7815 @item -no-crt0
7816 @opindex no-crt0
7817 Do not include the default crt0.
7819 @item -mflush-func=@var{func}
7820 @itemx -mno-flush-func
7821 @opindex mflush-func
7822 Specifies the function to call to flush the I and D caches, or to not
7823 call any such function.  If called, the function must take the same
7824 arguments as the common @code{_flush_func()}, that is, the address of the
7825 memory range for which the cache is being flushed, the size of the
7826 memory range, and the number 3 (to flush both caches).  The default
7827 depends on the target gcc was configured for, but commonly is either
7828 @samp{_flush_func} or @samp{__cpu_flush}.
7830 @item -mbranch-likely
7831 @itemx -mno-branch-likely
7832 @opindex mbranch-likely
7833 @opindex mno-branch-likely
7834 Enable or disable use of Branch Likely instructions, regardless of the
7835 default for the selected architecture.  By default, Branch Likely
7836 instructions may be generated if they are supported by the selected
7837 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7838 and processors which implement those architectures; for those, Branch
7839 Likely instructions will not be generated by default because the MIPS32
7840 and MIPS64 architectures specifically deprecate their use.
7841 @end table
7843 @node i386 and x86-64 Options
7844 @subsection Intel 386 and AMD x86-64 Options
7845 @cindex i386 Options
7846 @cindex x86-64 Options
7847 @cindex Intel 386 Options
7848 @cindex AMD x86-64 Options
7850 These @samp{-m} options are defined for the i386 and x86-64 family of
7851 computers:
7853 @table @gcctabopt
7854 @item -mcpu=@var{cpu-type}
7855 @opindex mcpu
7856 Tune to @var{cpu-type} everything applicable about the generated code, except
7857 for the ABI and the set of available instructions.  The choices for
7858 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7859 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7860 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7861 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7862 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8} and @samp{c3}.
7864 While picking a specific @var{cpu-type} will schedule things appropriately
7865 for that particular chip, the compiler will not generate any code that
7866 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7867 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7868 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7869 AMD chips as opposed to the Intel ones.
7871 @item -march=@var{cpu-type}
7872 @opindex march
7873 Generate instructions for the machine type @var{cpu-type}.  The choices
7874 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7875 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7877 @item -m386
7878 @itemx -m486
7879 @itemx -mpentium
7880 @itemx -mpentiumpro
7881 @opindex m386
7882 @opindex m486
7883 @opindex mpentium
7884 @opindex mpentiumpro
7885 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7886 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7887 These synonyms are deprecated.
7889 @item -mfpmath=@var{unit}
7890 @opindex march
7891 generate floating point arithmetics for selected unit @var{unit}.  the choices
7892 for @var{unit} are:
7894 @table @samp
7895 @item 387
7896 Use the standard 387 floating point coprocessor present majority of chips and
7897 emulated otherwise.  Code compiled with this option will run almost everywhere.
7898 The temporary results are computed in 80bit precision instead of precision
7899 specified by the type resulting in slightly different results compared to most
7900 of other chips. See @option{-ffloat-store} for more detailed description.
7902 This is the default choice for i386 compiler.
7904 @item sse
7905 Use scalar floating point instructions present in the SSE instruction set.
7906 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7907 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7908 instruction set supports only single precision arithmetics, thus the double and
7909 extended precision arithmetics is still done using 387.  Later version, present
7910 only in Pentium4 and the future AMD x86-64 chips supports double precision
7911 arithmetics too.
7913 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7914 @option{-msse2} switches to enable SSE extensions and make this option
7915 effective.  For x86-64 compiler, these extensions are enabled by default.
7917 The resulting code should be considerably faster in majority of cases and avoid
7918 the numerical instability problems of 387 code, but may break some existing
7919 code that expects temporaries to be 80bit.
7921 This is the default choice for x86-64 compiler.
7923 @item sse,387
7924 Attempt to utilize both instruction sets at once.  This effectively double the
7925 amount of available registers and on chips with separate execution units for
7926 387 and SSE the execution resources too.  Use this option with care, as it is
7927 still experimental, because gcc register allocator does not model separate
7928 functional units well resulting in instable performance.
7929 @end table
7931 @item -masm=@var{dialect}
7932 @opindex masm=@var{dialect}
7933 Output asm instructions using selected @var{dialect}. Supported choices are
7934 @samp{intel} or @samp{att} (the default one).
7936 @item -mieee-fp
7937 @itemx -mno-ieee-fp
7938 @opindex mieee-fp
7939 @opindex mno-ieee-fp
7940 Control whether or not the compiler uses IEEE floating point
7941 comparisons.  These handle correctly the case where the result of a
7942 comparison is unordered.
7944 @item -msoft-float
7945 @opindex msoft-float
7946 Generate output containing library calls for floating point.
7947 @strong{Warning:} the requisite libraries are not part of GCC@.
7948 Normally the facilities of the machine's usual C compiler are used, but
7949 this can't be done directly in cross-compilation.  You must make your
7950 own arrangements to provide suitable library functions for
7951 cross-compilation.
7953 On machines where a function returns floating point results in the 80387
7954 register stack, some floating point opcodes may be emitted even if
7955 @option{-msoft-float} is used.
7957 @item -mno-fp-ret-in-387
7958 @opindex mno-fp-ret-in-387
7959 Do not use the FPU registers for return values of functions.
7961 The usual calling convention has functions return values of types
7962 @code{float} and @code{double} in an FPU register, even if there
7963 is no FPU@.  The idea is that the operating system should emulate
7964 an FPU@.
7966 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7967 in ordinary CPU registers instead.
7969 @item -mno-fancy-math-387
7970 @opindex mno-fancy-math-387
7971 Some 387 emulators do not support the @code{sin}, @code{cos} and
7972 @code{sqrt} instructions for the 387.  Specify this option to avoid
7973 generating those instructions.  This option is the default on FreeBSD,
7974 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
7975 indicates that the target cpu will always have an FPU and so the
7976 instruction will not need emulation.  As of revision 2.6.1, these
7977 instructions are not generated unless you also use the
7978 @option{-funsafe-math-optimizations} switch.
7980 @item -malign-double
7981 @itemx -mno-align-double
7982 @opindex malign-double
7983 @opindex mno-align-double
7984 Control whether GCC aligns @code{double}, @code{long double}, and
7985 @code{long long} variables on a two word boundary or a one word
7986 boundary.  Aligning @code{double} variables on a two word boundary will
7987 produce code that runs somewhat faster on a @samp{Pentium} at the
7988 expense of more memory.
7990 @strong{Warning:} if you use the @option{-malign-double} switch,
7991 structures containing the above types will be aligned differently than
7992 the published application binary interface specifications for the 386
7993 and will not be binary compatible with structures in code compiled
7994 without that switch.
7996 @item -m128bit-long-double
7997 @opindex m128bit-long-double
7998 Control the size of @code{long double} type. i386 application binary interface
7999 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8000 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8001 impossible to reach with 12 byte long doubles in the array accesses.
8003 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8004 structures and arrays containing @code{long double} will change their size as
8005 well as function calling convention for function taking @code{long double}
8006 will be modified.
8008 @item -m96bit-long-double
8009 @opindex m96bit-long-double
8010 Set the size of @code{long double} to 96 bits as required by the i386
8011 application binary interface.  This is the default.
8013 @item -msvr3-shlib
8014 @itemx -mno-svr3-shlib
8015 @opindex msvr3-shlib
8016 @opindex mno-svr3-shlib
8017 Control whether GCC places uninitialized local variables into the
8018 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8019 into @code{bss}.  These options are meaningful only on System V Release 3.
8021 @item -mrtd
8022 @opindex mrtd
8023 Use a different function-calling convention, in which functions that
8024 take a fixed number of arguments return with the @code{ret} @var{num}
8025 instruction, which pops their arguments while returning.  This saves one
8026 instruction in the caller since there is no need to pop the arguments
8027 there.
8029 You can specify that an individual function is called with this calling
8030 sequence with the function attribute @samp{stdcall}.  You can also
8031 override the @option{-mrtd} option by using the function attribute
8032 @samp{cdecl}.  @xref{Function Attributes}.
8034 @strong{Warning:} this calling convention is incompatible with the one
8035 normally used on Unix, so you cannot use it if you need to call
8036 libraries compiled with the Unix compiler.
8038 Also, you must provide function prototypes for all functions that
8039 take variable numbers of arguments (including @code{printf});
8040 otherwise incorrect code will be generated for calls to those
8041 functions.
8043 In addition, seriously incorrect code will result if you call a
8044 function with too many arguments.  (Normally, extra arguments are
8045 harmlessly ignored.)
8047 @item -mregparm=@var{num}
8048 @opindex mregparm
8049 Control how many registers are used to pass integer arguments.  By
8050 default, no registers are used to pass arguments, and at most 3
8051 registers can be used.  You can control this behavior for a specific
8052 function by using the function attribute @samp{regparm}.
8053 @xref{Function Attributes}.
8055 @strong{Warning:} if you use this switch, and
8056 @var{num} is nonzero, then you must build all modules with the same
8057 value, including any libraries.  This includes the system libraries and
8058 startup modules.
8060 @item -mpreferred-stack-boundary=@var{num}
8061 @opindex mpreferred-stack-boundary
8062 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8063 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8064 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8065 size (@option{-Os}), in which case the default is the minimum correct
8066 alignment (4 bytes for x86, and 8 bytes for x86-64).
8068 On Pentium and PentiumPro, @code{double} and @code{long double} values
8069 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8070 suffer significant run time performance penalties.  On Pentium III, the
8071 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8072 penalties if it is not 16 byte aligned.
8074 To ensure proper alignment of this values on the stack, the stack boundary
8075 must be as aligned as that required by any value stored on the stack.
8076 Further, every function must be generated such that it keeps the stack
8077 aligned.  Thus calling a function compiled with a higher preferred
8078 stack boundary from a function compiled with a lower preferred stack
8079 boundary will most likely misalign the stack.  It is recommended that
8080 libraries that use callbacks always use the default setting.
8082 This extra alignment does consume extra stack space, and generally
8083 increases code size.  Code that is sensitive to stack space usage, such
8084 as embedded systems and operating system kernels, may want to reduce the
8085 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8087 @item -mmmx
8088 @itemx -mno-mmx
8089 @item -msse
8090 @itemx -mno-sse
8091 @item -msse2
8092 @itemx -mno-sse2
8093 @item -m3dnow
8094 @itemx -mno-3dnow
8095 @opindex mmmx
8096 @opindex mno-mmx
8097 @opindex msse
8098 @opindex mno-sse
8099 @opindex m3dnow
8100 @opindex mno-3dnow
8101 These switches enable or disable the use of built-in functions that allow
8102 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8104 @xref{X86 Built-in Functions}, for details of the functions enabled
8105 and disabled by these switches.
8107 To have SSE/SSE2 instructions generated automatically from floating-point
8108 code, see @option{-mfpmath=sse}.
8110 @item -mpush-args
8111 @itemx -mno-push-args
8112 @opindex mpush-args
8113 @opindex mno-push-args
8114 Use PUSH operations to store outgoing parameters.  This method is shorter
8115 and usually equally fast as method using SUB/MOV operations and is enabled
8116 by default.  In some cases disabling it may improve performance because of
8117 improved scheduling and reduced dependencies.
8119 @item -maccumulate-outgoing-args
8120 @opindex maccumulate-outgoing-args
8121 If enabled, the maximum amount of space required for outgoing arguments will be
8122 computed in the function prologue.  This is faster on most modern CPUs
8123 because of reduced dependencies, improved scheduling and reduced stack usage
8124 when preferred stack boundary is not equal to 2.  The drawback is a notable
8125 increase in code size.  This switch implies @option{-mno-push-args}.
8127 @item -mthreads
8128 @opindex mthreads
8129 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8130 on thread-safe exception handling must compile and link all code with the
8131 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8132 @option{-D_MT}; when linking, it links in a special thread helper library
8133 @option{-lmingwthrd} which cleans up per thread exception handling data.
8135 @item -mno-align-stringops
8136 @opindex mno-align-stringops
8137 Do not align destination of inlined string operations.  This switch reduces
8138 code size and improves performance in case the destination is already aligned,
8139 but gcc don't know about it.
8141 @item -minline-all-stringops
8142 @opindex minline-all-stringops
8143 By default GCC inlines string operations only when destination is known to be
8144 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8145 size, but may improve performance of code that depends on fast memcpy, strlen
8146 and memset for short lengths.
8148 @item -momit-leaf-frame-pointer
8149 @opindex momit-leaf-frame-pointer
8150 Don't keep the frame pointer in a register for leaf functions.  This
8151 avoids the instructions to save, set up and restore frame pointers and
8152 makes an extra register available in leaf functions.  The option
8153 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8154 which might make debugging harder.
8155 @end table
8157 These @samp{-m} switches are supported in addition to the above
8158 on AMD x86-64 processors in 64-bit environments.
8160 @table @gcctabopt
8161 @item -m32
8162 @itemx -m64
8163 @opindex m32
8164 @opindex m64
8165 Generate code for a 32-bit or 64-bit environment.
8166 The 32-bit environment sets int, long and pointer to 32 bits and
8167 generates code that runs on any i386 system.
8168 The 64-bit environment sets int to 32 bits and long and pointer
8169 to 64 bits and generates code for AMD's x86-64 architecture.
8171 @item -mno-red-zone
8172 @opindex no-red-zone
8173 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8174 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8175 stack pointer that will not be modified by signal or interrupt handlers
8176 and therefore can be used for temporary data without adjusting the stack
8177 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8179 @item -mcmodel=small
8180 @opindex mcmodel=small
8181 Generate code for the small code model: the program and its symbols must
8182 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8183 Programs can be statically or dynamically linked.  This is the default
8184 code model.
8186 @item -mcmodel=kernel
8187 @opindex mcmodel=kernel
8188 Generate code for the kernel code model.  The kernel runs in the
8189 negative 2 GB of the address space.
8190 This model has to be used for Linux kernel code.
8192 @item -mcmodel=medium
8193 @opindex mcmodel=medium
8194 Generate code for the medium model: The program is linked in the lower 2
8195 GB of the address space but symbols can be located anywhere in the
8196 address space.  Programs can be statically or dynamically linked, but
8197 building of shared libraries are not supported with the medium model.
8199 @item -mcmodel=large
8200 @opindex mcmodel=large
8201 Generate code for the large model: This model makes no assumptions
8202 about addresses and sizes of sections.  Currently GCC does not implement
8203 this model.
8204 @end table
8206 @node HPPA Options
8207 @subsection HPPA Options
8208 @cindex HPPA Options
8210 These @samp{-m} options are defined for the HPPA family of computers:
8212 @table @gcctabopt
8213 @item -march=@var{architecture-type}
8214 @opindex march
8215 Generate code for the specified architecture.  The choices for
8216 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8217 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8218 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8219 architecture option for your machine.  Code compiled for lower numbered
8220 architectures will run on higher numbered architectures, but not the
8221 other way around.
8223 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8224 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8225 support.
8227 @item -mpa-risc-1-0
8228 @itemx -mpa-risc-1-1
8229 @itemx -mpa-risc-2-0
8230 @opindex mpa-risc-1-0
8231 @opindex mpa-risc-1-1
8232 @opindex mpa-risc-2-0
8233 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8235 @item -mbig-switch
8236 @opindex mbig-switch
8237 Generate code suitable for big switch tables.  Use this option only if
8238 the assembler/linker complain about out of range branches within a switch
8239 table.
8241 @item -mjump-in-delay
8242 @opindex mjump-in-delay
8243 Fill delay slots of function calls with unconditional jump instructions
8244 by modifying the return pointer for the function call to be the target
8245 of the conditional jump.
8247 @item -mdisable-fpregs
8248 @opindex mdisable-fpregs
8249 Prevent floating point registers from being used in any manner.  This is
8250 necessary for compiling kernels which perform lazy context switching of
8251 floating point registers.  If you use this option and attempt to perform
8252 floating point operations, the compiler will abort.
8254 @item -mdisable-indexing
8255 @opindex mdisable-indexing
8256 Prevent the compiler from using indexing address modes.  This avoids some
8257 rather obscure problems when compiling MIG generated code under MACH@.
8259 @item -mno-space-regs
8260 @opindex mno-space-regs
8261 Generate code that assumes the target has no space registers.  This allows
8262 GCC to generate faster indirect calls and use unscaled index address modes.
8264 Such code is suitable for level 0 PA systems and kernels.
8266 @item -mfast-indirect-calls
8267 @opindex mfast-indirect-calls
8268 Generate code that assumes calls never cross space boundaries.  This
8269 allows GCC to emit code which performs faster indirect calls.
8271 This option will not work in the presence of shared libraries or nested
8272 functions.
8274 @item -mlong-load-store
8275 @opindex mlong-load-store
8276 Generate 3-instruction load and store sequences as sometimes required by
8277 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8278 the HP compilers.
8280 @item -mportable-runtime
8281 @opindex mportable-runtime
8282 Use the portable calling conventions proposed by HP for ELF systems.
8284 @item -mgas
8285 @opindex mgas
8286 Enable the use of assembler directives only GAS understands.
8288 @item -mschedule=@var{cpu-type}
8289 @opindex mschedule
8290 Schedule code according to the constraints for the machine type
8291 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8292 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8293 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8294 proper scheduling option for your machine.  The default scheduling is
8295 @samp{8000}.
8297 @item -mlinker-opt
8298 @opindex mlinker-opt
8299 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8300 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8301 linkers in which they give bogus error messages when linking some programs.
8303 @item -msoft-float
8304 @opindex msoft-float
8305 Generate output containing library calls for floating point.
8306 @strong{Warning:} the requisite libraries are not available for all HPPA
8307 targets.  Normally the facilities of the machine's usual C compiler are
8308 used, but this cannot be done directly in cross-compilation.  You must make
8309 your own arrangements to provide suitable library functions for
8310 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8311 does provide software floating point support.
8313 @option{-msoft-float} changes the calling convention in the output file;
8314 therefore, it is only useful if you compile @emph{all} of a program with
8315 this option.  In particular, you need to compile @file{libgcc.a}, the
8316 library that comes with GCC, with @option{-msoft-float} in order for
8317 this to work.
8319 @item -msio
8320 @opindex msio
8321 Generate the predefine, @code{_SIO}, for server IO.  The default is
8322 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8323 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8324 options are available under HP-UX and HI-UX.
8326 @item -mgnu-ld
8327 @opindex gnu-ld
8328 Use GNU ld specific options.  This passes @option{-shared} to ld when
8329 building a shared library.  It is the default when GCC is configured,
8330 explicitly or implicitly, with the GNU linker.  This option does not
8331 have any affect on which ld is called, it only changes what parameters
8332 are passed to that ld.  The ld that is called is determined by the
8333 @option{--with-ld} configure option, gcc's program search path, and
8334 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8335 using @samp{which `gcc -print-prog-name=ld`}.
8337 @item -mhp-ld
8338 @opindex hp-ld
8339 Use HP ld specific options.  This passes @option{-b} to ld when building
8340 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8341 links.  It is the default when GCC is configured, explicitly or
8342 implicitly, with the HP linker.  This option does not have any affect on
8343 which ld is called, it only changes what parameters are passed to that
8344 ld.  The ld that is called is determined by the @option{--with-ld}
8345 configure option, gcc's program search path, and finally by the user's
8346 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8347 `gcc -print-prog-name=ld`}.
8349 @item -mlong-calls
8350 @opindex mno-long-calls
8351 Generate code that uses long call sequences.  This ensures that a call
8352 is always able to reach linker generated stubs.  The default is to generate
8353 long calls only when the distance from the call site to the beginning
8354 of the function or translation unit, as the case may be, exceeds a
8355 predefined limit set by the branch type being used.  The limits for
8356 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8357 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8358 240,000 bytes.
8360 Distances are measured from the beginning of functions when using the
8361 @option{-ffunction-sections} option, or when using the @option{-mgas}
8362 and @option{-mno-portable-runtime} options together under HP-UX with
8363 the SOM linker.
8365 It is normally not desirable to use this option as it will degrade
8366 performance.  However, it may be useful in large applications,
8367 particularly when partial linking is used to build the application.
8369 The types of long calls used depends on the capabilities of the
8370 assembler and linker, and the type of code being generated.  The
8371 impact on systems that support long absolute calls, and long pic
8372 symbol-difference or pc-relative calls should be relatively small.
8373 However, an indirect call is used on 32-bit ELF systems in pic code
8374 and it is quite long.
8376 @end table
8378 @node Intel 960 Options
8379 @subsection Intel 960 Options
8381 These @samp{-m} options are defined for the Intel 960 implementations:
8383 @table @gcctabopt
8384 @item -m@var{cpu-type}
8385 @opindex mka
8386 @opindex mkb
8387 @opindex mmc
8388 @opindex mca
8389 @opindex mcf
8390 @opindex msa
8391 @opindex msb
8392 Assume the defaults for the machine type @var{cpu-type} for some of
8393 the other options, including instruction scheduling, floating point
8394 support, and addressing modes.  The choices for @var{cpu-type} are
8395 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8396 @samp{sa}, and @samp{sb}.
8397 The default is
8398 @samp{kb}.
8400 @item -mnumerics
8401 @itemx -msoft-float
8402 @opindex mnumerics
8403 @opindex msoft-float
8404 The @option{-mnumerics} option indicates that the processor does support
8405 floating-point instructions.  The @option{-msoft-float} option indicates
8406 that floating-point support should not be assumed.
8408 @item -mleaf-procedures
8409 @itemx -mno-leaf-procedures
8410 @opindex mleaf-procedures
8411 @opindex mno-leaf-procedures
8412 Do (or do not) attempt to alter leaf procedures to be callable with the
8413 @code{bal} instruction as well as @code{call}.  This will result in more
8414 efficient code for explicit calls when the @code{bal} instruction can be
8415 substituted by the assembler or linker, but less efficient code in other
8416 cases, such as calls via function pointers, or using a linker that doesn't
8417 support this optimization.
8419 @item -mtail-call
8420 @itemx -mno-tail-call
8421 @opindex mtail-call
8422 @opindex mno-tail-call
8423 Do (or do not) make additional attempts (beyond those of the
8424 machine-independent portions of the compiler) to optimize tail-recursive
8425 calls into branches.  You may not want to do this because the detection of
8426 cases where this is not valid is not totally complete.  The default is
8427 @option{-mno-tail-call}.
8429 @item -mcomplex-addr
8430 @itemx -mno-complex-addr
8431 @opindex mcomplex-addr
8432 @opindex mno-complex-addr
8433 Assume (or do not assume) that the use of a complex addressing mode is a
8434 win on this implementation of the i960.  Complex addressing modes may not
8435 be worthwhile on the K-series, but they definitely are on the C-series.
8436 The default is currently @option{-mcomplex-addr} for all processors except
8437 the CB and CC@.
8439 @item -mcode-align
8440 @itemx -mno-code-align
8441 @opindex mcode-align
8442 @opindex mno-code-align
8443 Align code to 8-byte boundaries for faster fetching (or don't bother).
8444 Currently turned on by default for C-series implementations only.
8446 @ignore
8447 @item -mclean-linkage
8448 @itemx -mno-clean-linkage
8449 @opindex mclean-linkage
8450 @opindex mno-clean-linkage
8451 These options are not fully implemented.
8452 @end ignore
8454 @item -mic-compat
8455 @itemx -mic2.0-compat
8456 @itemx -mic3.0-compat
8457 @opindex mic-compat
8458 @opindex mic2.0-compat
8459 @opindex mic3.0-compat
8460 Enable compatibility with iC960 v2.0 or v3.0.
8462 @item -masm-compat
8463 @itemx -mintel-asm
8464 @opindex masm-compat
8465 @opindex mintel-asm
8466 Enable compatibility with the iC960 assembler.
8468 @item -mstrict-align
8469 @itemx -mno-strict-align
8470 @opindex mstrict-align
8471 @opindex mno-strict-align
8472 Do not permit (do permit) unaligned accesses.
8474 @item -mold-align
8475 @opindex mold-align
8476 Enable structure-alignment compatibility with Intel's gcc release version
8477 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8479 @item -mlong-double-64
8480 @opindex mlong-double-64
8481 Implement type @samp{long double} as 64-bit floating point numbers.
8482 Without the option @samp{long double} is implemented by 80-bit
8483 floating point numbers.  The only reason we have it because there is
8484 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8485 is only useful for people using soft-float targets.  Otherwise, we
8486 should recommend against use of it.
8488 @end table
8490 @node DEC Alpha Options
8491 @subsection DEC Alpha Options
8493 These @samp{-m} options are defined for the DEC Alpha implementations:
8495 @table @gcctabopt
8496 @item -mno-soft-float
8497 @itemx -msoft-float
8498 @opindex mno-soft-float
8499 @opindex msoft-float
8500 Use (do not use) the hardware floating-point instructions for
8501 floating-point operations.  When @option{-msoft-float} is specified,
8502 functions in @file{libgcc.a} will be used to perform floating-point
8503 operations.  Unless they are replaced by routines that emulate the
8504 floating-point operations, or compiled in such a way as to call such
8505 emulations routines, these routines will issue floating-point
8506 operations.   If you are compiling for an Alpha without floating-point
8507 operations, you must ensure that the library is built so as not to call
8508 them.
8510 Note that Alpha implementations without floating-point operations are
8511 required to have floating-point registers.
8513 @item -mfp-reg
8514 @itemx -mno-fp-regs
8515 @opindex mfp-reg
8516 @opindex mno-fp-regs
8517 Generate code that uses (does not use) the floating-point register set.
8518 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8519 register set is not used, floating point operands are passed in integer
8520 registers as if they were integers and floating-point results are passed
8521 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8522 so any function with a floating-point argument or return value called by code
8523 compiled with @option{-mno-fp-regs} must also be compiled with that
8524 option.
8526 A typical use of this option is building a kernel that does not use,
8527 and hence need not save and restore, any floating-point registers.
8529 @item -mieee
8530 @opindex mieee
8531 The Alpha architecture implements floating-point hardware optimized for
8532 maximum performance.  It is mostly compliant with the IEEE floating
8533 point standard.  However, for full compliance, software assistance is
8534 required.  This option generates code fully IEEE compliant code
8535 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8536 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8537 defined during compilation.  The resulting code is less efficient but is
8538 able to correctly support denormalized numbers and exceptional IEEE
8539 values such as not-a-number and plus/minus infinity.  Other Alpha
8540 compilers call this option @option{-ieee_with_no_inexact}.
8542 @item -mieee-with-inexact
8543 @opindex mieee-with-inexact
8544 This is like @option{-mieee} except the generated code also maintains
8545 the IEEE @var{inexact-flag}.  Turning on this option causes the
8546 generated code to implement fully-compliant IEEE math.  In addition to
8547 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8548 macro.  On some Alpha implementations the resulting code may execute
8549 significantly slower than the code generated by default.  Since there is
8550 very little code that depends on the @var{inexact-flag}, you should
8551 normally not specify this option.  Other Alpha compilers call this
8552 option @option{-ieee_with_inexact}.
8554 @item -mfp-trap-mode=@var{trap-mode}
8555 @opindex mfp-trap-mode
8556 This option controls what floating-point related traps are enabled.
8557 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8558 The trap mode can be set to one of four values:
8560 @table @samp
8561 @item n
8562 This is the default (normal) setting.  The only traps that are enabled
8563 are the ones that cannot be disabled in software (e.g., division by zero
8564 trap).
8566 @item u
8567 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8568 as well.
8570 @item su
8571 Like @samp{su}, but the instructions are marked to be safe for software
8572 completion (see Alpha architecture manual for details).
8574 @item sui
8575 Like @samp{su}, but inexact traps are enabled as well.
8576 @end table
8578 @item -mfp-rounding-mode=@var{rounding-mode}
8579 @opindex mfp-rounding-mode
8580 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8581 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8584 @table @samp
8585 @item n
8586 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8587 the nearest machine number or towards the even machine number in case
8588 of a tie.
8590 @item m
8591 Round towards minus infinity.
8593 @item c
8594 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8596 @item d
8597 Dynamic rounding mode.  A field in the floating point control register
8598 (@var{fpcr}, see Alpha architecture reference manual) controls the
8599 rounding mode in effect.  The C library initializes this register for
8600 rounding towards plus infinity.  Thus, unless your program modifies the
8601 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8602 @end table
8604 @item -mtrap-precision=@var{trap-precision}
8605 @opindex mtrap-precision
8606 In the Alpha architecture, floating point traps are imprecise.  This
8607 means without software assistance it is impossible to recover from a
8608 floating trap and program execution normally needs to be terminated.
8609 GCC can generate code that can assist operating system trap handlers
8610 in determining the exact location that caused a floating point trap.
8611 Depending on the requirements of an application, different levels of
8612 precisions can be selected:
8614 @table @samp
8615 @item p
8616 Program precision.  This option is the default and means a trap handler
8617 can only identify which program caused a floating point exception.
8619 @item f
8620 Function precision.  The trap handler can determine the function that
8621 caused a floating point exception.
8623 @item i
8624 Instruction precision.  The trap handler can determine the exact
8625 instruction that caused a floating point exception.
8626 @end table
8628 Other Alpha compilers provide the equivalent options called
8629 @option{-scope_safe} and @option{-resumption_safe}.
8631 @item -mieee-conformant
8632 @opindex mieee-conformant
8633 This option marks the generated code as IEEE conformant.  You must not
8634 use this option unless you also specify @option{-mtrap-precision=i} and either
8635 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8636 is to emit the line @samp{.eflag 48} in the function prologue of the
8637 generated assembly file.  Under DEC Unix, this has the effect that
8638 IEEE-conformant math library routines will be linked in.
8640 @item -mbuild-constants
8641 @opindex mbuild-constants
8642 Normally GCC examines a 32- or 64-bit integer constant to
8643 see if it can construct it from smaller constants in two or three
8644 instructions.  If it cannot, it will output the constant as a literal and
8645 generate code to load it from the data segment at runtime.
8647 Use this option to require GCC to construct @emph{all} integer constants
8648 using code, even if it takes more instructions (the maximum is six).
8650 You would typically use this option to build a shared library dynamic
8651 loader.  Itself a shared library, it must relocate itself in memory
8652 before it can find the variables and constants in its own data segment.
8654 @item -malpha-as
8655 @itemx -mgas
8656 @opindex malpha-as
8657 @opindex mgas
8658 Select whether to generate code to be assembled by the vendor-supplied
8659 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8661 @item -mbwx
8662 @itemx -mno-bwx
8663 @itemx -mcix
8664 @itemx -mno-cix
8665 @itemx -mfix
8666 @itemx -mno-fix
8667 @itemx -mmax
8668 @itemx -mno-max
8669 @opindex mbwx
8670 @opindex mno-bwx
8671 @opindex mcix
8672 @opindex mno-cix
8673 @opindex mfix
8674 @opindex mno-fix
8675 @opindex mmax
8676 @opindex mno-max
8677 Indicate whether GCC should generate code to use the optional BWX,
8678 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8679 sets supported by the CPU type specified via @option{-mcpu=} option or that
8680 of the CPU on which GCC was built if none was specified.
8682 @item -mfloat-vax
8683 @itemx -mfloat-ieee
8684 @opindex mfloat-vax
8685 @opindex mfloat-ieee
8686 Generate code that uses (does not use) VAX F and G floating point
8687 arithmetic instead of IEEE single and double precision.
8689 @item -mexplicit-relocs
8690 @itemx -mno-explicit-relocs
8691 @opindex mexplicit-relocs
8692 @opindex mno-explicit-relocs
8693 Older Alpha assemblers provided no way to generate symbol relocations
8694 except via assembler macros.  Use of these macros does not allow
8695 optimal instruction scheduling.  GNU binutils as of version 2.12
8696 supports a new syntax that allows the compiler to explicitly mark
8697 which relocations should apply to which instructions.  This option
8698 is mostly useful for debugging, as GCC detects the capabilities of
8699 the assembler when it is built and sets the default accordingly.
8701 @item -msmall-data
8702 @itemx -mlarge-data
8703 @opindex msmall-data
8704 @opindex mlarge-data
8705 When @option{-mexplicit-relocs} is in effect, static data is
8706 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8707 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8708 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8709 16-bit relocations off of the @code{$gp} register.  This limits the
8710 size of the small data area to 64KB, but allows the variables to be
8711 directly accessed via a single instruction.
8713 The default is @option{-mlarge-data}.  With this option the data area
8714 is limited to just below 2GB.  Programs that require more than 2GB of
8715 data must use @code{malloc} or @code{mmap} to allocate the data in the
8716 heap instead of in the program's data segment.
8718 When generating code for shared libraries, @option{-fpic} implies
8719 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8721 @item -msmall-text
8722 @itemx -mlarge-text
8723 @opindex msmall-text
8724 @opindex mlarge-text
8725 When @option{-msmall-text} is used, the compiler assumes that the
8726 code of the entire program (or shared library) fits in 4MB, and is
8727 thus reachable with a branch instruction.  When @option{-msmall-data}
8728 is used, the compiler can assume that all local symbols share the
8729 same @code{$gp} value, and thus reduce the number of instructions
8730 required for a function call from 4 to 1.
8732 The default is @option{-mlarge-text}.
8734 @item -mcpu=@var{cpu_type}
8735 @opindex mcpu
8736 Set the instruction set and instruction scheduling parameters for
8737 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8738 style name or the corresponding chip number.  GCC supports scheduling
8739 parameters for the EV4, EV5 and EV6 family of processors and will
8740 choose the default values for the instruction set from the processor
8741 you specify.  If you do not specify a processor type, GCC will default
8742 to the processor on which the compiler was built.
8744 Supported values for @var{cpu_type} are
8746 @table @samp
8747 @item ev4
8748 @item ev45
8749 @itemx 21064
8750 Schedules as an EV4 and has no instruction set extensions.
8752 @item ev5
8753 @itemx 21164
8754 Schedules as an EV5 and has no instruction set extensions.
8756 @item ev56
8757 @itemx 21164a
8758 Schedules as an EV5 and supports the BWX extension.
8760 @item pca56
8761 @itemx 21164pc
8762 @itemx 21164PC
8763 Schedules as an EV5 and supports the BWX and MAX extensions.
8765 @item ev6
8766 @itemx 21264
8767 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8769 @item ev67
8770 @item 21264a
8771 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8772 @end table
8774 @item -mtune=@var{cpu_type}
8775 @opindex mtune
8776 Set only the instruction scheduling parameters for machine type
8777 @var{cpu_type}.  The instruction set is not changed.
8779 @item -mmemory-latency=@var{time}
8780 @opindex mmemory-latency
8781 Sets the latency the scheduler should assume for typical memory
8782 references as seen by the application.  This number is highly
8783 dependent on the memory access patterns used by the application
8784 and the size of the external cache on the machine.
8786 Valid options for @var{time} are
8788 @table @samp
8789 @item @var{number}
8790 A decimal number representing clock cycles.
8792 @item L1
8793 @itemx L2
8794 @itemx L3
8795 @itemx main
8796 The compiler contains estimates of the number of clock cycles for
8797 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8798 (also called Dcache, Scache, and Bcache), as well as to main memory.
8799 Note that L3 is only valid for EV5.
8801 @end table
8802 @end table
8804 @node DEC Alpha/VMS Options
8805 @subsection DEC Alpha/VMS Options
8807 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8809 @table @gcctabopt
8810 @item -mvms-return-codes
8811 @opindex mvms-return-codes
8812 Return VMS condition codes from main.  The default is to return POSIX
8813 style condition (e.g.@ error) codes.
8814 @end table
8816 @node H8/300 Options
8817 @subsection H8/300 Options
8819 These @samp{-m} options are defined for the H8/300 implementations:
8821 @table @gcctabopt
8822 @item -mrelax
8823 @opindex mrelax
8824 Shorten some address references at link time, when possible; uses the
8825 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8826 ld.info, Using ld}, for a fuller description.
8828 @item -mh
8829 @opindex mh
8830 Generate code for the H8/300H@.
8832 @item -ms
8833 @opindex ms
8834 Generate code for the H8S@.
8836 @item -mn
8837 @opindex mn
8838 Generate code for the H8S and H8/300H in the normal mode.  This switch
8839 must be used either with -mh or -ms.
8841 @item -ms2600
8842 @opindex ms2600
8843 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8845 @item -mint32
8846 @opindex mint32
8847 Make @code{int} data 32 bits by default.
8849 @item -malign-300
8850 @opindex malign-300
8851 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8852 The default for the H8/300H and H8S is to align longs and floats on 4
8853 byte boundaries.
8854 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8855 This option has no effect on the H8/300.
8856 @end table
8858 @node SH Options
8859 @subsection SH Options
8861 These @samp{-m} options are defined for the SH implementations:
8863 @table @gcctabopt
8864 @item -m1
8865 @opindex m1
8866 Generate code for the SH1.
8868 @item -m2
8869 @opindex m2
8870 Generate code for the SH2.
8872 @item -m2e
8873 Generate code for the SH2e.
8875 @item -m3
8876 @opindex m3
8877 Generate code for the SH3.
8879 @item -m3e
8880 @opindex m3e
8881 Generate code for the SH3e.
8883 @item -m4-nofpu
8884 @opindex m4-nofpu
8885 Generate code for the SH4 without a floating-point unit.
8887 @item -m4-single-only
8888 @opindex m4-single-only
8889 Generate code for the SH4 with a floating-point unit that only
8890 supports single-precision arithmetic.
8892 @item -m4-single
8893 @opindex m4-single
8894 Generate code for the SH4 assuming the floating-point unit is in
8895 single-precision mode by default.
8897 @item -m4
8898 @opindex m4
8899 Generate code for the SH4.
8901 @item -mb
8902 @opindex mb
8903 Compile code for the processor in big endian mode.
8905 @item -ml
8906 @opindex ml
8907 Compile code for the processor in little endian mode.
8909 @item -mdalign
8910 @opindex mdalign
8911 Align doubles at 64-bit boundaries.  Note that this changes the calling
8912 conventions, and thus some functions from the standard C library will
8913 not work unless you recompile it first with @option{-mdalign}.
8915 @item -mrelax
8916 @opindex mrelax
8917 Shorten some address references at link time, when possible; uses the
8918 linker option @option{-relax}.
8920 @item -mbigtable
8921 @opindex mbigtable
8922 Use 32-bit offsets in @code{switch} tables.  The default is to use
8923 16-bit offsets.
8925 @item -mfmovd
8926 @opindex mfmovd
8927 Enable the use of the instruction @code{fmovd}.
8929 @item -mhitachi
8930 @opindex mhitachi
8931 Comply with the calling conventions defined by Hitachi.
8933 @item -mnomacsave
8934 @opindex mnomacsave
8935 Mark the @code{MAC} register as call-clobbered, even if
8936 @option{-mhitachi} is given.
8938 @item -mieee
8939 @opindex mieee
8940 Increase IEEE-compliance of floating-point code.
8942 @item -misize
8943 @opindex misize
8944 Dump instruction size and location in the assembly code.
8946 @item -mpadstruct
8947 @opindex mpadstruct
8948 This option is deprecated.  It pads structures to multiple of 4 bytes,
8949 which is incompatible with the SH ABI@.
8951 @item -mspace
8952 @opindex mspace
8953 Optimize for space instead of speed.  Implied by @option{-Os}.
8955 @item -mprefergot
8956 @opindex mprefergot
8957 When generating position-independent code, emit function calls using
8958 the Global Offset Table instead of the Procedure Linkage Table.
8960 @item -musermode
8961 @opindex musermode
8962 Generate a library function call to invalidate instruction cache
8963 entries, after fixing up a trampoline.  This library function call
8964 doesn't assume it can write to the whole memory address space.  This
8965 is the default when the target is @code{sh-*-linux*}.
8966 @end table
8968 @node System V Options
8969 @subsection Options for System V
8971 These additional options are available on System V Release 4 for
8972 compatibility with other compilers on those systems:
8974 @table @gcctabopt
8975 @item -G
8976 @opindex G
8977 Create a shared object.
8978 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8980 @item -Qy
8981 @opindex Qy
8982 Identify the versions of each tool used by the compiler, in a
8983 @code{.ident} assembler directive in the output.
8985 @item -Qn
8986 @opindex Qn
8987 Refrain from adding @code{.ident} directives to the output file (this is
8988 the default).
8990 @item -YP,@var{dirs}
8991 @opindex YP
8992 Search the directories @var{dirs}, and no others, for libraries
8993 specified with @option{-l}.
8995 @item -Ym,@var{dir}
8996 @opindex Ym
8997 Look in the directory @var{dir} to find the M4 preprocessor.
8998 The assembler uses this option.
8999 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9000 @c the generic assembler that comes with Solaris takes just -Ym.
9001 @end table
9003 @node TMS320C3x/C4x Options
9004 @subsection TMS320C3x/C4x Options
9005 @cindex TMS320C3x/C4x Options
9007 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9009 @table @gcctabopt
9011 @item -mcpu=@var{cpu_type}
9012 @opindex mcpu
9013 Set the instruction set, register set, and instruction scheduling
9014 parameters for machine type @var{cpu_type}.  Supported values for
9015 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9016 @samp{c44}.  The default is @samp{c40} to generate code for the
9017 TMS320C40.
9019 @item -mbig-memory
9020 @item -mbig
9021 @itemx -msmall-memory
9022 @itemx -msmall
9023 @opindex mbig-memory
9024 @opindex mbig
9025 @opindex msmall-memory
9026 @opindex msmall
9027 Generates code for the big or small memory model.  The small memory
9028 model assumed that all data fits into one 64K word page.  At run-time
9029 the data page (DP) register must be set to point to the 64K page
9030 containing the .bss and .data program sections.  The big memory model is
9031 the default and requires reloading of the DP register for every direct
9032 memory access.
9034 @item -mbk
9035 @itemx -mno-bk
9036 @opindex mbk
9037 @opindex mno-bk
9038 Allow (disallow) allocation of general integer operands into the block
9039 count register BK@.
9041 @item -mdb
9042 @itemx -mno-db
9043 @opindex mdb
9044 @opindex mno-db
9045 Enable (disable) generation of code using decrement and branch,
9046 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9047 on the safe side, this is disabled for the C3x, since the maximum
9048 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9049 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9050 that it can utilize the decrement and branch instruction, but will give
9051 up if there is more than one memory reference in the loop.  Thus a loop
9052 where the loop counter is decremented can generate slightly more
9053 efficient code, in cases where the RPTB instruction cannot be utilized.
9055 @item -mdp-isr-reload
9056 @itemx -mparanoid
9057 @opindex mdp-isr-reload
9058 @opindex mparanoid
9059 Force the DP register to be saved on entry to an interrupt service
9060 routine (ISR), reloaded to point to the data section, and restored on
9061 exit from the ISR@.  This should not be required unless someone has
9062 violated the small memory model by modifying the DP register, say within
9063 an object library.
9065 @item -mmpyi
9066 @itemx -mno-mpyi
9067 @opindex mmpyi
9068 @opindex mno-mpyi
9069 For the C3x use the 24-bit MPYI instruction for integer multiplies
9070 instead of a library call to guarantee 32-bit results.  Note that if one
9071 of the operands is a constant, then the multiplication will be performed
9072 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9073 then squaring operations are performed inline instead of a library call.
9075 @item -mfast-fix
9076 @itemx -mno-fast-fix
9077 @opindex mfast-fix
9078 @opindex mno-fast-fix
9079 The C3x/C4x FIX instruction to convert a floating point value to an
9080 integer value chooses the nearest integer less than or equal to the
9081 floating point value rather than to the nearest integer.  Thus if the
9082 floating point number is negative, the result will be incorrectly
9083 truncated an additional code is necessary to detect and correct this
9084 case.  This option can be used to disable generation of the additional
9085 code required to correct the result.
9087 @item -mrptb
9088 @itemx -mno-rptb
9089 @opindex mrptb
9090 @opindex mno-rptb
9091 Enable (disable) generation of repeat block sequences using the RPTB
9092 instruction for zero overhead looping.  The RPTB construct is only used
9093 for innermost loops that do not call functions or jump across the loop
9094 boundaries.  There is no advantage having nested RPTB loops due to the
9095 overhead required to save and restore the RC, RS, and RE registers.
9096 This is enabled by default with @option{-O2}.
9098 @item -mrpts=@var{count}
9099 @itemx -mno-rpts
9100 @opindex mrpts
9101 @opindex mno-rpts
9102 Enable (disable) the use of the single instruction repeat instruction
9103 RPTS@.  If a repeat block contains a single instruction, and the loop
9104 count can be guaranteed to be less than the value @var{count}, GCC will
9105 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9106 then a RPTS will be emitted even if the loop count cannot be determined
9107 at compile time.  Note that the repeated instruction following RPTS does
9108 not have to be reloaded from memory each iteration, thus freeing up the
9109 CPU buses for operands.  However, since interrupts are blocked by this
9110 instruction, it is disabled by default.
9112 @item -mloop-unsigned
9113 @itemx -mno-loop-unsigned
9114 @opindex mloop-unsigned
9115 @opindex mno-loop-unsigned
9116 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9117 is @math{2^{31} + 1} since these instructions test if the iteration count is
9118 negative to terminate the loop.  If the iteration count is unsigned
9119 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9120 exceeded.  This switch allows an unsigned iteration count.
9122 @item -mti
9123 @opindex mti
9124 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9125 with.  This also enforces compatibility with the API employed by the TI
9126 C3x C compiler.  For example, long doubles are passed as structures
9127 rather than in floating point registers.
9129 @item -mregparm
9130 @itemx -mmemparm
9131 @opindex mregparm
9132 @opindex mmemparm
9133 Generate code that uses registers (stack) for passing arguments to functions.
9134 By default, arguments are passed in registers where possible rather
9135 than by pushing arguments on to the stack.
9137 @item -mparallel-insns
9138 @itemx -mno-parallel-insns
9139 @opindex mparallel-insns
9140 @opindex mno-parallel-insns
9141 Allow the generation of parallel instructions.  This is enabled by
9142 default with @option{-O2}.
9144 @item -mparallel-mpy
9145 @itemx -mno-parallel-mpy
9146 @opindex mparallel-mpy
9147 @opindex mno-parallel-mpy
9148 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9149 provided @option{-mparallel-insns} is also specified.  These instructions have
9150 tight register constraints which can pessimize the code generation
9151 of large functions.
9153 @end table
9155 @node V850 Options
9156 @subsection V850 Options
9157 @cindex V850 Options
9159 These @samp{-m} options are defined for V850 implementations:
9161 @table @gcctabopt
9162 @item -mlong-calls
9163 @itemx -mno-long-calls
9164 @opindex mlong-calls
9165 @opindex mno-long-calls
9166 Treat all calls as being far away (near).  If calls are assumed to be
9167 far away, the compiler will always load the functions address up into a
9168 register, and call indirect through the pointer.
9170 @item -mno-ep
9171 @itemx -mep
9172 @opindex mno-ep
9173 @opindex mep
9174 Do not optimize (do optimize) basic blocks that use the same index
9175 pointer 4 or more times to copy pointer into the @code{ep} register, and
9176 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9177 option is on by default if you optimize.
9179 @item -mno-prolog-function
9180 @itemx -mprolog-function
9181 @opindex mno-prolog-function
9182 @opindex mprolog-function
9183 Do not use (do use) external functions to save and restore registers at
9184 the prolog and epilog of a function.  The external functions are slower,
9185 but use less code space if more than one function saves the same number
9186 of registers.  The @option{-mprolog-function} option is on by default if
9187 you optimize.
9189 @item -mspace
9190 @opindex mspace
9191 Try to make the code as small as possible.  At present, this just turns
9192 on the @option{-mep} and @option{-mprolog-function} options.
9194 @item -mtda=@var{n}
9195 @opindex mtda
9196 Put static or global variables whose size is @var{n} bytes or less into
9197 the tiny data area that register @code{ep} points to.  The tiny data
9198 area can hold up to 256 bytes in total (128 bytes for byte references).
9200 @item -msda=@var{n}
9201 @opindex msda
9202 Put static or global variables whose size is @var{n} bytes or less into
9203 the small data area that register @code{gp} points to.  The small data
9204 area can hold up to 64 kilobytes.
9206 @item -mzda=@var{n}
9207 @opindex mzda
9208 Put static or global variables whose size is @var{n} bytes or less into
9209 the first 32 kilobytes of memory.
9211 @item -mv850
9212 @opindex mv850
9213 Specify that the target processor is the V850.
9215 @item -mbig-switch
9216 @opindex mbig-switch
9217 Generate code suitable for big switch tables.  Use this option only if
9218 the assembler/linker complain about out of range branches within a switch
9219 table.
9221 @item -mapp-regs
9222 @opindex -mapp-regs
9223 This option will cause r2 and r5 to be used in the code generated by
9224 the compiler.  This setting is the default.
9226 @item -mno-app-regs
9227 @opindex -mno-app-regs
9228 This option will cause r2 and r5 to be treated as fixed registers.
9229   
9230 @item -mv850e
9231 @opindex -mv850e
9232 Specify that the target processor is the V850E.  The preprocessor
9233 constant @samp{__v850e__} will be defined if this option is used.
9235 If neither @option{-mv850} nor @option{-mv850e} are defined
9236 then a default target processor will be chosen and the relevant
9237 @samp{__v850*__} preprocessor constant will be defined.
9239 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9240 defined, regardless of which processor variant is the target.
9242 @item -mdisable-callt
9243 @opindex -mdisable-callt
9244 This option will suppress generation of the CALLT instruction for the
9245 v850e flavors of the v850 architecture.  The default is
9246 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9248 @end table
9250 @node ARC Options
9251 @subsection ARC Options
9252 @cindex ARC Options
9254 These options are defined for ARC implementations:
9256 @table @gcctabopt
9257 @item -EL
9258 @opindex EL
9259 Compile code for little endian mode.  This is the default.
9261 @item -EB
9262 @opindex EB
9263 Compile code for big endian mode.
9265 @item -mmangle-cpu
9266 @opindex mmangle-cpu
9267 Prepend the name of the cpu to all public symbol names.
9268 In multiple-processor systems, there are many ARC variants with different
9269 instruction and register set characteristics.  This flag prevents code
9270 compiled for one cpu to be linked with code compiled for another.
9271 No facility exists for handling variants that are ``almost identical''.
9272 This is an all or nothing option.
9274 @item -mcpu=@var{cpu}
9275 @opindex mcpu
9276 Compile code for ARC variant @var{cpu}.
9277 Which variants are supported depend on the configuration.
9278 All variants support @option{-mcpu=base}, this is the default.
9280 @item -mtext=@var{text-section}
9281 @itemx -mdata=@var{data-section}
9282 @itemx -mrodata=@var{readonly-data-section}
9283 @opindex mtext
9284 @opindex mdata
9285 @opindex mrodata
9286 Put functions, data, and readonly data in @var{text-section},
9287 @var{data-section}, and @var{readonly-data-section} respectively
9288 by default.  This can be overridden with the @code{section} attribute.
9289 @xref{Variable Attributes}.
9291 @end table
9293 @node NS32K Options
9294 @subsection NS32K Options
9295 @cindex NS32K options
9297 These are the @samp{-m} options defined for the 32000 series.  The default
9298 values for these options depends on which style of 32000 was selected when
9299 the compiler was configured; the defaults for the most common choices are
9300 given below.
9302 @table @gcctabopt
9303 @item -m32032
9304 @itemx -m32032
9305 @opindex m32032
9306 @opindex m32032
9307 Generate output for a 32032.  This is the default
9308 when the compiler is configured for 32032 and 32016 based systems.
9310 @item -m32332
9311 @itemx -m32332
9312 @opindex m32332
9313 @opindex m32332
9314 Generate output for a 32332.  This is the default
9315 when the compiler is configured for 32332-based systems.
9317 @item -m32532
9318 @itemx -m32532
9319 @opindex m32532
9320 @opindex m32532
9321 Generate output for a 32532.  This is the default
9322 when the compiler is configured for 32532-based systems.
9324 @item -m32081
9325 @opindex m32081
9326 Generate output containing 32081 instructions for floating point.
9327 This is the default for all systems.
9329 @item -m32381
9330 @opindex m32381
9331 Generate output containing 32381 instructions for floating point.  This
9332 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9333 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9335 @item -mmulti-add
9336 @opindex mmulti-add
9337 Try and generate multiply-add floating point instructions @code{polyF}
9338 and @code{dotF}.  This option is only available if the @option{-m32381}
9339 option is in effect.  Using these instructions requires changes to
9340 register allocation which generally has a negative impact on
9341 performance.  This option should only be enabled when compiling code
9342 particularly likely to make heavy use of multiply-add instructions.
9344 @item -mnomulti-add
9345 @opindex mnomulti-add
9346 Do not try and generate multiply-add floating point instructions
9347 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9349 @item -msoft-float
9350 @opindex msoft-float
9351 Generate output containing library calls for floating point.
9352 @strong{Warning:} the requisite libraries may not be available.
9354 @item -mieee-compare
9355 @itemx -mno-ieee-compare
9356 @opindex mieee-compare
9357 @opindex mno-ieee-compare
9358 Control whether or not the compiler uses IEEE floating point
9359 comparisons.  These handle correctly the case where the result of a
9360 comparison is unordered.
9361 @strong{Warning:} the requisite kernel support may not be available.
9363 @item -mnobitfield
9364 @opindex mnobitfield
9365 Do not use the bit-field instructions.  On some machines it is faster to
9366 use shifting and masking operations.  This is the default for the pc532.
9368 @item -mbitfield
9369 @opindex mbitfield
9370 Do use the bit-field instructions.  This is the default for all platforms
9371 except the pc532.
9373 @item -mrtd
9374 @opindex mrtd
9375 Use a different function-calling convention, in which functions
9376 that take a fixed number of arguments return pop their
9377 arguments on return with the @code{ret} instruction.
9379 This calling convention is incompatible with the one normally
9380 used on Unix, so you cannot use it if you need to call libraries
9381 compiled with the Unix compiler.
9383 Also, you must provide function prototypes for all functions that
9384 take variable numbers of arguments (including @code{printf});
9385 otherwise incorrect code will be generated for calls to those
9386 functions.
9388 In addition, seriously incorrect code will result if you call a
9389 function with too many arguments.  (Normally, extra arguments are
9390 harmlessly ignored.)
9392 This option takes its name from the 680x0 @code{rtd} instruction.
9395 @item -mregparam
9396 @opindex mregparam
9397 Use a different function-calling convention where the first two arguments
9398 are passed in registers.
9400 This calling convention is incompatible with the one normally
9401 used on Unix, so you cannot use it if you need to call libraries
9402 compiled with the Unix compiler.
9404 @item -mnoregparam
9405 @opindex mnoregparam
9406 Do not pass any arguments in registers.  This is the default for all
9407 targets.
9409 @item -msb
9410 @opindex msb
9411 It is OK to use the sb as an index register which is always loaded with
9412 zero.  This is the default for the pc532-netbsd target.
9414 @item -mnosb
9415 @opindex mnosb
9416 The sb register is not available for use or has not been initialized to
9417 zero by the run time system.  This is the default for all targets except
9418 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9419 @option{-fpic} is set.
9421 @item -mhimem
9422 @opindex mhimem
9423 Many ns32000 series addressing modes use displacements of up to 512MB@.
9424 If an address is above 512MB then displacements from zero can not be used.
9425 This option causes code to be generated which can be loaded above 512MB@.
9426 This may be useful for operating systems or ROM code.
9428 @item -mnohimem
9429 @opindex mnohimem
9430 Assume code will be loaded in the first 512MB of virtual address space.
9431 This is the default for all platforms.
9434 @end table
9436 @node AVR Options
9437 @subsection AVR Options
9438 @cindex AVR Options
9440 These options are defined for AVR implementations:
9442 @table @gcctabopt
9443 @item -mmcu=@var{mcu}
9444 @opindex mmcu
9445 Specify ATMEL AVR instruction set or MCU type.
9447 Instruction set avr1 is for the minimal AVR core, not supported by the C
9448 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9449 attiny11, attiny12, attiny15, attiny28).
9451 Instruction set avr2 (default) is for the classic AVR core with up to
9452 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9453 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9454 at90c8534, at90s8535).
9456 Instruction set avr3 is for the classic AVR core with up to 128K program
9457 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9459 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9460 memory space (MCU types: atmega8, atmega83, atmega85).
9462 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9463 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9464 atmega64, atmega128, at43usb355, at94k).
9466 @item -msize
9467 @opindex msize
9468 Output instruction sizes to the asm file.
9470 @item -minit-stack=@var{N}
9471 @opindex minit-stack
9472 Specify the initial stack address, which may be a symbol or numeric value,
9473 @samp{__stack} is the default.
9475 @item -mno-interrupts
9476 @opindex mno-interrupts
9477 Generated code is not compatible with hardware interrupts.
9478 Code size will be smaller.
9480 @item -mcall-prologues
9481 @opindex mcall-prologues
9482 Functions prologues/epilogues expanded as call to appropriate
9483 subroutines.  Code size will be smaller.
9485 @item -mno-tablejump
9486 @opindex mno-tablejump
9487 Do not generate tablejump insns which sometimes increase code size.
9489 @item -mtiny-stack
9490 @opindex mtiny-stack
9491 Change only the low 8 bits of the stack pointer.
9492 @end table
9494 @node MCore Options
9495 @subsection MCore Options
9496 @cindex MCore options
9498 These are the @samp{-m} options defined for the Motorola M*Core
9499 processors.
9501 @table @gcctabopt
9503 @item -mhardlit
9504 @itemx -mhardlit
9505 @itemx -mno-hardlit
9506 @opindex mhardlit
9507 @opindex mhardlit
9508 @opindex mno-hardlit
9509 Inline constants into the code stream if it can be done in two
9510 instructions or less.
9512 @item -mdiv
9513 @itemx -mdiv
9514 @itemx -mno-div
9515 @opindex mdiv
9516 @opindex mdiv
9517 @opindex mno-div
9518 Use the divide instruction.  (Enabled by default).
9520 @item -mrelax-immediate
9521 @itemx -mrelax-immediate
9522 @itemx -mno-relax-immediate
9523 @opindex mrelax-immediate
9524 @opindex mrelax-immediate
9525 @opindex mno-relax-immediate
9526 Allow arbitrary sized immediates in bit operations.
9528 @item -mwide-bitfields
9529 @itemx -mwide-bitfields
9530 @itemx -mno-wide-bitfields
9531 @opindex mwide-bitfields
9532 @opindex mwide-bitfields
9533 @opindex mno-wide-bitfields
9534 Always treat bit-fields as int-sized.
9536 @item -m4byte-functions
9537 @itemx -m4byte-functions
9538 @itemx -mno-4byte-functions
9539 @opindex m4byte-functions
9540 @opindex m4byte-functions
9541 @opindex mno-4byte-functions
9542 Force all functions to be aligned to a four byte boundary.
9544 @item -mcallgraph-data
9545 @itemx -mcallgraph-data
9546 @itemx -mno-callgraph-data
9547 @opindex mcallgraph-data
9548 @opindex mcallgraph-data
9549 @opindex mno-callgraph-data
9550 Emit callgraph information.
9552 @item -mslow-bytes
9553 @itemx -mslow-bytes
9554 @itemx -mno-slow-bytes
9555 @opindex mslow-bytes
9556 @opindex mslow-bytes
9557 @opindex mno-slow-bytes
9558 Prefer word access when reading byte quantities.
9560 @item -mlittle-endian
9561 @itemx -mlittle-endian
9562 @itemx -mbig-endian
9563 @opindex mlittle-endian
9564 @opindex mlittle-endian
9565 @opindex mbig-endian
9566 Generate code for a little endian target.
9568 @item -m210
9569 @itemx -m210
9570 @itemx -m340
9571 @opindex m210
9572 @opindex m210
9573 @opindex m340
9574 Generate code for the 210 processor.
9575 @end table
9577 @node IA-64 Options
9578 @subsection IA-64 Options
9579 @cindex IA-64 Options
9581 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9583 @table @gcctabopt
9584 @item -mbig-endian
9585 @opindex mbig-endian
9586 Generate code for a big endian target.  This is the default for HP-UX@.
9588 @item -mlittle-endian
9589 @opindex mlittle-endian
9590 Generate code for a little endian target.  This is the default for AIX5
9591 and Linux.
9593 @item -mgnu-as
9594 @itemx -mno-gnu-as
9595 @opindex mgnu-as
9596 @opindex mno-gnu-as
9597 Generate (or don't) code for the GNU assembler.  This is the default.
9598 @c Also, this is the default if the configure option @option{--with-gnu-as}
9599 @c is used.
9601 @item -mgnu-ld
9602 @itemx -mno-gnu-ld
9603 @opindex mgnu-ld
9604 @opindex mno-gnu-ld
9605 Generate (or don't) code for the GNU linker.  This is the default.
9606 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9607 @c is used.
9609 @item -mno-pic
9610 @opindex mno-pic
9611 Generate code that does not use a global pointer register.  The result
9612 is not position independent code, and violates the IA-64 ABI@.
9614 @item -mvolatile-asm-stop
9615 @itemx -mno-volatile-asm-stop
9616 @opindex mvolatile-asm-stop
9617 @opindex mno-volatile-asm-stop
9618 Generate (or don't) a stop bit immediately before and after volatile asm
9619 statements.
9621 @item -mb-step
9622 @opindex mb-step
9623 Generate code that works around Itanium B step errata.
9625 @item -mregister-names
9626 @itemx -mno-register-names
9627 @opindex mregister-names
9628 @opindex mno-register-names
9629 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9630 the stacked registers.  This may make assembler output more readable.
9632 @item -mno-sdata
9633 @itemx -msdata
9634 @opindex mno-sdata
9635 @opindex msdata
9636 Disable (or enable) optimizations that use the small data section.  This may
9637 be useful for working around optimizer bugs.
9639 @item -mconstant-gp
9640 @opindex mconstant-gp
9641 Generate code that uses a single constant global pointer value.  This is
9642 useful when compiling kernel code.
9644 @item -mauto-pic
9645 @opindex mauto-pic
9646 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9647 This is useful when compiling firmware code.
9649 @item -minline-float-divide-min-latency
9650 @opindex minline-float-divide-min-latency
9651 Generate code for inline divides of floating point values
9652 using the minimum latency algorithm.
9654 @item -minline-float-divide-max-throughput
9655 @opindex minline-float-divide-max-throughput
9656 Generate code for inline divides of floating point values
9657 using the maximum throughput algorithm.
9659 @item -minline-int-divide-min-latency
9660 @opindex minline-int-divide-min-latency
9661 Generate code for inline divides of integer values
9662 using the minimum latency algorithm.
9664 @item -minline-int-divide-max-throughput
9665 @opindex minline-int-divide-max-throughput
9666 Generate code for inline divides of integer values
9667 using the maximum throughput algorithm.
9669 @item -mno-dwarf2-asm
9670 @itemx -mdwarf2-asm
9671 @opindex mno-dwarf2-asm
9672 @opindex mdwarf2-asm
9673 Don't (or do) generate assembler code for the DWARF2 line number debugging
9674 info.  This may be useful when not using the GNU assembler.
9676 @item -mfixed-range=@var{register-range}
9677 @opindex mfixed-range
9678 Generate code treating the given register range as fixed registers.
9679 A fixed register is one that the register allocator can not use.  This is
9680 useful when compiling kernel code.  A register range is specified as
9681 two registers separated by a dash.  Multiple register ranges can be
9682 specified separated by a comma.
9684 @item -mearly-stop-bits
9685 @itemx -mno-early-stop-bits
9686 @opindex mearly-stop-bits
9687 @opindex mno-early-stop-bits
9688 Allow stop bits to be placed earlier than immediately preceding the
9689 instruction that triggered the stop bit.  This can improve instruction
9690 scheduling, but does not always do so.
9691 @end table
9693 @node D30V Options
9694 @subsection D30V Options
9695 @cindex D30V Options
9697 These @samp{-m} options are defined for D30V implementations:
9699 @table @gcctabopt
9700 @item -mextmem
9701 @opindex mextmem
9702 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9703 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9704 memory, which starts at location @code{0x80000000}.
9706 @item -mextmemory
9707 @opindex mextmemory
9708 Same as the @option{-mextmem} switch.
9710 @item -monchip
9711 @opindex monchip
9712 Link the @samp{.text} section into onchip text memory, which starts at
9713 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9714 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9715 into onchip data memory, which starts at location @code{0x20000000}.
9717 @item -mno-asm-optimize
9718 @itemx -masm-optimize
9719 @opindex mno-asm-optimize
9720 @opindex masm-optimize
9721 Disable (enable) passing @option{-O} to the assembler when optimizing.
9722 The assembler uses the @option{-O} option to automatically parallelize
9723 adjacent short instructions where possible.
9725 @item -mbranch-cost=@var{n}
9726 @opindex mbranch-cost
9727 Increase the internal costs of branches to @var{n}.  Higher costs means
9728 that the compiler will issue more instructions to avoid doing a branch.
9729 The default is 2.
9731 @item -mcond-exec=@var{n}
9732 @opindex mcond-exec
9733 Specify the maximum number of conditionally executed instructions that
9734 replace a branch.  The default is 4.
9735 @end table
9737 @node S/390 and zSeries Options
9738 @subsection S/390 and zSeries Options
9739 @cindex S/390 and zSeries Options
9741 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9743 @table @gcctabopt
9744 @item -mhard-float
9745 @itemx -msoft-float
9746 @opindex mhard-float
9747 @opindex msoft-float
9748 Use (do not use) the hardware floating-point instructions and registers
9749 for floating-point operations.  When @option{-msoft-float} is specified,
9750 functions in @file{libgcc.a} will be used to perform floating-point
9751 operations.  When @option{-mhard-float} is specified, the compiler
9752 generates IEEE floating-point instructions.  This is the default.
9754 @item -mbackchain
9755 @itemx -mno-backchain
9756 @opindex mbackchain
9757 @opindex mno-backchain
9758 Generate (or do not generate) code which maintains an explicit
9759 backchain within the stack frame that points to the caller's frame.
9760 This is currently needed to allow debugging.  The default is to
9761 generate the backchain.
9763 @item -msmall-exec
9764 @itemx -mno-small-exec
9765 @opindex msmall-exec
9766 @opindex mno-small-exec
9767 Generate (or do not generate) code using the @code{bras} instruction
9768 to do subroutine calls.
9769 This only works reliably if the total executable size does not
9770 exceed 64k.  The default is to use the @code{basr} instruction instead,
9771 which does not have this limitation.
9773 @item -m64
9774 @itemx -m31
9775 @opindex m64
9776 @opindex m31
9777 When @option{-m31} is specified, generate code compliant to the
9778 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9779 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9780 particular to generate 64-bit instructions.  For the @samp{s390}
9781 targets, the default is @option{-m31}, while the @samp{s390x}
9782 targets default to @option{-m64}.
9784 @item -mzarch
9785 @itemx -mesa
9786 @opindex mzarch
9787 @opindex mesa
9788 When @option{-mzarch} is specified, generate code using the 
9789 instructions available on z/Architecture. 
9790 When @option{-mesa} is specified, generate code using the 
9791 instructions available on ESA/390. Note that @option{-mesa} is
9792 not possible with @option{-m64}.
9793 For the @samp{s390} targets, the default is @option{-mesa}, 
9794 while the @samp{s390x} targets default to @option{-mzarch}.
9796 @item -mmvcle
9797 @itemx -mno-mvcle
9798 @opindex mmvcle
9799 @opindex mno-mvcle
9800 Generate (or do not generate) code using the @code{mvcle} instruction
9801 to perform block moves.  When @option{-mno-mvcle} is specified,
9802 use a @code{mvc} loop instead.  This is the default.
9804 @item -mdebug
9805 @itemx -mno-debug
9806 @opindex mdebug
9807 @opindex mno-debug
9808 Print (or do not print) additional debug information when compiling.
9809 The default is to not print debug information.
9811 @item -march=@var{arch}
9812 @opindex march
9813 Generate code that will run on @var{arch}, which is the name of system
9814 representing a certain processor type. Possible values for
9815 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
9817 @item -mtune=@var{arch}
9818 @opindex mtune
9819 Tune to @var{cpu-type} everything applicable about the generated code,
9820  except for the ABI and the set of available instructions. 
9821 The list of @var{arch} values is the same as for @option{-march}.
9823 @end table
9825 @node CRIS Options
9826 @subsection CRIS Options
9827 @cindex CRIS Options
9829 These options are defined specifically for the CRIS ports.
9831 @table @gcctabopt
9832 @item -march=@var{architecture-type}
9833 @itemx -mcpu=@var{architecture-type}
9834 @opindex march
9835 @opindex mcpu
9836 Generate code for the specified architecture.  The choices for
9837 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9838 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9839 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9840 @samp{v10}.
9842 @item -mtune=@var{architecture-type}
9843 @opindex mtune
9844 Tune to @var{architecture-type} everything applicable about the generated
9845 code, except for the ABI and the set of available instructions.  The
9846 choices for @var{architecture-type} are the same as for
9847 @option{-march=@var{architecture-type}}.
9849 @item -mmax-stack-frame=@var{n}
9850 @opindex mmax-stack-frame
9851 Warn when the stack frame of a function exceeds @var{n} bytes.
9853 @item -melinux-stacksize=@var{n}
9854 @opindex melinux-stacksize
9855 Only available with the @samp{cris-axis-aout} target.  Arranges for
9856 indications in the program to the kernel loader that the stack of the
9857 program should be set to @var{n} bytes.
9859 @item -metrax4
9860 @itemx -metrax100
9861 @opindex metrax4
9862 @opindex metrax100
9863 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9864 @option{-march=v3} and @option{-march=v8} respectively.
9866 @item -mpdebug
9867 @opindex mpdebug
9868 Enable CRIS-specific verbose debug-related information in the assembly
9869 code.  This option also has the effect to turn off the @samp{#NO_APP}
9870 formatted-code indicator to the assembler at the beginning of the
9871 assembly file.
9873 @item -mcc-init
9874 @opindex mcc-init
9875 Do not use condition-code results from previous instruction; always emit
9876 compare and test instructions before use of condition codes.
9878 @item -mno-side-effects
9879 @opindex mno-side-effects
9880 Do not emit instructions with side-effects in addressing modes other than
9881 post-increment.
9883 @item -mstack-align
9884 @itemx -mno-stack-align
9885 @itemx -mdata-align
9886 @itemx -mno-data-align
9887 @itemx -mconst-align
9888 @itemx -mno-const-align
9889 @opindex mstack-align
9890 @opindex mno-stack-align
9891 @opindex mdata-align
9892 @opindex mno-data-align
9893 @opindex mconst-align
9894 @opindex mno-const-align
9895 These options (no-options) arranges (eliminate arrangements) for the
9896 stack-frame, individual data and constants to be aligned for the maximum
9897 single data access size for the chosen CPU model.  The default is to
9898 arrange for 32-bit alignment.  ABI details such as structure layout are
9899 not affected by these options.
9901 @item -m32-bit
9902 @itemx -m16-bit
9903 @itemx -m8-bit
9904 @opindex m32-bit
9905 @opindex m16-bit
9906 @opindex m8-bit
9907 Similar to the stack- data- and const-align options above, these options
9908 arrange for stack-frame, writable data and constants to all be 32-bit,
9909 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9911 @item -mno-prologue-epilogue
9912 @itemx -mprologue-epilogue
9913 @opindex mno-prologue-epilogue
9914 @opindex mprologue-epilogue
9915 With @option{-mno-prologue-epilogue}, the normal function prologue and
9916 epilogue that sets up the stack-frame are omitted and no return
9917 instructions or return sequences are generated in the code.  Use this
9918 option only together with visual inspection of the compiled code: no
9919 warnings or errors are generated when call-saved registers must be saved,
9920 or storage for local variable needs to be allocated.
9922 @item -mno-gotplt
9923 @itemx -mgotplt
9924 @opindex mno-gotplt
9925 @opindex mgotplt
9926 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9927 instruction sequences that load addresses for functions from the PLT part
9928 of the GOT rather than (traditional on other architectures) calls to the
9929 PLT.  The default is @option{-mgotplt}.
9931 @item -maout
9932 @opindex maout
9933 Legacy no-op option only recognized with the cris-axis-aout target.
9935 @item -melf
9936 @opindex melf
9937 Legacy no-op option only recognized with the cris-axis-elf and
9938 cris-axis-linux-gnu targets.
9940 @item -melinux
9941 @opindex melinux
9942 Only recognized with the cris-axis-aout target, where it selects a
9943 GNU/linux-like multilib, include files and instruction set for
9944 @option{-march=v8}.
9946 @item -mlinux
9947 @opindex mlinux
9948 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9950 @item -sim
9951 @opindex sim
9952 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9953 to link with input-output functions from a simulator library.  Code,
9954 initialized data and zero-initialized data are allocated consecutively.
9956 @item -sim2
9957 @opindex sim2
9958 Like @option{-sim}, but pass linker options to locate initialized data at
9959 0x40000000 and zero-initialized data at 0x80000000.
9960 @end table
9962 @node MMIX Options
9963 @subsection MMIX Options
9964 @cindex MMIX Options
9966 These options are defined for the MMIX:
9968 @table @gcctabopt
9969 @item -mlibfuncs
9970 @itemx -mno-libfuncs
9971 @opindex mlibfuncs
9972 @opindex mno-libfuncs
9973 Specify that intrinsic library functions are being compiled, passing all
9974 values in registers, no matter the size.
9976 @item -mepsilon
9977 @itemx -mno-epsilon
9978 @opindex mepsilon
9979 @opindex mno-epsilon
9980 Generate floating-point comparison instructions that compare with respect
9981 to the @code{rE} epsilon register.
9983 @item -mabi=mmixware
9984 @itemx -mabi=gnu
9985 @opindex mabi-mmixware
9986 @opindex mabi=gnu
9987 Generate code that passes function parameters and return values that (in
9988 the called function) are seen as registers @code{$0} and up, as opposed to
9989 the GNU ABI which uses global registers @code{$231} and up.
9991 @item -mzero-extend
9992 @itemx -mno-zero-extend
9993 @opindex mzero-extend
9994 @opindex mno-zero-extend
9995 When reading data from memory in sizes shorter than 64 bits, use (do not
9996 use) zero-extending load instructions by default, rather than
9997 sign-extending ones.
9999 @item -mknuthdiv
10000 @itemx -mno-knuthdiv
10001 @opindex mknuthdiv
10002 @opindex mno-knuthdiv
10003 Make the result of a division yielding a remainder have the same sign as
10004 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10005 remainder follows the sign of the dividend.  Both methods are
10006 arithmetically valid, the latter being almost exclusively used.
10008 @item -mtoplevel-symbols
10009 @itemx -mno-toplevel-symbols
10010 @opindex mtoplevel-symbols
10011 @opindex mno-toplevel-symbols
10012 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10013 code can be used with the @code{PREFIX} assembly directive.
10015 @item -melf
10016 @opindex melf
10017 Generate an executable in the ELF format, rather than the default
10018 @samp{mmo} format used by the @command{mmix} simulator.
10020 @item -mbranch-predict
10021 @itemx -mno-branch-predict
10022 @opindex mbranch-predict
10023 @opindex mno-branch-predict
10024 Use (do not use) the probable-branch instructions, when static branch
10025 prediction indicates a probable branch.
10027 @item -mbase-addresses
10028 @itemx -mno-base-addresses
10029 @opindex mbase-addresses
10030 @opindex mno-base-addresses
10031 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10032 base address automatically generates a request (handled by the assembler
10033 and the linker) for a constant to be set up in a global register.  The
10034 register is used for one or more base address requests within the range 0
10035 to 255 from the value held in the register.  The generally leads to short
10036 and fast code, but the number of different data items that can be
10037 addressed is limited.  This means that a program that uses lots of static
10038 data may require @option{-mno-base-addresses}.
10040 @item -msingle-exit
10041 @itemx -mno-single-exit
10042 @opindex msingle-exit
10043 @opindex mno-single-exit
10044 Force (do not force) generated code to have a single exit point in each
10045 function.
10046 @end table
10048 @node PDP-11 Options
10049 @subsection PDP-11 Options
10050 @cindex PDP-11 Options
10052 These options are defined for the PDP-11:
10054 @table @gcctabopt
10055 @item -mfpu
10056 @opindex mfpu
10057 Use hardware FPP floating point.  This is the default.  (FIS floating
10058 point on the PDP-11/40 is not supported.)
10060 @item -msoft-float
10061 @opindex msoft-float
10062 Do not use hardware floating point.
10064 @item -mac0
10065 @opindex mac0
10066 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10068 @item -mno-ac0
10069 @opindex mno-ac0
10070 Return floating-point results in memory.  This is the default.
10072 @item -m40
10073 @opindex m40
10074 Generate code for a PDP-11/40.
10076 @item -m45
10077 @opindex m45
10078 Generate code for a PDP-11/45.  This is the default.
10080 @item -m10
10081 @opindex m10
10082 Generate code for a PDP-11/10.
10084 @item -mbcopy-builtin
10085 @opindex bcopy-builtin
10086 Use inline @code{movstrhi} patterns for copying memory.  This is the
10087 default.
10089 @item -mbcopy
10090 @opindex mbcopy
10091 Do not use inline @code{movstrhi} patterns for copying memory.
10093 @item -mint16
10094 @itemx -mno-int32
10095 @opindex mint16
10096 @opindex mno-int32
10097 Use 16-bit @code{int}.  This is the default.
10099 @item -mint32
10100 @itemx -mno-int16
10101 @opindex mint32
10102 @opindex mno-int16
10103 Use 32-bit @code{int}.
10105 @item -mfloat64
10106 @itemx -mno-float32
10107 @opindex mfloat64
10108 @opindex mno-float32
10109 Use 64-bit @code{float}.  This is the default.
10111 @item -mfloat32
10112 @item -mno-float64
10113 @opindex mfloat32
10114 @opindex mno-float64
10115 Use 32-bit @code{float}.
10117 @item -mabshi
10118 @opindex mabshi
10119 Use @code{abshi2} pattern.  This is the default.
10121 @item -mno-abshi
10122 @opindex mno-abshi
10123 Do not use @code{abshi2} pattern.
10125 @item -mbranch-expensive
10126 @opindex mbranch-expensive
10127 Pretend that branches are expensive.  This is for experimenting with
10128 code generation only.
10130 @item -mbranch-cheap
10131 @opindex mbranch-cheap
10132 Do not pretend that branches are expensive.  This is the default.
10134 @item -msplit
10135 @opindex msplit
10136 Generate code for a system with split I&D.
10138 @item -mno-split
10139 @opindex mno-split
10140 Generate code for a system without split I&D.  This is the default.
10142 @item -munix-asm
10143 @opindex munix-asm
10144 Use Unix assembler syntax.  This is the default when configured for
10145 @samp{pdp11-*-bsd}.
10147 @item -mdec-asm
10148 @opindex mdec-asm
10149 Use DEC assembler syntax.  This is the default when configured for any
10150 PDP-11 target other than @samp{pdp11-*-bsd}.
10151 @end table
10153 @node Xstormy16 Options
10154 @subsection Xstormy16 Options
10155 @cindex Xstormy16 Options
10157 These options are defined for Xstormy16:
10159 @table @gcctabopt
10160 @item -msim
10161 @opindex msim
10162 Choose startup files and linker script suitable for the simulator.
10163 @end table
10165 @node FRV Options
10166 @subsection FRV Options
10167 @cindex FRV Options
10169 @table @gcctabopt
10170 @item -mgpr-32
10171 @opindex mgpr-32
10173 Only use the first 32 general purpose registers.
10175 @item -mgpr-64
10176 @opindex mgpr-64
10178 Use all 64 general purpose registers.
10180 @item -mfpr-32
10181 @opindex mfpr-32
10183 Use only the first 32 floating point registers.
10185 @item -mfpr-64
10186 @opindex mfpr-64
10188 Use all 64 floating point registers
10190 @item -mhard-float
10191 @opindex mhard-float
10193 Use hardware instructions for floating point operations.
10195 @item -msoft-float
10196 @opindex msoft-float
10198 Use library routines for floating point operations.
10200 @item -malloc-cc
10201 @opindex malloc-cc
10203 Dynamically allocate condition code registers.
10205 @item -mfixed-cc
10206 @opindex mfixed-cc
10208 Do not try to dynamically allocate condition code registers, only
10209 use @code{icc0} and @code{fcc0}.
10211 @item -mdword
10212 @opindex mdword
10214 Change ABI to use double word insns.
10216 @item -mno-dword
10217 @opindex mno-dword
10219 Do not use double word instructions.
10221 @item -mdouble
10222 @opindex mdouble
10224 Use floating point double instructions.
10226 @item -mno-double
10227 @opindex mno-double
10229 Do not use floating point double instructions.
10231 @item -mmedia
10232 @opindex mmedia
10234 Use media instructions.
10236 @item -mno-media
10237 @opindex mno-media
10239 Do not use media instructions.
10241 @item -mmuladd
10242 @opindex mmuladd
10244 Use multiply and add/subtract instructions.
10246 @item -mno-muladd
10247 @opindex mno-muladd
10249 Do not use multiply and add/subtract instructions.
10251 @item -mlibrary-pic
10252 @opindex mlibrary-pic
10254 Enable PIC support for building libraries
10256 @item -macc-4
10257 @opindex macc-4
10259 Use only the first four media accumulator registers.
10261 @item -macc-8
10262 @opindex macc-8
10264 Use all eight media accumulator registers.
10266 @item -mpack
10267 @opindex mpack
10269 Pack VLIW instructions.
10271 @item -mno-pack
10272 @opindex mno-pack
10274 Do not pack VLIW instructions.
10276 @item -mno-eflags
10277 @opindex mno-eflags
10279 Do not mark ABI switches in e_flags.
10281 @item -mcond-move
10282 @opindex mcond-move
10284 Enable the use of conditional-move instructions (default).
10286 This switch is mainly for debugging the compiler and will likely be removed
10287 in a future version.
10289 @item -mno-cond-move
10290 @opindex mno-cond-move
10292 Disable the use of conditional-move instructions.
10294 This switch is mainly for debugging the compiler and will likely be removed
10295 in a future version.
10297 @item -mscc
10298 @opindex mscc
10300 Enable the use of conditional set instructions (default).
10302 This switch is mainly for debugging the compiler and will likely be removed
10303 in a future version.
10305 @item -mno-scc
10306 @opindex mno-scc
10308 Disable the use of conditional set instructions.
10310 This switch is mainly for debugging the compiler and will likely be removed
10311 in a future version.
10313 @item -mcond-exec
10314 @opindex mcond-exec
10316 Enable the use of conditional execution (default).
10318 This switch is mainly for debugging the compiler and will likely be removed
10319 in a future version.
10321 @item -mno-cond-exec
10322 @opindex mno-cond-exec
10324 Disable the use of conditional execution.
10326 This switch is mainly for debugging the compiler and will likely be removed
10327 in a future version.
10329 @item -mvliw-branch
10330 @opindex mvliw-branch
10332 Run a pass to pack branches into VLIW instructions (default).
10334 This switch is mainly for debugging the compiler and will likely be removed
10335 in a future version.
10337 @item -mno-vliw-branch
10338 @opindex mno-vliw-branch
10340 Do not run a pass to pack branches into VLIW instructions.
10342 This switch is mainly for debugging the compiler and will likely be removed
10343 in a future version.
10345 @item -mmulti-cond-exec
10346 @opindex mmulti-cond-exec
10348 Enable optimization of @code{&&} and @code{||} in conditional execution
10349 (default).
10351 This switch is mainly for debugging the compiler and will likely be removed
10352 in a future version.
10354 @item -mno-multi-cond-exec
10355 @opindex mno-multi-cond-exec
10357 Disable optimization of @code{&&} and @code{||} in conditional execution.
10359 This switch is mainly for debugging the compiler and will likely be removed
10360 in a future version.
10362 @item -mnested-cond-exec
10363 @opindex mnested-cond-exec
10365 Enable nested conditional execution optimizations (default).
10367 This switch is mainly for debugging the compiler and will likely be removed
10368 in a future version.
10370 @item -mno-nested-cond-exec
10371 @opindex mno-nested-cond-exec
10373 Disable nested conditional execution optimizations.
10375 This switch is mainly for debugging the compiler and will likely be removed
10376 in a future version.
10378 @item -mtomcat-stats
10379 @opindex mtomcat-stats
10381 Cause gas to print out tomcat statistics.
10383 @item -mcpu=@var{cpu}
10384 @opindex mcpu
10386 Select the processor type for which to generate code.  Possible values are
10387 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10388 @samp{frv}.
10390 @end table
10392 @node Xtensa Options
10393 @subsection Xtensa Options
10394 @cindex Xtensa Options
10396 The Xtensa architecture is designed to support many different
10397 configurations.  The compiler's default options can be set to match a
10398 particular Xtensa configuration by copying a configuration file into the
10399 GCC sources when building GCC@.  The options below may be used to
10400 override the default options.
10402 @table @gcctabopt
10403 @item -mbig-endian
10404 @itemx -mlittle-endian
10405 @opindex mbig-endian
10406 @opindex mlittle-endian
10407 Specify big-endian or little-endian byte ordering for the target Xtensa
10408 processor.
10410 @item -mdensity
10411 @itemx -mno-density
10412 @opindex mdensity
10413 @opindex mno-density
10414 Enable or disable use of the optional Xtensa code density instructions.
10416 @item -mmac16
10417 @itemx -mno-mac16
10418 @opindex mmac16
10419 @opindex mno-mac16
10420 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10421 will generate MAC16 instructions from standard C code, with the
10422 limitation that it will use neither the MR register file nor any
10423 instruction that operates on the MR registers.  When this option is
10424 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10425 combination of core instructions and library calls, depending on whether
10426 any other multiplier options are enabled.
10428 @item -mmul16
10429 @itemx -mno-mul16
10430 @opindex mmul16
10431 @opindex mno-mul16
10432 Enable or disable use of the 16-bit integer multiplier option.  When
10433 enabled, the compiler will generate 16-bit multiply instructions for
10434 multiplications of 16 bits or smaller in standard C code.  When this
10435 option is disabled, the compiler will either use 32-bit multiply or
10436 MAC16 instructions if they are available or generate library calls to
10437 perform the multiply operations using shifts and adds.
10439 @item -mmul32
10440 @itemx -mno-mul32
10441 @opindex mmul32
10442 @opindex mno-mul32
10443 Enable or disable use of the 32-bit integer multiplier option.  When
10444 enabled, the compiler will generate 32-bit multiply instructions for
10445 multiplications of 32 bits or smaller in standard C code.  When this
10446 option is disabled, the compiler will generate library calls to perform
10447 the multiply operations using either shifts and adds or 16-bit multiply
10448 instructions if they are available.
10450 @item -mnsa
10451 @itemx -mno-nsa
10452 @opindex mnsa
10453 @opindex mno-nsa
10454 Enable or disable use of the optional normalization shift amount
10455 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10457 @item -mminmax
10458 @itemx -mno-minmax
10459 @opindex mminmax
10460 @opindex mno-minmax
10461 Enable or disable use of the optional minimum and maximum value
10462 instructions.
10464 @item -msext
10465 @itemx -mno-sext
10466 @opindex msext
10467 @opindex mno-sext
10468 Enable or disable use of the optional sign extend (@code{SEXT})
10469 instruction.
10471 @item -mbooleans
10472 @itemx -mno-booleans
10473 @opindex mbooleans
10474 @opindex mno-booleans
10475 Enable or disable support for the boolean register file used by Xtensa
10476 coprocessors.  This is not typically useful by itself but may be
10477 required for other options that make use of the boolean registers (e.g.,
10478 the floating-point option).
10480 @item -mhard-float
10481 @itemx -msoft-float
10482 @opindex mhard-float
10483 @opindex msoft-float
10484 Enable or disable use of the floating-point option.  When enabled, GCC
10485 generates floating-point instructions for 32-bit @code{float}
10486 operations.  When this option is disabled, GCC generates library calls
10487 to emulate 32-bit floating-point operations using integer instructions.
10488 Regardless of this option, 64-bit @code{double} operations are always
10489 emulated with calls to library functions.
10491 @item -mfused-madd
10492 @itemx -mno-fused-madd
10493 @opindex mfused-madd
10494 @opindex mno-fused-madd
10495 Enable or disable use of fused multiply/add and multiply/subtract
10496 instructions in the floating-point option.  This has no effect if the
10497 floating-point option is not also enabled.  Disabling fused multiply/add
10498 and multiply/subtract instructions forces the compiler to use separate
10499 instructions for the multiply and add/subtract operations.  This may be
10500 desirable in some cases where strict IEEE 754-compliant results are
10501 required: the fused multiply add/subtract instructions do not round the
10502 intermediate result, thereby producing results with @emph{more} bits of
10503 precision than specified by the IEEE standard.  Disabling fused multiply
10504 add/subtract instructions also ensures that the program output is not
10505 sensitive to the compiler's ability to combine multiply and add/subtract
10506 operations.
10508 @item -mserialize-volatile
10509 @itemx -mno-serialize-volatile
10510 @opindex mserialize-volatile
10511 @opindex mno-serialize-volatile
10512 When this option is enabled, GCC inserts @code{MEMW} instructions before
10513 @code{volatile} memory references to guarantee sequential consistency.
10514 The default is @option{-mserialize-volatile}.  Use
10515 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10517 @item -mtext-section-literals
10518 @itemx -mno-text-section-literals
10519 @opindex mtext-section-literals
10520 @opindex mno-text-section-literals
10521 Control the treatment of literal pools.  The default is
10522 @option{-mno-text-section-literals}, which places literals in a separate
10523 section in the output file.  This allows the literal pool to be placed
10524 in a data RAM/ROM, and it also allows the linker to combine literal
10525 pools from separate object files to remove redundant literals and
10526 improve code size.  With @option{-mtext-section-literals}, the literals
10527 are interspersed in the text section in order to keep them as close as
10528 possible to their references.  This may be necessary for large assembly
10529 files.
10531 @item -mtarget-align
10532 @itemx -mno-target-align
10533 @opindex mtarget-align
10534 @opindex mno-target-align
10535 When this option is enabled, GCC instructs the assembler to
10536 automatically align instructions to reduce branch penalties at the
10537 expense of some code density.  The assembler attempts to widen density
10538 instructions to align branch targets and the instructions following call
10539 instructions.  If there are not enough preceding safe density
10540 instructions to align a target, no widening will be performed.  The
10541 default is @option{-mtarget-align}.  These options do not affect the
10542 treatment of auto-aligned instructions like @code{LOOP}, which the
10543 assembler will always align, either by widening density instructions or
10544 by inserting no-op instructions.
10546 @item -mlongcalls
10547 @itemx -mno-longcalls
10548 @opindex mlongcalls
10549 @opindex mno-longcalls
10550 When this option is enabled, GCC instructs the assembler to translate
10551 direct calls to indirect calls unless it can determine that the target
10552 of a direct call is in the range allowed by the call instruction.  This
10553 translation typically occurs for calls to functions in other source
10554 files.  Specifically, the assembler translates a direct @code{CALL}
10555 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10556 The default is @option{-mno-longcalls}.  This option should be used in
10557 programs where the call target can potentially be out of range.  This
10558 option is implemented in the assembler, not the compiler, so the
10559 assembly code generated by GCC will still show direct call
10560 instructions---look at the disassembled object code to see the actual
10561 instructions.  Note that the assembler will use an indirect call for
10562 every cross-file call, not just those that really will be out of range.
10563 @end table
10565 @node Code Gen Options
10566 @section Options for Code Generation Conventions
10567 @cindex code generation conventions
10568 @cindex options, code generation
10569 @cindex run-time options
10571 These machine-independent options control the interface conventions
10572 used in code generation.
10574 Most of them have both positive and negative forms; the negative form
10575 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10576 one of the forms is listed---the one which is not the default.  You
10577 can figure out the other form by either removing @samp{no-} or adding
10580 @table @gcctabopt
10581 @item -fexceptions
10582 @opindex fexceptions
10583 Enable exception handling.  Generates extra code needed to propagate
10584 exceptions.  For some targets, this implies GCC will generate frame
10585 unwind information for all functions, which can produce significant data
10586 size overhead, although it does not affect execution.  If you do not
10587 specify this option, GCC will enable it by default for languages like
10588 C++ which normally require exception handling, and disable it for
10589 languages like C that do not normally require it.  However, you may need
10590 to enable this option when compiling C code that needs to interoperate
10591 properly with exception handlers written in C++.  You may also wish to
10592 disable this option if you are compiling older C++ programs that don't
10593 use exception handling.
10595 @item -fnon-call-exceptions
10596 @opindex fnon-call-exceptions
10597 Generate code that allows trapping instructions to throw exceptions.
10598 Note that this requires platform-specific runtime support that does
10599 not exist everywhere.  Moreover, it only allows @emph{trapping}
10600 instructions to throw exceptions, i.e.@: memory references or floating
10601 point instructions.  It does not allow exceptions to be thrown from
10602 arbitrary signal handlers such as @code{SIGALRM}.
10604 @item -funwind-tables
10605 @opindex funwind-tables
10606 Similar to @option{-fexceptions}, except that it will just generate any needed
10607 static data, but will not affect the generated code in any other way.
10608 You will normally not enable this option; instead, a language processor
10609 that needs this handling would enable it on your behalf.
10611 @item -fasynchronous-unwind-tables
10612 @opindex funwind-tables
10613 Generate unwind table in dwarf2 format, if supported by target machine.  The
10614 table is exact at each instruction boundary, so it can be used for stack
10615 unwinding from asynchronous events (such as debugger or garbage collector).
10617 @item -fpcc-struct-return
10618 @opindex fpcc-struct-return
10619 Return ``short'' @code{struct} and @code{union} values in memory like
10620 longer ones, rather than in registers.  This convention is less
10621 efficient, but it has the advantage of allowing intercallability between
10622 GCC-compiled files and files compiled with other compilers, particularly
10623 the Portable C Compiler (pcc).
10625 The precise convention for returning structures in memory depends
10626 on the target configuration macros.
10628 Short structures and unions are those whose size and alignment match
10629 that of some integer type.
10631 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10632 switch is not binary compatible with code compiled with the
10633 @option{-freg-struct-return} switch.
10634 Use it to conform to a non-default application binary interface.
10636 @item -freg-struct-return
10637 @opindex freg-struct-return
10638 Return @code{struct} and @code{union} values in registers when possible.
10639 This is more efficient for small structures than
10640 @option{-fpcc-struct-return}.
10642 If you specify neither @option{-fpcc-struct-return} nor
10643 @option{-freg-struct-return}, GCC defaults to whichever convention is
10644 standard for the target.  If there is no standard convention, GCC
10645 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10646 the principal compiler.  In those cases, we can choose the standard, and
10647 we chose the more efficient register return alternative.
10649 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10650 switch is not binary compatible with code compiled with the
10651 @option{-fpcc-struct-return} switch.
10652 Use it to conform to a non-default application binary interface.
10654 @item -fshort-enums
10655 @opindex fshort-enums
10656 Allocate to an @code{enum} type only as many bytes as it needs for the
10657 declared range of possible values.  Specifically, the @code{enum} type
10658 will be equivalent to the smallest integer type which has enough room.
10660 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10661 code that is not binary compatible with code generated without that switch.
10662 Use it to conform to a non-default application binary interface.
10664 @item -fshort-double
10665 @opindex fshort-double
10666 Use the same size for @code{double} as for @code{float}.
10668 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10669 code that is not binary compatible with code generated without that switch.
10670 Use it to conform to a non-default application binary interface.
10672 @item -fshort-wchar
10673 @opindex fshort-wchar
10674 Override the underlying type for @samp{wchar_t} to be @samp{short
10675 unsigned int} instead of the default for the target.  This option is
10676 useful for building programs to run under WINE@.
10678 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10679 code that is not binary compatible with code generated without that switch.
10680 Use it to conform to a non-default application binary interface.
10682 @item -fshared-data
10683 @opindex fshared-data
10684 Requests that the data and non-@code{const} variables of this
10685 compilation be shared data rather than private data.  The distinction
10686 makes sense only on certain operating systems, where shared data is
10687 shared between processes running the same program, while private data
10688 exists in one copy per process.
10690 @item -fno-common
10691 @opindex fno-common
10692 In C, allocate even uninitialized global variables in the data section of the
10693 object file, rather than generating them as common blocks.  This has the
10694 effect that if the same variable is declared (without @code{extern}) in
10695 two different compilations, you will get an error when you link them.
10696 The only reason this might be useful is if you wish to verify that the
10697 program will work on other systems which always work this way.
10699 @item -fno-ident
10700 @opindex fno-ident
10701 Ignore the @samp{#ident} directive.
10703 @item -fno-gnu-linker
10704 @opindex fno-gnu-linker
10705 Do not output global initializations (such as C++ constructors and
10706 destructors) in the form used by the GNU linker (on systems where the GNU
10707 linker is the standard method of handling them).  Use this option when
10708 you want to use a non-GNU linker, which also requires using the
10709 @command{collect2} program to make sure the system linker includes
10710 constructors and destructors.  (@command{collect2} is included in the GCC
10711 distribution.)  For systems which @emph{must} use @command{collect2}, the
10712 compiler driver @command{gcc} is configured to do this automatically.
10714 @item -finhibit-size-directive
10715 @opindex finhibit-size-directive
10716 Don't output a @code{.size} assembler directive, or anything else that
10717 would cause trouble if the function is split in the middle, and the
10718 two halves are placed at locations far apart in memory.  This option is
10719 used when compiling @file{crtstuff.c}; you should not need to use it
10720 for anything else.
10722 @item -fverbose-asm
10723 @opindex fverbose-asm
10724 Put extra commentary information in the generated assembly code to
10725 make it more readable.  This option is generally only of use to those
10726 who actually need to read the generated assembly code (perhaps while
10727 debugging the compiler itself).
10729 @option{-fno-verbose-asm}, the default, causes the
10730 extra information to be omitted and is useful when comparing two assembler
10731 files.
10733 @item -fvolatile
10734 @opindex fvolatile
10735 Consider all memory references through pointers to be volatile.
10737 @item -fvolatile-global
10738 @opindex fvolatile-global
10739 Consider all memory references to extern and global data items to
10740 be volatile.  GCC does not consider static data items to be volatile
10741 because of this switch.
10743 @item -fvolatile-static
10744 @opindex fvolatile-static
10745 Consider all memory references to static data to be volatile.
10747 @item -fpic
10748 @opindex fpic
10749 @cindex global offset table
10750 @cindex PIC
10751 Generate position-independent code (PIC) suitable for use in a shared
10752 library, if supported for the target machine.  Such code accesses all
10753 constant addresses through a global offset table (GOT)@.  The dynamic
10754 loader resolves the GOT entries when the program starts (the dynamic
10755 loader is not part of GCC; it is part of the operating system).  If
10756 the GOT size for the linked executable exceeds a machine-specific
10757 maximum size, you get an error message from the linker indicating that
10758 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10759 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10760 on the m68k and RS/6000.  The 386 has no such limit.)
10762 Position-independent code requires special support, and therefore works
10763 only on certain machines.  For the 386, GCC supports PIC for System V
10764 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10765 position-independent.
10767 @item -fPIC
10768 @opindex fPIC
10769 If supported for the target machine, emit position-independent code,
10770 suitable for dynamic linking and avoiding any limit on the size of the
10771 global offset table.  This option makes a difference on the m68k, m88k,
10772 and the SPARC.
10774 Position-independent code requires special support, and therefore works
10775 only on certain machines.
10777 @item -ffixed-@var{reg}
10778 @opindex ffixed
10779 Treat the register named @var{reg} as a fixed register; generated code
10780 should never refer to it (except perhaps as a stack pointer, frame
10781 pointer or in some other fixed role).
10783 @var{reg} must be the name of a register.  The register names accepted
10784 are machine-specific and are defined in the @code{REGISTER_NAMES}
10785 macro in the machine description macro file.
10787 This flag does not have a negative form, because it specifies a
10788 three-way choice.
10790 @item -fcall-used-@var{reg}
10791 @opindex fcall-used
10792 Treat the register named @var{reg} as an allocable register that is
10793 clobbered by function calls.  It may be allocated for temporaries or
10794 variables that do not live across a call.  Functions compiled this way
10795 will not save and restore the register @var{reg}.
10797 It is an error to used this flag with the frame pointer or stack pointer.
10798 Use of this flag for other registers that have fixed pervasive roles in
10799 the machine's execution model will produce disastrous results.
10801 This flag does not have a negative form, because it specifies a
10802 three-way choice.
10804 @item -fcall-saved-@var{reg}
10805 @opindex fcall-saved
10806 Treat the register named @var{reg} as an allocable register saved by
10807 functions.  It may be allocated even for temporaries or variables that
10808 live across a call.  Functions compiled this way will save and restore
10809 the register @var{reg} if they use it.
10811 It is an error to used this flag with the frame pointer or stack pointer.
10812 Use of this flag for other registers that have fixed pervasive roles in
10813 the machine's execution model will produce disastrous results.
10815 A different sort of disaster will result from the use of this flag for
10816 a register in which function values may be returned.
10818 This flag does not have a negative form, because it specifies a
10819 three-way choice.
10821 @item -fpack-struct
10822 @opindex fpack-struct
10823 Pack all structure members together without holes.
10825 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10826 code that is not binary compatible with code generated without that switch.
10827 Additionally, it makes the code suboptimal.
10828 Use it to conform to a non-default application binary interface.
10830 @item -finstrument-functions
10831 @opindex finstrument-functions
10832 Generate instrumentation calls for entry and exit to functions.  Just
10833 after function entry and just before function exit, the following
10834 profiling functions will be called with the address of the current
10835 function and its call site.  (On some platforms,
10836 @code{__builtin_return_address} does not work beyond the current
10837 function, so the call site information may not be available to the
10838 profiling functions otherwise.)
10840 @example
10841 void __cyg_profile_func_enter (void *this_fn,
10842                                void *call_site);
10843 void __cyg_profile_func_exit  (void *this_fn,
10844                                void *call_site);
10845 @end example
10847 The first argument is the address of the start of the current function,
10848 which may be looked up exactly in the symbol table.
10850 This instrumentation is also done for functions expanded inline in other
10851 functions.  The profiling calls will indicate where, conceptually, the
10852 inline function is entered and exited.  This means that addressable
10853 versions of such functions must be available.  If all your uses of a
10854 function are expanded inline, this may mean an additional expansion of
10855 code size.  If you use @samp{extern inline} in your C code, an
10856 addressable version of such functions must be provided.  (This is
10857 normally the case anyways, but if you get lucky and the optimizer always
10858 expands the functions inline, you might have gotten away without
10859 providing static copies.)
10861 A function may be given the attribute @code{no_instrument_function}, in
10862 which case this instrumentation will not be done.  This can be used, for
10863 example, for the profiling functions listed above, high-priority
10864 interrupt routines, and any functions from which the profiling functions
10865 cannot safely be called (perhaps signal handlers, if the profiling
10866 routines generate output or allocate memory).
10868 @item -fstack-check
10869 @opindex fstack-check
10870 Generate code to verify that you do not go beyond the boundary of the
10871 stack.  You should specify this flag if you are running in an
10872 environment with multiple threads, but only rarely need to specify it in
10873 a single-threaded environment since stack overflow is automatically
10874 detected on nearly all systems if there is only one stack.
10876 Note that this switch does not actually cause checking to be done; the
10877 operating system must do that.  The switch causes generation of code
10878 to ensure that the operating system sees the stack being extended.
10880 @item -fstack-limit-register=@var{reg}
10881 @itemx -fstack-limit-symbol=@var{sym}
10882 @itemx -fno-stack-limit
10883 @opindex fstack-limit-register
10884 @opindex fstack-limit-symbol
10885 @opindex fno-stack-limit
10886 Generate code to ensure that the stack does not grow beyond a certain value,
10887 either the value of a register or the address of a symbol.  If the stack
10888 would grow beyond the value, a signal is raised.  For most targets,
10889 the signal is raised before the stack overruns the boundary, so
10890 it is possible to catch the signal without taking special precautions.
10892 For instance, if the stack starts at absolute address @samp{0x80000000}
10893 and grows downwards, you can use the flags
10894 @option{-fstack-limit-symbol=__stack_limit} and
10895 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10896 of 128KB@.  Note that this may only work with the GNU linker.
10898 @cindex aliasing of parameters
10899 @cindex parameters, aliased
10900 @item -fargument-alias
10901 @itemx -fargument-noalias
10902 @itemx -fargument-noalias-global
10903 @opindex fargument-alias
10904 @opindex fargument-noalias
10905 @opindex fargument-noalias-global
10906 Specify the possible relationships among parameters and between
10907 parameters and global data.
10909 @option{-fargument-alias} specifies that arguments (parameters) may
10910 alias each other and may alias global storage.@*
10911 @option{-fargument-noalias} specifies that arguments do not alias
10912 each other, but may alias global storage.@*
10913 @option{-fargument-noalias-global} specifies that arguments do not
10914 alias each other and do not alias global storage.
10916 Each language will automatically use whatever option is required by
10917 the language standard.  You should not need to use these options yourself.
10919 @item -fleading-underscore
10920 @opindex fleading-underscore
10921 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10922 change the way C symbols are represented in the object file.  One use
10923 is to help link with legacy assembly code.
10925 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
10926 generate code that is not binary compatible with code generated without that
10927 switch.  Use it to conform to a non-default application binary interface.
10928 Not all targets provide complete support for this switch.
10930 @item -ftls-model=@var{model}
10931 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10932 The @var{model} argument should be one of @code{global-dynamic},
10933 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10935 The default without @option{-fpic} is @code{initial-exec}; with
10936 @option{-fpic} the default is @code{global-dynamic}.
10937 @end table
10939 @c man end
10941 @node Environment Variables
10942 @section Environment Variables Affecting GCC
10943 @cindex environment variables
10945 @c man begin ENVIRONMENT
10947 This section describes several environment variables that affect how GCC
10948 operates.  Some of them work by specifying directories or prefixes to use
10949 when searching for various kinds of files.  Some are used to specify other
10950 aspects of the compilation environment.
10952 Note that you can also specify places to search using options such as
10953 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10954 take precedence over places specified using environment variables, which
10955 in turn take precedence over those specified by the configuration of GCC@.
10956 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10957 GNU Compiler Collection (GCC) Internals}.
10959 @table @env
10960 @item LANG
10961 @itemx LC_CTYPE
10962 @c @itemx LC_COLLATE
10963 @itemx LC_MESSAGES
10964 @c @itemx LC_MONETARY
10965 @c @itemx LC_NUMERIC
10966 @c @itemx LC_TIME
10967 @itemx LC_ALL
10968 @findex LANG
10969 @findex LC_CTYPE
10970 @c @findex LC_COLLATE
10971 @findex LC_MESSAGES
10972 @c @findex LC_MONETARY
10973 @c @findex LC_NUMERIC
10974 @c @findex LC_TIME
10975 @findex LC_ALL
10976 @cindex locale
10977 These environment variables control the way that GCC uses
10978 localization information that allow GCC to work with different
10979 national conventions.  GCC inspects the locale categories
10980 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10981 so.  These locale categories can be set to any value supported by your
10982 installation.  A typical value is @samp{en_UK} for English in the United
10983 Kingdom.
10985 The @env{LC_CTYPE} environment variable specifies character
10986 classification.  GCC uses it to determine the character boundaries in
10987 a string; this is needed for some multibyte encodings that contain quote
10988 and escape characters that would otherwise be interpreted as a string
10989 end or escape.
10991 The @env{LC_MESSAGES} environment variable specifies the language to
10992 use in diagnostic messages.
10994 If the @env{LC_ALL} environment variable is set, it overrides the value
10995 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10996 and @env{LC_MESSAGES} default to the value of the @env{LANG}
10997 environment variable.  If none of these variables are set, GCC
10998 defaults to traditional C English behavior.
11000 @item TMPDIR
11001 @findex TMPDIR
11002 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11003 files.  GCC uses temporary files to hold the output of one stage of
11004 compilation which is to be used as input to the next stage: for example,
11005 the output of the preprocessor, which is the input to the compiler
11006 proper.
11008 @item GCC_EXEC_PREFIX
11009 @findex GCC_EXEC_PREFIX
11010 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11011 names of the subprograms executed by the compiler.  No slash is added
11012 when this prefix is combined with the name of a subprogram, but you can
11013 specify a prefix that ends with a slash if you wish.
11015 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11016 an appropriate prefix to use based on the pathname it was invoked with.
11018 If GCC cannot find the subprogram using the specified prefix, it
11019 tries looking in the usual places for the subprogram.
11021 The default value of @env{GCC_EXEC_PREFIX} is
11022 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11023 of @code{prefix} when you ran the @file{configure} script.
11025 Other prefixes specified with @option{-B} take precedence over this prefix.
11027 This prefix is also used for finding files such as @file{crt0.o} that are
11028 used for linking.
11030 In addition, the prefix is used in an unusual way in finding the
11031 directories to search for header files.  For each of the standard
11032 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11033 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11034 replacing that beginning with the specified prefix to produce an
11035 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11036 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11037 These alternate directories are searched first; the standard directories
11038 come next.
11040 @item COMPILER_PATH
11041 @findex COMPILER_PATH
11042 The value of @env{COMPILER_PATH} is a colon-separated list of
11043 directories, much like @env{PATH}.  GCC tries the directories thus
11044 specified when searching for subprograms, if it can't find the
11045 subprograms using @env{GCC_EXEC_PREFIX}.
11047 @item LIBRARY_PATH
11048 @findex LIBRARY_PATH
11049 The value of @env{LIBRARY_PATH} is a colon-separated list of
11050 directories, much like @env{PATH}.  When configured as a native compiler,
11051 GCC tries the directories thus specified when searching for special
11052 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11053 using GCC also uses these directories when searching for ordinary
11054 libraries for the @option{-l} option (but directories specified with
11055 @option{-L} come first).
11057 @item LANG
11058 @findex LANG
11059 @cindex locale definition
11060 This variable is used to pass locale information to the compiler.  One way in
11061 which this information is used is to determine the character set to be used
11062 when character literals, string literals and comments are parsed in C and C++.
11063 When the compiler is configured to allow multibyte characters,
11064 the following values for @env{LANG} are recognized:
11066 @table @samp
11067 @item C-JIS
11068 Recognize JIS characters.
11069 @item C-SJIS
11070 Recognize SJIS characters.
11071 @item C-EUCJP
11072 Recognize EUCJP characters.
11073 @end table
11075 If @env{LANG} is not defined, or if it has some other value, then the
11076 compiler will use mblen and mbtowc as defined by the default locale to
11077 recognize and translate multibyte characters.
11078 @end table
11080 @noindent
11081 Some additional environments variables affect the behavior of the
11082 preprocessor.
11084 @include cppenv.texi
11086 @c man end
11088 @node Precompiled Headers
11089 @section Using Precompiled Headers
11090 @cindex precompiled headers
11091 @cindex speed of compilation
11093 Often large projects have many header files that are included in every
11094 source file.  The time the compiler takes to process these header files
11095 over and over again can account for nearly all of the time required to
11096 build the project.  To make builds faster, GCC allows users to
11097 `precompile' a header file; then, if builds can use the precompiled
11098 header file they will be much faster.
11100 To create a precompiled header file, simply compile it as you would any
11101 other file, if necessary using the @option{-x} option to make the driver
11102 treat it as a C or C++ header file.  You will probably want to use a
11103 tool like @command{make} to keep the precompiled header up-to-date when
11104 the headers it contains change.
11106 A precompiled header file will be searched for when @code{#include} is
11107 seen in the compilation.  As it searches for the included file
11108 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11109 compiler looks for a precompiled header in each directory just before it
11110 looks for the include file in that directory.  The name searched for is
11111 the name specified in the @code{#include} with @samp{.pch} appended.  If
11112 the precompiled header file can't be used, it is ignored.
11114 For instance, if you have @code{#include "all.h"}, and you have
11115 @file{all.h.pch} in the same directory as @file{all.h}, then the
11116 precompiled header file will be used if possible, and the original
11117 header will be used otherwise.
11119 Alternatively, you might decide to put the precompiled header file in a
11120 directory and use @option{-I} to ensure that directory is searched
11121 before (or instead of) the directory containing the original header.
11122 Then, if you want to check that the precompiled header file is always
11123 used, you can put a file of the same name as the original header in this
11124 directory containing an @code{#error} command.
11126 This also works with @option{-include}.  So yet another way to use
11127 precompiled headers, good for projects not designed with precompiled
11128 header files in mind, is to simply take most of the header files used by
11129 a project, include them from another header file, precompile that header
11130 file, and @option{-include} the precompiled header.  If the header files
11131 have guards against multiple inclusion, they will be skipped because
11132 they've already been included (in the precompiled header).
11134 If you need to precompile the same header file for different
11135 languages, targets, or compiler options, you can instead make a
11136 @emph{directory} named like @file{all.h.pch}, and put each precompiled
11137 header in the directory.  (It doesn't matter what you call the files
11138 in the directory, every precompiled header in the directory will be
11139 considered.)  The first precompiled header encountered in the
11140 directory that is valid for this compilation will be used; they're
11141 searched in no particular order.
11143 There are many other possibilities, limited only by your imagination,
11144 good sense, and the constraints of your build system.
11146 A precompiled header file can be used only when these conditions apply:
11148 @itemize
11149 @item
11150 Only one precompiled header can be used in a particular compilation.
11151 @item
11152 A precompiled header can't be used once the first C token is seen.  You
11153 can have preprocessor directives before a precompiled header; you can
11154 even include a precompiled header from inside another header, so long as
11155 there are no C tokens before the @code{#include}.
11156 @item
11157 The precompiled header file must be produced for the same language as
11158 the current compilation.  You can't use a C precompiled header for a C++
11159 compilation.
11160 @item
11161 The precompiled header file must be produced by the same compiler
11162 version and configuration as the current compilation is using.
11163 The easiest way to guarantee this is to use the same compiler binary
11164 for creating and using precompiled headers.
11165 @item
11166 Any macros defined before the precompiled header (including with
11167 @option{-D}) must either be defined in the same way as when the
11168 precompiled header was generated, or must not affect the precompiled
11169 header, which usually means that the they don't appear in the
11170 precompiled header at all.
11171 @item
11172 Certain command-line options must be defined in the same way as when the
11173 precompiled header was generated.  At present, it's not clear which
11174 options are safe to change and which are not; the safest choice is to
11175 use exactly the same options when generating and using the precompiled
11176 header.
11177 @end itemize
11179 For all of these but the last, the compiler will automatically ignore
11180 the precompiled header if the conditions aren't met.  For the last item,
11181 some option changes will cause the precompiled header to be rejected,
11182 but not all incompatible option combinations have yet been found.  If
11183 you find a new incompatible combination, please consider filing a bug
11184 report, see @ref{Bugs}.
11186 @node Running Protoize
11187 @section Running Protoize
11189 The program @code{protoize} is an optional part of GCC@.  You can use
11190 it to add prototypes to a program, thus converting the program to ISO
11191 C in one respect.  The companion program @code{unprotoize} does the
11192 reverse: it removes argument types from any prototypes that are found.
11194 When you run these programs, you must specify a set of source files as
11195 command line arguments.  The conversion programs start out by compiling
11196 these files to see what functions they define.  The information gathered
11197 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11199 After scanning comes actual conversion.  The specified files are all
11200 eligible to be converted; any files they include (whether sources or
11201 just headers) are eligible as well.
11203 But not all the eligible files are converted.  By default,
11204 @code{protoize} and @code{unprotoize} convert only source and header
11205 files in the current directory.  You can specify additional directories
11206 whose files should be converted with the @option{-d @var{directory}}
11207 option.  You can also specify particular files to exclude with the
11208 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11209 directory name matches one of the specified directory names, and its
11210 name within the directory has not been excluded.
11212 Basic conversion with @code{protoize} consists of rewriting most
11213 function definitions and function declarations to specify the types of
11214 the arguments.  The only ones not rewritten are those for varargs
11215 functions.
11217 @code{protoize} optionally inserts prototype declarations at the
11218 beginning of the source file, to make them available for any calls that
11219 precede the function's definition.  Or it can insert prototype
11220 declarations with block scope in the blocks where undeclared functions
11221 are called.
11223 Basic conversion with @code{unprotoize} consists of rewriting most
11224 function declarations to remove any argument types, and rewriting
11225 function definitions to the old-style pre-ISO form.
11227 Both conversion programs print a warning for any function declaration or
11228 definition that they can't convert.  You can suppress these warnings
11229 with @option{-q}.
11231 The output from @code{protoize} or @code{unprotoize} replaces the
11232 original source file.  The original file is renamed to a name ending
11233 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11234 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11235 for DOS) file already exists, then the source file is simply discarded.
11237 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11238 scan the program and collect information about the functions it uses.
11239 So neither of these programs will work until GCC is installed.
11241 Here is a table of the options you can use with @code{protoize} and
11242 @code{unprotoize}.  Each option works with both programs unless
11243 otherwise stated.
11245 @table @code
11246 @item -B @var{directory}
11247 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11248 usual directory (normally @file{/usr/local/lib}).  This file contains
11249 prototype information about standard system functions.  This option
11250 applies only to @code{protoize}.
11252 @item -c @var{compilation-options}
11253 Use @var{compilation-options} as the options when running @command{gcc} to
11254 produce the @samp{.X} files.  The special option @option{-aux-info} is
11255 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11257 Note that the compilation options must be given as a single argument to
11258 @code{protoize} or @code{unprotoize}.  If you want to specify several
11259 @command{gcc} options, you must quote the entire set of compilation options
11260 to make them a single word in the shell.
11262 There are certain @command{gcc} arguments that you cannot use, because they
11263 would produce the wrong kind of output.  These include @option{-g},
11264 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11265 the @var{compilation-options}, they are ignored.
11267 @item -C
11268 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11269 systems) instead of @samp{.c}.  This is convenient if you are converting
11270 a C program to C++.  This option applies only to @code{protoize}.
11272 @item -g
11273 Add explicit global declarations.  This means inserting explicit
11274 declarations at the beginning of each source file for each function
11275 that is called in the file and was not declared.  These declarations
11276 precede the first function definition that contains a call to an
11277 undeclared function.  This option applies only to @code{protoize}.
11279 @item -i @var{string}
11280 Indent old-style parameter declarations with the string @var{string}.
11281 This option applies only to @code{protoize}.
11283 @code{unprotoize} converts prototyped function definitions to old-style
11284 function definitions, where the arguments are declared between the
11285 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11286 uses five spaces as the indentation.  If you want to indent with just
11287 one space instead, use @option{-i " "}.
11289 @item -k
11290 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11291 is finished.
11293 @item -l
11294 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11295 a prototype declaration for each function in each block which calls the
11296 function without any declaration.  This option applies only to
11297 @code{protoize}.
11299 @item -n
11300 Make no real changes.  This mode just prints information about the conversions
11301 that would have been done without @option{-n}.
11303 @item -N
11304 Make no @samp{.save} files.  The original files are simply deleted.
11305 Use this option with caution.
11307 @item -p @var{program}
11308 Use the program @var{program} as the compiler.  Normally, the name
11309 @file{gcc} is used.
11311 @item -q
11312 Work quietly.  Most warnings are suppressed.
11314 @item -v
11315 Print the version number, just like @option{-v} for @command{gcc}.
11316 @end table
11318 If you need special compiler options to compile one of your program's
11319 source files, then you should generate that file's @samp{.X} file
11320 specially, by running @command{gcc} on that source file with the
11321 appropriate options and the option @option{-aux-info}.  Then run
11322 @code{protoize} on the entire set of files.  @code{protoize} will use
11323 the existing @samp{.X} file because it is newer than the source file.
11324 For example:
11326 @example
11327 gcc -Dfoo=bar file1.c -aux-info file1.X
11328 protoize *.c
11329 @end example
11331 @noindent
11332 You need to include the special files along with the rest in the
11333 @code{protoize} command, even though their @samp{.X} files already
11334 exist, because otherwise they won't get converted.
11336 @xref{Protoize Caveats}, for more information on how to use
11337 @code{protoize} successfully.