Add support for Cirrus EP9312, an ARM variant.
[official-gcc.git] / gcc / doc / invoke.texi
blobcfcf4dc9e0880dcccc3c5f83aadc498f41fb39d6
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.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), 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 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm -floop-optimize -fcrossjumping @gol
274 -fif-conversion -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations -ffinite-math-only @gol
282 -fno-trapping-math -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -freduce-all-givs -fregmove  -frename-registers @gol
286 -freorder-blocks -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  -fsignaling-nans @gol
291 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
292 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
293 -funroll-all-loops  -funroll-loops  -funswitch-loops @gol
294 --param @var{name}=@var{value}
295 -O  -O0  -O1  -O2  -O3  -Os}
297 @item Preprocessor Options
298 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
299 @gccoptlist{
300 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
301 -C  -dD  -dI  -dM  -dN @gol
302 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
303 -idirafter @var{dir} @gol
304 -include @var{file}  -imacros @var{file} @gol
305 -iprefix @var{file}  -iwithprefix @var{dir} @gol
306 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
307 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
308 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
310 @item Assembler Option
311 @xref{Assembler Options,,Passing Options to the Assembler}.
312 @gccoptlist{
313 -Wa,@var{option} -Xassembler @var{option}}
315 @item Linker Options
316 @xref{Link Options,,Options for Linking}.
317 @gccoptlist{
318 @var{object-file-name}  -l@var{library} @gol
319 -nostartfiles  -nodefaultlibs  -nostdlib @gol
320 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
321 -Wl,@var{option}  -Xlinker @var{option} @gol
322 -u @var{symbol}}
324 @item Directory Options
325 @xref{Directory Options,,Options for Directory Search}.
326 @gccoptlist{
327 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
329 @item Target Options
330 @c I wrote this xref this way to avoid overfull hbox. -- rms
331 @xref{Target Options}.
332 @gccoptlist{
333 -V @var{version} -b @var{machine}}
335 @item Machine Dependent Options
336 @xref{Submodel Options,,Hardware Models and Configurations}.
338 @emph{M680x0 Options}
339 @gccoptlist{
340 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
341 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
342 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
343 -malign-int  -mstrict-align}
345 @emph{M68hc1x Options}
346 @gccoptlist{
347 -m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
348 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
349 -msoft-reg-count=@var{count}}
351 @emph{VAX Options}
352 @gccoptlist{
353 -mg  -mgnu  -munix}
355 @emph{SPARC Options}
356 @gccoptlist{
357 -mcpu=@var{cpu-type} @gol
358 -mtune=@var{cpu-type} @gol
359 -mcmodel=@var{code-model} @gol
360 -m32  -m64 @gol
361 -mapp-regs  -mbroken-saverestore  -mcypress @gol
362 -mfaster-structs  -mflat @gol
363 -mfpu  -mhard-float  -mhard-quad-float @gol
364 -mimpure-text  -mlive-g0  -mno-app-regs @gol
365 -mno-faster-structs  -mno-flat  -mno-fpu @gol
366 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
367 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
368 -msupersparc  -munaligned-doubles  -mv8}
370 @emph{ARM Options}
371 @gccoptlist{
372 -mapcs-frame  -mno-apcs-frame @gol
373 -mapcs-26  -mapcs-32 @gol
374 -mapcs-stack-check  -mno-apcs-stack-check @gol
375 -mapcs-float  -mno-apcs-float @gol
376 -mapcs-reentrant  -mno-apcs-reentrant @gol
377 -msched-prolog  -mno-sched-prolog @gol
378 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
379 -malignment-traps  -mno-alignment-traps @gol
380 -msoft-float  -mhard-float  -mfpe @gol
381 -mthumb-interwork  -mno-thumb-interwork @gol
382 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
383 -mstructure-size-boundary=@var{n} @gol
384 -mabort-on-noreturn @gol
385 -mlong-calls  -mno-long-calls @gol
386 -msingle-pic-base  -mno-single-pic-base @gol
387 -mpic-register=@var{reg} @gol
388 -mnop-fun-dllimport @gol
389 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @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 @gol
710 -fverbose-asm  -fpack-struct  -fstack-check @gol
711 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
712 -fargument-alias  -fargument-noalias @gol
713 -fargument-noalias-global  -fleading-underscore @gol
714 -ftls-model=@var{model} @gol
715 -ftrapv -fbounds-check}
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 Add code so that program flow @dfn{arcs} are instrumented.  During
3039 execution the program records how many times each branch and call is
3040 executed and how many times it is taken or returns.  When the compiled
3041 program exits it saves this data to a file called
3042 @file{@var{auxname}.da} for each source file. The data may be used for
3043 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3044 test coverage analysis (@option{-ftest-coverage}). Each object file's
3045 @var{auxname} is generated from the name of the output file, if
3046 explicitly specified and it is not the final executable, otherwise it is
3047 the basename of the source file. In both cases any suffix is removed
3048 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3049 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3051 @itemize
3053 @item
3054 Compile the source files with @option{-fprofile-arcs} plus optimization
3055 and code generation options. For test coverage analysis, use the
3056 additional @option{-ftest-coverage} option. You do not need to profile
3057 every source file in a program.
3059 @item
3060 Link your object files as normal.
3062 @item
3063 Run the program on a representative workload to generate the arc profile
3064 information. This may be repeated any number of times.
3066 @item
3067 For profile-directed optimizations, compile the source files again with
3068 the same optimization and code generation options plus
3069 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3070 Control Optimization}).
3072 @item
3073 For test coverage analysis, use @command{gcov} to produce human readable
3074 information from the @file{.bbg} and @file{.da} files. Refer to the
3075 @command{gcov} documentation for further information.
3077 @end itemize
3079 With @option{-fprofile-arcs}, for each function of your program GCC
3080 creates a program flow graph, then finds a spanning tree for the graph.
3081 Only arcs that are not on the spanning tree have to be instrumented: the
3082 compiler adds code to count the number of times that these arcs are
3083 executed.  When an arc is the only exit or only entrance to a block, the
3084 instrumentation code can be added to the block; otherwise, a new basic
3085 block must be created to hold the instrumentation code.
3087 @need 2000
3088 @item -ftest-coverage
3089 @opindex ftest-coverage
3090 Produce a graph file that the @command{gcov} code-coverage utility
3091 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3092 show program coverage. Each source file's data file is called
3093 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3094 above for a description of @var{auxname} and instructions on how to
3095 generate test coverage data. Coverage data will match the source files
3096 more closely, if you do not optimize.
3098 @item -d@var{letters}
3099 @opindex d
3100 Says to make debugging dumps during compilation at times specified by
3101 @var{letters}.  This is used for debugging the compiler.  The file names
3102 for most of the dumps are made by appending a pass number and a word to
3103 the @var{dumpname}. @var{dumpname} is generated from the name of the
3104 output file, if explicitly specified and it is not an executable,
3105 otherwise it is the basename of the source file. In both cases any
3106 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3107 Here are the possible letters for use in @var{letters}, and their
3108 meanings:
3110 @table @samp
3111 @item A
3112 @opindex dA
3113 Annotate the assembler output with miscellaneous debugging information.
3114 @item b
3115 @opindex db
3116 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3117 @item B
3118 @opindex dB
3119 Dump after block reordering, to @file{@var{file}.32.bbro}.
3120 @item c
3121 @opindex dc
3122 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3123 @item C
3124 @opindex dC
3125 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3126 @item d
3127 @opindex dd
3128 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3129 @item D
3130 @opindex dD
3131 Dump all macro definitions, at the end of preprocessing, in addition to
3132 normal output.
3133 @item e
3134 @opindex de
3135 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3136 @file{@var{file}.07.ussa}.
3137 @item E
3138 @opindex dE
3139 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3140 @item f
3141 @opindex df
3142 Dump after life analysis, to @file{@var{file}.18.life}.
3143 @item F
3144 @opindex dF
3145 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3146 @item g
3147 @opindex dg
3148 Dump after global register allocation, to @file{@var{file}.24.greg}.
3149 @item h
3150 @opindex dh
3151 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3152 @item k
3153 @opindex dk
3154 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3155 @item o
3156 @opindex do
3157 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3158 @item G
3159 @opindex dG
3160 Dump after GCSE, to @file{@var{file}.11.gcse}.
3161 @item i
3162 @opindex di
3163 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3164 @item j
3165 @opindex dj
3166 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3167 @item k
3168 @opindex dk
3169 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3170 @item l
3171 @opindex dl
3172 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3173 @item L
3174 @opindex dL
3175 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3176 @file{@var{file}.18.loop2}.
3177 @item M
3178 @opindex dM
3179 Dump after performing the machine dependent reorganization pass, to
3180 @file{@var{file}.33.mach}.
3181 @item n
3182 @opindex dn
3183 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3184 @item N
3185 @opindex dN
3186 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3187 @item r
3188 @opindex dr
3189 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3190 @item R
3191 @opindex dR
3192 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3193 @item s
3194 @opindex ds
3195 Dump after CSE (including the jump optimization that sometimes follows
3196 CSE), to @file{@var{file}.09.cse}.
3197 @item S
3198 @opindex dS
3199 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3200 @item t
3201 @opindex dt
3202 Dump after the second CSE pass (including the jump optimization that
3203 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3204 @item u
3205 @opindex du
3206 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3207 @item w
3208 @opindex dw
3209 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3210 @item X
3211 @opindex dX
3212 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3213 @item z
3214 @opindex dz
3215 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3216 @item a
3217 @opindex da
3218 Produce all the dumps listed above.
3219 @item m
3220 @opindex dm
3221 Print statistics on memory usage, at the end of the run, to
3222 standard error.
3223 @item p
3224 @opindex dp
3225 Annotate the assembler output with a comment indicating which
3226 pattern and alternative was used.  The length of each instruction is
3227 also printed.
3228 @item P
3229 @opindex dP
3230 Dump the RTL in the assembler output as a comment before each instruction.
3231 Also turns on @option{-dp} annotation.
3232 @item v
3233 @opindex dv
3234 For each of the other indicated dump files (except for
3235 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3236 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3237 @item x
3238 @opindex dx
3239 Just generate RTL for a function instead of compiling it.  Usually used
3240 with @samp{r}.
3241 @item y
3242 @opindex dy
3243 Dump debugging information during parsing, to standard error.
3244 @end table
3246 @item -fdump-unnumbered
3247 @opindex fdump-unnumbered
3248 When doing debugging dumps (see @option{-d} option above), suppress instruction
3249 numbers and line number note output.  This makes it more feasible to
3250 use diff on debugging dumps for compiler invocations with different
3251 options, in particular with and without @option{-g}.
3253 @item -fdump-translation-unit @r{(C and C++ only)}
3254 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3255 @opindex fdump-translation-unit
3256 Dump a representation of the tree structure for the entire translation
3257 unit to a file.  The file name is made by appending @file{.tu} to the
3258 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3259 controls the details of the dump as described for the
3260 @option{-fdump-tree} options.
3262 @item -fdump-class-hierarchy @r{(C++ only)}
3263 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3264 @opindex fdump-class-hierarchy
3265 Dump a representation of each class's hierarchy and virtual function
3266 table layout to a file.  The file name is made by appending @file{.class}
3267 to the source file name.  If the @samp{-@var{options}} form is used,
3268 @var{options} controls the details of the dump as described for the
3269 @option{-fdump-tree} options.
3271 @item -fdump-tree-@var{switch} @r{(C++ only)}
3272 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3273 @opindex fdump-tree
3274 Control the dumping at various stages of processing the intermediate
3275 language tree to a file.  The file name is generated by appending a switch
3276 specific suffix to the source file name.  If the @samp{-@var{options}}
3277 form is used, @var{options} is a list of @samp{-} separated options that
3278 control the details of the dump. Not all options are applicable to all
3279 dumps, those which are not meaningful will be ignored. The following
3280 options are available
3282 @table @samp
3283 @item address
3284 Print the address of each node.  Usually this is not meaningful as it
3285 changes according to the environment and source file. Its primary use
3286 is for tying up a dump file with a debug environment.
3287 @item slim
3288 Inhibit dumping of members of a scope or body of a function merely
3289 because that scope has been reached. Only dump such items when they
3290 are directly reachable by some other path.
3291 @item all
3292 Turn on all options.
3293 @end table
3295 The following tree dumps are possible:
3296 @table @samp
3297 @item original
3298 Dump before any tree based optimization, to @file{@var{file}.original}.
3299 @item optimized
3300 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3301 @item inlined
3302 Dump after function inlining, to @file{@var{file}.inlined}.
3303 @end table
3305 @item -fsched-verbose=@var{n}
3306 @opindex fsched-verbose
3307 On targets that use instruction scheduling, this option controls the
3308 amount of debugging output the scheduler prints.  This information is
3309 written to standard error, unless @option{-dS} or @option{-dR} is
3310 specified, in which case it is output to the usual dump
3311 listing file, @file{.sched} or @file{.sched2} respectively.  However
3312 for @var{n} greater than nine, the output is always printed to standard
3313 error.
3315 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3316 same information as @option{-dRS}.  For @var{n} greater than one, it
3317 also output basic block probabilities, detailed ready list information
3318 and unit/insn info.  For @var{n} greater than two, it includes RTL
3319 at abort point, control-flow and regions info.  And for @var{n} over
3320 four, @option{-fsched-verbose} also includes dependence info.
3322 @item -save-temps
3323 @opindex save-temps
3324 Store the usual ``temporary'' intermediate files permanently; place them
3325 in the current directory and name them based on the source file.  Thus,
3326 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3327 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3328 preprocessed @file{foo.i} output file even though the compiler now
3329 normally uses an integrated preprocessor.
3331 @item -time
3332 @opindex time
3333 Report the CPU time taken by each subprocess in the compilation
3334 sequence.  For C source files, this is the compiler proper and assembler
3335 (plus the linker if linking is done).  The output looks like this:
3337 @smallexample
3338 # cc1 0.12 0.01
3339 # as 0.00 0.01
3340 @end smallexample
3342 The first number on each line is the ``user time,'' that is time spent
3343 executing the program itself.  The second number is ``system time,''
3344 time spent executing operating system routines on behalf of the program.
3345 Both numbers are in seconds.
3347 @item -print-file-name=@var{library}
3348 @opindex print-file-name
3349 Print the full absolute name of the library file @var{library} that
3350 would be used when linking---and don't do anything else.  With this
3351 option, GCC does not compile or link anything; it just prints the
3352 file name.
3354 @item -print-multi-directory
3355 @opindex print-multi-directory
3356 Print the directory name corresponding to the multilib selected by any
3357 other switches present in the command line.  This directory is supposed
3358 to exist in @env{GCC_EXEC_PREFIX}.
3360 @item -print-multi-lib
3361 @opindex print-multi-lib
3362 Print the mapping from multilib directory names to compiler switches
3363 that enable them.  The directory name is separated from the switches by
3364 @samp{;}, and each switch starts with an @samp{@@} instead of the
3365 @samp{-}, without spaces between multiple switches.  This is supposed to
3366 ease shell-processing.
3368 @item -print-prog-name=@var{program}
3369 @opindex print-prog-name
3370 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3372 @item -print-libgcc-file-name
3373 @opindex print-libgcc-file-name
3374 Same as @option{-print-file-name=libgcc.a}.
3376 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3377 but you do want to link with @file{libgcc.a}.  You can do
3379 @example
3380 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3381 @end example
3383 @item -print-search-dirs
3384 @opindex print-search-dirs
3385 Print the name of the configured installation directory and a list of
3386 program and library directories gcc will search---and don't do anything else.
3388 This is useful when gcc prints the error message
3389 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3390 To resolve this you either need to put @file{cpp0} and the other compiler
3391 components where gcc expects to find them, or you can set the environment
3392 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3393 Don't forget the trailing '/'.
3394 @xref{Environment Variables}.
3396 @item -dumpmachine
3397 @opindex dumpmachine
3398 Print the compiler's target machine (for example,
3399 @samp{i686-pc-linux-gnu})---and don't do anything else.
3401 @item -dumpversion
3402 @opindex dumpversion
3403 Print the compiler version (for example, @samp{3.0})---and don't do
3404 anything else.
3406 @item -dumpspecs
3407 @opindex dumpspecs
3408 Print the compiler's built-in specs---and don't do anything else.  (This
3409 is used when GCC itself is being built.)  @xref{Spec Files}.
3410 @end table
3412 @node Optimize Options
3413 @section Options That Control Optimization
3414 @cindex optimize options
3415 @cindex options, optimization
3417 These options control various sorts of optimizations.
3419 Without any optimization option, the compiler's goal is to reduce the
3420 cost of compilation and to make debugging produce the expected
3421 results.  Statements are independent: if you stop the program with a
3422 breakpoint between statements, you can then assign a new value to any
3423 variable or change the program counter to any other statement in the
3424 function and get exactly the results you would expect from the source
3425 code.
3427 Turning on optimization flags makes the compiler attempt to improve
3428 the performance and/or code size at the expense of compilation time
3429 and possibly the ability to debug the program.
3431 Not all optimizations are controlled directly by a flag.  Only
3432 optimizations that have a flag are listed.
3434 @table @gcctabopt
3435 @item -O
3436 @itemx -O1
3437 @opindex O
3438 @opindex O1
3439 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3440 more memory for a large function.
3442 With @option{-O}, the compiler tries to reduce code size and execution
3443 time, without performing any optimizations that take a great deal of
3444 compilation time.
3446 @option{-O} turns on the following optimization flags: 
3447 @gccoptlist{-fdefer-pop 
3448 -fmerge-constants
3449 -fthread-jumps
3450 -floop-optimize
3451 -fcrossjumping
3452 -fif-conversion
3453 -fif-conversion2
3454 -fdelayed-branch
3455 -fguess-branch-probability
3456 -fcprop-registers}
3458 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3459 where doing so does not interfere with debugging.
3461 @item -O2
3462 @opindex O2
3463 Optimize even more.  GCC performs nearly all supported optimizations
3464 that do not involve a space-speed tradeoff.  The compiler does not
3465 perform loop unrolling or function inlining when you specify @option{-O2}.
3466 As compared to @option{-O}, this option increases both compilation time
3467 and the performance of the generated code.
3469 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3470 also turns on the following optimization flags:
3471 @gccoptlist{-fforce-mem
3472 -foptimize-sibling-calls
3473 -fstrength-reduce
3474 -fcse-follow-jumps  -fcse-skip-blocks
3475 -frerun-cse-after-loop  -frerun-loop-opt
3476 -fgcse   -fgcse-lm   -fgcse-sm
3477 -fdelete-null-pointer-checks
3478 -fexpensive-optimizations
3479 -fregmove
3480 -fschedule-insns  -fschedule-insns2
3481 -fsched-interblock -fsched-spec
3482 -fcaller-saves
3483 -fpeephole2
3484 -freorder-blocks  -freorder-functions
3485 -fstrict-aliasing
3486 -falign-functions  -falign-jumps
3487 -falign-loops  -falign-labels}
3489 Please note the warning under @option{-fgcse} about
3490 invoking @option{-O2} on programs that use computed gotos.
3492 @item -O3
3493 @opindex O3
3494 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3495 @option{-O2} and also turns on the @option{-finline-functions} and
3496 @option{-frename-registers} options.
3498 @item -O0
3499 @opindex O0
3500 Do not optimize.  This is the default.
3502 @item -Os
3503 @opindex Os
3504 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3505 do not typically increase code size.  It also performs further
3506 optimizations designed to reduce code size.
3508 @option{-Os} disables the following optimization flags:
3509 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops
3510 -falign-labels  -freorder-blocks -fprefetch-loop-arrays}
3512 If you use multiple @option{-O} options, with or without level numbers,
3513 the last such option is the one that is effective.
3514 @end table
3516 Options of the form @option{-f@var{flag}} specify machine-independent
3517 flags.  Most flags have both positive and negative forms; the negative
3518 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3519 below, only one of the forms is listed---the one you typically will
3520 use.  You can figure out the other form by either removing @samp{no-}
3521 or adding it.
3523 The following options control specific optimizations.  They are either
3524 activated by @option{-O} options or are related to ones that are.  You
3525 can use the following flags in the rare cases when ``fine-tuning'' of
3526 optimizations to be performed is desired.
3528 @table @gcctabopt
3529 @item -fno-default-inline
3530 @opindex fno-default-inline
3531 Do not make member functions inline by default merely because they are
3532 defined inside the class scope (C++ only).  Otherwise, when you specify
3533 @w{@option{-O}}, member functions defined inside class scope are compiled
3534 inline by default; i.e., you don't need to add @samp{inline} in front of
3535 the member function name.
3537 @item -fno-defer-pop
3538 @opindex fno-defer-pop
3539 Always pop the arguments to each function call as soon as that function
3540 returns.  For machines which must pop arguments after a function call,
3541 the compiler normally lets arguments accumulate on the stack for several
3542 function calls and pops them all at once.
3544 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3546 @item -fforce-mem
3547 @opindex fforce-mem
3548 Force memory operands to be copied into registers before doing
3549 arithmetic on them.  This produces better code by making all memory
3550 references potential common subexpressions.  When they are not common
3551 subexpressions, instruction combination should eliminate the separate
3552 register-load.
3554 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3556 @item -fforce-addr
3557 @opindex fforce-addr
3558 Force memory address constants to be copied into registers before
3559 doing arithmetic on them.  This may produce better code just as
3560 @option{-fforce-mem} may.
3562 @item -fomit-frame-pointer
3563 @opindex fomit-frame-pointer
3564 Don't keep the frame pointer in a register for functions that
3565 don't need one.  This avoids the instructions to save, set up and
3566 restore frame pointers; it also makes an extra register available
3567 in many functions.  @strong{It also makes debugging impossible on
3568 some machines.}
3570 On some machines, such as the VAX, this flag has no effect, because
3571 the standard calling sequence automatically handles the frame pointer
3572 and nothing is saved by pretending it doesn't exist.  The
3573 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3574 whether a target machine supports this flag.  @xref{Registers,,Register
3575 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3577 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3579 @item -foptimize-sibling-calls
3580 @opindex foptimize-sibling-calls
3581 Optimize sibling and tail recursive calls.
3583 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3585 @item -fno-inline
3586 @opindex fno-inline
3587 Don't pay attention to the @code{inline} keyword.  Normally this option
3588 is used to keep the compiler from expanding any functions inline.
3589 Note that if you are not optimizing, no functions can be expanded inline.
3591 @item -finline-functions
3592 @opindex finline-functions
3593 Integrate all simple functions into their callers.  The compiler
3594 heuristically decides which functions are simple enough to be worth
3595 integrating in this way.
3597 If all calls to a given function are integrated, and the function is
3598 declared @code{static}, then the function is normally not output as
3599 assembler code in its own right.
3601 Enabled at level @option{-O3}.
3603 @item -finline-limit=@var{n}
3604 @opindex finline-limit
3605 By default, gcc limits the size of functions that can be inlined.  This flag
3606 allows the control of this limit for functions that are explicitly marked as
3607 inline (i.e., marked with the inline keyword or defined within the class
3608 definition in c++).  @var{n} is the size of functions that can be inlined in
3609 number of pseudo instructions (not counting parameter handling).  The default
3610 value of @var{n} is 600.
3611 Increasing this value can result in more inlined code at
3612 the cost of compilation time and memory consumption.  Decreasing usually makes
3613 the compilation faster and less code will be inlined (which presumably
3614 means slower programs).  This option is particularly useful for programs that
3615 use inlining heavily such as those based on recursive templates with C++.
3617 @emph{Note:} pseudo instruction represents, in this particular context, an
3618 abstract measurement of function's size.  In no way, it represents a count
3619 of assembly instructions and as such its exact meaning might change from one
3620 release to an another.
3622 @item -fkeep-inline-functions
3623 @opindex fkeep-inline-functions
3624 Even if all calls to a given function are integrated, and the function
3625 is declared @code{static}, nevertheless output a separate run-time
3626 callable version of the function.  This switch does not affect
3627 @code{extern inline} functions.
3629 @item -fkeep-static-consts
3630 @opindex fkeep-static-consts
3631 Emit variables declared @code{static const} when optimization isn't turned
3632 on, even if the variables aren't referenced.
3634 GCC enables this option by default.  If you want to force the compiler to
3635 check if the variable was referenced, regardless of whether or not
3636 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3638 @item -fmerge-constants
3639 Attempt to merge identical constants (string constants and floating point
3640 constants) across compilation units.
3642 This option is the default for optimized compilation if the assembler and
3643 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3644 behavior.
3646 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3648 @item -fmerge-all-constants
3649 Attempt to merge identical constants and identical variables.
3651 This option implies @option{-fmerge-constants}.  In addition to
3652 @option{-fmerge-constants} this considers e.g. even constant initialized
3653 arrays or initialized constant variables with integral or floating point
3654 types.  Languages like C or C++ require each non-automatic variable to
3655 have distinct location, so using this option will result in non-conforming
3656 behavior.
3658 @item -fnew-ra
3659 @opindex fnew-ra
3660 Use a graph coloring register allocator.  Currently this option is meant
3661 for testing, so we are interested to hear about miscompilations with
3662 @option{-fnew-ra}.
3664 @item -fno-branch-count-reg
3665 @opindex fno-branch-count-reg
3666 Do not use ``decrement and branch'' instructions on a count register,
3667 but instead generate a sequence of instructions that decrement a
3668 register, compare it against zero, then branch based upon the result.
3669 This option is only meaningful on architectures that support such
3670 instructions, which include x86, PowerPC, IA-64 and S/390.
3672 The default is @option{-fbranch-count-reg}, enabled when
3673 @option{-fstrength-reduce} is enabled.
3675 @item -fno-function-cse
3676 @opindex fno-function-cse
3677 Do not put function addresses in registers; make each instruction that
3678 calls a constant function contain the function's address explicitly.
3680 This option results in less efficient code, but some strange hacks
3681 that alter the assembler output may be confused by the optimizations
3682 performed when this option is not used.
3684 The default is @option{-ffunction-cse}
3686 @item -fno-zero-initialized-in-bss
3687 @opindex fno-zero-initialized-in-bss
3688 If the target supports a BSS section, GCC by default puts variables that
3689 are initialized to zero into BSS@.  This can save space in the resulting
3690 code.
3692 This option turns off this behavior because some programs explicitly
3693 rely on variables going to the data section.  E.g., so that the
3694 resulting executable can find the beginning of that section and/or make
3695 assumptions based on that.
3697 The default is @option{-fzero-initialized-in-bss}.
3699 @item -fstrength-reduce
3700 @opindex fstrength-reduce
3701 Perform the optimizations of loop strength reduction and
3702 elimination of iteration variables.
3704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3706 @item -fthread-jumps
3707 @opindex fthread-jumps
3708 Perform optimizations where we check to see if a jump branches to a
3709 location where another comparison subsumed by the first is found.  If
3710 so, the first branch is redirected to either the destination of the
3711 second branch or a point immediately following it, depending on whether
3712 the condition is known to be true or false.
3714 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3716 @item -fcse-follow-jumps
3717 @opindex fcse-follow-jumps
3718 In common subexpression elimination, scan through jump instructions
3719 when the target of the jump is not reached by any other path.  For
3720 example, when CSE encounters an @code{if} statement with an
3721 @code{else} clause, CSE will follow the jump when the condition
3722 tested is false.
3724 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3726 @item -fcse-skip-blocks
3727 @opindex fcse-skip-blocks
3728 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3729 follow jumps which conditionally skip over blocks.  When CSE
3730 encounters a simple @code{if} statement with no else clause,
3731 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3732 body of the @code{if}.
3734 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3736 @item -frerun-cse-after-loop
3737 @opindex frerun-cse-after-loop
3738 Re-run common subexpression elimination after loop optimizations has been
3739 performed.
3741 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3743 @item -frerun-loop-opt
3744 @opindex frerun-loop-opt
3745 Run the loop optimizer twice.
3747 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3749 @item -fgcse
3750 @opindex fgcse
3751 Perform a global common subexpression elimination pass.
3752 This pass also performs global constant and copy propagation.
3754 @emph{Note:} When compiling a program using computed gotos, a GCC
3755 extension, you may get better runtime performance if you disable
3756 the global common subexpression elimination pass by adding
3757 @option{-fno-gcse} to the command line.
3759 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3761 @item -fgcse-lm
3762 @opindex fgcse-lm
3763 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3764 attempt to move loads which are only killed by stores into themselves.  This
3765 allows a loop containing a load/store sequence to be changed to a load outside
3766 the loop, and a copy/store within the loop.
3768 Enabled by default when gcse is enabled.
3770 @item -fgcse-sm
3771 @opindex fgcse-sm
3772 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3773 subexpression elimination.  This pass will attempt to move stores out of loops.
3774 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3775 can be changed to a load before the loop and a store after the loop.
3777 Enabled by default when gcse is enabled.
3779 @item -floop-optimize
3780 @opindex floop-optimize
3781 Perform loop optimizations: move constant expressions out of loops, simplify
3782 exit test conditions and optionally do strength-reduction and loop unrolling as
3783 well.
3785 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3787 @item -fcrossjumping
3788 @opindex crossjumping
3789 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3790 resulting code may or may not perform better than without cross-jumping.
3792 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3794 @item -fif-conversion
3795 @opindex if-conversion
3796 Attempt to transform conditional jumps into branch-less equivalents.  This
3797 include use of conditional moves, min, max, set flags and abs instructions, and
3798 some tricks doable by standard arithmetics.  The use of conditional execution
3799 on chips where it is available is controlled by @code{if-conversion2}.
3801 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3803 @item -fif-conversion2
3804 @opindex if-conversion2
3805 Use conditional execution (where available) to transform conditional jumps into
3806 branch-less equivalents.
3808 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3810 @item -fdelete-null-pointer-checks
3811 @opindex fdelete-null-pointer-checks
3812 Use global dataflow analysis to identify and eliminate useless checks
3813 for null pointers.  The compiler assumes that dereferencing a null
3814 pointer would have halted the program.  If a pointer is checked after
3815 it has already been dereferenced, it cannot be null.
3817 In some environments, this assumption is not true, and programs can
3818 safely dereference null pointers.  Use
3819 @option{-fno-delete-null-pointer-checks} to disable this optimization
3820 for programs which depend on that behavior.
3822 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3824 @item -fexpensive-optimizations
3825 @opindex fexpensive-optimizations
3826 Perform a number of minor optimizations that are relatively expensive.
3828 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3830 @item -foptimize-register-move
3831 @itemx -fregmove
3832 @opindex foptimize-register-move
3833 @opindex fregmove
3834 Attempt to reassign register numbers in move instructions and as
3835 operands of other simple instructions in order to maximize the amount of
3836 register tying.  This is especially helpful on machines with two-operand
3837 instructions.
3839 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3840 optimization.
3842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3844 @item -fdelayed-branch
3845 @opindex fdelayed-branch
3846 If supported for the target machine, attempt to reorder instructions
3847 to exploit instruction slots available after delayed branch
3848 instructions.
3850 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3852 @item -fschedule-insns
3853 @opindex fschedule-insns
3854 If supported for the target machine, attempt to reorder instructions to
3855 eliminate execution stalls due to required data being unavailable.  This
3856 helps machines that have slow floating point or memory load instructions
3857 by allowing other instructions to be issued until the result of the load
3858 or floating point instruction is required.
3860 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3862 @item -fschedule-insns2
3863 @opindex fschedule-insns2
3864 Similar to @option{-fschedule-insns}, but requests an additional pass of
3865 instruction scheduling after register allocation has been done.  This is
3866 especially useful on machines with a relatively small number of
3867 registers and where memory load instructions take more than one cycle.
3869 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3871 @item -fno-sched-interblock
3872 @opindex fno-sched-interblock
3873 Don't schedule instructions across basic blocks.  This is normally
3874 enabled by default when scheduling before register allocation, i.e.@:
3875 with @option{-fschedule-insns} or at @option{-O2} or higher.
3877 @item -fno-sched-spec
3878 @opindex fno-sched-spec
3879 Don't allow speculative motion of non-load instructions.  This is normally
3880 enabled by default when scheduling before register allocation, i.e.@:
3881 with @option{-fschedule-insns} or at @option{-O2} or higher.
3883 @item -fsched-spec-load
3884 @opindex fsched-spec-load
3885 Allow speculative motion of some load instructions.  This only makes
3886 sense when scheduling before register allocation, i.e.@: with
3887 @option{-fschedule-insns} or at @option{-O2} or higher.
3889 @item -fsched-spec-load-dangerous
3890 @opindex fsched-spec-load-dangerous
3891 Allow speculative motion of more load instructions.  This only makes
3892 sense when scheduling before register allocation, i.e.@: with
3893 @option{-fschedule-insns} or at @option{-O2} or higher.
3895 @item -fcaller-saves
3896 @opindex fcaller-saves
3897 Enable values to be allocated in registers that will be clobbered by
3898 function calls, by emitting extra instructions to save and restore the
3899 registers around such calls.  Such allocation is done only when it
3900 seems to result in better code than would otherwise be produced.
3902 This option is always enabled by default on certain machines, usually
3903 those which have no call-preserved registers to use instead.
3905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3907 @item -fmove-all-movables
3908 @opindex fmove-all-movables
3909 Forces all invariant computations in loops to be moved
3910 outside the loop.
3912 @item -freduce-all-givs
3913 @opindex freduce-all-givs
3914 Forces all general-induction variables in loops to be
3915 strength-reduced.
3917 @emph{Note:} When compiling programs written in Fortran,
3918 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3919 by default when you use the optimizer.
3921 These options may generate better or worse code; results are highly
3922 dependent on the structure of loops within the source code.
3924 These two options are intended to be removed someday, once
3925 they have helped determine the efficacy of various
3926 approaches to improving loop optimizations.
3928 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3929 know how use of these options affects
3930 the performance of your production code.
3931 We're very interested in code that runs @emph{slower}
3932 when these options are @emph{enabled}.
3934 @item -fno-peephole
3935 @itemx -fno-peephole2
3936 @opindex fno-peephole
3937 @opindex fno-peephole2
3938 Disable any machine-specific peephole optimizations.  The difference
3939 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3940 are implemented in the compiler; some targets use one, some use the
3941 other, a few use both.
3943 @option{-fpeephole} is enabled by default.
3944 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3946 @item -fno-guess-branch-probability
3947 @opindex fno-guess-branch-probability
3948 Do not guess branch probabilities using a randomized model.
3950 Sometimes gcc will opt to use a randomized model to guess branch
3951 probabilities, when none are available from either profiling feedback
3952 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3953 different runs of the compiler on the same program may produce different
3954 object code.
3956 In a hard real-time system, people don't want different runs of the
3957 compiler to produce code that has different behavior; minimizing
3958 non-determinism is of paramount import.  This switch allows users to
3959 reduce non-determinism, possibly at the expense of inferior
3960 optimization.
3962 The default is @option{-fguess-branch-probability} at levels
3963 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3965 @item -freorder-blocks
3966 @opindex freorder-blocks
3967 Reorder basic blocks in the compiled function in order to reduce number of
3968 taken branches and improve code locality.
3970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3972 @item -freorder-functions
3973 @opindex freorder-functions
3974 Reorder basic blocks in the compiled function in order to reduce number of
3975 taken branches and improve code locality. This is implemented by using special
3976 subsections @code{text.hot} for most frequently executed functions and
3977 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
3978 the linker so object file format must support named sections and linker must
3979 place them in a reasonable way.
3981 Also profile feedback must be available in to make this option effective.  See
3982 @option{-fprofile-arcs} for details.
3984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3986 @item -fstrict-aliasing
3987 @opindex fstrict-aliasing
3988 Allows the compiler to assume the strictest aliasing rules applicable to
3989 the language being compiled.  For C (and C++), this activates
3990 optimizations based on the type of expressions.  In particular, an
3991 object of one type is assumed never to reside at the same address as an
3992 object of a different type, unless the types are almost the same.  For
3993 example, an @code{unsigned int} can alias an @code{int}, but not a
3994 @code{void*} or a @code{double}.  A character type may alias any other
3995 type.
3997 Pay special attention to code like this:
3998 @example
3999 union a_union @{
4000   int i;
4001   double d;
4004 int f() @{
4005   a_union t;
4006   t.d = 3.0;
4007   return t.i;
4009 @end example
4010 The practice of reading from a different union member than the one most
4011 recently written to (called ``type-punning'') is common.  Even with
4012 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4013 is accessed through the union type.  So, the code above will work as
4014 expected.  However, this code might not:
4015 @example
4016 int f() @{
4017   a_union t;
4018   int* ip;
4019   t.d = 3.0;
4020   ip = &t.i;
4021   return *ip;
4023 @end example
4025 Every language that wishes to perform language-specific alias analysis
4026 should define a function that computes, given an @code{tree}
4027 node, an alias set for the node.  Nodes in different alias sets are not
4028 allowed to alias.  For an example, see the C front-end function
4029 @code{c_get_alias_set}.
4031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4033 @item -falign-functions
4034 @itemx -falign-functions=@var{n}
4035 @opindex falign-functions
4036 Align the start of functions to the next power-of-two greater than
4037 @var{n}, skipping up to @var{n} bytes.  For instance,
4038 @option{-falign-functions=32} aligns functions to the next 32-byte
4039 boundary, but @option{-falign-functions=24} would align to the next
4040 32-byte boundary only if this can be done by skipping 23 bytes or less.
4042 @option{-fno-align-functions} and @option{-falign-functions=1} are
4043 equivalent and mean that functions will not be aligned.
4045 Some assemblers only support this flag when @var{n} is a power of two;
4046 in that case, it is rounded up.
4048 If @var{n} is not specified, use a machine-dependent default.
4050 Enabled at levels @option{-O2}, @option{-O3}.
4052 @item -falign-labels
4053 @itemx -falign-labels=@var{n}
4054 @opindex falign-labels
4055 Align all branch targets to a power-of-two boundary, skipping up to
4056 @var{n} bytes like @option{-falign-functions}.  This option can easily
4057 make code slower, because it must insert dummy operations for when the
4058 branch target is reached in the usual flow of the code.
4060 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4061 are greater than this value, then their values are used instead.
4063 If @var{n} is not specified, use a machine-dependent default which is
4064 very likely to be @samp{1}, meaning no alignment.
4066 Enabled at levels @option{-O2}, @option{-O3}.
4068 @item -falign-loops
4069 @itemx -falign-loops=@var{n}
4070 @opindex falign-loops
4071 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4072 like @option{-falign-functions}.  The hope is that the loop will be
4073 executed many times, which will make up for any execution of the dummy
4074 operations.
4076 If @var{n} is not specified, use a machine-dependent default.
4078 Enabled at levels @option{-O2}, @option{-O3}.
4080 @item -falign-jumps
4081 @itemx -falign-jumps=@var{n}
4082 @opindex falign-jumps
4083 Align branch targets to a power-of-two boundary, for branch targets
4084 where the targets can only be reached by jumping, skipping up to @var{n}
4085 bytes like @option{-falign-functions}.  In this case, no dummy operations
4086 need be executed.
4088 If @var{n} is not specified, use a machine-dependent default.
4090 Enabled at levels @option{-O2}, @option{-O3}.
4092 @item -frename-registers
4093 @opindex frename-registers
4094 Attempt to avoid false dependencies in scheduled code by making use
4095 of registers left over after register allocation.  This optimization
4096 will most benefit processors with lots of registers.  It can, however,
4097 make debugging impossible, since variables will no longer stay in
4098 a ``home register''.
4100 Enabled at levels @option{-O3}.
4102 @item -fno-cprop-registers
4103 @opindex fno-cprop-registers
4104 After register allocation and post-register allocation instruction splitting,
4105 we perform a copy-propagation pass to try to reduce scheduling dependencies
4106 and occasionally eliminate the copy.
4108 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4110 @end table
4112 The following options control compiler behavior regarding floating
4113 point arithmetic.  These options trade off between speed and
4114 correctness.  All must be specifically enabled.
4116 @table @gcctabopt
4117 @item -ffloat-store
4118 @opindex ffloat-store
4119 Do not store floating point variables in registers, and inhibit other
4120 options that might change whether a floating point value is taken from a
4121 register or memory.
4123 @cindex floating point precision
4124 This option prevents undesirable excess precision on machines such as
4125 the 68000 where the floating registers (of the 68881) keep more
4126 precision than a @code{double} is supposed to have.  Similarly for the
4127 x86 architecture.  For most programs, the excess precision does only
4128 good, but a few programs rely on the precise definition of IEEE floating
4129 point.  Use @option{-ffloat-store} for such programs, after modifying
4130 them to store all pertinent intermediate computations into variables.
4132 @item -ffast-math
4133 @opindex ffast-math
4134 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4135 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4136 @option{-fno-signaling-nans}.
4138 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4140 This option should never be turned on by any @option{-O} option since
4141 it can result in incorrect output for programs which depend on
4142 an exact implementation of IEEE or ISO rules/specifications for
4143 math functions.
4145 @item -fno-math-errno
4146 @opindex fno-math-errno
4147 Do not set ERRNO after calling math functions that are executed
4148 with a single instruction, e.g., sqrt.  A program that relies on
4149 IEEE exceptions for math error handling may want to use this flag
4150 for speed while maintaining IEEE arithmetic compatibility.
4152 This option should never be turned on by any @option{-O} option since
4153 it can result in incorrect output for programs which depend on
4154 an exact implementation of IEEE or ISO rules/specifications for
4155 math functions.
4157 The default is @option{-fmath-errno}.
4159 @item -funsafe-math-optimizations
4160 @opindex funsafe-math-optimizations
4161 Allow optimizations for floating-point arithmetic that (a) assume
4162 that arguments and results are valid and (b) may violate IEEE or
4163 ANSI standards.  When used at link-time, it may include libraries
4164 or startup files that change the default FPU control word or other
4165 similar optimizations.
4167 This option should never be turned on by any @option{-O} option since
4168 it can result in incorrect output for programs which depend on
4169 an exact implementation of IEEE or ISO rules/specifications for
4170 math functions.
4172 The default is @option{-fno-unsafe-math-optimizations}.
4174 @item -ffinite-math-only
4175 @opindex ffinite-math-only
4176 Allow optimizations for floating-point arithmetic that assume
4177 that arguments and results are not NaNs or +-Infs.
4179 This option should never be turned on by any @option{-O} option since
4180 it can result in incorrect output for programs which depend on
4181 an exact implementation of IEEE or ISO rules/specifications.
4183 The default is @option{-fno-finite-math-only}.
4185 @item -fno-trapping-math
4186 @opindex fno-trapping-math
4187 Compile code assuming that floating-point operations cannot generate
4188 user-visible traps.  These traps include division by zero, overflow,
4189 underflow, inexact result and invalid operation.  This option implies
4190 @option{-fno-signaling-nans}.  Setting this option may allow faster
4191 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4193 This option should never be turned on by any @option{-O} option since
4194 it can result in incorrect output for programs which depend on
4195 an exact implementation of IEEE or ISO rules/specifications for
4196 math functions.
4198 The default is @option{-ftrapping-math}.
4200 @item -fsignaling-nans
4201 @opindex fsignaling-nans
4202 Compile code assuming that IEEE signaling NaNs may generate user-visible
4203 traps during floating-point operations.  Setting this option disables
4204 optimizations that may change the number of exceptions visible with
4205 signaling NaNs.  This option implies @option{-ftrapping-math}.
4207 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4208 be defined.
4210 The default is @option{-fno-signaling-nans}.
4212 This option is experimental and does not currently guarantee to
4213 disable all GCC optimizations that affect signaling NaN behavior.
4215 @item -fsingle-precision-constant
4216 @opindex fsingle-precision-constant
4217 Treat floating point constant as single precision constant instead of
4218 implicitly converting it to double precision constant.
4221 @end table
4223 The following options control optimizations that may improve
4224 performance, but are not enabled by any @option{-O} options.  This
4225 section includes experimental options that may produce broken code.
4227 @table @gcctabopt
4228 @item -fbranch-probabilities
4229 @opindex fbranch-probabilities
4230 After running a program compiled with @option{-fprofile-arcs}
4231 (@pxref{Debugging Options,, Options for Debugging Your Program or
4232 @command{gcc}}), you can compile it a second time using
4233 @option{-fbranch-probabilities}, to improve optimizations based on
4234 the number of times each branch was taken.  When the program
4235 compiled with @option{-fprofile-arcs} exits it saves arc execution
4236 counts to a file called @file{@var{sourcename}.da} for each source
4237 file  The information in this data file is very dependent on the
4238 structure of the generated code, so you must use the same source code
4239 and the same optimization options for both compilations.
4241 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
4242 note on the first instruction of each basic block, and a
4243 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4244 These can be used to improve optimization.  Currently, they are only
4245 used in one place: in @file{reorg.c}, instead of guessing which path a
4246 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4247 exactly determine which path is taken more often.
4249 @item -fnew-ra
4250 @opindex fnew-ra
4251 Use a graph coloring register allocator.  Currently this option is meant
4252 for testing, so we are interested to hear about miscompilations with
4253 @option{-fnew-ra}.
4255 @item -ftracer
4256 @opindex ftracer
4257 Perform tail duplication to enlarge superblock size. This transformation
4258 simplifies the control flow of the function allowing other optimizations to do
4259 better job.
4261 @item -funroll-loops
4262 @opindex funroll-loops
4263 Unroll loops whose number of iterations can be determined at compile
4264 time or upon entry to the loop.  @option{-funroll-loops} implies both
4265 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4266 option makes code larger, and may or may not make it run faster.
4268 @item -funroll-all-loops
4269 @opindex funroll-all-loops
4270 Unroll all loops, even if their number of iterations is uncertain when
4271 the loop is entered.  This usually makes programs run more slowly.
4272 @option{-funroll-all-loops} implies the same options as
4273 @option{-funroll-loops},
4275 @item -funswitch-loops
4276 @opindex funswitch-loops
4277 Move branches with loop invariant conditions out of the loop, with duplicates
4278 of the loop on both branches (modified according to result of the condition).
4280 @item -fprefetch-loop-arrays
4281 @opindex fprefetch-loop-arrays
4282 If supported by the target machine, generate instructions to prefetch
4283 memory to improve the performance of loops that access large arrays.
4285 Disabled at level @option{-Os}.
4287 @item -ffunction-sections
4288 @itemx -fdata-sections
4289 @opindex ffunction-sections
4290 @opindex fdata-sections
4291 Place each function or data item into its own section in the output
4292 file if the target supports arbitrary sections.  The name of the
4293 function or the name of the data item determines the section's name
4294 in the output file.
4296 Use these options on systems where the linker can perform optimizations
4297 to improve locality of reference in the instruction space.  HPPA
4298 processors running HP-UX and SPARC processors running Solaris 2 have
4299 linkers with such optimizations.  Other systems using the ELF object format
4300 as well as AIX may have these optimizations in the future.
4302 Only use these options when there are significant benefits from doing
4303 so.  When you specify these options, the assembler and linker will
4304 create larger object and executable files and will also be slower.
4305 You will not be able to use @code{gprof} on all systems if you
4306 specify this option and you may have problems with debugging if
4307 you specify both this option and @option{-g}.
4309 @item -fssa
4310 @opindex fssa
4311 Perform optimizations in static single assignment form.  Each function's
4312 flow graph is translated into SSA form, optimizations are performed, and
4313 the flow graph is translated back from SSA form.  Users should not
4314 specify this option, since it is not yet ready for production use.
4316 @item -fssa-ccp
4317 @opindex fssa-ccp
4318 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4319 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4321 @item -fssa-dce
4322 @opindex fssa-dce
4323 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4324 Like @option{-fssa}, this is an experimental feature.
4329 @item --param @var{name}=@var{value}
4330 @opindex param
4331 In some places, GCC uses various constants to control the amount of
4332 optimization that is done.  For example, GCC will not inline functions
4333 that contain more that a certain number of instructions.  You can
4334 control some of these constants on the command-line using the
4335 @option{--param} option.
4337 In each case, the @var{value} is an integer.  The allowable choices for
4338 @var{name} are given in the following table:
4340 @table @gcctabopt
4341 @item max-delay-slot-insn-search
4342 The maximum number of instructions to consider when looking for an
4343 instruction to fill a delay slot.  If more than this arbitrary number of
4344 instructions is searched, the time savings from filling the delay slot
4345 will be minimal so stop searching.  Increasing values mean more
4346 aggressive optimization, making the compile time increase with probably
4347 small improvement in executable run time.
4349 @item max-delay-slot-live-search
4350 When trying to fill delay slots, the maximum number of instructions to
4351 consider when searching for a block with valid live register
4352 information.  Increasing this arbitrarily chosen value means more
4353 aggressive optimization, increasing the compile time.  This parameter
4354 should be removed when the delay slot code is rewritten to maintain the
4355 control-flow graph.
4357 @item max-gcse-memory
4358 The approximate maximum amount of memory that will be allocated in
4359 order to perform the global common subexpression elimination
4360 optimization.  If more memory than specified is required, the
4361 optimization will not be done.
4363 @item max-gcse-passes
4364 The maximum number of passes of GCSE to run.
4366 @item max-pending-list-length
4367 The maximum number of pending dependencies scheduling will allow
4368 before flushing the current state and starting over.  Large functions
4369 with few branches or calls can create excessively large lists which
4370 needlessly consume memory and resources.
4372 @item max-inline-insns
4373 If an function contains more than this many instructions, it
4374 will not be inlined.  This option is precisely equivalent to
4375 @option{-finline-limit}.
4377 @item max-unrolled-insns
4378 The maximum number of instructions that a loop should have if that loop
4379 is unrolled, and if the loop is unrolled, it determines how many times
4380 the loop code is unrolled.
4382 @item max-unswitch-insns
4383 The maximum number of insns of an unswitched loop.
4385 @item max-unswitch-level
4386 The maximum number of branches unswitched in a single loop.
4388 @item hot-bb-count-fraction
4389 Select fraction of the maximal count of repetitions of basic block in program
4390 given basic block needs to have to be considered hot.
4392 @item hot-bb-frequency-fraction
4393 Select fraction of the maximal frequency of executions of basic block in
4394 function given basic block needs to have to be considered hot
4396 @item tracer-dynamic-coverage
4397 @itemx tracer-dynamic-coverage-feedback
4399 This value is used to limit superblock formation once the given percentage of
4400 executed instructions is covered.  This limits unnecessary code size
4401 expansion.
4403 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4404 feedback is available.  The real profiles (as opposed to statically estimated
4405 ones) are much less balanced allowing the threshold to be larger value.
4407 @item tracer-max-code-growth
4408 Stop tail duplication once code growth has reached given percentage.  This is
4409 rather hokey argument, as most of the duplicates will be eliminated later in
4410 cross jumping, so it may be set to much higher values than is the desired code
4411 growth.
4413 @item tracer-min-branch-ratio
4415 Stop reverse growth when the reverse probability of best edge is less than this
4416 threshold (in percent).
4418 @item tracer-min-branch-ratio
4419 @itemx tracer-min-branch-ratio-feedback
4421 Stop forward growth if the best edge do have probability lower than this
4422 threshold.
4424 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4425 compilation for profile feedback and one for compilation without.  The value
4426 for compilation with profile feedback needs to be more conservative (higher) in
4427 order to make tracer effective.
4429 @item ggc-min-expand
4431 GCC uses a garbage collector to manage its own memory allocation.  This
4432 parameter specifies the minimum percentage by which the garbage
4433 collector's heap should be allowed to expand between collections.
4434 Tuning this may improve compilation speed; it has no effect on code
4435 generation.
4437 The default is 30%.  Setting this parameter and
4438 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4439 every opportunity.  This is extremely slow, but can be useful for
4440 debugging.
4442 @item ggc-min-heapsize
4444 Minimum size of the garbage collector's heap before it begins bothering
4445 to collect garbage.  The first collection occurs after the heap expands
4446 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4447 tuning this may improve compilation speed, and has no effect on code
4448 generation.
4450 The default is 4096 (four megabytes).  Setting this parameter very large
4451 effectively disables garbage collection.  Setting this parameter and
4452 @option{ggc-min-expand} to zero causes a full collection to occur at
4453 every opportunity.  
4455 @end table
4456 @end table
4458 @node Preprocessor Options
4459 @section Options Controlling the Preprocessor
4460 @cindex preprocessor options
4461 @cindex options, preprocessor
4463 These options control the C preprocessor, which is run on each C source
4464 file before actual compilation.
4466 If you use the @option{-E} option, nothing is done except preprocessing.
4467 Some of these options make sense only together with @option{-E} because
4468 they cause the preprocessor output to be unsuitable for actual
4469 compilation.
4471 @table @gcctabopt
4472 @opindex Wp
4473 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4474 and pass @var{option} directly through to the preprocessor.  If
4475 @var{option} contains commas, it is split into multiple options at the
4476 commas.  However, many options are modified, translated or interpreted
4477 by the compiler driver before being passed to the preprocessor, and
4478 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4479 interface is undocumented and subject to change, so whenever possible
4480 you should avoid using @option{-Wp} and let the driver handle the
4481 options instead.
4483 @item -Xpreprocessor @var{option}
4484 @opindex preprocessor
4485 Pass @var{option} as an option to the preprocessor.  You can use this to
4486 supply system-specific preprocessor options which GCC does not know how to
4487 recognize.
4489 If you want to pass an option that takes an argument, you must use
4490 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4491 @end table
4493 @include cppopts.texi
4495 @node Assembler Options
4496 @section Passing Options to the Assembler
4498 @c prevent bad page break with this line
4499 You can pass options to the assembler.
4501 @table @gcctabopt
4502 @item -Wa,@var{option}
4503 @opindex Wa
4504 Pass @var{option} as an option to the assembler.  If @var{option}
4505 contains commas, it is split into multiple options at the commas.
4507 @item -Xassembler @var{option}
4508 @opindex Xassembler
4509 Pass @var{option} as an option to the assembler.  You can use this to
4510 supply system-specific assembler options which GCC does not know how to
4511 recognize.
4513 If you want to pass an option that takes an argument, you must use
4514 @option{-Xassembler} twice, once for the option and once for the argument.
4516 @end table
4518 @node Link Options
4519 @section Options for Linking
4520 @cindex link options
4521 @cindex options, linking
4523 These options come into play when the compiler links object files into
4524 an executable output file.  They are meaningless if the compiler is
4525 not doing a link step.
4527 @table @gcctabopt
4528 @cindex file names
4529 @item @var{object-file-name}
4530 A file name that does not end in a special recognized suffix is
4531 considered to name an object file or library.  (Object files are
4532 distinguished from libraries by the linker according to the file
4533 contents.)  If linking is done, these object files are used as input
4534 to the linker.
4536 @item -c
4537 @itemx -S
4538 @itemx -E
4539 @opindex c
4540 @opindex S
4541 @opindex E
4542 If any of these options is used, then the linker is not run, and
4543 object file names should not be used as arguments.  @xref{Overall
4544 Options}.
4546 @cindex Libraries
4547 @item -l@var{library}
4548 @itemx -l @var{library}
4549 @opindex l
4550 Search the library named @var{library} when linking.  (The second
4551 alternative with the library as a separate argument is only for
4552 POSIX compliance and is not recommended.)
4554 It makes a difference where in the command you write this option; the
4555 linker searches and processes libraries and object files in the order they
4556 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4557 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4558 to functions in @samp{z}, those functions may not be loaded.
4560 The linker searches a standard list of directories for the library,
4561 which is actually a file named @file{lib@var{library}.a}.  The linker
4562 then uses this file as if it had been specified precisely by name.
4564 The directories searched include several standard system directories
4565 plus any that you specify with @option{-L}.
4567 Normally the files found this way are library files---archive files
4568 whose members are object files.  The linker handles an archive file by
4569 scanning through it for members which define symbols that have so far
4570 been referenced but not defined.  But if the file that is found is an
4571 ordinary object file, it is linked in the usual fashion.  The only
4572 difference between using an @option{-l} option and specifying a file name
4573 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4574 and searches several directories.
4576 @item -lobjc
4577 @opindex lobjc
4578 You need this special case of the @option{-l} option in order to
4579 link an Objective-C program.
4581 @item -nostartfiles
4582 @opindex nostartfiles
4583 Do not use the standard system startup files when linking.
4584 The standard system libraries are used normally, unless @option{-nostdlib}
4585 or @option{-nodefaultlibs} is used.
4587 @item -nodefaultlibs
4588 @opindex nodefaultlibs
4589 Do not use the standard system libraries when linking.
4590 Only the libraries you specify will be passed to the linker.
4591 The standard startup files are used normally, unless @option{-nostartfiles}
4592 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4593 for System V (and ISO C) environments or to bcopy and bzero for
4594 BSD environments.  These entries are usually resolved by entries in
4595 libc.  These entry points should be supplied through some other
4596 mechanism when this option is specified.
4598 @item -nostdlib
4599 @opindex nostdlib
4600 Do not use the standard system startup files or libraries when linking.
4601 No startup files and only the libraries you specify will be passed to
4602 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4603 for System V (and ISO C) environments or to bcopy and bzero for
4604 BSD environments.  These entries are usually resolved by entries in
4605 libc.  These entry points should be supplied through some other
4606 mechanism when this option is specified.
4608 @cindex @option{-lgcc}, use with @option{-nostdlib}
4609 @cindex @option{-nostdlib} and unresolved references
4610 @cindex unresolved references and @option{-nostdlib}
4611 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4612 @cindex @option{-nodefaultlibs} and unresolved references
4613 @cindex unresolved references and @option{-nodefaultlibs}
4614 One of the standard libraries bypassed by @option{-nostdlib} and
4615 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4616 that GCC uses to overcome shortcomings of particular machines, or special
4617 needs for some languages.
4618 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4619 Collection (GCC) Internals},
4620 for more discussion of @file{libgcc.a}.)
4621 In most cases, you need @file{libgcc.a} even when you want to avoid
4622 other standard libraries.  In other words, when you specify @option{-nostdlib}
4623 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4624 This ensures that you have no unresolved references to internal GCC
4625 library subroutines.  (For example, @samp{__main}, used to ensure C++
4626 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4627 GNU Compiler Collection (GCC) Internals}.)
4629 @item -s
4630 @opindex s
4631 Remove all symbol table and relocation information from the executable.
4633 @item -static
4634 @opindex static
4635 On systems that support dynamic linking, this prevents linking with the shared
4636 libraries.  On other systems, this option has no effect.
4638 @item -shared
4639 @opindex shared
4640 Produce a shared object which can then be linked with other objects to
4641 form an executable.  Not all systems support this option.  For predictable
4642 results, you must also specify the same set of options that were used to
4643 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4644 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4645 needs to build supplementary stub code for constructors to work.  On
4646 multi-libbed systems, @samp{gcc -shared} must select the correct support
4647 libraries to link against.  Failing to supply the correct flags may lead
4648 to subtle defects.  Supplying them in cases where they are not necessary
4649 is innocuous.}
4651 @item -shared-libgcc
4652 @itemx -static-libgcc
4653 @opindex shared-libgcc
4654 @opindex static-libgcc
4655 On systems that provide @file{libgcc} as a shared library, these options
4656 force the use of either the shared or static version respectively.
4657 If no shared version of @file{libgcc} was built when the compiler was
4658 configured, these options have no effect.
4660 There are several situations in which an application should use the
4661 shared @file{libgcc} instead of the static version.  The most common
4662 of these is when the application wishes to throw and catch exceptions
4663 across different shared libraries.  In that case, each of the libraries
4664 as well as the application itself should use the shared @file{libgcc}.
4666 Therefore, the G++ and GCJ drivers automatically add
4667 @option{-shared-libgcc} whenever you build a shared library or a main
4668 executable, because C++ and Java programs typically use exceptions, so
4669 this is the right thing to do.
4671 If, instead, you use the GCC driver to create shared libraries, you may
4672 find that they will not always be linked with the shared @file{libgcc}.
4673 If GCC finds, at its configuration time, that you have a GNU linker that
4674 does not support option @option{--eh-frame-hdr}, it will link the shared
4675 version of @file{libgcc} into shared libraries by default.  Otherwise,
4676 it will take advantage of the linker and optimize away the linking with
4677 the shared version of @file{libgcc}, linking with the static version of
4678 libgcc by default.  This allows exceptions to propagate through such
4679 shared libraries, without incurring relocation costs at library load
4680 time.
4682 However, if a library or main executable is supposed to throw or catch
4683 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4684 for the languages used in the program, or using the option
4685 @option{-shared-libgcc}, such that it is linked with the shared
4686 @file{libgcc}.
4688 @item -symbolic
4689 @opindex symbolic
4690 Bind references to global symbols when building a shared object.  Warn
4691 about any unresolved references (unless overridden by the link editor
4692 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4693 this option.
4695 @item -Xlinker @var{option}
4696 @opindex Xlinker
4697 Pass @var{option} as an option to the linker.  You can use this to
4698 supply system-specific linker options which GCC does not know how to
4699 recognize.
4701 If you want to pass an option that takes an argument, you must use
4702 @option{-Xlinker} twice, once for the option and once for the argument.
4703 For example, to pass @option{-assert definitions}, you must write
4704 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4705 @option{-Xlinker "-assert definitions"}, because this passes the entire
4706 string as a single argument, which is not what the linker expects.
4708 @item -Wl,@var{option}
4709 @opindex Wl
4710 Pass @var{option} as an option to the linker.  If @var{option} contains
4711 commas, it is split into multiple options at the commas.
4713 @item -u @var{symbol}
4714 @opindex u
4715 Pretend the symbol @var{symbol} is undefined, to force linking of
4716 library modules to define it.  You can use @option{-u} multiple times with
4717 different symbols to force loading of additional library modules.
4718 @end table
4720 @node Directory Options
4721 @section Options for Directory Search
4722 @cindex directory options
4723 @cindex options, directory search
4724 @cindex search path
4726 These options specify directories to search for header files, for
4727 libraries and for parts of the compiler:
4729 @table @gcctabopt
4730 @item -I@var{dir}
4731 @opindex I
4732 Add the directory @var{dir} to the head of the list of directories to be
4733 searched for header files.  This can be used to override a system header
4734 file, substituting your own version, since these directories are
4735 searched before the system header file directories.  However, you should
4736 not use this option to add directories that contain vendor-supplied
4737 system header files (use @option{-isystem} for that).  If you use more than
4738 one @option{-I} option, the directories are scanned in left-to-right
4739 order; the standard system directories come after.
4741 If a standard system include directory, or a directory specified with
4742 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4743 option will be ignored.  The directory will still be searched but as a
4744 system directory at its normal position in the system include chain.
4745 This is to ensure that GCC's procedure to fix buggy system headers and
4746 the ordering for the include_next directive are not inadvertently changed.
4747 If you really need to change the search order for system directories,
4748 use the @option{-nostdinc} and/or @option{-isystem} options.
4750 @item -I-
4751 @opindex I-
4752 Any directories you specify with @option{-I} options before the @option{-I-}
4753 option are searched only for the case of @samp{#include "@var{file}"};
4754 they are not searched for @samp{#include <@var{file}>}.
4756 If additional directories are specified with @option{-I} options after
4757 the @option{-I-}, these directories are searched for all @samp{#include}
4758 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4759 this way.)
4761 In addition, the @option{-I-} option inhibits the use of the current
4762 directory (where the current input file came from) as the first search
4763 directory for @samp{#include "@var{file}"}.  There is no way to
4764 override this effect of @option{-I-}.  With @option{-I.} you can specify
4765 searching the directory which was current when the compiler was
4766 invoked.  That is not exactly the same as what the preprocessor does
4767 by default, but it is often satisfactory.
4769 @option{-I-} does not inhibit the use of the standard system directories
4770 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4771 independent.
4773 @item -L@var{dir}
4774 @opindex L
4775 Add directory @var{dir} to the list of directories to be searched
4776 for @option{-l}.
4778 @item -B@var{prefix}
4779 @opindex B
4780 This option specifies where to find the executables, libraries,
4781 include files, and data files of the compiler itself.
4783 The compiler driver program runs one or more of the subprograms
4784 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4785 @var{prefix} as a prefix for each program it tries to run, both with and
4786 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4788 For each subprogram to be run, the compiler driver first tries the
4789 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4790 was not specified, the driver tries two standard prefixes, which are
4791 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4792 those results in a file name that is found, the unmodified program
4793 name is searched for using the directories specified in your
4794 @env{PATH} environment variable.
4796 The compiler will check to see if the path provided by the @option{-B}
4797 refers to a directory, and if necessary it will add a directory
4798 separator character at the end of the path.
4800 @option{-B} prefixes that effectively specify directory names also apply
4801 to libraries in the linker, because the compiler translates these
4802 options into @option{-L} options for the linker.  They also apply to
4803 includes files in the preprocessor, because the compiler translates these
4804 options into @option{-isystem} options for the preprocessor.  In this case,
4805 the compiler appends @samp{include} to the prefix.
4807 The run-time support file @file{libgcc.a} can also be searched for using
4808 the @option{-B} prefix, if needed.  If it is not found there, the two
4809 standard prefixes above are tried, and that is all.  The file is left
4810 out of the link if it is not found by those means.
4812 Another way to specify a prefix much like the @option{-B} prefix is to use
4813 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4814 Variables}.
4816 As a special kludge, if the path provided by @option{-B} is
4817 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4818 9, then it will be replaced by @file{[dir/]include}.  This is to help
4819 with boot-strapping the compiler.
4821 @item -specs=@var{file}
4822 @opindex specs
4823 Process @var{file} after the compiler reads in the standard @file{specs}
4824 file, in order to override the defaults that the @file{gcc} driver
4825 program uses when determining what switches to pass to @file{cc1},
4826 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4827 @option{-specs=@var{file}} can be specified on the command line, and they
4828 are processed in order, from left to right.
4829 @end table
4831 @c man end
4833 @node Spec Files
4834 @section Specifying subprocesses and the switches to pass to them
4835 @cindex Spec Files
4836 @command{gcc} is a driver program.  It performs its job by invoking a
4837 sequence of other programs to do the work of compiling, assembling and
4838 linking.  GCC interprets its command-line parameters and uses these to
4839 deduce which programs it should invoke, and which command-line options
4840 it ought to place on their command lines.  This behavior is controlled
4841 by @dfn{spec strings}.  In most cases there is one spec string for each
4842 program that GCC can invoke, but a few programs have multiple spec
4843 strings to control their behavior.  The spec strings built into GCC can
4844 be overridden by using the @option{-specs=} command-line switch to specify
4845 a spec file.
4847 @dfn{Spec files} are plaintext files that are used to construct spec
4848 strings.  They consist of a sequence of directives separated by blank
4849 lines.  The type of directive is determined by the first non-whitespace
4850 character on the line and it can be one of the following:
4852 @table @code
4853 @item %@var{command}
4854 Issues a @var{command} to the spec file processor.  The commands that can
4855 appear here are:
4857 @table @code
4858 @item %include <@var{file}>
4859 @cindex %include
4860 Search for @var{file} and insert its text at the current point in the
4861 specs file.
4863 @item %include_noerr <@var{file}>
4864 @cindex %include_noerr
4865 Just like @samp{%include}, but do not generate an error message if the include
4866 file cannot be found.
4868 @item %rename @var{old_name} @var{new_name}
4869 @cindex %rename
4870 Rename the spec string @var{old_name} to @var{new_name}.
4872 @end table
4874 @item *[@var{spec_name}]:
4875 This tells the compiler to create, override or delete the named spec
4876 string.  All lines after this directive up to the next directive or
4877 blank line are considered to be the text for the spec string.  If this
4878 results in an empty string then the spec will be deleted.  (Or, if the
4879 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4880 does not currently exist a new spec will be created.  If the spec does
4881 exist then its contents will be overridden by the text of this
4882 directive, unless the first character of that text is the @samp{+}
4883 character, in which case the text will be appended to the spec.
4885 @item [@var{suffix}]:
4886 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4887 and up to the next directive or blank line are considered to make up the
4888 spec string for the indicated suffix.  When the compiler encounters an
4889 input file with the named suffix, it will processes the spec string in
4890 order to work out how to compile that file.  For example:
4892 @smallexample
4893 .ZZ:
4894 z-compile -input %i
4895 @end smallexample
4897 This says that any input file whose name ends in @samp{.ZZ} should be
4898 passed to the program @samp{z-compile}, which should be invoked with the
4899 command-line switch @option{-input} and with the result of performing the
4900 @samp{%i} substitution.  (See below.)
4902 As an alternative to providing a spec string, the text that follows a
4903 suffix directive can be one of the following:
4905 @table @code
4906 @item @@@var{language}
4907 This says that the suffix is an alias for a known @var{language}.  This is
4908 similar to using the @option{-x} command-line switch to GCC to specify a
4909 language explicitly.  For example:
4911 @smallexample
4912 .ZZ:
4913 @@c++
4914 @end smallexample
4916 Says that .ZZ files are, in fact, C++ source files.
4918 @item #@var{name}
4919 This causes an error messages saying:
4921 @smallexample
4922 @var{name} compiler not installed on this system.
4923 @end smallexample
4924 @end table
4926 GCC already has an extensive list of suffixes built into it.
4927 This directive will add an entry to the end of the list of suffixes, but
4928 since the list is searched from the end backwards, it is effectively
4929 possible to override earlier entries using this technique.
4931 @end table
4933 GCC has the following spec strings built into it.  Spec files can
4934 override these strings or create their own.  Note that individual
4935 targets can also add their own spec strings to this list.
4937 @smallexample
4938 asm          Options to pass to the assembler
4939 asm_final    Options to pass to the assembler post-processor
4940 cpp          Options to pass to the C preprocessor
4941 cc1          Options to pass to the C compiler
4942 cc1plus      Options to pass to the C++ compiler
4943 endfile      Object files to include at the end of the link
4944 link         Options to pass to the linker
4945 lib          Libraries to include on the command line to the linker
4946 libgcc       Decides which GCC support library to pass to the linker
4947 linker       Sets the name of the linker
4948 predefines   Defines to be passed to the C preprocessor
4949 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4950              by default
4951 startfile    Object files to include at the start of the link
4952 @end smallexample
4954 Here is a small example of a spec file:
4956 @smallexample
4957 %rename lib                 old_lib
4959 *lib:
4960 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4961 @end smallexample
4963 This example renames the spec called @samp{lib} to @samp{old_lib} and
4964 then overrides the previous definition of @samp{lib} with a new one.
4965 The new definition adds in some extra command-line options before
4966 including the text of the old definition.
4968 @dfn{Spec strings} are a list of command-line options to be passed to their
4969 corresponding program.  In addition, the spec strings can contain
4970 @samp{%}-prefixed sequences to substitute variable text or to
4971 conditionally insert text into the command line.  Using these constructs
4972 it is possible to generate quite complex command lines.
4974 Here is a table of all defined @samp{%}-sequences for spec
4975 strings.  Note that spaces are not generated automatically around the
4976 results of expanding these sequences.  Therefore you can concatenate them
4977 together or combine them with constant text in a single argument.
4979 @table @code
4980 @item %%
4981 Substitute one @samp{%} into the program name or argument.
4983 @item %i
4984 Substitute the name of the input file being processed.
4986 @item %b
4987 Substitute the basename of the input file being processed.
4988 This is the substring up to (and not including) the last period
4989 and not including the directory.
4991 @item %B
4992 This is the same as @samp{%b}, but include the file suffix (text after
4993 the last period).
4995 @item %d
4996 Marks the argument containing or following the @samp{%d} as a
4997 temporary file name, so that that file will be deleted if GCC exits
4998 successfully.  Unlike @samp{%g}, this contributes no text to the
4999 argument.
5001 @item %g@var{suffix}
5002 Substitute a file name that has suffix @var{suffix} and is chosen
5003 once per compilation, and mark the argument in the same way as
5004 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5005 name is now chosen in a way that is hard to predict even when previously
5006 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5007 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5008 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5009 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5010 was simply substituted with a file name chosen once per compilation,
5011 without regard to any appended suffix (which was therefore treated
5012 just like ordinary text), making such attacks more likely to succeed.
5014 @item %u@var{suffix}
5015 Like @samp{%g}, but generates a new temporary file name even if
5016 @samp{%u@var{suffix}} was already seen.
5018 @item %U@var{suffix}
5019 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5020 new one if there is no such last file name.  In the absence of any
5021 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5022 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5023 would involve the generation of two distinct file names, one
5024 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5025 simply substituted with a file name chosen for the previous @samp{%u},
5026 without regard to any appended suffix.
5028 @item %j@var{suffix}
5029 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5030 writable, and if save-temps is off; otherwise, substitute the name
5031 of a temporary file, just like @samp{%u}.  This temporary file is not
5032 meant for communication between processes, but rather as a junk
5033 disposal mechanism.
5035 @item %|@var{suffix}
5036 @itemx %m@var{suffix}
5037 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5038 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5039 all.  These are the two most common ways to instruct a program that it
5040 should read from standard input or write to standard output.  If you
5041 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5042 construct: see for example @file{f/lang-specs.h}.
5044 @item %.@var{SUFFIX}
5045 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5046 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5047 terminated by the next space or %.
5049 @item %w
5050 Marks the argument containing or following the @samp{%w} as the
5051 designated output file of this compilation.  This puts the argument
5052 into the sequence of arguments that @samp{%o} will substitute later.
5054 @item %o
5055 Substitutes the names of all the output files, with spaces
5056 automatically placed around them.  You should write spaces
5057 around the @samp{%o} as well or the results are undefined.
5058 @samp{%o} is for use in the specs for running the linker.
5059 Input files whose names have no recognized suffix are not compiled
5060 at all, but they are included among the output files, so they will
5061 be linked.
5063 @item %O
5064 Substitutes the suffix for object files.  Note that this is
5065 handled specially when it immediately follows @samp{%g, %u, or %U},
5066 because of the need for those to form complete file names.  The
5067 handling is such that @samp{%O} is treated exactly as if it had already
5068 been substituted, except that @samp{%g, %u, and %U} do not currently
5069 support additional @var{suffix} characters following @samp{%O} as they would
5070 following, for example, @samp{.o}.
5072 @item %p
5073 Substitutes the standard macro predefinitions for the
5074 current target machine.  Use this when running @code{cpp}.
5076 @item %P
5077 Like @samp{%p}, but puts @samp{__} before and after the name of each
5078 predefined macro, except for macros that start with @samp{__} or with
5079 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5082 @item %I
5083 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
5085 @item %s
5086 Current argument is the name of a library or startup file of some sort.
5087 Search for that file in a standard list of directories and substitute
5088 the full name found.
5090 @item %e@var{str}
5091 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5092 Use this when inconsistent options are detected.
5094 @item %(@var{name})
5095 Substitute the contents of spec string @var{name} at this point.
5097 @item %[@var{name}]
5098 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5100 @item %x@{@var{option}@}
5101 Accumulate an option for @samp{%X}.
5103 @item %X
5104 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5105 spec string.
5107 @item %Y
5108 Output the accumulated assembler options specified by @option{-Wa}.
5110 @item %Z
5111 Output the accumulated preprocessor options specified by @option{-Wp}.
5113 @item %v1
5114 Substitute the major version number of GCC@.
5115 (For version 2.9.5, this is 2.)
5117 @item %v2
5118 Substitute the minor version number of GCC@.
5119 (For version 2.9.5, this is 9.)
5121 @item %v3
5122 Substitute the patch level number of GCC@.
5123 (For version 2.9.5, this is 5.)
5125 @item %a
5126 Process the @code{asm} spec.  This is used to compute the
5127 switches to be passed to the assembler.
5129 @item %A
5130 Process the @code{asm_final} spec.  This is a spec string for
5131 passing switches to an assembler post-processor, if such a program is
5132 needed.
5134 @item %l
5135 Process the @code{link} spec.  This is the spec for computing the
5136 command line passed to the linker.  Typically it will make use of the
5137 @samp{%L %G %S %D and %E} sequences.
5139 @item %D
5140 Dump out a @option{-L} option for each directory that GCC believes might
5141 contain startup files.  If the target supports multilibs then the
5142 current multilib directory will be prepended to each of these paths.
5144 @item %M
5145 Output the multilib directory with directory separators replaced with
5146 @samp{_}.  If multilib directories are not set, or the multilib directory is
5147 @file{.} then this option emits nothing.
5149 @item %L
5150 Process the @code{lib} spec.  This is a spec string for deciding which
5151 libraries should be included on the command line to the linker.
5153 @item %G
5154 Process the @code{libgcc} spec.  This is a spec string for deciding
5155 which GCC support library should be included on the command line to the linker.
5157 @item %S
5158 Process the @code{startfile} spec.  This is a spec for deciding which
5159 object files should be the first ones passed to the linker.  Typically
5160 this might be a file named @file{crt0.o}.
5162 @item %E
5163 Process the @code{endfile} spec.  This is a spec string that specifies
5164 the last object files that will be passed to the linker.
5166 @item %C
5167 Process the @code{cpp} spec.  This is used to construct the arguments
5168 to be passed to the C preprocessor.
5170 @item %c
5171 Process the @code{signed_char} spec.  This is intended to be used
5172 to tell cpp whether a char is signed.  It typically has the definition:
5173 @smallexample
5174 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5175 @end smallexample
5177 @item %1
5178 Process the @code{cc1} spec.  This is used to construct the options to be
5179 passed to the actual C compiler (@samp{cc1}).
5181 @item %2
5182 Process the @code{cc1plus} spec.  This is used to construct the options to be
5183 passed to the actual C++ compiler (@samp{cc1plus}).
5185 @item %*
5186 Substitute the variable part of a matched option.  See below.
5187 Note that each comma in the substituted string is replaced by
5188 a single space.
5190 @item %<@code{S}
5191 Remove all occurrences of @code{-S} from the command line.  Note---this
5192 command is position dependent.  @samp{%} commands in the spec string
5193 before this one will see @code{-S}, @samp{%} commands in the spec string
5194 after this one will not.
5196 @item %:@var{function}(@var{args})
5197 Call the named function @var{function}, passing it @var{args}.
5198 @var{args} is first processed as a nested spec string, then split
5199 into an argument vector in the usual fashion.  The function returns
5200 a string which is processed as if it had appeared literally as part
5201 of the current spec.
5203 The following built-in spec functions are provided:
5205 @table @code
5206 @item @code{if-exists}
5207 The @code{if-exists} spec function takes one argument, an absolute
5208 pathname to a file.  If the file exists, @code{if-exists} returns the
5209 pathname.  Here is a small example of its usage:
5211 @smallexample
5212 *startfile:
5213 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5214 @end smallexample
5216 @item @code{if-exists-else}
5217 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5218 spec function, except that it takes two arguments.  The first argument is
5219 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5220 returns the pathname.  If it does not exist, it returns the second argument.
5221 This way, @code{if-exists-else} can be used to select one file or another,
5222 based on the existence of the first.  Here is a small example of its usage:
5224 @smallexample 
5225 *startfile:
5226 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5227 @end smallexample
5228 @end table 
5230 @item %@{@code{S}@}
5231 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5232 If that switch was not specified, this substitutes nothing.  Note that
5233 the leading dash is omitted when specifying this option, and it is
5234 automatically inserted if the substitution is performed.  Thus the spec
5235 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5236 and would output the command line option @option{-foo}.
5238 @item %W@{@code{S}@}
5239 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5240 deleted on failure.
5242 @item %@{@code{S}*@}
5243 Substitutes all the switches specified to GCC whose names start
5244 with @code{-S}, but which also take an argument.  This is used for
5245 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5246 GCC considers @option{-o foo} as being
5247 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5248 text, including the space.  Thus two arguments would be generated.
5250 @item %@{@code{S}*&@code{T}*@}
5251 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5252 (the order of @code{S} and @code{T} in the spec is not significant).
5253 There can be any number of ampersand-separated variables; for each the
5254 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5256 @item %@{@code{S}:@code{X}@}
5257 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5259 @item %@{!@code{S}:@code{X}@}
5260 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5262 @item %@{@code{S}*:@code{X}@}
5263 Substitutes @code{X} if one or more switches whose names start with
5264 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5265 once, no matter how many such switches appeared.  However, if @code{%*}
5266 appears somewhere in @code{X}, then @code{X} will be substituted once
5267 for each matching switch, with the @code{%*} replaced by the part of
5268 that switch that matched the @code{*}.
5270 @item %@{.@code{S}:@code{X}@}
5271 Substitutes @code{X}, if processing a file with suffix @code{S}.
5273 @item %@{!.@code{S}:@code{X}@}
5274 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5276 @item %@{@code{S}|@code{P}:@code{X}@}
5277 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5278 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5279 although they have a stronger binding than the @samp{|}.  If @code{%*}
5280 appears in @code{X}, all of the alternatives must be starred, and only
5281 the first matching alternative is substituted.
5283 For example, a spec string like this:
5285 @smallexample
5286 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5287 @end smallexample
5289 will output the following command-line options from the following input
5290 command-line options:
5292 @smallexample
5293 fred.c        -foo -baz
5294 jim.d         -bar -boggle
5295 -d fred.c     -foo -baz -boggle
5296 -d jim.d      -bar -baz -boggle
5297 @end smallexample
5299 @item %@{S:X; T:Y; :D@}
5301 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5302 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5303 be as many clauses as you need.  This may be combined with @code{.}, 
5304 @code{!}, @code{|}, and @code{*} as needed.
5307 @end table
5309 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5310 construct may contain other nested @samp{%} constructs or spaces, or
5311 even newlines.  They are processed as usual, as described above.
5312 Trailing white space in @code{X} is ignored.  White space may also
5313 appear anywhere on the left side of the colon in these constructs,
5314 except between @code{.} or @code{*} and the corresponding word.
5316 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5317 handled specifically in these constructs.  If another value of
5318 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5319 @option{-W} switch is found later in the command line, the earlier
5320 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5321 just one letter, which passes all matching options.
5323 The character @samp{|} at the beginning of the predicate text is used to
5324 indicate that a command should be piped to the following command, but
5325 only if @option{-pipe} is specified.
5327 It is built into GCC which switches take arguments and which do not.
5328 (You might think it would be useful to generalize this to allow each
5329 compiler's spec to say which switches take arguments.  But this cannot
5330 be done in a consistent fashion.  GCC cannot even decide which input
5331 files have been specified without knowing which switches take arguments,
5332 and it must know which input files to compile in order to tell which
5333 compilers to run).
5335 GCC also knows implicitly that arguments starting in @option{-l} are to be
5336 treated as compiler output files, and passed to the linker in their
5337 proper position among the other output files.
5339 @c man begin OPTIONS
5341 @node Target Options
5342 @section Specifying Target Machine and Compiler Version
5343 @cindex target options
5344 @cindex cross compiling
5345 @cindex specifying machine version
5346 @cindex specifying compiler version and target machine
5347 @cindex compiler version, specifying
5348 @cindex target machine, specifying
5350 The usual way to run GCC is to run the executable called @file{gcc}, or
5351 @file{<machine>-gcc} when cross-compiling, or
5352 @file{<machine>-gcc-<version>} to run a version other than the one that
5353 was installed last.  Sometimes this is inconvenient, so GCC provides
5354 options that will switch to another cross-compiler or version.
5356 @table @gcctabopt
5357 @item -b @var{machine}
5358 @opindex b
5359 The argument @var{machine} specifies the target machine for compilation.
5361 The value to use for @var{machine} is the same as was specified as the
5362 machine type when configuring GCC as a cross-compiler.  For
5363 example, if a cross-compiler was configured with @samp{configure
5364 i386v}, meaning to compile for an 80386 running System V, then you
5365 would specify @option{-b i386v} to run that cross compiler.
5367 @item -V @var{version}
5368 @opindex V
5369 The argument @var{version} specifies which version of GCC to run.
5370 This is useful when multiple versions are installed.  For example,
5371 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5372 @end table
5374 The @option{-V} and @option{-b} options work by running the
5375 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5376 use them if you can just run that directly.
5378 @node Submodel Options
5379 @section Hardware Models and Configurations
5380 @cindex submodel options
5381 @cindex specifying hardware config
5382 @cindex hardware models and configurations, specifying
5383 @cindex machine dependent options
5385 Earlier we discussed the standard option @option{-b} which chooses among
5386 different installed compilers for completely different target
5387 machines, such as VAX vs.@: 68000 vs.@: 80386.
5389 In addition, each of these target machine types can have its own
5390 special options, starting with @samp{-m}, to choose among various
5391 hardware models or configurations---for example, 68010 vs 68020,
5392 floating coprocessor or none.  A single installed version of the
5393 compiler can compile for any model or configuration, according to the
5394 options specified.
5396 Some configurations of the compiler also support additional special
5397 options, usually for compatibility with other compilers on the same
5398 platform.
5400 These options are defined by the macro @code{TARGET_SWITCHES} in the
5401 machine description.  The default for the options is also defined by
5402 that macro, which enables you to change the defaults.
5404 @menu
5405 * M680x0 Options::
5406 * M68hc1x Options::
5407 * VAX Options::
5408 * SPARC Options::
5409 * ARM Options::
5410 * MN10200 Options::
5411 * MN10300 Options::
5412 * M32R/D Options::
5413 * M88K Options::
5414 * RS/6000 and PowerPC Options::
5415 * Darwin Options::
5416 * RT Options::
5417 * MIPS Options::
5418 * i386 and x86-64 Options::
5419 * HPPA Options::
5420 * Intel 960 Options::
5421 * DEC Alpha Options::
5422 * DEC Alpha/VMS Options::
5423 * H8/300 Options::
5424 * SH Options::
5425 * System V Options::
5426 * TMS320C3x/C4x Options::
5427 * V850 Options::
5428 * ARC Options::
5429 * NS32K Options::
5430 * AVR Options::
5431 * MCore Options::
5432 * IA-64 Options::
5433 * D30V Options::
5434 * S/390 and zSeries Options::
5435 * CRIS Options::
5436 * MMIX Options::
5437 * PDP-11 Options::
5438 * Xstormy16 Options::
5439 * Xtensa Options::
5440 * FRV Options::
5441 @end menu
5443 @node M680x0 Options
5444 @subsection M680x0 Options
5445 @cindex M680x0 options
5447 These are the @samp{-m} options defined for the 68000 series.  The default
5448 values for these options depends on which style of 68000 was selected when
5449 the compiler was configured; the defaults for the most common choices are
5450 given below.
5452 @table @gcctabopt
5453 @item -m68000
5454 @itemx -mc68000
5455 @opindex m68000
5456 @opindex mc68000
5457 Generate output for a 68000.  This is the default
5458 when the compiler is configured for 68000-based systems.
5460 Use this option for microcontrollers with a 68000 or EC000 core,
5461 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5463 @item -m68020
5464 @itemx -mc68020
5465 @opindex m68020
5466 @opindex mc68020
5467 Generate output for a 68020.  This is the default
5468 when the compiler is configured for 68020-based systems.
5470 @item -m68881
5471 @opindex m68881
5472 Generate output containing 68881 instructions for floating point.
5473 This is the default for most 68020 systems unless @option{--nfp} was
5474 specified when the compiler was configured.
5476 @item -m68030
5477 @opindex m68030
5478 Generate output for a 68030.  This is the default when the compiler is
5479 configured for 68030-based systems.
5481 @item -m68040
5482 @opindex m68040
5483 Generate output for a 68040.  This is the default when the compiler is
5484 configured for 68040-based systems.
5486 This option inhibits the use of 68881/68882 instructions that have to be
5487 emulated by software on the 68040.  Use this option if your 68040 does not
5488 have code to emulate those instructions.
5490 @item -m68060
5491 @opindex m68060
5492 Generate output for a 68060.  This is the default when the compiler is
5493 configured for 68060-based systems.
5495 This option inhibits the use of 68020 and 68881/68882 instructions that
5496 have to be emulated by software on the 68060.  Use this option if your 68060
5497 does not have code to emulate those instructions.
5499 @item -mcpu32
5500 @opindex mcpu32
5501 Generate output for a CPU32.  This is the default
5502 when the compiler is configured for CPU32-based systems.
5504 Use this option for microcontrollers with a
5505 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5506 68336, 68340, 68341, 68349 and 68360.
5508 @item -m5200
5509 @opindex m5200
5510 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5511 when the compiler is configured for 520X-based systems.
5513 Use this option for microcontroller with a 5200 core, including
5514 the MCF5202, MCF5203, MCF5204 and MCF5202.
5517 @item -m68020-40
5518 @opindex m68020-40
5519 Generate output for a 68040, without using any of the new instructions.
5520 This results in code which can run relatively efficiently on either a
5521 68020/68881 or a 68030 or a 68040.  The generated code does use the
5522 68881 instructions that are emulated on the 68040.
5524 @item -m68020-60
5525 @opindex m68020-60
5526 Generate output for a 68060, without using any of the new instructions.
5527 This results in code which can run relatively efficiently on either a
5528 68020/68881 or a 68030 or a 68040.  The generated code does use the
5529 68881 instructions that are emulated on the 68060.
5531 @item -mfpa
5532 @opindex mfpa
5533 Generate output containing Sun FPA instructions for floating point.
5535 @item -msoft-float
5536 @opindex msoft-float
5537 Generate output containing library calls for floating point.
5538 @strong{Warning:} the requisite libraries are not available for all m68k
5539 targets.  Normally the facilities of the machine's usual C compiler are
5540 used, but this can't be done directly in cross-compilation.  You must
5541 make your own arrangements to provide suitable library functions for
5542 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5543 @samp{m68k-*-coff} do provide software floating point support.
5545 @item -mshort
5546 @opindex mshort
5547 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5549 @item -mnobitfield
5550 @opindex mnobitfield
5551 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5552 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5554 @item -mbitfield
5555 @opindex mbitfield
5556 Do use the bit-field instructions.  The @option{-m68020} option implies
5557 @option{-mbitfield}.  This is the default if you use a configuration
5558 designed for a 68020.
5560 @item -mrtd
5561 @opindex mrtd
5562 Use a different function-calling convention, in which functions
5563 that take a fixed number of arguments return with the @code{rtd}
5564 instruction, which pops their arguments while returning.  This
5565 saves one instruction in the caller since there is no need to pop
5566 the arguments there.
5568 This calling convention is incompatible with the one normally
5569 used on Unix, so you cannot use it if you need to call libraries
5570 compiled with the Unix compiler.
5572 Also, you must provide function prototypes for all functions that
5573 take variable numbers of arguments (including @code{printf});
5574 otherwise incorrect code will be generated for calls to those
5575 functions.
5577 In addition, seriously incorrect code will result if you call a
5578 function with too many arguments.  (Normally, extra arguments are
5579 harmlessly ignored.)
5581 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5582 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5584 @item -malign-int
5585 @itemx -mno-align-int
5586 @opindex malign-int
5587 @opindex mno-align-int
5588 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5589 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5590 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5591 Aligning variables on 32-bit boundaries produces code that runs somewhat
5592 faster on processors with 32-bit busses at the expense of more memory.
5594 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5595 align structures containing the above types  differently than
5596 most published application binary interface specifications for the m68k.
5598 @item -mpcrel
5599 @opindex mpcrel
5600 Use the pc-relative addressing mode of the 68000 directly, instead of
5601 using a global offset table.  At present, this option implies @option{-fpic},
5602 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5603 not presently supported with @option{-mpcrel}, though this could be supported for
5604 68020 and higher processors.
5606 @item -mno-strict-align
5607 @itemx -mstrict-align
5608 @opindex mno-strict-align
5609 @opindex mstrict-align
5610 Do not (do) assume that unaligned memory references will be handled by
5611 the system.
5613 @end table
5615 @node M68hc1x Options
5616 @subsection M68hc1x Options
5617 @cindex M68hc1x options
5619 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5620 microcontrollers.  The default values for these options depends on
5621 which style of microcontroller was selected when the compiler was configured;
5622 the defaults for the most common choices are given below.
5624 @table @gcctabopt
5625 @item -m6811
5626 @itemx -m68hc11
5627 @opindex m6811
5628 @opindex m68hc11
5629 Generate output for a 68HC11.  This is the default
5630 when the compiler is configured for 68HC11-based systems.
5632 @item -m6812
5633 @itemx -m68hc12
5634 @opindex m6812
5635 @opindex m68hc12
5636 Generate output for a 68HC12.  This is the default
5637 when the compiler is configured for 68HC12-based systems.
5639 @item -m68S12
5640 @itemx -m68hcs12
5641 @opindex m68S12
5642 @opindex m68hcs12
5643 Generate output for a 68HCS12.  
5645 @item -mauto-incdec
5646 @opindex mauto-incdec
5647 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5648 addressing modes.
5650 @item -minmax
5651 @itemx -nominmax
5652 @opindex minmax
5653 @opindex mnominmax
5654 Enable the use of 68HC12 min and max instructions.
5656 @item -mlong-calls
5657 @itemx -mno-long-calls
5658 @opindex mlong-calls
5659 @opindex mno-long-calls
5660 Treat all calls as being far away (near).  If calls are assumed to be
5661 far away, the compiler will use the @code{call} instruction to
5662 call a function and the @code{rtc} instruction for returning.
5664 @item -mshort
5665 @opindex mshort
5666 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5668 @item -msoft-reg-count=@var{count}
5669 @opindex msoft-reg-count
5670 Specify the number of pseudo-soft registers which are used for the
5671 code generation.  The maximum number is 32.  Using more pseudo-soft
5672 register may or may not result in better code depending on the program.
5673 The default is 4 for 68HC11 and 2 for 68HC12.
5675 @end table
5677 @node VAX Options
5678 @subsection VAX Options
5679 @cindex VAX options
5681 These @samp{-m} options are defined for the VAX:
5683 @table @gcctabopt
5684 @item -munix
5685 @opindex munix
5686 Do not output certain jump instructions (@code{aobleq} and so on)
5687 that the Unix assembler for the VAX cannot handle across long
5688 ranges.
5690 @item -mgnu
5691 @opindex mgnu
5692 Do output those jump instructions, on the assumption that you
5693 will assemble with the GNU assembler.
5695 @item -mg
5696 @opindex mg
5697 Output code for g-format floating point numbers instead of d-format.
5698 @end table
5700 @node SPARC Options
5701 @subsection SPARC Options
5702 @cindex SPARC options
5704 These @samp{-m} switches are supported on the SPARC:
5706 @table @gcctabopt
5707 @item -mno-app-regs
5708 @itemx -mapp-regs
5709 @opindex mno-app-regs
5710 @opindex mapp-regs
5711 Specify @option{-mapp-regs} to generate output using the global registers
5712 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5713 is the default.
5715 To be fully SVR4 ABI compliant at the cost of some performance loss,
5716 specify @option{-mno-app-regs}.  You should compile libraries and system
5717 software with this option.
5719 @item -mfpu
5720 @itemx -mhard-float
5721 @opindex mfpu
5722 @opindex mhard-float
5723 Generate output containing floating point instructions.  This is the
5724 default.
5726 @item -mno-fpu
5727 @itemx -msoft-float
5728 @opindex mno-fpu
5729 @opindex msoft-float
5730 Generate output containing library calls for floating point.
5731 @strong{Warning:} the requisite libraries are not available for all SPARC
5732 targets.  Normally the facilities of the machine's usual C compiler are
5733 used, but this cannot be done directly in cross-compilation.  You must make
5734 your own arrangements to provide suitable library functions for
5735 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5736 @samp{sparclite-*-*} do provide software floating point support.
5738 @option{-msoft-float} changes the calling convention in the output file;
5739 therefore, it is only useful if you compile @emph{all} of a program with
5740 this option.  In particular, you need to compile @file{libgcc.a}, the
5741 library that comes with GCC, with @option{-msoft-float} in order for
5742 this to work.
5744 @item -mhard-quad-float
5745 @opindex mhard-quad-float
5746 Generate output containing quad-word (long double) floating point
5747 instructions.
5749 @item -msoft-quad-float
5750 @opindex msoft-quad-float
5751 Generate output containing library calls for quad-word (long double)
5752 floating point instructions.  The functions called are those specified
5753 in the SPARC ABI@.  This is the default.
5755 As of this writing, there are no sparc implementations that have hardware
5756 support for the quad-word floating point instructions.  They all invoke
5757 a trap handler for one of these instructions, and then the trap handler
5758 emulates the effect of the instruction.  Because of the trap handler overhead,
5759 this is much slower than calling the ABI library routines.  Thus the
5760 @option{-msoft-quad-float} option is the default.
5762 @item -mno-flat
5763 @itemx -mflat
5764 @opindex mno-flat
5765 @opindex mflat
5766 With @option{-mflat}, the compiler does not generate save/restore instructions
5767 and will use a ``flat'' or single register window calling convention.
5768 This model uses %i7 as the frame pointer and is compatible with the normal
5769 register window model.  Code from either may be intermixed.
5770 The local registers and the input registers (0--5) are still treated as
5771 ``call saved'' registers and will be saved on the stack as necessary.
5773 With @option{-mno-flat} (the default), the compiler emits save/restore
5774 instructions (except for leaf functions) and is the normal mode of operation.
5776 @item -mno-unaligned-doubles
5777 @itemx -munaligned-doubles
5778 @opindex mno-unaligned-doubles
5779 @opindex munaligned-doubles
5780 Assume that doubles have 8 byte alignment.  This is the default.
5782 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5783 alignment only if they are contained in another type, or if they have an
5784 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5785 Specifying this option avoids some rare compatibility problems with code
5786 generated by other compilers.  It is not the default because it results
5787 in a performance loss, especially for floating point code.
5789 @item -mno-faster-structs
5790 @itemx -mfaster-structs
5791 @opindex mno-faster-structs
5792 @opindex mfaster-structs
5793 With @option{-mfaster-structs}, the compiler assumes that structures
5794 should have 8 byte alignment.  This enables the use of pairs of
5795 @code{ldd} and @code{std} instructions for copies in structure
5796 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5797 However, the use of this changed alignment directly violates the SPARC
5798 ABI@.  Thus, it's intended only for use on targets where the developer
5799 acknowledges that their resulting code will not be directly in line with
5800 the rules of the ABI@.
5802 @item -mv8
5803 @itemx -msparclite
5804 @opindex mv8
5805 @opindex msparclite
5806 These two options select variations on the SPARC architecture.
5808 By default (unless specifically configured for the Fujitsu SPARClite),
5809 GCC generates code for the v7 variant of the SPARC architecture.
5811 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5812 code is that the compiler emits the integer multiply and integer
5813 divide instructions which exist in SPARC v8 but not in SPARC v7.
5815 @option{-msparclite} will give you SPARClite code.  This adds the integer
5816 multiply, integer divide step and scan (@code{ffs}) instructions which
5817 exist in SPARClite but not in SPARC v7.
5819 These options are deprecated and will be deleted in a future GCC release.
5820 They have been replaced with @option{-mcpu=xxx}.
5822 @item -mcypress
5823 @itemx -msupersparc
5824 @opindex mcypress
5825 @opindex msupersparc
5826 These two options select the processor for which the code is optimized.
5828 With @option{-mcypress} (the default), the compiler optimizes code for the
5829 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5830 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5832 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5833 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5834 of the full SPARC v8 instruction set.
5836 These options are deprecated and will be deleted in a future GCC release.
5837 They have been replaced with @option{-mcpu=xxx}.
5839 @item -mcpu=@var{cpu_type}
5840 @opindex mcpu
5841 Set the instruction set, register set, and instruction scheduling parameters
5842 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5843 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5844 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5845 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5846 @samp{ultrasparc3}.
5848 Default instruction scheduling parameters are used for values that select
5849 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5850 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5852 Here is a list of each supported architecture and their supported
5853 implementations.
5855 @smallexample
5856     v7:             cypress
5857     v8:             supersparc, hypersparc
5858     sparclite:      f930, f934, sparclite86x
5859     sparclet:       tsc701
5860     v9:             ultrasparc, ultrasparc3
5861 @end smallexample
5863 @item -mtune=@var{cpu_type}
5864 @opindex mtune
5865 Set the instruction scheduling parameters for machine type
5866 @var{cpu_type}, but do not set the instruction set or register set that the
5867 option @option{-mcpu=@var{cpu_type}} would.
5869 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5870 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5871 that select a particular cpu implementation.  Those are @samp{cypress},
5872 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5873 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5874 @samp{ultrasparc3}.
5876 @end table
5878 These @samp{-m} switches are supported in addition to the above
5879 on the SPARCLET processor.
5881 @table @gcctabopt
5882 @item -mlittle-endian
5883 @opindex mlittle-endian
5884 Generate code for a processor running in little-endian mode.
5886 @item -mlive-g0
5887 @opindex mlive-g0
5888 Treat register @code{%g0} as a normal register.
5889 GCC will continue to clobber it as necessary but will not assume
5890 it always reads as 0.
5892 @item -mbroken-saverestore
5893 @opindex mbroken-saverestore
5894 Generate code that does not use non-trivial forms of the @code{save} and
5895 @code{restore} instructions.  Early versions of the SPARCLET processor do
5896 not correctly handle @code{save} and @code{restore} instructions used with
5897 arguments.  They correctly handle them used without arguments.  A @code{save}
5898 instruction used without arguments increments the current window pointer
5899 but does not allocate a new stack frame.  It is assumed that the window
5900 overflow trap handler will properly handle this case as will interrupt
5901 handlers.
5902 @end table
5904 These @samp{-m} switches are supported in addition to the above
5905 on SPARC V9 processors in 64-bit environments.
5907 @table @gcctabopt
5908 @item -mlittle-endian
5909 @opindex mlittle-endian
5910 Generate code for a processor running in little-endian mode.
5912 @item -m32
5913 @itemx -m64
5914 @opindex m32
5915 @opindex m64
5916 Generate code for a 32-bit or 64-bit environment.
5917 The 32-bit environment sets int, long and pointer to 32 bits.
5918 The 64-bit environment sets int to 32 bits and long and pointer
5919 to 64 bits.
5921 @item -mcmodel=medlow
5922 @opindex mcmodel=medlow
5923 Generate code for the Medium/Low code model: the program must be linked
5924 in the low 32 bits of the address space.  Pointers are 64 bits.
5925 Programs can be statically or dynamically linked.
5927 @item -mcmodel=medmid
5928 @opindex mcmodel=medmid
5929 Generate code for the Medium/Middle code model: the program must be linked
5930 in the low 44 bits of the address space, the text segment must be less than
5931 2G bytes, and data segment must be within 2G of the text segment.
5932 Pointers are 64 bits.
5934 @item -mcmodel=medany
5935 @opindex mcmodel=medany
5936 Generate code for the Medium/Anywhere code model: the program may be linked
5937 anywhere in the address space, the text segment must be less than
5938 2G bytes, and data segment must be within 2G of the text segment.
5939 Pointers are 64 bits.
5941 @item -mcmodel=embmedany
5942 @opindex mcmodel=embmedany
5943 Generate code for the Medium/Anywhere code model for embedded systems:
5944 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5945 (determined at link time).  Register %g4 points to the base of the
5946 data segment.  Pointers are still 64 bits.
5947 Programs are statically linked, PIC is not supported.
5949 @item -mstack-bias
5950 @itemx -mno-stack-bias
5951 @opindex mstack-bias
5952 @opindex mno-stack-bias
5953 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5954 frame pointer if present, are offset by @minus{}2047 which must be added back
5955 when making stack frame references.
5956 Otherwise, assume no such offset is present.
5957 @end table
5959 @node ARM Options
5960 @subsection ARM Options
5961 @cindex ARM options
5963 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5964 architectures:
5966 @table @gcctabopt
5967 @item -mapcs-frame
5968 @opindex mapcs-frame
5969 Generate a stack frame that is compliant with the ARM Procedure Call
5970 Standard for all functions, even if this is not strictly necessary for
5971 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5972 with this option will cause the stack frames not to be generated for
5973 leaf functions.  The default is @option{-mno-apcs-frame}.
5975 @item -mapcs
5976 @opindex mapcs
5977 This is a synonym for @option{-mapcs-frame}.
5979 @item -mapcs-26
5980 @opindex mapcs-26
5981 Generate code for a processor running with a 26-bit program counter,
5982 and conforming to the function calling standards for the APCS 26-bit
5983 option.  This option replaces the @option{-m2} and @option{-m3} options
5984 of previous releases of the compiler.
5986 @item -mapcs-32
5987 @opindex mapcs-32
5988 Generate code for a processor running with a 32-bit program counter,
5989 and conforming to the function calling standards for the APCS 32-bit
5990 option.  This option replaces the @option{-m6} option of previous releases
5991 of the compiler.
5993 @ignore
5994 @c not currently implemented
5995 @item -mapcs-stack-check
5996 @opindex mapcs-stack-check
5997 Generate code to check the amount of stack space available upon entry to
5998 every function (that actually uses some stack space).  If there is
5999 insufficient space available then either the function
6000 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6001 called, depending upon the amount of stack space required.  The run time
6002 system is required to provide these functions.  The default is
6003 @option{-mno-apcs-stack-check}, since this produces smaller code.
6005 @c not currently implemented
6006 @item -mapcs-float
6007 @opindex mapcs-float
6008 Pass floating point arguments using the float point registers.  This is
6009 one of the variants of the APCS@.  This option is recommended if the
6010 target hardware has a floating point unit or if a lot of floating point
6011 arithmetic is going to be performed by the code.  The default is
6012 @option{-mno-apcs-float}, since integer only code is slightly increased in
6013 size if @option{-mapcs-float} is used.
6015 @c not currently implemented
6016 @item -mapcs-reentrant
6017 @opindex mapcs-reentrant
6018 Generate reentrant, position independent code.  The default is
6019 @option{-mno-apcs-reentrant}.
6020 @end ignore
6022 @item -mthumb-interwork
6023 @opindex mthumb-interwork
6024 Generate code which supports calling between the ARM and Thumb
6025 instruction sets.  Without this option the two instruction sets cannot
6026 be reliably used inside one program.  The default is
6027 @option{-mno-thumb-interwork}, since slightly larger code is generated
6028 when @option{-mthumb-interwork} is specified.
6030 @item -mno-sched-prolog
6031 @opindex mno-sched-prolog
6032 Prevent the reordering of instructions in the function prolog, or the
6033 merging of those instruction with the instructions in the function's
6034 body.  This means that all functions will start with a recognizable set
6035 of instructions (or in fact one of a choice from a small set of
6036 different function prologues), and this information can be used to
6037 locate the start if functions inside an executable piece of code.  The
6038 default is @option{-msched-prolog}.
6040 @item -mhard-float
6041 @opindex mhard-float
6042 Generate output containing floating point instructions.  This is the
6043 default.
6045 @item -msoft-float
6046 @opindex msoft-float
6047 Generate output containing library calls for floating point.
6048 @strong{Warning:} the requisite libraries are not available for all ARM
6049 targets.  Normally the facilities of the machine's usual C compiler are
6050 used, but this cannot be done directly in cross-compilation.  You must make
6051 your own arrangements to provide suitable library functions for
6052 cross-compilation.
6054 @option{-msoft-float} changes the calling convention in the output file;
6055 therefore, it is only useful if you compile @emph{all} of a program with
6056 this option.  In particular, you need to compile @file{libgcc.a}, the
6057 library that comes with GCC, with @option{-msoft-float} in order for
6058 this to work.
6060 @item -mlittle-endian
6061 @opindex mlittle-endian
6062 Generate code for a processor running in little-endian mode.  This is
6063 the default for all standard configurations.
6065 @item -mbig-endian
6066 @opindex mbig-endian
6067 Generate code for a processor running in big-endian mode; the default is
6068 to compile code for a little-endian processor.
6070 @item -mwords-little-endian
6071 @opindex mwords-little-endian
6072 This option only applies when generating code for big-endian processors.
6073 Generate code for a little-endian word order but a big-endian byte
6074 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6075 option should only be used if you require compatibility with code for
6076 big-endian ARM processors generated by versions of the compiler prior to
6077 2.8.
6079 @item -malignment-traps
6080 @opindex malignment-traps
6081 Generate code that will not trap if the MMU has alignment traps enabled.
6082 On ARM architectures prior to ARMv4, there were no instructions to
6083 access half-word objects stored in memory.  However, when reading from
6084 memory a feature of the ARM architecture allows a word load to be used,
6085 even if the address is unaligned, and the processor core will rotate the
6086 data as it is being loaded.  This option tells the compiler that such
6087 misaligned accesses will cause a MMU trap and that it should instead
6088 synthesize the access as a series of byte accesses.  The compiler can
6089 still use word accesses to load half-word data if it knows that the
6090 address is aligned to a word boundary.
6092 This option is ignored when compiling for ARM architecture 4 or later,
6093 since these processors have instructions to directly access half-word
6094 objects in memory.
6096 @item -mno-alignment-traps
6097 @opindex mno-alignment-traps
6098 Generate code that assumes that the MMU will not trap unaligned
6099 accesses.  This produces better code when the target instruction set
6100 does not have half-word memory operations (i.e.@: implementations prior to
6101 ARMv4).
6103 Note that you cannot use this option to access unaligned word objects,
6104 since the processor will only fetch one 32-bit aligned object from
6105 memory.
6107 The default setting for most targets is @option{-mno-alignment-traps}, since
6108 this produces better code when there are no half-word memory
6109 instructions available.
6111 @item -mshort-load-bytes
6112 @itemx -mno-short-load-words
6113 @opindex mshort-load-bytes
6114 @opindex mno-short-load-words
6115 These are deprecated aliases for @option{-malignment-traps}.
6117 @item -mno-short-load-bytes
6118 @itemx -mshort-load-words
6119 @opindex mno-short-load-bytes
6120 @opindex mshort-load-words
6121 This are deprecated aliases for @option{-mno-alignment-traps}.
6123 @item -mcpu=@var{name}
6124 @opindex mcpu
6125 This specifies the name of the target ARM processor.  GCC uses this name
6126 to determine what kind of instructions it can emit when generating
6127 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6128 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6129 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6130 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6131 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6132 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6133 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6134 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6135 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6136 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6138 @itemx -mtune=@var{name}
6139 @opindex mtune
6140 This option is very similar to the @option{-mcpu=} option, except that
6141 instead of specifying the actual target processor type, and hence
6142 restricting which instructions can be used, it specifies that GCC should
6143 tune the performance of the code as if the target were of the type
6144 specified in this option, but still choosing the instructions that it
6145 will generate based on the cpu specified by a @option{-mcpu=} option.
6146 For some ARM implementations better performance can be obtained by using
6147 this option.
6149 @item -march=@var{name}
6150 @opindex march
6151 This specifies the name of the target ARM architecture.  GCC uses this
6152 name to determine what kind of instructions it can emit when generating
6153 assembly code.  This option can be used in conjunction with or instead
6154 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6155 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6156 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6158 @item -mfpe=@var{number}
6159 @itemx -mfp=@var{number}
6160 @opindex mfpe
6161 @opindex mfp
6162 This specifies the version of the floating point emulation available on
6163 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6164 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6166 @item -mstructure-size-boundary=@var{n}
6167 @opindex mstructure-size-boundary
6168 The size of all structures and unions will be rounded up to a multiple
6169 of the number of bits set by this option.  Permissible values are 8 and
6170 32.  The default value varies for different toolchains.  For the COFF
6171 targeted toolchain the default value is 8.  Specifying the larger number
6172 can produce faster, more efficient code, but can also increase the size
6173 of the program.  The two values are potentially incompatible.  Code
6174 compiled with one value cannot necessarily expect to work with code or
6175 libraries compiled with the other value, if they exchange information
6176 using structures or unions.
6178 @item -mabort-on-noreturn
6179 @opindex mabort-on-noreturn
6180 Generate a call to the function @code{abort} at the end of a
6181 @code{noreturn} function.  It will be executed if the function tries to
6182 return.
6184 @item -mlong-calls
6185 @itemx -mno-long-calls
6186 @opindex mlong-calls
6187 @opindex mno-long-calls
6188 Tells the compiler to perform function calls by first loading the
6189 address of the function into a register and then performing a subroutine
6190 call on this register.  This switch is needed if the target function
6191 will lie outside of the 64 megabyte addressing range of the offset based
6192 version of subroutine call instruction.
6194 Even if this switch is enabled, not all function calls will be turned
6195 into long calls.  The heuristic is that static functions, functions
6196 which have the @samp{short-call} attribute, functions that are inside
6197 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6198 definitions have already been compiled within the current compilation
6199 unit, will not be turned into long calls.  The exception to this rule is
6200 that weak function definitions, functions with the @samp{long-call}
6201 attribute or the @samp{section} attribute, and functions that are within
6202 the scope of a @samp{#pragma long_calls} directive, will always be
6203 turned into long calls.
6205 This feature is not enabled by default.  Specifying
6206 @option{-mno-long-calls} will restore the default behavior, as will
6207 placing the function calls within the scope of a @samp{#pragma
6208 long_calls_off} directive.  Note these switches have no effect on how
6209 the compiler generates code to handle function calls via function
6210 pointers.
6212 @item -mnop-fun-dllimport
6213 @opindex mnop-fun-dllimport
6214 Disable support for the @code{dllimport} attribute.
6216 @item -msingle-pic-base
6217 @opindex msingle-pic-base
6218 Treat the register used for PIC addressing as read-only, rather than
6219 loading it in the prologue for each function.  The run-time system is
6220 responsible for initializing this register with an appropriate value
6221 before execution begins.
6223 @item -mpic-register=@var{reg}
6224 @opindex mpic-register
6225 Specify the register to be used for PIC addressing.  The default is R10
6226 unless stack-checking is enabled, when R9 is used.
6228 @item -mcirrus-fix-invalid-insns
6229 @opindex -mcirrus-fix-invalid-insns
6230 @opindex -mno-cirrus-fix-invalid-insns
6231 Insert NOPs into the instruction stream to in order to work around
6232 problems with invalid Maverick instruction combinations.  This option
6233 is only valid if the @option{-mcpu=ep9312} option has been used to
6234 enable generation of instructions for the Cirrus Maverick floating
6235 point co-processor.  This option is not enabled by default, since the
6236 problem is only present in older Maverick implemenations.  The default
6237 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6238 switch.
6240 @item -mpoke-function-name
6241 @opindex mpoke-function-name
6242 Write the name of each function into the text section, directly
6243 preceding the function prologue.  The generated code is similar to this:
6245 @smallexample
6246      t0
6247          .ascii "arm_poke_function_name", 0
6248          .align
6249      t1
6250          .word 0xff000000 + (t1 - t0)
6251      arm_poke_function_name
6252          mov     ip, sp
6253          stmfd   sp!, @{fp, ip, lr, pc@}
6254          sub     fp, ip, #4
6255 @end smallexample
6257 When performing a stack backtrace, code can inspect the value of
6258 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6259 location @code{pc - 12} and the top 8 bits are set, then we know that
6260 there is a function name embedded immediately preceding this location
6261 and has length @code{((pc[-3]) & 0xff000000)}.
6263 @item -mthumb
6264 @opindex mthumb
6265 Generate code for the 16-bit Thumb instruction set.  The default is to
6266 use the 32-bit ARM instruction set.
6268 @item -mtpcs-frame
6269 @opindex mtpcs-frame
6270 Generate a stack frame that is compliant with the Thumb Procedure Call
6271 Standard for all non-leaf functions.  (A leaf function is one that does
6272 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6274 @item -mtpcs-leaf-frame
6275 @opindex mtpcs-leaf-frame
6276 Generate a stack frame that is compliant with the Thumb Procedure Call
6277 Standard for all leaf functions.  (A leaf function is one that does
6278 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6280 @item -mcallee-super-interworking
6281 @opindex mcallee-super-interworking
6282 Gives all externally visible functions in the file being compiled an ARM
6283 instruction set header which switches to Thumb mode before executing the
6284 rest of the function.  This allows these functions to be called from
6285 non-interworking code.
6287 @item -mcaller-super-interworking
6288 @opindex mcaller-super-interworking
6289 Allows calls via function pointers (including virtual functions) to
6290 execute correctly regardless of whether the target code has been
6291 compiled for interworking or not.  There is a small overhead in the cost
6292 of executing a function pointer if this option is enabled.
6294 @end table
6296 @node MN10200 Options
6297 @subsection MN10200 Options
6298 @cindex MN10200 options
6299 These @option{-m} options are defined for Matsushita MN10200 architectures:
6300 @table @gcctabopt
6302 @item -mrelax
6303 @opindex mrelax
6304 Indicate to the linker that it should perform a relaxation optimization pass
6305 to shorten branches, calls and absolute memory addresses.  This option only
6306 has an effect when used on the command line for the final link step.
6308 This option makes symbolic debugging impossible.
6309 @end table
6311 @node MN10300 Options
6312 @subsection MN10300 Options
6313 @cindex MN10300 options
6314 These @option{-m} options are defined for Matsushita MN10300 architectures:
6316 @table @gcctabopt
6317 @item -mmult-bug
6318 @opindex mmult-bug
6319 Generate code to avoid bugs in the multiply instructions for the MN10300
6320 processors.  This is the default.
6322 @item -mno-mult-bug
6323 @opindex mno-mult-bug
6324 Do not generate code to avoid bugs in the multiply instructions for the
6325 MN10300 processors.
6327 @item -mam33
6328 @opindex mam33
6329 Generate code which uses features specific to the AM33 processor.
6331 @item -mno-am33
6332 @opindex mno-am33
6333 Do not generate code which uses features specific to the AM33 processor.  This
6334 is the default.
6336 @item -mno-crt0
6337 @opindex mno-crt0
6338 Do not link in the C run-time initialization object file.
6340 @item -mrelax
6341 @opindex mrelax
6342 Indicate to the linker that it should perform a relaxation optimization pass
6343 to shorten branches, calls and absolute memory addresses.  This option only
6344 has an effect when used on the command line for the final link step.
6346 This option makes symbolic debugging impossible.
6347 @end table
6350 @node M32R/D Options
6351 @subsection M32R/D Options
6352 @cindex M32R/D options
6354 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6356 @table @gcctabopt
6357 @item -m32rx
6358 @opindex m32rx
6359 Generate code for the M32R/X@.
6361 @item -m32r
6362 @opindex m32r
6363 Generate code for the M32R@.  This is the default.
6365 @item -mcode-model=small
6366 @opindex mcode-model=small
6367 Assume all objects live in the lower 16MB of memory (so that their addresses
6368 can be loaded with the @code{ld24} instruction), and assume all subroutines
6369 are reachable with the @code{bl} instruction.
6370 This is the default.
6372 The addressability of a particular object can be set with the
6373 @code{model} attribute.
6375 @item -mcode-model=medium
6376 @opindex mcode-model=medium
6377 Assume objects may be anywhere in the 32-bit address space (the compiler
6378 will generate @code{seth/add3} instructions to load their addresses), and
6379 assume all subroutines are reachable with the @code{bl} instruction.
6381 @item -mcode-model=large
6382 @opindex mcode-model=large
6383 Assume objects may be anywhere in the 32-bit address space (the compiler
6384 will generate @code{seth/add3} instructions to load their addresses), and
6385 assume subroutines may not be reachable with the @code{bl} instruction
6386 (the compiler will generate the much slower @code{seth/add3/jl}
6387 instruction sequence).
6389 @item -msdata=none
6390 @opindex msdata=none
6391 Disable use of the small data area.  Variables will be put into
6392 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6393 @code{section} attribute has been specified).
6394 This is the default.
6396 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6397 Objects may be explicitly put in the small data area with the
6398 @code{section} attribute using one of these sections.
6400 @item -msdata=sdata
6401 @opindex msdata=sdata
6402 Put small global and static data in the small data area, but do not
6403 generate special code to reference them.
6405 @item -msdata=use
6406 @opindex msdata=use
6407 Put small global and static data in the small data area, and generate
6408 special instructions to reference them.
6410 @item -G @var{num}
6411 @opindex G
6412 @cindex smaller data references
6413 Put global and static objects less than or equal to @var{num} bytes
6414 into the small data or bss sections instead of the normal data or bss
6415 sections.  The default value of @var{num} is 8.
6416 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6417 for this option to have any effect.
6419 All modules should be compiled with the same @option{-G @var{num}} value.
6420 Compiling with different values of @var{num} may or may not work; if it
6421 doesn't the linker will give an error message---incorrect code will not be
6422 generated.
6424 @end table
6426 @node M88K Options
6427 @subsection M88K Options
6428 @cindex M88k options
6430 These @samp{-m} options are defined for Motorola 88k architectures:
6432 @table @gcctabopt
6433 @item -m88000
6434 @opindex m88000
6435 Generate code that works well on both the m88100 and the
6436 m88110.
6438 @item -m88100
6439 @opindex m88100
6440 Generate code that works best for the m88100, but that also
6441 runs on the m88110.
6443 @item -m88110
6444 @opindex m88110
6445 Generate code that works best for the m88110, and may not run
6446 on the m88100.
6448 @item -mbig-pic
6449 @opindex mbig-pic
6450 Obsolete option to be removed from the next revision.
6451 Use @option{-fPIC}.
6453 @item -midentify-revision
6454 @opindex midentify-revision
6455 @cindex identifying source, compiler (88k)
6456 Include an @code{ident} directive in the assembler output recording the
6457 source file name, compiler name and version, timestamp, and compilation
6458 flags used.
6460 @item -mno-underscores
6461 @opindex mno-underscores
6462 @cindex underscores, avoiding (88k)
6463 In assembler output, emit symbol names without adding an underscore
6464 character at the beginning of each name.  The default is to use an
6465 underscore as prefix on each name.
6467 @item -mocs-debug-info
6468 @itemx -mno-ocs-debug-info
6469 @opindex mocs-debug-info
6470 @opindex mno-ocs-debug-info
6471 @cindex OCS (88k)
6472 @cindex debugging, 88k OCS
6473 Include (or omit) additional debugging information (about registers used
6474 in each stack frame) as specified in the 88open Object Compatibility
6475 Standard, ``OCS''@.  This extra information allows debugging of code that
6476 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6477 SVr3.2 is to include this information; other 88k configurations omit this
6478 information by default.
6480 @item -mocs-frame-position
6481 @opindex mocs-frame-position
6482 @cindex register positions in frame (88k)
6483 When emitting COFF debugging information for automatic variables and
6484 parameters stored on the stack, use the offset from the canonical frame
6485 address, which is the stack pointer (register 31) on entry to the
6486 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6487 @option{-mocs-frame-position}; other 88k configurations have the default
6488 @option{-mno-ocs-frame-position}.
6490 @item -mno-ocs-frame-position
6491 @opindex mno-ocs-frame-position
6492 @cindex register positions in frame (88k)
6493 When emitting COFF debugging information for automatic variables and
6494 parameters stored on the stack, use the offset from the frame pointer
6495 register (register 30).  When this option is in effect, the frame
6496 pointer is not eliminated when debugging information is selected by the
6497 -g switch.
6499 @item -moptimize-arg-area
6500 @opindex moptimize-arg-area
6501 @cindex arguments in frame (88k)
6502 Save space by reorganizing the stack frame.  This option generates code
6503 that does not agree with the 88open specifications, but uses less
6504 memory.
6506 @itemx -mno-optimize-arg-area
6507 @opindex mno-optimize-arg-area
6508 Do not reorganize the stack frame to save space.  This is the default.
6509 The generated conforms to the specification, but uses more memory.
6511 @item -mshort-data-@var{num}
6512 @opindex mshort-data
6513 @cindex smaller data references (88k)
6514 @cindex r0-relative references (88k)
6515 Generate smaller data references by making them relative to @code{r0},
6516 which allows loading a value using a single instruction (rather than the
6517 usual two).  You control which data references are affected by
6518 specifying @var{num} with this option.  For example, if you specify
6519 @option{-mshort-data-512}, then the data references affected are those
6520 involving displacements of less than 512 bytes.
6521 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6522 than 64k.
6524 @item -mserialize-volatile
6525 @opindex mserialize-volatile
6526 @itemx -mno-serialize-volatile
6527 @opindex mno-serialize-volatile
6528 @cindex sequential consistency on 88k
6529 Do, or don't, generate code to guarantee sequential consistency
6530 of volatile memory references.  By default, consistency is
6531 guaranteed.
6533 The order of memory references made by the MC88110 processor does
6534 not always match the order of the instructions requesting those
6535 references.  In particular, a load instruction may execute before
6536 a preceding store instruction.  Such reordering violates
6537 sequential consistency of volatile memory references, when there
6538 are multiple processors.   When consistency must be guaranteed,
6539 GCC generates special instructions, as needed, to force
6540 execution in the proper order.
6542 The MC88100 processor does not reorder memory references and so
6543 always provides sequential consistency.  However, by default, GCC
6544 generates the special instructions to guarantee consistency
6545 even when you use @option{-m88100}, so that the code may be run on an
6546 MC88110 processor.  If you intend to run your code only on the
6547 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6549 The extra code generated to guarantee consistency may affect the
6550 performance of your application.  If you know that you can safely
6551 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6553 @item -msvr4
6554 @itemx -msvr3
6555 @opindex msvr4
6556 @opindex msvr3
6557 @cindex assembler syntax, 88k
6558 @cindex SVr4
6559 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6560 related to System V release 4 (SVr4).  This controls the following:
6562 @enumerate
6563 @item
6564 Which variant of the assembler syntax to emit.
6565 @item
6566 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6567 that is used on System V release 4.
6568 @item
6569 @option{-msvr4} makes GCC issue additional declaration directives used in
6570 SVr4.
6571 @end enumerate
6573 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6574 @option{-msvr3} is the default for all other m88k configurations.
6576 @item -mversion-03.00
6577 @opindex mversion-03.00
6578 This option is obsolete, and is ignored.
6579 @c ??? which asm syntax better for GAS?  option there too?
6581 @item -mno-check-zero-division
6582 @itemx -mcheck-zero-division
6583 @opindex mno-check-zero-division
6584 @opindex mcheck-zero-division
6585 @cindex zero division on 88k
6586 Do, or don't, generate code to guarantee that integer division by
6587 zero will be detected.  By default, detection is guaranteed.
6589 Some models of the MC88100 processor fail to trap upon integer
6590 division by zero under certain conditions.  By default, when
6591 compiling code that might be run on such a processor, GCC
6592 generates code that explicitly checks for zero-valued divisors
6593 and traps with exception number 503 when one is detected.  Use of
6594 @option{-mno-check-zero-division} suppresses such checking for code
6595 generated to run on an MC88100 processor.
6597 GCC assumes that the MC88110 processor correctly detects all instances
6598 of integer division by zero.  When @option{-m88110} is specified, no
6599 explicit checks for zero-valued divisors are generated, and both
6600 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6601 ignored.
6603 @item -muse-div-instruction
6604 @opindex muse-div-instruction
6605 @cindex divide instruction, 88k
6606 Use the div instruction for signed integer division on the
6607 MC88100 processor.  By default, the div instruction is not used.
6609 On the MC88100 processor the signed integer division instruction
6610 div) traps to the operating system on a negative operand.  The
6611 operating system transparently completes the operation, but at a
6612 large cost in execution time.  By default, when compiling code
6613 that might be run on an MC88100 processor, GCC emulates signed
6614 integer division using the unsigned integer division instruction
6615 divu), thereby avoiding the large penalty of a trap to the
6616 operating system.  Such emulation has its own, smaller, execution
6617 cost in both time and space.  To the extent that your code's
6618 important signed integer division operations are performed on two
6619 nonnegative operands, it may be desirable to use the div
6620 instruction directly.
6622 On the MC88110 processor the div instruction (also known as the
6623 divs instruction) processes negative operands without trapping to
6624 the operating system.  When @option{-m88110} is specified,
6625 @option{-muse-div-instruction} is ignored, and the div instruction is used
6626 for signed integer division.
6628 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6629 particular, the behavior of such a division with and without
6630 @option{-muse-div-instruction} may differ.
6632 @item -mtrap-large-shift
6633 @itemx -mhandle-large-shift
6634 @opindex mtrap-large-shift
6635 @opindex mhandle-large-shift
6636 @cindex bit shift overflow (88k)
6637 @cindex large bit shifts (88k)
6638 Include code to detect bit-shifts of more than 31 bits; respectively,
6639 trap such shifts or emit code to handle them properly.  By default GCC
6640 makes no special provision for large bit shifts.
6642 @item -mwarn-passed-structs
6643 @opindex mwarn-passed-structs
6644 @cindex structure passing (88k)
6645 Warn when a function passes a struct as an argument or result.
6646 Structure-passing conventions have changed during the evolution of the C
6647 language, and are often the source of portability problems.  By default,
6648 GCC issues no such warning.
6649 @end table
6651 @c break page here to avoid unsightly interparagraph stretch.
6652 @c -zw, 2001-8-17
6653 @page
6655 @node RS/6000 and PowerPC Options
6656 @subsection IBM RS/6000 and PowerPC Options
6657 @cindex RS/6000 and PowerPC Options
6658 @cindex IBM RS/6000 and PowerPC Options
6660 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6661 @table @gcctabopt
6662 @item -mpower
6663 @itemx -mno-power
6664 @itemx -mpower2
6665 @itemx -mno-power2
6666 @itemx -mpowerpc
6667 @itemx -mno-powerpc
6668 @itemx -mpowerpc-gpopt
6669 @itemx -mno-powerpc-gpopt
6670 @itemx -mpowerpc-gfxopt
6671 @itemx -mno-powerpc-gfxopt
6672 @itemx -mpowerpc64
6673 @itemx -mno-powerpc64
6674 @opindex mpower
6675 @opindex mno-power
6676 @opindex mpower2
6677 @opindex mno-power2
6678 @opindex mpowerpc
6679 @opindex mno-powerpc
6680 @opindex mpowerpc-gpopt
6681 @opindex mno-powerpc-gpopt
6682 @opindex mpowerpc-gfxopt
6683 @opindex mno-powerpc-gfxopt
6684 @opindex mpowerpc64
6685 @opindex mno-powerpc64
6686 GCC supports two related instruction set architectures for the
6687 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6688 instructions supported by the @samp{rios} chip set used in the original
6689 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6690 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6691 the IBM 4xx microprocessors.
6693 Neither architecture is a subset of the other.  However there is a
6694 large common subset of instructions supported by both.  An MQ
6695 register is included in processors supporting the POWER architecture.
6697 You use these options to specify which instructions are available on the
6698 processor you are using.  The default value of these options is
6699 determined when configuring GCC@.  Specifying the
6700 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6701 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6702 rather than the options listed above.
6704 The @option{-mpower} option allows GCC to generate instructions that
6705 are found only in the POWER architecture and to use the MQ register.
6706 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6707 to generate instructions that are present in the POWER2 architecture but
6708 not the original POWER architecture.
6710 The @option{-mpowerpc} option allows GCC to generate instructions that
6711 are found only in the 32-bit subset of the PowerPC architecture.
6712 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6713 GCC to use the optional PowerPC architecture instructions in the
6714 General Purpose group, including floating-point square root.  Specifying
6715 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6716 use the optional PowerPC architecture instructions in the Graphics
6717 group, including floating-point select.
6719 The @option{-mpowerpc64} option allows GCC to generate the additional
6720 64-bit instructions that are found in the full PowerPC64 architecture
6721 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6722 @option{-mno-powerpc64}.
6724 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6725 will use only the instructions in the common subset of both
6726 architectures plus some special AIX common-mode calls, and will not use
6727 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6728 permits GCC to use any instruction from either architecture and to
6729 allow use of the MQ register; specify this for the Motorola MPC601.
6731 @item -mnew-mnemonics
6732 @itemx -mold-mnemonics
6733 @opindex mnew-mnemonics
6734 @opindex mold-mnemonics
6735 Select which mnemonics to use in the generated assembler code.  With
6736 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6737 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6738 assembler mnemonics defined for the POWER architecture.  Instructions
6739 defined in only one architecture have only one mnemonic; GCC uses that
6740 mnemonic irrespective of which of these options is specified.
6742 GCC defaults to the mnemonics appropriate for the architecture in
6743 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6744 value of these option.  Unless you are building a cross-compiler, you
6745 should normally not specify either @option{-mnew-mnemonics} or
6746 @option{-mold-mnemonics}, but should instead accept the default.
6748 @item -mcpu=@var{cpu_type}
6749 @opindex mcpu
6750 Set architecture type, register usage, choice of mnemonics, and
6751 instruction scheduling parameters for machine type @var{cpu_type}.
6752 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6753 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6754 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6755 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6756 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6757 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6759 @option{-mcpu=common} selects a completely generic processor.  Code
6760 generated under this option will run on any POWER or PowerPC processor.
6761 GCC will use only the instructions in the common subset of both
6762 architectures, and will not use the MQ register.  GCC assumes a generic
6763 processor model for scheduling purposes.
6765 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6766 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6767 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6768 types, with an appropriate, generic processor model assumed for
6769 scheduling purposes.
6771 The other options specify a specific processor.  Code generated under
6772 those options will run best on that processor, and may not run at all on
6773 others.
6775 The @option{-mcpu} options automatically enable or disable other
6776 @option{-m} options as follows:
6778 @table @samp
6779 @item common
6780 @option{-mno-power}, @option{-mno-powerpc}
6782 @item power
6783 @itemx power2
6784 @itemx rios1
6785 @itemx rios2
6786 @itemx rsc
6787 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6789 @item powerpc
6790 @itemx rs64a
6791 @itemx 602
6792 @itemx 603
6793 @itemx 603e
6794 @itemx 604
6795 @itemx 620
6796 @itemx 630
6797 @itemx 740
6798 @itemx 7400
6799 @itemx 7450
6800 @itemx 750
6801 @itemx 505
6802 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6804 @item 601
6805 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6807 @item 403
6808 @itemx 821
6809 @itemx 860
6810 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6811 @end table
6813 @item -mtune=@var{cpu_type}
6814 @opindex mtune
6815 Set the instruction scheduling parameters for machine type
6816 @var{cpu_type}, but do not set the architecture type, register usage, or
6817 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6818 values for @var{cpu_type} are used for @option{-mtune} as for
6819 @option{-mcpu}.  If both are specified, the code generated will use the
6820 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6821 scheduling parameters set by @option{-mtune}.
6823 @item -maltivec
6824 @itemx -mno-altivec
6825 @opindex maltivec
6826 @opindex mno-altivec
6827 These switches enable or disable the use of built-in functions that
6828 allow access to the AltiVec instruction set.  You may also need to set
6829 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6830 enhancements.
6832 @item -mabi=spe
6833 @opindex mabi=spe
6834 Extend the current ABI with SPE ABI extensions.  This does not change
6835 the default ABI, instead it adds the SPE ABI extensions to the current
6836 ABI@.
6838 @item -mabi=no-spe
6839 @opindex mabi=no-spe
6840 Disable Booke SPE ABI extensions for the current ABI.
6842 @item -misel=@var{yes/no}
6843 @itemx -misel
6844 @opindex misel
6845 This switch enables or disables the generation of ISEL instructions.
6847 @item -mfull-toc
6848 @itemx -mno-fp-in-toc
6849 @itemx -mno-sum-in-toc
6850 @itemx -mminimal-toc
6851 @opindex mfull-toc
6852 @opindex mno-fp-in-toc
6853 @opindex mno-sum-in-toc
6854 @opindex mminimal-toc
6855 Modify generation of the TOC (Table Of Contents), which is created for
6856 every executable file.  The @option{-mfull-toc} option is selected by
6857 default.  In that case, GCC will allocate at least one TOC entry for
6858 each unique non-automatic variable reference in your program.  GCC
6859 will also place floating-point constants in the TOC@.  However, only
6860 16,384 entries are available in the TOC@.
6862 If you receive a linker error message that saying you have overflowed
6863 the available TOC space, you can reduce the amount of TOC space used
6864 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6865 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6866 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6867 generate code to calculate the sum of an address and a constant at
6868 run-time instead of putting that sum into the TOC@.  You may specify one
6869 or both of these options.  Each causes GCC to produce very slightly
6870 slower and larger code at the expense of conserving TOC space.
6872 If you still run out of space in the TOC even when you specify both of
6873 these options, specify @option{-mminimal-toc} instead.  This option causes
6874 GCC to make only one TOC entry for every file.  When you specify this
6875 option, GCC will produce code that is slower and larger but which
6876 uses extremely little TOC space.  You may wish to use this option
6877 only on files that contain less frequently executed code.
6879 @item -maix64
6880 @itemx -maix32
6881 @opindex maix64
6882 @opindex maix32
6883 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6884 @code{long} type, and the infrastructure needed to support them.
6885 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6886 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6887 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6889 @item -mxl-call
6890 @itemx -mno-xl-call
6891 @opindex mxl-call
6892 @opindex mno-xl-call
6893 On AIX, pass floating-point arguments to prototyped functions beyond the
6894 register save area (RSA) on the stack in addition to argument FPRs.  The
6895 AIX calling convention was extended but not initially documented to
6896 handle an obscure K&R C case of calling a function that takes the
6897 address of its arguments with fewer arguments than declared.  AIX XL
6898 compilers access floating point arguments which do not fit in the
6899 RSA from the stack when a subroutine is compiled without
6900 optimization.  Because always storing floating-point arguments on the
6901 stack is inefficient and rarely needed, this option is not enabled by
6902 default and only is necessary when calling subroutines compiled by AIX
6903 XL compilers without optimization.
6905 @item -mpe
6906 @opindex mpe
6907 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6908 application written to use message passing with special startup code to
6909 enable the application to run.  The system must have PE installed in the
6910 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6911 must be overridden with the @option{-specs=} option to specify the
6912 appropriate directory location.  The Parallel Environment does not
6913 support threads, so the @option{-mpe} option and the @option{-pthread}
6914 option are incompatible.
6916 @item -msoft-float
6917 @itemx -mhard-float
6918 @opindex msoft-float
6919 @opindex mhard-float
6920 Generate code that does not use (uses) the floating-point register set.
6921 Software floating point emulation is provided if you use the
6922 @option{-msoft-float} option, and pass the option to GCC when linking.
6924 @item -mmultiple
6925 @itemx -mno-multiple
6926 @opindex mmultiple
6927 @opindex mno-multiple
6928 Generate code that uses (does not use) the load multiple word
6929 instructions and the store multiple word instructions.  These
6930 instructions are generated by default on POWER systems, and not
6931 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6932 endian PowerPC systems, since those instructions do not work when the
6933 processor is in little endian mode.  The exceptions are PPC740 and
6934 PPC750 which permit the instructions usage in little endian mode.
6936 @item -mstring
6937 @itemx -mno-string
6938 @opindex mstring
6939 @opindex mno-string
6940 Generate code that uses (does not use) the load string instructions
6941 and the store string word instructions to save multiple registers and
6942 do small block moves.  These instructions are generated by default on
6943 POWER systems, and not generated on PowerPC systems.  Do not use
6944 @option{-mstring} on little endian PowerPC systems, since those
6945 instructions do not work when the processor is in little endian mode.
6946 The exceptions are PPC740 and PPC750 which permit the instructions
6947 usage in little endian mode.
6949 @item -mupdate
6950 @itemx -mno-update
6951 @opindex mupdate
6952 @opindex mno-update
6953 Generate code that uses (does not use) the load or store instructions
6954 that update the base register to the address of the calculated memory
6955 location.  These instructions are generated by default.  If you use
6956 @option{-mno-update}, there is a small window between the time that the
6957 stack pointer is updated and the address of the previous frame is
6958 stored, which means code that walks the stack frame across interrupts or
6959 signals may get corrupted data.
6961 @item -mfused-madd
6962 @itemx -mno-fused-madd
6963 @opindex mfused-madd
6964 @opindex mno-fused-madd
6965 Generate code that uses (does not use) the floating point multiply and
6966 accumulate instructions.  These instructions are generated by default if
6967 hardware floating is used.
6969 @item -mno-bit-align
6970 @itemx -mbit-align
6971 @opindex mno-bit-align
6972 @opindex mbit-align
6973 On System V.4 and embedded PowerPC systems do not (do) force structures
6974 and unions that contain bit-fields to be aligned to the base type of the
6975 bit-field.
6977 For example, by default a structure containing nothing but 8
6978 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6979 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6980 the structure would be aligned to a 1 byte boundary and be one byte in
6981 size.
6983 @item -mno-strict-align
6984 @itemx -mstrict-align
6985 @opindex mno-strict-align
6986 @opindex mstrict-align
6987 On System V.4 and embedded PowerPC systems do not (do) assume that
6988 unaligned memory references will be handled by the system.
6990 @item -mrelocatable
6991 @itemx -mno-relocatable
6992 @opindex mrelocatable
6993 @opindex mno-relocatable
6994 On embedded PowerPC systems generate code that allows (does not allow)
6995 the program to be relocated to a different address at runtime.  If you
6996 use @option{-mrelocatable} on any module, all objects linked together must
6997 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6999 @item -mrelocatable-lib
7000 @itemx -mno-relocatable-lib
7001 @opindex mrelocatable-lib
7002 @opindex mno-relocatable-lib
7003 On embedded PowerPC systems generate code that allows (does not allow)
7004 the program to be relocated to a different address at runtime.  Modules
7005 compiled with @option{-mrelocatable-lib} can be linked with either modules
7006 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7007 with modules compiled with the @option{-mrelocatable} options.
7009 @item -mno-toc
7010 @itemx -mtoc
7011 @opindex mno-toc
7012 @opindex mtoc
7013 On System V.4 and embedded PowerPC systems do not (do) assume that
7014 register 2 contains a pointer to a global area pointing to the addresses
7015 used in the program.
7017 @item -mlittle
7018 @itemx -mlittle-endian
7019 @opindex mlittle
7020 @opindex mlittle-endian
7021 On System V.4 and embedded PowerPC systems compile code for the
7022 processor in little endian mode.  The @option{-mlittle-endian} option is
7023 the same as @option{-mlittle}.
7025 @item -mbig
7026 @itemx -mbig-endian
7027 @opindex mbig
7028 @opindex mbig-endian
7029 On System V.4 and embedded PowerPC systems compile code for the
7030 processor in big endian mode.  The @option{-mbig-endian} option is
7031 the same as @option{-mbig}.
7033 @item -mcall-sysv
7034 @opindex mcall-sysv
7035 On System V.4 and embedded PowerPC systems compile code using calling
7036 conventions that adheres to the March 1995 draft of the System V
7037 Application Binary Interface, PowerPC processor supplement.  This is the
7038 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7040 @item -mcall-sysv-eabi
7041 @opindex mcall-sysv-eabi
7042 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7044 @item -mcall-sysv-noeabi
7045 @opindex mcall-sysv-noeabi
7046 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7048 @item -mcall-aix
7049 @opindex mcall-aix
7050 On System V.4 and embedded PowerPC systems compile code using calling
7051 conventions that are similar to those used on AIX@.  This is the
7052 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7054 @item -mcall-solaris
7055 @opindex mcall-solaris
7056 On System V.4 and embedded PowerPC systems compile code for the Solaris
7057 operating system.
7059 @item -mcall-linux
7060 @opindex mcall-linux
7061 On System V.4 and embedded PowerPC systems compile code for the
7062 Linux-based GNU system.
7064 @item -mcall-gnu
7065 @opindex mcall-gnu
7066 On System V.4 and embedded PowerPC systems compile code for the
7067 Hurd-based GNU system.
7069 @item -mcall-netbsd
7070 @opindex mcall-netbsd
7071 On System V.4 and embedded PowerPC systems compile code for the
7072 NetBSD operating system.
7074 @item -maix-struct-return
7075 @opindex maix-struct-return
7076 Return all structures in memory (as specified by the AIX ABI)@.
7078 @item -msvr4-struct-return
7079 @opindex msvr4-struct-return
7080 Return structures smaller than 8 bytes in registers (as specified by the
7081 SVR4 ABI)@.
7083 @item -mabi=altivec
7084 @opindex mabi=altivec
7085 Extend the current ABI with AltiVec ABI extensions.  This does not
7086 change the default ABI, instead it adds the AltiVec ABI extensions to
7087 the current ABI@.
7089 @item -mabi=no-altivec
7090 @opindex mabi=no-altivec
7091 Disable AltiVec ABI extensions for the current ABI.
7093 @item -mprototype
7094 @itemx -mno-prototype
7095 @opindex mprototype
7096 @opindex mno-prototype
7097 On System V.4 and embedded PowerPC systems assume that all calls to
7098 variable argument functions are properly prototyped.  Otherwise, the
7099 compiler must insert an instruction before every non prototyped call to
7100 set or clear bit 6 of the condition code register (@var{CR}) to
7101 indicate whether floating point values were passed in the floating point
7102 registers in case the function takes a variable arguments.  With
7103 @option{-mprototype}, only calls to prototyped variable argument functions
7104 will set or clear the bit.
7106 @item -msim
7107 @opindex msim
7108 On embedded PowerPC systems, assume that the startup module is called
7109 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7110 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7111 configurations.
7113 @item -mmvme
7114 @opindex mmvme
7115 On embedded PowerPC systems, assume that the startup module is called
7116 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7117 @file{libc.a}.
7119 @item -mads
7120 @opindex mads
7121 On embedded PowerPC systems, assume that the startup module is called
7122 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7123 @file{libc.a}.
7125 @item -myellowknife
7126 @opindex myellowknife
7127 On embedded PowerPC systems, assume that the startup module is called
7128 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7129 @file{libc.a}.
7131 @item -mvxworks
7132 @opindex mvxworks
7133 On System V.4 and embedded PowerPC systems, specify that you are
7134 compiling for a VxWorks system.
7136 @item -mwindiss
7137 @opindex mwindiss
7138 Specify that you are compiling for the WindISS simulation environment.
7140 @item -memb
7141 @opindex memb
7142 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7143 header to indicate that @samp{eabi} extended relocations are used.
7145 @item -meabi
7146 @itemx -mno-eabi
7147 @opindex meabi
7148 @opindex mno-eabi
7149 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7150 Embedded Applications Binary Interface (eabi) which is a set of
7151 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7152 means that the stack is aligned to an 8 byte boundary, a function
7153 @code{__eabi} is called to from @code{main} to set up the eabi
7154 environment, and the @option{-msdata} option can use both @code{r2} and
7155 @code{r13} to point to two separate small data areas.  Selecting
7156 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7157 do not call an initialization function from @code{main}, and the
7158 @option{-msdata} option will only use @code{r13} to point to a single
7159 small data area.  The @option{-meabi} option is on by default if you
7160 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7162 @item -msdata=eabi
7163 @opindex msdata=eabi
7164 On System V.4 and embedded PowerPC systems, put small initialized
7165 @code{const} global and static data in the @samp{.sdata2} section, which
7166 is pointed to by register @code{r2}.  Put small initialized
7167 non-@code{const} global and static data in the @samp{.sdata} section,
7168 which is pointed to by register @code{r13}.  Put small uninitialized
7169 global and static data in the @samp{.sbss} section, which is adjacent to
7170 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7171 incompatible with the @option{-mrelocatable} option.  The
7172 @option{-msdata=eabi} option also sets the @option{-memb} option.
7174 @item -msdata=sysv
7175 @opindex msdata=sysv
7176 On System V.4 and embedded PowerPC systems, put small global and static
7177 data in the @samp{.sdata} section, which is pointed to by register
7178 @code{r13}.  Put small uninitialized global and static data in the
7179 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7180 The @option{-msdata=sysv} option is incompatible with the
7181 @option{-mrelocatable} option.
7183 @item -msdata=default
7184 @itemx -msdata
7185 @opindex msdata=default
7186 @opindex msdata
7187 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7188 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7189 same as @option{-msdata=sysv}.
7191 @item -msdata-data
7192 @opindex msdata-data
7193 On System V.4 and embedded PowerPC systems, put small global and static
7194 data in the @samp{.sdata} section.  Put small uninitialized global and
7195 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7196 to address small data however.  This is the default behavior unless
7197 other @option{-msdata} options are used.
7199 @item -msdata=none
7200 @itemx -mno-sdata
7201 @opindex msdata=none
7202 @opindex mno-sdata
7203 On embedded PowerPC systems, put all initialized global and static data
7204 in the @samp{.data} section, and all uninitialized data in the
7205 @samp{.bss} section.
7207 @item -G @var{num}
7208 @opindex G
7209 @cindex smaller data references (PowerPC)
7210 @cindex .sdata/.sdata2 references (PowerPC)
7211 On embedded PowerPC systems, put global and static items less than or
7212 equal to @var{num} bytes into the small data or bss sections instead of
7213 the normal data or bss section.  By default, @var{num} is 8.  The
7214 @option{-G @var{num}} switch is also passed to the linker.
7215 All modules should be compiled with the same @option{-G @var{num}} value.
7217 @item -mregnames
7218 @itemx -mno-regnames
7219 @opindex mregnames
7220 @opindex mno-regnames
7221 On System V.4 and embedded PowerPC systems do (do not) emit register
7222 names in the assembly language output using symbolic forms.
7224 @item -mlongcall
7225 @itemx -mno-longcall
7226 @opindex mlongcall
7227 @opindex mno-longcall
7228 Default to making all function calls via pointers, so that functions
7229 which reside further than 64 megabytes (67,108,864 bytes) from the
7230 current location can be called.  This setting can be overridden by the
7231 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7233 Some linkers are capable of detecting out-of-range calls and generating
7234 glue code on the fly.  On these systems, long calls are unnecessary and
7235 generate slower code.  As of this writing, the AIX linker can do this,
7236 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7237 to the GNU linker for 32-bit PowerPC systems as well.
7239 In the future, we may cause GCC to ignore all longcall specifications
7240 when the linker is known to generate glue.
7242 @item -pthread
7243 @opindex pthread
7244 Adds support for multithreading with the @dfn{pthreads} library.
7245 This option sets flags for both the preprocessor and linker.
7247 @end table
7249 @node Darwin Options
7250 @subsection Darwin Options
7251 @cindex Darwin options
7252 @table @gcctabopt
7253 @item -all_load    
7254 @opindex all_load   
7255 Loads all members of static archive libraries.
7256 See man ld(1) for more information.
7258 @item -arch_errors_fatal
7259 @opindex arch_errors_fatal
7260 Cause the errors having to do with files that have the wrong architecture
7261 to be fatal.
7263 @item -bind_at_load
7264 @opindex bind_at_load
7265 Causes the output file to be marked such that the dynamic linker will
7266 bind all undefined references when the file is loaded or launched.
7268 @item -bundle     
7269 @opindex bundle
7270 Produce a Mach-o bundle format file.
7271 See man ld(1) for more information.
7273 @item -bundle_loader @var{executable}
7274 @opindex bundle_loader
7275 This specifies the @var{executable} that will be loading the build
7276 output file being linked. See man ld(1) for more information.
7278 @item -allowable_client  @var{client_name}
7279 @item -arch_only
7281 @item -client_name       
7282 @item -compatibility_version
7283 @item -current_version    
7284 @item -dependency-file
7285 @item -dylib_file    
7286 @item -dylinker_install_name
7287 @item -dynamic
7288 @item -dynamiclib   
7289 @item -exported_symbols_list  
7290 @item -filelist
7291 @item -flat_namespace   
7292 @item -force_cpusubtype_ALL
7293 @item -force_flat_namespace   
7294 @item -headerpad_max_install_names
7295 @item -image_base  
7296 @item -init
7297 @item -install_name
7298 @item -keep_private_externs
7299 @item -multi_module
7300 @item -multiply_defined      
7301 @item -multiply_defined_unused      
7302 @item -noall_load  
7303 @item -nomultidefs
7304 @item -noprebind     
7305 @item -noseglinkedit
7306 @item -pagezero_size    
7307 @item -prebind
7308 @item -prebind_all_twolevel_modules
7309 @item -private_bundle
7310 @item -read_only_relocs
7311 @item -sectalign  
7312 @item -sectobjectsymbols    
7313 @item -whyload
7314 @item -seg1addr 
7315 @item -sectcreate
7316 @item -sectobjectsymbols
7317 @item -sectorder
7318 @item -seg_addr_table
7319 @item -seg_addr_table_filename
7320 @item -seglinkedit
7321 @item -segprot   
7322 @item -segs_read_only_addr
7323 @item -segs_read_write_addr
7324 @item -single_module   
7325 @item -static
7326 @item -sub_library
7327 @item -sub_umbrella 
7328 @item -twolevel_namespace
7329 @item -umbrella
7330 @item -undefined
7331 @item -unexported_symbols_list
7332 @item -weak_reference_mismatches
7333 @item -whatsloaded  
7335 @opindex allowable_client
7336 @opindex arch_only    
7337 @opindex client_name
7338 @opindex compatibility_version
7339 @opindex current_version
7340 @opindex dependency-file
7341 @opindex dylib_file
7342 @opindex dylinker_install_name
7343 @opindex dynamic
7344 @opindex dynamiclib
7345 @opindex exported_symbols_list
7346 @opindex filelist  
7347 @opindex flat_namespace    
7348 @opindex force_cpusubtype_ALL
7349 @opindex force_flat_namespace
7350 @opindex headerpad_max_install_names
7351 @opindex image_base
7352 @opindex init     
7353 @opindex install_name
7354 @opindex keep_private_externs
7355 @opindex multi_module   
7356 @opindex multiply_defined
7357 @opindex multiply_defined_unused   
7358 @opindex noall_load  
7359 @opindex nomultidefs   
7360 @opindex noprebind
7361 @opindex noseglinkedit      
7362 @opindex pagezero_size
7363 @opindex prebind
7364 @opindex prebind_all_twolevel_modules
7365 @opindex private_bundle 
7366 @opindex read_only_relocs
7367 @opindex sectalign   
7368 @opindex sectobjectsymbols    
7369 @opindex whyload  
7370 @opindex seg1addr
7371 @opindex sectcreate       
7372 @opindex sectobjectsymbols 
7373 @opindex sectorder     
7374 @opindex seg_addr_table
7375 @opindex seg_addr_table_filename
7376 @opindex seglinkedit
7377 @opindex segprot
7378 @opindex segs_read_only_addr
7379 @opindex segs_read_write_addr
7380 @opindex single_module
7381 @opindex static
7382 @opindex sub_library
7383 @opindex sub_umbrella
7384 @opindex twolevel_namespace
7385 @opindex umbrella
7386 @opindex undefined
7387 @opindex unexported_symbols_list
7388 @opindex weak_reference_mismatches
7389 @opindex whatsloaded
7391 This options are available for Darwin linker. Darwin linker man page
7392 describes them in detail.
7393 @end table
7396 @node RT Options
7397 @subsection IBM RT Options
7398 @cindex RT options
7399 @cindex IBM RT options
7401 These @samp{-m} options are defined for the IBM RT PC:
7403 @table @gcctabopt
7404 @item -min-line-mul
7405 @opindex min-line-mul
7406 Use an in-line code sequence for integer multiplies.  This is the
7407 default.
7409 @item -mcall-lib-mul
7410 @opindex mcall-lib-mul
7411 Call @code{lmul$$} for integer multiples.
7413 @item -mfull-fp-blocks
7414 @opindex mfull-fp-blocks
7415 Generate full-size floating point data blocks, including the minimum
7416 amount of scratch space recommended by IBM@.  This is the default.
7418 @item -mminimum-fp-blocks
7419 @opindex mminimum-fp-blocks
7420 Do not include extra scratch space in floating point data blocks.  This
7421 results in smaller code, but slower execution, since scratch space must
7422 be allocated dynamically.
7424 @cindex @file{stdarg.h} and RT PC
7425 @item -mfp-arg-in-fpregs
7426 @opindex mfp-arg-in-fpregs
7427 Use a calling sequence incompatible with the IBM calling convention in
7428 which floating point arguments are passed in floating point registers.
7429 Note that @code{stdarg.h} will not work with floating point operands
7430 if this option is specified.
7432 @item -mfp-arg-in-gregs
7433 @opindex mfp-arg-in-gregs
7434 Use the normal calling convention for floating point arguments.  This is
7435 the default.
7437 @item -mhc-struct-return
7438 @opindex mhc-struct-return
7439 Return structures of more than one word in memory, rather than in a
7440 register.  This provides compatibility with the MetaWare HighC (hc)
7441 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7442 with the Portable C Compiler (pcc).
7444 @item -mnohc-struct-return
7445 @opindex mnohc-struct-return
7446 Return some structures of more than one word in registers, when
7447 convenient.  This is the default.  For compatibility with the
7448 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7449 option @option{-mhc-struct-return}.
7450 @end table
7452 @node MIPS Options
7453 @subsection MIPS Options
7454 @cindex MIPS options
7456 These @samp{-m} options are defined for the MIPS family of computers:
7458 @table @gcctabopt
7460 @item -march=@var{arch}
7461 @opindex march
7462 Generate code that will run on @var{arch}, which can be the name of a
7463 generic MIPS ISA, or the name of a particular processor.
7464 The ISA names are:
7465 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7466 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7467 The processor names are:
7468 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7469 @samp{m4k},
7470 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7471 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7472 @samp{orion},
7473 @samp{sb1},
7474 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7475 The special value @samp{from-abi} selects the
7476 most compatible architecture for the selected ABI (that is,
7477 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7479 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7480 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7481 @samp{vr} may be written @samp{r}.
7483 GCC defines two macros based on the value of this option.  The first
7484 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7485 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7486 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7487 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7488 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7490 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7491 above.  In other words, it will have the full prefix and will not
7492 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7493 the macro names the resolved architecture (either @samp{"mips1"} or
7494 @samp{"mips3"}).  It names the default architecture when no
7495 @option{-march} option is given.
7497 @item -mtune=@var{arch}
7498 @opindex mtune
7499 Optimize for @var{arch}.  Among other things, this option controls
7500 the way instructions are scheduled, and the perceived cost of arithmetic
7501 operations.  The list of @var{arch} values is the same as for
7502 @option{-march}.
7504 When this option is not used, GCC will optimize for the processor
7505 specified by @option{-march}.  By using @option{-march} and
7506 @option{-mtune} together, it is possible to generate code that will
7507 run on a family of processors, but optimize the code for one
7508 particular member of that family.
7510 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7511 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7512 @samp{-march} ones described above.
7514 @item -mips1
7515 @opindex mips1
7516 Equivalent to @samp{-march=mips1}.
7518 @item -mips2
7519 @opindex mips2
7520 Equivalent to @samp{-march=mips2}.
7522 @item -mips3
7523 @opindex mips3
7524 Equivalent to @samp{-march=mips3}.
7526 @item -mips4
7527 @opindex mips4
7528 Equivalent to @samp{-march=mips4}.
7530 @item -mips32
7531 @opindex mips32
7532 Equivalent to @samp{-march=mips32}.
7534 @item -mips32r2
7535 @opindex mips32r2
7536 Equivalent to @samp{-march=mips32r2}.
7538 @item -mips64
7539 @opindex mips64
7540 Equivalent to @samp{-march=mips64}.
7542 @item -mfused-madd
7543 @itemx -mno-fused-madd
7544 @opindex mfused-madd
7545 @opindex mno-fused-madd
7546 Generate code that uses (does not use) the floating point multiply and
7547 accumulate instructions, when they are available.  These instructions
7548 are generated by default if they are available, but this may be
7549 undesirable if the extra precision causes problems or on certain chips
7550 in the mode where denormals are rounded to zero where denormals
7551 generated by multiply and accumulate instructions cause exceptions
7552 anyway.
7554 @item -mfp32
7555 @opindex mfp32
7556 Assume that floating point registers are 32 bits wide.
7558 @item -mfp64
7559 @opindex mfp64
7560 Assume that floating point registers are 64 bits wide.
7562 @item -mgp32
7563 @opindex mgp32
7564 Assume that general purpose registers are 32 bits wide.
7566 @item -mgp64
7567 @opindex mgp64
7568 Assume that general purpose registers are 64 bits wide.
7570 @item -mint64
7571 @opindex mint64
7572 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7573 explanation of the default, and the width of pointers.
7575 @item -mlong64
7576 @opindex mlong64
7577 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7578 explanation of the default, and the width of pointers.
7580 @item -mlong32
7581 @opindex mlong32
7582 Force long, int, and pointer types to be 32 bits wide.
7584 The default size of ints, longs and pointers depends on the ABI@.  All
7585 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7586 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7587 are the same size as longs, or the same size as integer registers,
7588 whichever is smaller.
7590 @item -mabi=32
7591 @itemx -mabi=o64
7592 @itemx -mabi=n32
7593 @itemx -mabi=64
7594 @itemx -mabi=eabi
7595 @itemx -mabi=meabi
7596 @opindex mabi=32
7597 @opindex mabi=o64
7598 @opindex mabi=n32
7599 @opindex mabi=64
7600 @opindex mabi=eabi
7601 @opindex mabi=meabi
7602 Generate code for the given ABI@.
7604 Note that there are two embedded ABIs: @option{-mabi=eabi}
7605 selects the one defined by Cygnus while @option{-meabi=meabi}
7606 selects the one defined by MIPS@.  Both these ABIs have
7607 32-bit and 64-bit variants.  Normally, GCC will generate
7608 64-bit code when you select a 64-bit architecture, but you
7609 can use @option{-mgp32} to get 32-bit code instead.
7611 @item -mabi-fake-default
7612 @opindex mabi-fake-default
7613 You don't want to know what this option does.  No, really.  I mean
7614 it.  Move on to the next option.
7616 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7617 wants the default set of options to get the root of the multilib tree,
7618 and the shared library SONAMEs without any multilib-indicating
7619 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7620 we want to default to the N32 ABI, while still being binary-compatible
7621 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7622 binary-compatible means shared libraries should have the same SONAMEs,
7623 and libraries should live in the same location.  Having O32 libraries
7624 in a sub-directory named say @file{o32} is not acceptable.
7626 So we trick GCC into believing that O32 is the default ABI, except
7627 that we override the default with some internal command-line
7628 processing magic.  Problem is, if we stopped at that, and you then
7629 created a multilib-aware package that used the output of @command{gcc
7630 -print-multi-lib} to decide which multilibs to build, and how, and
7631 you'd find yourself in an awkward situation when you found out that
7632 some of the options listed ended up mapping to the same multilib, and
7633 none of your libraries was actually built for the multilib that
7634 @option{-print-multi-lib} claims to be the default.  So we added this
7635 option that disables the default switcher, falling back to GCC's
7636 original notion of the default library.  Confused yet?
7638 For short: don't ever use this option, unless you find it in the list
7639 of additional options to be used when building for multilibs, in the
7640 output of @option{gcc -print-multi-lib}.
7642 @item -mmips-as
7643 @opindex mmips-as
7644 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7645 add normal debug information.  This is the default for all
7646 platforms except for the OSF/1 reference platform, using the OSF/rose
7647 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7648 switches are used, the @file{mips-tfile} program will encapsulate the
7649 stabs within MIPS ECOFF@.
7651 @item -mgas
7652 @opindex mgas
7653 Generate code for the GNU assembler.  This is the default on the OSF/1
7654 reference platform, using the OSF/rose object format.  Also, this is
7655 the default if the configure option @option{--with-gnu-as} is used.
7657 @item -msplit-addresses
7658 @itemx -mno-split-addresses
7659 @opindex msplit-addresses
7660 @opindex mno-split-addresses
7661 Generate code to load the high and low parts of address constants separately.
7662 This allows GCC to optimize away redundant loads of the high order
7663 bits of addresses.  This optimization requires GNU as and GNU ld.
7664 This optimization is enabled by default for some embedded targets where
7665 GNU as and GNU ld are standard.
7667 @item -mrnames
7668 @itemx -mno-rnames
7669 @opindex mrnames
7670 @opindex mno-rnames
7671 The @option{-mrnames} switch says to output code using the MIPS software
7672 names for the registers, instead of the hardware names (ie, @var{a0}
7673 instead of @var{$4}).  The only known assembler that supports this option
7674 is the Algorithmics assembler.
7676 @item -mgpopt
7677 @itemx -mno-gpopt
7678 @opindex mgpopt
7679 @opindex mno-gpopt
7680 The @option{-mgpopt} switch says to write all of the data declarations
7681 before the instructions in the text section, this allows the MIPS
7682 assembler to generate one word memory references instead of using two
7683 words for short global or static data items.  This is on by default if
7684 optimization is selected.
7686 @item -mstats
7687 @itemx -mno-stats
7688 @opindex mstats
7689 @opindex mno-stats
7690 For each non-inline function processed, the @option{-mstats} switch
7691 causes the compiler to emit one line to the standard error file to
7692 print statistics about the program (number of registers saved, stack
7693 size, etc.).
7695 @item -mmemcpy
7696 @itemx -mno-memcpy
7697 @opindex mmemcpy
7698 @opindex mno-memcpy
7699 The @option{-mmemcpy} switch makes all block moves call the appropriate
7700 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7701 generating inline code.
7703 @item -mmips-tfile
7704 @itemx -mno-mips-tfile
7705 @opindex mmips-tfile
7706 @opindex mno-mips-tfile
7707 The @option{-mno-mips-tfile} switch causes the compiler not
7708 postprocess the object file with the @file{mips-tfile} program,
7709 after the MIPS assembler has generated it to add debug support.  If
7710 @file{mips-tfile} is not run, then no local variables will be
7711 available to the debugger.  In addition, @file{stage2} and
7712 @file{stage3} objects will have the temporary file names passed to the
7713 assembler embedded in the object file, which means the objects will
7714 not compare the same.  The @option{-mno-mips-tfile} switch should only
7715 be used when there are bugs in the @file{mips-tfile} program that
7716 prevents compilation.
7718 @item -msoft-float
7719 @opindex msoft-float
7720 Generate output containing library calls for floating point.
7721 @strong{Warning:} the requisite libraries are not part of GCC@.
7722 Normally the facilities of the machine's usual C compiler are used, but
7723 this can't be done directly in cross-compilation.  You must make your
7724 own arrangements to provide suitable library functions for
7725 cross-compilation.
7727 @item -mhard-float
7728 @opindex mhard-float
7729 Generate output containing floating point instructions.  This is the
7730 default if you use the unmodified sources.
7732 @item -mabicalls
7733 @itemx -mno-abicalls
7734 @opindex mabicalls
7735 @opindex mno-abicalls
7736 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7737 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7738 position independent code.
7740 @item -mlong-calls
7741 @itemx -mno-long-calls
7742 @opindex mlong-calls
7743 @opindex mno-long-calls
7744 Do all calls with the @samp{JALR} instruction, which requires
7745 loading up a function's address into a register before the call.
7746 You need to use this switch, if you call outside of the current
7747 512 megabyte segment to functions that are not through pointers.
7749 @item -mhalf-pic
7750 @itemx -mno-half-pic
7751 @opindex mhalf-pic
7752 @opindex mno-half-pic
7753 Put pointers to extern references into the data section and load them
7754 up, rather than put the references in the text section.
7756 @item -membedded-pic
7757 @itemx -mno-embedded-pic
7758 @opindex membedded-pic
7759 @opindex mno-embedded-pic
7760 Generate PIC code suitable for some embedded systems.  All calls are
7761 made using PC relative address, and all data is addressed using the $gp
7762 register.  No more than 65536 bytes of global data may be used.  This
7763 requires GNU as and GNU ld which do most of the work.  This currently
7764 only works on targets which use ECOFF; it does not work with ELF@.
7766 @item -membedded-data
7767 @itemx -mno-embedded-data
7768 @opindex membedded-data
7769 @opindex mno-embedded-data
7770 Allocate variables to the read-only data section first if possible, then
7771 next in the small data section if possible, otherwise in data.  This gives
7772 slightly slower code than the default, but reduces the amount of RAM required
7773 when executing, and thus may be preferred for some embedded systems.
7775 @item -muninit-const-in-rodata
7776 @itemx -mno-uninit-const-in-rodata
7777 @opindex muninit-const-in-rodata
7778 @opindex mno-uninit-const-in-rodata
7779 When used together with @option{-membedded-data}, it will always store uninitialized
7780 const variables in the read-only data section.
7782 @item -msingle-float
7783 @itemx -mdouble-float
7784 @opindex msingle-float
7785 @opindex mdouble-float
7786 The @option{-msingle-float} switch tells gcc to assume that the floating
7787 point coprocessor only supports single precision operations, as on the
7788 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7789 double precision operations.  This is the default.
7791 @item -mmad
7792 @itemx -mno-mad
7793 @opindex mmad
7794 @opindex mno-mad
7795 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7796 as on the @samp{r4650} chip.
7798 @item -m4650
7799 @opindex m4650
7800 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7801 @option{-mcpu=r4650}.
7803 @item -mips16
7804 @itemx -mno-mips16
7805 @opindex mips16
7806 @opindex mno-mips16
7807 Enable 16-bit instructions.
7809 @item -mentry
7810 @opindex mentry
7811 Use the entry and exit pseudo ops.  This option can only be used with
7812 @option{-mips16}.
7814 @item -EL
7815 @opindex EL
7816 Compile code for the processor in little endian mode.
7817 The requisite libraries are assumed to exist.
7819 @item -EB
7820 @opindex EB
7821 Compile code for the processor in big endian mode.
7822 The requisite libraries are assumed to exist.
7824 @item -G @var{num}
7825 @opindex G
7826 @cindex smaller data references (MIPS)
7827 @cindex gp-relative references (MIPS)
7828 Put global and static items less than or equal to @var{num} bytes into
7829 the small data or bss sections instead of the normal data or bss
7830 section.  This allows the assembler to emit one word memory reference
7831 instructions based on the global pointer (@var{gp} or @var{$28}),
7832 instead of the normal two words used.  By default, @var{num} is 8 when
7833 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7834 @option{-G @var{num}} switch is also passed to the assembler and linker.
7835 All modules should be compiled with the same @option{-G @var{num}}
7836 value.
7838 @item -nocpp
7839 @opindex nocpp
7840 Tell the MIPS assembler to not run its preprocessor over user
7841 assembler files (with a @samp{.s} suffix) when assembling them.
7843 @item -mfix7000
7844 @opindex mfix7000
7845 Pass an option to gas which will cause nops to be inserted if
7846 the read of the destination register of an mfhi or mflo instruction
7847 occurs in the following two instructions.
7849 @item -no-crt0
7850 @opindex no-crt0
7851 Do not include the default crt0.
7853 @item -mflush-func=@var{func}
7854 @itemx -mno-flush-func
7855 @opindex mflush-func
7856 Specifies the function to call to flush the I and D caches, or to not
7857 call any such function.  If called, the function must take the same
7858 arguments as the common @code{_flush_func()}, that is, the address of the
7859 memory range for which the cache is being flushed, the size of the
7860 memory range, and the number 3 (to flush both caches).  The default
7861 depends on the target gcc was configured for, but commonly is either
7862 @samp{_flush_func} or @samp{__cpu_flush}.
7864 @item -mbranch-likely
7865 @itemx -mno-branch-likely
7866 @opindex mbranch-likely
7867 @opindex mno-branch-likely
7868 Enable or disable use of Branch Likely instructions, regardless of the
7869 default for the selected architecture.  By default, Branch Likely
7870 instructions may be generated if they are supported by the selected
7871 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7872 and processors which implement those architectures; for those, Branch
7873 Likely instructions will not be generated by default because the MIPS32
7874 and MIPS64 architectures specifically deprecate their use.
7875 @end table
7877 @node i386 and x86-64 Options
7878 @subsection Intel 386 and AMD x86-64 Options
7879 @cindex i386 Options
7880 @cindex x86-64 Options
7881 @cindex Intel 386 Options
7882 @cindex AMD x86-64 Options
7884 These @samp{-m} options are defined for the i386 and x86-64 family of
7885 computers:
7887 @table @gcctabopt
7888 @item -mcpu=@var{cpu-type}
7889 @opindex mcpu
7890 Tune to @var{cpu-type} everything applicable about the generated code, except
7891 for the ABI and the set of available instructions.  The choices for
7892 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7893 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7894 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7895 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7896 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8} and @samp{c3}.
7898 While picking a specific @var{cpu-type} will schedule things appropriately
7899 for that particular chip, the compiler will not generate any code that
7900 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7901 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7902 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7903 AMD chips as opposed to the Intel ones.
7905 @item -march=@var{cpu-type}
7906 @opindex march
7907 Generate instructions for the machine type @var{cpu-type}.  The choices
7908 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7909 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7911 @item -m386
7912 @itemx -m486
7913 @itemx -mpentium
7914 @itemx -mpentiumpro
7915 @opindex m386
7916 @opindex m486
7917 @opindex mpentium
7918 @opindex mpentiumpro
7919 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7920 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7921 These synonyms are deprecated.
7923 @item -mfpmath=@var{unit}
7924 @opindex march
7925 generate floating point arithmetics for selected unit @var{unit}.  the choices
7926 for @var{unit} are:
7928 @table @samp
7929 @item 387
7930 Use the standard 387 floating point coprocessor present majority of chips and
7931 emulated otherwise.  Code compiled with this option will run almost everywhere.
7932 The temporary results are computed in 80bit precision instead of precision
7933 specified by the type resulting in slightly different results compared to most
7934 of other chips. See @option{-ffloat-store} for more detailed description.
7936 This is the default choice for i386 compiler.
7938 @item sse
7939 Use scalar floating point instructions present in the SSE instruction set.
7940 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7941 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7942 instruction set supports only single precision arithmetics, thus the double and
7943 extended precision arithmetics is still done using 387.  Later version, present
7944 only in Pentium4 and the future AMD x86-64 chips supports double precision
7945 arithmetics too.
7947 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7948 @option{-msse2} switches to enable SSE extensions and make this option
7949 effective.  For x86-64 compiler, these extensions are enabled by default.
7951 The resulting code should be considerably faster in majority of cases and avoid
7952 the numerical instability problems of 387 code, but may break some existing
7953 code that expects temporaries to be 80bit.
7955 This is the default choice for x86-64 compiler.
7957 @item sse,387
7958 Attempt to utilize both instruction sets at once.  This effectively double the
7959 amount of available registers and on chips with separate execution units for
7960 387 and SSE the execution resources too.  Use this option with care, as it is
7961 still experimental, because gcc register allocator does not model separate
7962 functional units well resulting in instable performance.
7963 @end table
7965 @item -masm=@var{dialect}
7966 @opindex masm=@var{dialect}
7967 Output asm instructions using selected @var{dialect}. Supported choices are
7968 @samp{intel} or @samp{att} (the default one).
7970 @item -mieee-fp
7971 @itemx -mno-ieee-fp
7972 @opindex mieee-fp
7973 @opindex mno-ieee-fp
7974 Control whether or not the compiler uses IEEE floating point
7975 comparisons.  These handle correctly the case where the result of a
7976 comparison is unordered.
7978 @item -msoft-float
7979 @opindex msoft-float
7980 Generate output containing library calls for floating point.
7981 @strong{Warning:} the requisite libraries are not part of GCC@.
7982 Normally the facilities of the machine's usual C compiler are used, but
7983 this can't be done directly in cross-compilation.  You must make your
7984 own arrangements to provide suitable library functions for
7985 cross-compilation.
7987 On machines where a function returns floating point results in the 80387
7988 register stack, some floating point opcodes may be emitted even if
7989 @option{-msoft-float} is used.
7991 @item -mno-fp-ret-in-387
7992 @opindex mno-fp-ret-in-387
7993 Do not use the FPU registers for return values of functions.
7995 The usual calling convention has functions return values of types
7996 @code{float} and @code{double} in an FPU register, even if there
7997 is no FPU@.  The idea is that the operating system should emulate
7998 an FPU@.
8000 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8001 in ordinary CPU registers instead.
8003 @item -mno-fancy-math-387
8004 @opindex mno-fancy-math-387
8005 Some 387 emulators do not support the @code{sin}, @code{cos} and
8006 @code{sqrt} instructions for the 387.  Specify this option to avoid
8007 generating those instructions.  This option is the default on FreeBSD,
8008 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8009 indicates that the target cpu will always have an FPU and so the
8010 instruction will not need emulation.  As of revision 2.6.1, these
8011 instructions are not generated unless you also use the
8012 @option{-funsafe-math-optimizations} switch.
8014 @item -malign-double
8015 @itemx -mno-align-double
8016 @opindex malign-double
8017 @opindex mno-align-double
8018 Control whether GCC aligns @code{double}, @code{long double}, and
8019 @code{long long} variables on a two word boundary or a one word
8020 boundary.  Aligning @code{double} variables on a two word boundary will
8021 produce code that runs somewhat faster on a @samp{Pentium} at the
8022 expense of more memory.
8024 @strong{Warning:} if you use the @option{-malign-double} switch,
8025 structures containing the above types will be aligned differently than
8026 the published application binary interface specifications for the 386
8027 and will not be binary compatible with structures in code compiled
8028 without that switch.
8030 @item -m128bit-long-double
8031 @opindex m128bit-long-double
8032 Control the size of @code{long double} type. i386 application binary interface
8033 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8034 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8035 impossible to reach with 12 byte long doubles in the array accesses.
8037 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8038 structures and arrays containing @code{long double} will change their size as
8039 well as function calling convention for function taking @code{long double}
8040 will be modified.
8042 @item -m96bit-long-double
8043 @opindex m96bit-long-double
8044 Set the size of @code{long double} to 96 bits as required by the i386
8045 application binary interface.  This is the default.
8047 @item -msvr3-shlib
8048 @itemx -mno-svr3-shlib
8049 @opindex msvr3-shlib
8050 @opindex mno-svr3-shlib
8051 Control whether GCC places uninitialized local variables into the
8052 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8053 into @code{bss}.  These options are meaningful only on System V Release 3.
8055 @item -mrtd
8056 @opindex mrtd
8057 Use a different function-calling convention, in which functions that
8058 take a fixed number of arguments return with the @code{ret} @var{num}
8059 instruction, which pops their arguments while returning.  This saves one
8060 instruction in the caller since there is no need to pop the arguments
8061 there.
8063 You can specify that an individual function is called with this calling
8064 sequence with the function attribute @samp{stdcall}.  You can also
8065 override the @option{-mrtd} option by using the function attribute
8066 @samp{cdecl}.  @xref{Function Attributes}.
8068 @strong{Warning:} this calling convention is incompatible with the one
8069 normally used on Unix, so you cannot use it if you need to call
8070 libraries compiled with the Unix compiler.
8072 Also, you must provide function prototypes for all functions that
8073 take variable numbers of arguments (including @code{printf});
8074 otherwise incorrect code will be generated for calls to those
8075 functions.
8077 In addition, seriously incorrect code will result if you call a
8078 function with too many arguments.  (Normally, extra arguments are
8079 harmlessly ignored.)
8081 @item -mregparm=@var{num}
8082 @opindex mregparm
8083 Control how many registers are used to pass integer arguments.  By
8084 default, no registers are used to pass arguments, and at most 3
8085 registers can be used.  You can control this behavior for a specific
8086 function by using the function attribute @samp{regparm}.
8087 @xref{Function Attributes}.
8089 @strong{Warning:} if you use this switch, and
8090 @var{num} is nonzero, then you must build all modules with the same
8091 value, including any libraries.  This includes the system libraries and
8092 startup modules.
8094 @item -mpreferred-stack-boundary=@var{num}
8095 @opindex mpreferred-stack-boundary
8096 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8097 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8098 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8099 size (@option{-Os}), in which case the default is the minimum correct
8100 alignment (4 bytes for x86, and 8 bytes for x86-64).
8102 On Pentium and PentiumPro, @code{double} and @code{long double} values
8103 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8104 suffer significant run time performance penalties.  On Pentium III, the
8105 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8106 penalties if it is not 16 byte aligned.
8108 To ensure proper alignment of this values on the stack, the stack boundary
8109 must be as aligned as that required by any value stored on the stack.
8110 Further, every function must be generated such that it keeps the stack
8111 aligned.  Thus calling a function compiled with a higher preferred
8112 stack boundary from a function compiled with a lower preferred stack
8113 boundary will most likely misalign the stack.  It is recommended that
8114 libraries that use callbacks always use the default setting.
8116 This extra alignment does consume extra stack space, and generally
8117 increases code size.  Code that is sensitive to stack space usage, such
8118 as embedded systems and operating system kernels, may want to reduce the
8119 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8121 @item -mmmx
8122 @itemx -mno-mmx
8123 @item -msse
8124 @itemx -mno-sse
8125 @item -msse2
8126 @itemx -mno-sse2
8127 @item -m3dnow
8128 @itemx -mno-3dnow
8129 @opindex mmmx
8130 @opindex mno-mmx
8131 @opindex msse
8132 @opindex mno-sse
8133 @opindex m3dnow
8134 @opindex mno-3dnow
8135 These switches enable or disable the use of built-in functions that allow
8136 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8138 @xref{X86 Built-in Functions}, for details of the functions enabled
8139 and disabled by these switches.
8141 To have SSE/SSE2 instructions generated automatically from floating-point
8142 code, see @option{-mfpmath=sse}.
8144 @item -mpush-args
8145 @itemx -mno-push-args
8146 @opindex mpush-args
8147 @opindex mno-push-args
8148 Use PUSH operations to store outgoing parameters.  This method is shorter
8149 and usually equally fast as method using SUB/MOV operations and is enabled
8150 by default.  In some cases disabling it may improve performance because of
8151 improved scheduling and reduced dependencies.
8153 @item -maccumulate-outgoing-args
8154 @opindex maccumulate-outgoing-args
8155 If enabled, the maximum amount of space required for outgoing arguments will be
8156 computed in the function prologue.  This is faster on most modern CPUs
8157 because of reduced dependencies, improved scheduling and reduced stack usage
8158 when preferred stack boundary is not equal to 2.  The drawback is a notable
8159 increase in code size.  This switch implies @option{-mno-push-args}.
8161 @item -mthreads
8162 @opindex mthreads
8163 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8164 on thread-safe exception handling must compile and link all code with the
8165 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8166 @option{-D_MT}; when linking, it links in a special thread helper library
8167 @option{-lmingwthrd} which cleans up per thread exception handling data.
8169 @item -mno-align-stringops
8170 @opindex mno-align-stringops
8171 Do not align destination of inlined string operations.  This switch reduces
8172 code size and improves performance in case the destination is already aligned,
8173 but gcc don't know about it.
8175 @item -minline-all-stringops
8176 @opindex minline-all-stringops
8177 By default GCC inlines string operations only when destination is known to be
8178 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8179 size, but may improve performance of code that depends on fast memcpy, strlen
8180 and memset for short lengths.
8182 @item -momit-leaf-frame-pointer
8183 @opindex momit-leaf-frame-pointer
8184 Don't keep the frame pointer in a register for leaf functions.  This
8185 avoids the instructions to save, set up and restore frame pointers and
8186 makes an extra register available in leaf functions.  The option
8187 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8188 which might make debugging harder.
8189 @end table
8191 These @samp{-m} switches are supported in addition to the above
8192 on AMD x86-64 processors in 64-bit environments.
8194 @table @gcctabopt
8195 @item -m32
8196 @itemx -m64
8197 @opindex m32
8198 @opindex m64
8199 Generate code for a 32-bit or 64-bit environment.
8200 The 32-bit environment sets int, long and pointer to 32 bits and
8201 generates code that runs on any i386 system.
8202 The 64-bit environment sets int to 32 bits and long and pointer
8203 to 64 bits and generates code for AMD's x86-64 architecture.
8205 @item -mno-red-zone
8206 @opindex no-red-zone
8207 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8208 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8209 stack pointer that will not be modified by signal or interrupt handlers
8210 and therefore can be used for temporary data without adjusting the stack
8211 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8213 @item -mcmodel=small
8214 @opindex mcmodel=small
8215 Generate code for the small code model: the program and its symbols must
8216 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8217 Programs can be statically or dynamically linked.  This is the default
8218 code model.
8220 @item -mcmodel=kernel
8221 @opindex mcmodel=kernel
8222 Generate code for the kernel code model.  The kernel runs in the
8223 negative 2 GB of the address space.
8224 This model has to be used for Linux kernel code.
8226 @item -mcmodel=medium
8227 @opindex mcmodel=medium
8228 Generate code for the medium model: The program is linked in the lower 2
8229 GB of the address space but symbols can be located anywhere in the
8230 address space.  Programs can be statically or dynamically linked, but
8231 building of shared libraries are not supported with the medium model.
8233 @item -mcmodel=large
8234 @opindex mcmodel=large
8235 Generate code for the large model: This model makes no assumptions
8236 about addresses and sizes of sections.  Currently GCC does not implement
8237 this model.
8238 @end table
8240 @node HPPA Options
8241 @subsection HPPA Options
8242 @cindex HPPA Options
8244 These @samp{-m} options are defined for the HPPA family of computers:
8246 @table @gcctabopt
8247 @item -march=@var{architecture-type}
8248 @opindex march
8249 Generate code for the specified architecture.  The choices for
8250 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8251 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8252 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8253 architecture option for your machine.  Code compiled for lower numbered
8254 architectures will run on higher numbered architectures, but not the
8255 other way around.
8257 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8258 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8259 support.
8261 @item -mpa-risc-1-0
8262 @itemx -mpa-risc-1-1
8263 @itemx -mpa-risc-2-0
8264 @opindex mpa-risc-1-0
8265 @opindex mpa-risc-1-1
8266 @opindex mpa-risc-2-0
8267 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8269 @item -mbig-switch
8270 @opindex mbig-switch
8271 Generate code suitable for big switch tables.  Use this option only if
8272 the assembler/linker complain about out of range branches within a switch
8273 table.
8275 @item -mjump-in-delay
8276 @opindex mjump-in-delay
8277 Fill delay slots of function calls with unconditional jump instructions
8278 by modifying the return pointer for the function call to be the target
8279 of the conditional jump.
8281 @item -mdisable-fpregs
8282 @opindex mdisable-fpregs
8283 Prevent floating point registers from being used in any manner.  This is
8284 necessary for compiling kernels which perform lazy context switching of
8285 floating point registers.  If you use this option and attempt to perform
8286 floating point operations, the compiler will abort.
8288 @item -mdisable-indexing
8289 @opindex mdisable-indexing
8290 Prevent the compiler from using indexing address modes.  This avoids some
8291 rather obscure problems when compiling MIG generated code under MACH@.
8293 @item -mno-space-regs
8294 @opindex mno-space-regs
8295 Generate code that assumes the target has no space registers.  This allows
8296 GCC to generate faster indirect calls and use unscaled index address modes.
8298 Such code is suitable for level 0 PA systems and kernels.
8300 @item -mfast-indirect-calls
8301 @opindex mfast-indirect-calls
8302 Generate code that assumes calls never cross space boundaries.  This
8303 allows GCC to emit code which performs faster indirect calls.
8305 This option will not work in the presence of shared libraries or nested
8306 functions.
8308 @item -mlong-load-store
8309 @opindex mlong-load-store
8310 Generate 3-instruction load and store sequences as sometimes required by
8311 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8312 the HP compilers.
8314 @item -mportable-runtime
8315 @opindex mportable-runtime
8316 Use the portable calling conventions proposed by HP for ELF systems.
8318 @item -mgas
8319 @opindex mgas
8320 Enable the use of assembler directives only GAS understands.
8322 @item -mschedule=@var{cpu-type}
8323 @opindex mschedule
8324 Schedule code according to the constraints for the machine type
8325 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8326 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8327 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8328 proper scheduling option for your machine.  The default scheduling is
8329 @samp{8000}.
8331 @item -mlinker-opt
8332 @opindex mlinker-opt
8333 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8334 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8335 linkers in which they give bogus error messages when linking some programs.
8337 @item -msoft-float
8338 @opindex msoft-float
8339 Generate output containing library calls for floating point.
8340 @strong{Warning:} the requisite libraries are not available for all HPPA
8341 targets.  Normally the facilities of the machine's usual C compiler are
8342 used, but this cannot be done directly in cross-compilation.  You must make
8343 your own arrangements to provide suitable library functions for
8344 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8345 does provide software floating point support.
8347 @option{-msoft-float} changes the calling convention in the output file;
8348 therefore, it is only useful if you compile @emph{all} of a program with
8349 this option.  In particular, you need to compile @file{libgcc.a}, the
8350 library that comes with GCC, with @option{-msoft-float} in order for
8351 this to work.
8353 @item -msio
8354 @opindex msio
8355 Generate the predefine, @code{_SIO}, for server IO.  The default is
8356 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8357 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8358 options are available under HP-UX and HI-UX.
8360 @item -mgnu-ld
8361 @opindex gnu-ld
8362 Use GNU ld specific options.  This passes @option{-shared} to ld when
8363 building a shared library.  It is the default when GCC is configured,
8364 explicitly or implicitly, with the GNU linker.  This option does not
8365 have any affect on which ld is called, it only changes what parameters
8366 are passed to that ld.  The ld that is called is determined by the
8367 @option{--with-ld} configure option, gcc's program search path, and
8368 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8369 using @samp{which `gcc -print-prog-name=ld`}.
8371 @item -mhp-ld
8372 @opindex hp-ld
8373 Use HP ld specific options.  This passes @option{-b} to ld when building
8374 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8375 links.  It is the default when GCC is configured, explicitly or
8376 implicitly, with the HP linker.  This option does not have any affect on
8377 which ld is called, it only changes what parameters are passed to that
8378 ld.  The ld that is called is determined by the @option{--with-ld}
8379 configure option, gcc's program search path, and finally by the user's
8380 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8381 `gcc -print-prog-name=ld`}.
8383 @item -mlong-calls
8384 @opindex mno-long-calls
8385 Generate code that uses long call sequences.  This ensures that a call
8386 is always able to reach linker generated stubs.  The default is to generate
8387 long calls only when the distance from the call site to the beginning
8388 of the function or translation unit, as the case may be, exceeds a
8389 predefined limit set by the branch type being used.  The limits for
8390 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8391 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8392 240,000 bytes.
8394 Distances are measured from the beginning of functions when using the
8395 @option{-ffunction-sections} option, or when using the @option{-mgas}
8396 and @option{-mno-portable-runtime} options together under HP-UX with
8397 the SOM linker.
8399 It is normally not desirable to use this option as it will degrade
8400 performance.  However, it may be useful in large applications,
8401 particularly when partial linking is used to build the application.
8403 The types of long calls used depends on the capabilities of the
8404 assembler and linker, and the type of code being generated.  The
8405 impact on systems that support long absolute calls, and long pic
8406 symbol-difference or pc-relative calls should be relatively small.
8407 However, an indirect call is used on 32-bit ELF systems in pic code
8408 and it is quite long.
8410 @end table
8412 @node Intel 960 Options
8413 @subsection Intel 960 Options
8415 These @samp{-m} options are defined for the Intel 960 implementations:
8417 @table @gcctabopt
8418 @item -m@var{cpu-type}
8419 @opindex mka
8420 @opindex mkb
8421 @opindex mmc
8422 @opindex mca
8423 @opindex mcf
8424 @opindex msa
8425 @opindex msb
8426 Assume the defaults for the machine type @var{cpu-type} for some of
8427 the other options, including instruction scheduling, floating point
8428 support, and addressing modes.  The choices for @var{cpu-type} are
8429 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8430 @samp{sa}, and @samp{sb}.
8431 The default is
8432 @samp{kb}.
8434 @item -mnumerics
8435 @itemx -msoft-float
8436 @opindex mnumerics
8437 @opindex msoft-float
8438 The @option{-mnumerics} option indicates that the processor does support
8439 floating-point instructions.  The @option{-msoft-float} option indicates
8440 that floating-point support should not be assumed.
8442 @item -mleaf-procedures
8443 @itemx -mno-leaf-procedures
8444 @opindex mleaf-procedures
8445 @opindex mno-leaf-procedures
8446 Do (or do not) attempt to alter leaf procedures to be callable with the
8447 @code{bal} instruction as well as @code{call}.  This will result in more
8448 efficient code for explicit calls when the @code{bal} instruction can be
8449 substituted by the assembler or linker, but less efficient code in other
8450 cases, such as calls via function pointers, or using a linker that doesn't
8451 support this optimization.
8453 @item -mtail-call
8454 @itemx -mno-tail-call
8455 @opindex mtail-call
8456 @opindex mno-tail-call
8457 Do (or do not) make additional attempts (beyond those of the
8458 machine-independent portions of the compiler) to optimize tail-recursive
8459 calls into branches.  You may not want to do this because the detection of
8460 cases where this is not valid is not totally complete.  The default is
8461 @option{-mno-tail-call}.
8463 @item -mcomplex-addr
8464 @itemx -mno-complex-addr
8465 @opindex mcomplex-addr
8466 @opindex mno-complex-addr
8467 Assume (or do not assume) that the use of a complex addressing mode is a
8468 win on this implementation of the i960.  Complex addressing modes may not
8469 be worthwhile on the K-series, but they definitely are on the C-series.
8470 The default is currently @option{-mcomplex-addr} for all processors except
8471 the CB and CC@.
8473 @item -mcode-align
8474 @itemx -mno-code-align
8475 @opindex mcode-align
8476 @opindex mno-code-align
8477 Align code to 8-byte boundaries for faster fetching (or don't bother).
8478 Currently turned on by default for C-series implementations only.
8480 @ignore
8481 @item -mclean-linkage
8482 @itemx -mno-clean-linkage
8483 @opindex mclean-linkage
8484 @opindex mno-clean-linkage
8485 These options are not fully implemented.
8486 @end ignore
8488 @item -mic-compat
8489 @itemx -mic2.0-compat
8490 @itemx -mic3.0-compat
8491 @opindex mic-compat
8492 @opindex mic2.0-compat
8493 @opindex mic3.0-compat
8494 Enable compatibility with iC960 v2.0 or v3.0.
8496 @item -masm-compat
8497 @itemx -mintel-asm
8498 @opindex masm-compat
8499 @opindex mintel-asm
8500 Enable compatibility with the iC960 assembler.
8502 @item -mstrict-align
8503 @itemx -mno-strict-align
8504 @opindex mstrict-align
8505 @opindex mno-strict-align
8506 Do not permit (do permit) unaligned accesses.
8508 @item -mold-align
8509 @opindex mold-align
8510 Enable structure-alignment compatibility with Intel's gcc release version
8511 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8513 @item -mlong-double-64
8514 @opindex mlong-double-64
8515 Implement type @samp{long double} as 64-bit floating point numbers.
8516 Without the option @samp{long double} is implemented by 80-bit
8517 floating point numbers.  The only reason we have it because there is
8518 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8519 is only useful for people using soft-float targets.  Otherwise, we
8520 should recommend against use of it.
8522 @end table
8524 @node DEC Alpha Options
8525 @subsection DEC Alpha Options
8527 These @samp{-m} options are defined for the DEC Alpha implementations:
8529 @table @gcctabopt
8530 @item -mno-soft-float
8531 @itemx -msoft-float
8532 @opindex mno-soft-float
8533 @opindex msoft-float
8534 Use (do not use) the hardware floating-point instructions for
8535 floating-point operations.  When @option{-msoft-float} is specified,
8536 functions in @file{libgcc.a} will be used to perform floating-point
8537 operations.  Unless they are replaced by routines that emulate the
8538 floating-point operations, or compiled in such a way as to call such
8539 emulations routines, these routines will issue floating-point
8540 operations.   If you are compiling for an Alpha without floating-point
8541 operations, you must ensure that the library is built so as not to call
8542 them.
8544 Note that Alpha implementations without floating-point operations are
8545 required to have floating-point registers.
8547 @item -mfp-reg
8548 @itemx -mno-fp-regs
8549 @opindex mfp-reg
8550 @opindex mno-fp-regs
8551 Generate code that uses (does not use) the floating-point register set.
8552 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8553 register set is not used, floating point operands are passed in integer
8554 registers as if they were integers and floating-point results are passed
8555 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8556 so any function with a floating-point argument or return value called by code
8557 compiled with @option{-mno-fp-regs} must also be compiled with that
8558 option.
8560 A typical use of this option is building a kernel that does not use,
8561 and hence need not save and restore, any floating-point registers.
8563 @item -mieee
8564 @opindex mieee
8565 The Alpha architecture implements floating-point hardware optimized for
8566 maximum performance.  It is mostly compliant with the IEEE floating
8567 point standard.  However, for full compliance, software assistance is
8568 required.  This option generates code fully IEEE compliant code
8569 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8570 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8571 defined during compilation.  The resulting code is less efficient but is
8572 able to correctly support denormalized numbers and exceptional IEEE
8573 values such as not-a-number and plus/minus infinity.  Other Alpha
8574 compilers call this option @option{-ieee_with_no_inexact}.
8576 @item -mieee-with-inexact
8577 @opindex mieee-with-inexact
8578 This is like @option{-mieee} except the generated code also maintains
8579 the IEEE @var{inexact-flag}.  Turning on this option causes the
8580 generated code to implement fully-compliant IEEE math.  In addition to
8581 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8582 macro.  On some Alpha implementations the resulting code may execute
8583 significantly slower than the code generated by default.  Since there is
8584 very little code that depends on the @var{inexact-flag}, you should
8585 normally not specify this option.  Other Alpha compilers call this
8586 option @option{-ieee_with_inexact}.
8588 @item -mfp-trap-mode=@var{trap-mode}
8589 @opindex mfp-trap-mode
8590 This option controls what floating-point related traps are enabled.
8591 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8592 The trap mode can be set to one of four values:
8594 @table @samp
8595 @item n
8596 This is the default (normal) setting.  The only traps that are enabled
8597 are the ones that cannot be disabled in software (e.g., division by zero
8598 trap).
8600 @item u
8601 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8602 as well.
8604 @item su
8605 Like @samp{su}, but the instructions are marked to be safe for software
8606 completion (see Alpha architecture manual for details).
8608 @item sui
8609 Like @samp{su}, but inexact traps are enabled as well.
8610 @end table
8612 @item -mfp-rounding-mode=@var{rounding-mode}
8613 @opindex mfp-rounding-mode
8614 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8615 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8618 @table @samp
8619 @item n
8620 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8621 the nearest machine number or towards the even machine number in case
8622 of a tie.
8624 @item m
8625 Round towards minus infinity.
8627 @item c
8628 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8630 @item d
8631 Dynamic rounding mode.  A field in the floating point control register
8632 (@var{fpcr}, see Alpha architecture reference manual) controls the
8633 rounding mode in effect.  The C library initializes this register for
8634 rounding towards plus infinity.  Thus, unless your program modifies the
8635 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8636 @end table
8638 @item -mtrap-precision=@var{trap-precision}
8639 @opindex mtrap-precision
8640 In the Alpha architecture, floating point traps are imprecise.  This
8641 means without software assistance it is impossible to recover from a
8642 floating trap and program execution normally needs to be terminated.
8643 GCC can generate code that can assist operating system trap handlers
8644 in determining the exact location that caused a floating point trap.
8645 Depending on the requirements of an application, different levels of
8646 precisions can be selected:
8648 @table @samp
8649 @item p
8650 Program precision.  This option is the default and means a trap handler
8651 can only identify which program caused a floating point exception.
8653 @item f
8654 Function precision.  The trap handler can determine the function that
8655 caused a floating point exception.
8657 @item i
8658 Instruction precision.  The trap handler can determine the exact
8659 instruction that caused a floating point exception.
8660 @end table
8662 Other Alpha compilers provide the equivalent options called
8663 @option{-scope_safe} and @option{-resumption_safe}.
8665 @item -mieee-conformant
8666 @opindex mieee-conformant
8667 This option marks the generated code as IEEE conformant.  You must not
8668 use this option unless you also specify @option{-mtrap-precision=i} and either
8669 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8670 is to emit the line @samp{.eflag 48} in the function prologue of the
8671 generated assembly file.  Under DEC Unix, this has the effect that
8672 IEEE-conformant math library routines will be linked in.
8674 @item -mbuild-constants
8675 @opindex mbuild-constants
8676 Normally GCC examines a 32- or 64-bit integer constant to
8677 see if it can construct it from smaller constants in two or three
8678 instructions.  If it cannot, it will output the constant as a literal and
8679 generate code to load it from the data segment at runtime.
8681 Use this option to require GCC to construct @emph{all} integer constants
8682 using code, even if it takes more instructions (the maximum is six).
8684 You would typically use this option to build a shared library dynamic
8685 loader.  Itself a shared library, it must relocate itself in memory
8686 before it can find the variables and constants in its own data segment.
8688 @item -malpha-as
8689 @itemx -mgas
8690 @opindex malpha-as
8691 @opindex mgas
8692 Select whether to generate code to be assembled by the vendor-supplied
8693 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8695 @item -mbwx
8696 @itemx -mno-bwx
8697 @itemx -mcix
8698 @itemx -mno-cix
8699 @itemx -mfix
8700 @itemx -mno-fix
8701 @itemx -mmax
8702 @itemx -mno-max
8703 @opindex mbwx
8704 @opindex mno-bwx
8705 @opindex mcix
8706 @opindex mno-cix
8707 @opindex mfix
8708 @opindex mno-fix
8709 @opindex mmax
8710 @opindex mno-max
8711 Indicate whether GCC should generate code to use the optional BWX,
8712 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8713 sets supported by the CPU type specified via @option{-mcpu=} option or that
8714 of the CPU on which GCC was built if none was specified.
8716 @item -mfloat-vax
8717 @itemx -mfloat-ieee
8718 @opindex mfloat-vax
8719 @opindex mfloat-ieee
8720 Generate code that uses (does not use) VAX F and G floating point
8721 arithmetic instead of IEEE single and double precision.
8723 @item -mexplicit-relocs
8724 @itemx -mno-explicit-relocs
8725 @opindex mexplicit-relocs
8726 @opindex mno-explicit-relocs
8727 Older Alpha assemblers provided no way to generate symbol relocations
8728 except via assembler macros.  Use of these macros does not allow
8729 optimal instruction scheduling.  GNU binutils as of version 2.12
8730 supports a new syntax that allows the compiler to explicitly mark
8731 which relocations should apply to which instructions.  This option
8732 is mostly useful for debugging, as GCC detects the capabilities of
8733 the assembler when it is built and sets the default accordingly.
8735 @item -msmall-data
8736 @itemx -mlarge-data
8737 @opindex msmall-data
8738 @opindex mlarge-data
8739 When @option{-mexplicit-relocs} is in effect, static data is
8740 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8741 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8742 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8743 16-bit relocations off of the @code{$gp} register.  This limits the
8744 size of the small data area to 64KB, but allows the variables to be
8745 directly accessed via a single instruction.
8747 The default is @option{-mlarge-data}.  With this option the data area
8748 is limited to just below 2GB.  Programs that require more than 2GB of
8749 data must use @code{malloc} or @code{mmap} to allocate the data in the
8750 heap instead of in the program's data segment.
8752 When generating code for shared libraries, @option{-fpic} implies
8753 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8755 @item -msmall-text
8756 @itemx -mlarge-text
8757 @opindex msmall-text
8758 @opindex mlarge-text
8759 When @option{-msmall-text} is used, the compiler assumes that the
8760 code of the entire program (or shared library) fits in 4MB, and is
8761 thus reachable with a branch instruction.  When @option{-msmall-data}
8762 is used, the compiler can assume that all local symbols share the
8763 same @code{$gp} value, and thus reduce the number of instructions
8764 required for a function call from 4 to 1.
8766 The default is @option{-mlarge-text}.
8768 @item -mcpu=@var{cpu_type}
8769 @opindex mcpu
8770 Set the instruction set and instruction scheduling parameters for
8771 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8772 style name or the corresponding chip number.  GCC supports scheduling
8773 parameters for the EV4, EV5 and EV6 family of processors and will
8774 choose the default values for the instruction set from the processor
8775 you specify.  If you do not specify a processor type, GCC will default
8776 to the processor on which the compiler was built.
8778 Supported values for @var{cpu_type} are
8780 @table @samp
8781 @item ev4
8782 @item ev45
8783 @itemx 21064
8784 Schedules as an EV4 and has no instruction set extensions.
8786 @item ev5
8787 @itemx 21164
8788 Schedules as an EV5 and has no instruction set extensions.
8790 @item ev56
8791 @itemx 21164a
8792 Schedules as an EV5 and supports the BWX extension.
8794 @item pca56
8795 @itemx 21164pc
8796 @itemx 21164PC
8797 Schedules as an EV5 and supports the BWX and MAX extensions.
8799 @item ev6
8800 @itemx 21264
8801 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8803 @item ev67
8804 @item 21264a
8805 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8806 @end table
8808 @item -mtune=@var{cpu_type}
8809 @opindex mtune
8810 Set only the instruction scheduling parameters for machine type
8811 @var{cpu_type}.  The instruction set is not changed.
8813 @item -mmemory-latency=@var{time}
8814 @opindex mmemory-latency
8815 Sets the latency the scheduler should assume for typical memory
8816 references as seen by the application.  This number is highly
8817 dependent on the memory access patterns used by the application
8818 and the size of the external cache on the machine.
8820 Valid options for @var{time} are
8822 @table @samp
8823 @item @var{number}
8824 A decimal number representing clock cycles.
8826 @item L1
8827 @itemx L2
8828 @itemx L3
8829 @itemx main
8830 The compiler contains estimates of the number of clock cycles for
8831 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8832 (also called Dcache, Scache, and Bcache), as well as to main memory.
8833 Note that L3 is only valid for EV5.
8835 @end table
8836 @end table
8838 @node DEC Alpha/VMS Options
8839 @subsection DEC Alpha/VMS Options
8841 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8843 @table @gcctabopt
8844 @item -mvms-return-codes
8845 @opindex mvms-return-codes
8846 Return VMS condition codes from main.  The default is to return POSIX
8847 style condition (e.g.@ error) codes.
8848 @end table
8850 @node H8/300 Options
8851 @subsection H8/300 Options
8853 These @samp{-m} options are defined for the H8/300 implementations:
8855 @table @gcctabopt
8856 @item -mrelax
8857 @opindex mrelax
8858 Shorten some address references at link time, when possible; uses the
8859 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8860 ld.info, Using ld}, for a fuller description.
8862 @item -mh
8863 @opindex mh
8864 Generate code for the H8/300H@.
8866 @item -ms
8867 @opindex ms
8868 Generate code for the H8S@.
8870 @item -mn
8871 @opindex mn
8872 Generate code for the H8S and H8/300H in the normal mode.  This switch
8873 must be used either with -mh or -ms.
8875 @item -ms2600
8876 @opindex ms2600
8877 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8879 @item -mint32
8880 @opindex mint32
8881 Make @code{int} data 32 bits by default.
8883 @item -malign-300
8884 @opindex malign-300
8885 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8886 The default for the H8/300H and H8S is to align longs and floats on 4
8887 byte boundaries.
8888 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8889 This option has no effect on the H8/300.
8890 @end table
8892 @node SH Options
8893 @subsection SH Options
8895 These @samp{-m} options are defined for the SH implementations:
8897 @table @gcctabopt
8898 @item -m1
8899 @opindex m1
8900 Generate code for the SH1.
8902 @item -m2
8903 @opindex m2
8904 Generate code for the SH2.
8906 @item -m2e
8907 Generate code for the SH2e.
8909 @item -m3
8910 @opindex m3
8911 Generate code for the SH3.
8913 @item -m3e
8914 @opindex m3e
8915 Generate code for the SH3e.
8917 @item -m4-nofpu
8918 @opindex m4-nofpu
8919 Generate code for the SH4 without a floating-point unit.
8921 @item -m4-single-only
8922 @opindex m4-single-only
8923 Generate code for the SH4 with a floating-point unit that only
8924 supports single-precision arithmetic.
8926 @item -m4-single
8927 @opindex m4-single
8928 Generate code for the SH4 assuming the floating-point unit is in
8929 single-precision mode by default.
8931 @item -m4
8932 @opindex m4
8933 Generate code for the SH4.
8935 @item -mb
8936 @opindex mb
8937 Compile code for the processor in big endian mode.
8939 @item -ml
8940 @opindex ml
8941 Compile code for the processor in little endian mode.
8943 @item -mdalign
8944 @opindex mdalign
8945 Align doubles at 64-bit boundaries.  Note that this changes the calling
8946 conventions, and thus some functions from the standard C library will
8947 not work unless you recompile it first with @option{-mdalign}.
8949 @item -mrelax
8950 @opindex mrelax
8951 Shorten some address references at link time, when possible; uses the
8952 linker option @option{-relax}.
8954 @item -mbigtable
8955 @opindex mbigtable
8956 Use 32-bit offsets in @code{switch} tables.  The default is to use
8957 16-bit offsets.
8959 @item -mfmovd
8960 @opindex mfmovd
8961 Enable the use of the instruction @code{fmovd}.
8963 @item -mhitachi
8964 @opindex mhitachi
8965 Comply with the calling conventions defined by Hitachi.
8967 @item -mnomacsave
8968 @opindex mnomacsave
8969 Mark the @code{MAC} register as call-clobbered, even if
8970 @option{-mhitachi} is given.
8972 @item -mieee
8973 @opindex mieee
8974 Increase IEEE-compliance of floating-point code.
8976 @item -misize
8977 @opindex misize
8978 Dump instruction size and location in the assembly code.
8980 @item -mpadstruct
8981 @opindex mpadstruct
8982 This option is deprecated.  It pads structures to multiple of 4 bytes,
8983 which is incompatible with the SH ABI@.
8985 @item -mspace
8986 @opindex mspace
8987 Optimize for space instead of speed.  Implied by @option{-Os}.
8989 @item -mprefergot
8990 @opindex mprefergot
8991 When generating position-independent code, emit function calls using
8992 the Global Offset Table instead of the Procedure Linkage Table.
8994 @item -musermode
8995 @opindex musermode
8996 Generate a library function call to invalidate instruction cache
8997 entries, after fixing up a trampoline.  This library function call
8998 doesn't assume it can write to the whole memory address space.  This
8999 is the default when the target is @code{sh-*-linux*}.
9000 @end table
9002 @node System V Options
9003 @subsection Options for System V
9005 These additional options are available on System V Release 4 for
9006 compatibility with other compilers on those systems:
9008 @table @gcctabopt
9009 @item -G
9010 @opindex G
9011 Create a shared object.
9012 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9014 @item -Qy
9015 @opindex Qy
9016 Identify the versions of each tool used by the compiler, in a
9017 @code{.ident} assembler directive in the output.
9019 @item -Qn
9020 @opindex Qn
9021 Refrain from adding @code{.ident} directives to the output file (this is
9022 the default).
9024 @item -YP,@var{dirs}
9025 @opindex YP
9026 Search the directories @var{dirs}, and no others, for libraries
9027 specified with @option{-l}.
9029 @item -Ym,@var{dir}
9030 @opindex Ym
9031 Look in the directory @var{dir} to find the M4 preprocessor.
9032 The assembler uses this option.
9033 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9034 @c the generic assembler that comes with Solaris takes just -Ym.
9035 @end table
9037 @node TMS320C3x/C4x Options
9038 @subsection TMS320C3x/C4x Options
9039 @cindex TMS320C3x/C4x Options
9041 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9043 @table @gcctabopt
9045 @item -mcpu=@var{cpu_type}
9046 @opindex mcpu
9047 Set the instruction set, register set, and instruction scheduling
9048 parameters for machine type @var{cpu_type}.  Supported values for
9049 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9050 @samp{c44}.  The default is @samp{c40} to generate code for the
9051 TMS320C40.
9053 @item -mbig-memory
9054 @item -mbig
9055 @itemx -msmall-memory
9056 @itemx -msmall
9057 @opindex mbig-memory
9058 @opindex mbig
9059 @opindex msmall-memory
9060 @opindex msmall
9061 Generates code for the big or small memory model.  The small memory
9062 model assumed that all data fits into one 64K word page.  At run-time
9063 the data page (DP) register must be set to point to the 64K page
9064 containing the .bss and .data program sections.  The big memory model is
9065 the default and requires reloading of the DP register for every direct
9066 memory access.
9068 @item -mbk
9069 @itemx -mno-bk
9070 @opindex mbk
9071 @opindex mno-bk
9072 Allow (disallow) allocation of general integer operands into the block
9073 count register BK@.
9075 @item -mdb
9076 @itemx -mno-db
9077 @opindex mdb
9078 @opindex mno-db
9079 Enable (disable) generation of code using decrement and branch,
9080 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9081 on the safe side, this is disabled for the C3x, since the maximum
9082 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9083 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9084 that it can utilize the decrement and branch instruction, but will give
9085 up if there is more than one memory reference in the loop.  Thus a loop
9086 where the loop counter is decremented can generate slightly more
9087 efficient code, in cases where the RPTB instruction cannot be utilized.
9089 @item -mdp-isr-reload
9090 @itemx -mparanoid
9091 @opindex mdp-isr-reload
9092 @opindex mparanoid
9093 Force the DP register to be saved on entry to an interrupt service
9094 routine (ISR), reloaded to point to the data section, and restored on
9095 exit from the ISR@.  This should not be required unless someone has
9096 violated the small memory model by modifying the DP register, say within
9097 an object library.
9099 @item -mmpyi
9100 @itemx -mno-mpyi
9101 @opindex mmpyi
9102 @opindex mno-mpyi
9103 For the C3x use the 24-bit MPYI instruction for integer multiplies
9104 instead of a library call to guarantee 32-bit results.  Note that if one
9105 of the operands is a constant, then the multiplication will be performed
9106 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9107 then squaring operations are performed inline instead of a library call.
9109 @item -mfast-fix
9110 @itemx -mno-fast-fix
9111 @opindex mfast-fix
9112 @opindex mno-fast-fix
9113 The C3x/C4x FIX instruction to convert a floating point value to an
9114 integer value chooses the nearest integer less than or equal to the
9115 floating point value rather than to the nearest integer.  Thus if the
9116 floating point number is negative, the result will be incorrectly
9117 truncated an additional code is necessary to detect and correct this
9118 case.  This option can be used to disable generation of the additional
9119 code required to correct the result.
9121 @item -mrptb
9122 @itemx -mno-rptb
9123 @opindex mrptb
9124 @opindex mno-rptb
9125 Enable (disable) generation of repeat block sequences using the RPTB
9126 instruction for zero overhead looping.  The RPTB construct is only used
9127 for innermost loops that do not call functions or jump across the loop
9128 boundaries.  There is no advantage having nested RPTB loops due to the
9129 overhead required to save and restore the RC, RS, and RE registers.
9130 This is enabled by default with @option{-O2}.
9132 @item -mrpts=@var{count}
9133 @itemx -mno-rpts
9134 @opindex mrpts
9135 @opindex mno-rpts
9136 Enable (disable) the use of the single instruction repeat instruction
9137 RPTS@.  If a repeat block contains a single instruction, and the loop
9138 count can be guaranteed to be less than the value @var{count}, GCC will
9139 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9140 then a RPTS will be emitted even if the loop count cannot be determined
9141 at compile time.  Note that the repeated instruction following RPTS does
9142 not have to be reloaded from memory each iteration, thus freeing up the
9143 CPU buses for operands.  However, since interrupts are blocked by this
9144 instruction, it is disabled by default.
9146 @item -mloop-unsigned
9147 @itemx -mno-loop-unsigned
9148 @opindex mloop-unsigned
9149 @opindex mno-loop-unsigned
9150 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9151 is @math{2^{31} + 1} since these instructions test if the iteration count is
9152 negative to terminate the loop.  If the iteration count is unsigned
9153 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9154 exceeded.  This switch allows an unsigned iteration count.
9156 @item -mti
9157 @opindex mti
9158 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9159 with.  This also enforces compatibility with the API employed by the TI
9160 C3x C compiler.  For example, long doubles are passed as structures
9161 rather than in floating point registers.
9163 @item -mregparm
9164 @itemx -mmemparm
9165 @opindex mregparm
9166 @opindex mmemparm
9167 Generate code that uses registers (stack) for passing arguments to functions.
9168 By default, arguments are passed in registers where possible rather
9169 than by pushing arguments on to the stack.
9171 @item -mparallel-insns
9172 @itemx -mno-parallel-insns
9173 @opindex mparallel-insns
9174 @opindex mno-parallel-insns
9175 Allow the generation of parallel instructions.  This is enabled by
9176 default with @option{-O2}.
9178 @item -mparallel-mpy
9179 @itemx -mno-parallel-mpy
9180 @opindex mparallel-mpy
9181 @opindex mno-parallel-mpy
9182 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9183 provided @option{-mparallel-insns} is also specified.  These instructions have
9184 tight register constraints which can pessimize the code generation
9185 of large functions.
9187 @end table
9189 @node V850 Options
9190 @subsection V850 Options
9191 @cindex V850 Options
9193 These @samp{-m} options are defined for V850 implementations:
9195 @table @gcctabopt
9196 @item -mlong-calls
9197 @itemx -mno-long-calls
9198 @opindex mlong-calls
9199 @opindex mno-long-calls
9200 Treat all calls as being far away (near).  If calls are assumed to be
9201 far away, the compiler will always load the functions address up into a
9202 register, and call indirect through the pointer.
9204 @item -mno-ep
9205 @itemx -mep
9206 @opindex mno-ep
9207 @opindex mep
9208 Do not optimize (do optimize) basic blocks that use the same index
9209 pointer 4 or more times to copy pointer into the @code{ep} register, and
9210 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9211 option is on by default if you optimize.
9213 @item -mno-prolog-function
9214 @itemx -mprolog-function
9215 @opindex mno-prolog-function
9216 @opindex mprolog-function
9217 Do not use (do use) external functions to save and restore registers at
9218 the prolog and epilog of a function.  The external functions are slower,
9219 but use less code space if more than one function saves the same number
9220 of registers.  The @option{-mprolog-function} option is on by default if
9221 you optimize.
9223 @item -mspace
9224 @opindex mspace
9225 Try to make the code as small as possible.  At present, this just turns
9226 on the @option{-mep} and @option{-mprolog-function} options.
9228 @item -mtda=@var{n}
9229 @opindex mtda
9230 Put static or global variables whose size is @var{n} bytes or less into
9231 the tiny data area that register @code{ep} points to.  The tiny data
9232 area can hold up to 256 bytes in total (128 bytes for byte references).
9234 @item -msda=@var{n}
9235 @opindex msda
9236 Put static or global variables whose size is @var{n} bytes or less into
9237 the small data area that register @code{gp} points to.  The small data
9238 area can hold up to 64 kilobytes.
9240 @item -mzda=@var{n}
9241 @opindex mzda
9242 Put static or global variables whose size is @var{n} bytes or less into
9243 the first 32 kilobytes of memory.
9245 @item -mv850
9246 @opindex mv850
9247 Specify that the target processor is the V850.
9249 @item -mbig-switch
9250 @opindex mbig-switch
9251 Generate code suitable for big switch tables.  Use this option only if
9252 the assembler/linker complain about out of range branches within a switch
9253 table.
9255 @item -mapp-regs
9256 @opindex -mapp-regs
9257 This option will cause r2 and r5 to be used in the code generated by
9258 the compiler.  This setting is the default.
9260 @item -mno-app-regs
9261 @opindex -mno-app-regs
9262 This option will cause r2 and r5 to be treated as fixed registers.
9263   
9264 @item -mv850e
9265 @opindex -mv850e
9266 Specify that the target processor is the V850E.  The preprocessor
9267 constant @samp{__v850e__} will be defined if this option is used.
9269 If neither @option{-mv850} nor @option{-mv850e} are defined
9270 then a default target processor will be chosen and the relevant
9271 @samp{__v850*__} preprocessor constant will be defined.
9273 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9274 defined, regardless of which processor variant is the target.
9276 @item -mdisable-callt
9277 @opindex -mdisable-callt
9278 This option will suppress generation of the CALLT instruction for the
9279 v850e flavors of the v850 architecture.  The default is
9280 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9282 @end table
9284 @node ARC Options
9285 @subsection ARC Options
9286 @cindex ARC Options
9288 These options are defined for ARC implementations:
9290 @table @gcctabopt
9291 @item -EL
9292 @opindex EL
9293 Compile code for little endian mode.  This is the default.
9295 @item -EB
9296 @opindex EB
9297 Compile code for big endian mode.
9299 @item -mmangle-cpu
9300 @opindex mmangle-cpu
9301 Prepend the name of the cpu to all public symbol names.
9302 In multiple-processor systems, there are many ARC variants with different
9303 instruction and register set characteristics.  This flag prevents code
9304 compiled for one cpu to be linked with code compiled for another.
9305 No facility exists for handling variants that are ``almost identical''.
9306 This is an all or nothing option.
9308 @item -mcpu=@var{cpu}
9309 @opindex mcpu
9310 Compile code for ARC variant @var{cpu}.
9311 Which variants are supported depend on the configuration.
9312 All variants support @option{-mcpu=base}, this is the default.
9314 @item -mtext=@var{text-section}
9315 @itemx -mdata=@var{data-section}
9316 @itemx -mrodata=@var{readonly-data-section}
9317 @opindex mtext
9318 @opindex mdata
9319 @opindex mrodata
9320 Put functions, data, and readonly data in @var{text-section},
9321 @var{data-section}, and @var{readonly-data-section} respectively
9322 by default.  This can be overridden with the @code{section} attribute.
9323 @xref{Variable Attributes}.
9325 @end table
9327 @node NS32K Options
9328 @subsection NS32K Options
9329 @cindex NS32K options
9331 These are the @samp{-m} options defined for the 32000 series.  The default
9332 values for these options depends on which style of 32000 was selected when
9333 the compiler was configured; the defaults for the most common choices are
9334 given below.
9336 @table @gcctabopt
9337 @item -m32032
9338 @itemx -m32032
9339 @opindex m32032
9340 @opindex m32032
9341 Generate output for a 32032.  This is the default
9342 when the compiler is configured for 32032 and 32016 based systems.
9344 @item -m32332
9345 @itemx -m32332
9346 @opindex m32332
9347 @opindex m32332
9348 Generate output for a 32332.  This is the default
9349 when the compiler is configured for 32332-based systems.
9351 @item -m32532
9352 @itemx -m32532
9353 @opindex m32532
9354 @opindex m32532
9355 Generate output for a 32532.  This is the default
9356 when the compiler is configured for 32532-based systems.
9358 @item -m32081
9359 @opindex m32081
9360 Generate output containing 32081 instructions for floating point.
9361 This is the default for all systems.
9363 @item -m32381
9364 @opindex m32381
9365 Generate output containing 32381 instructions for floating point.  This
9366 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9367 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9369 @item -mmulti-add
9370 @opindex mmulti-add
9371 Try and generate multiply-add floating point instructions @code{polyF}
9372 and @code{dotF}.  This option is only available if the @option{-m32381}
9373 option is in effect.  Using these instructions requires changes to
9374 register allocation which generally has a negative impact on
9375 performance.  This option should only be enabled when compiling code
9376 particularly likely to make heavy use of multiply-add instructions.
9378 @item -mnomulti-add
9379 @opindex mnomulti-add
9380 Do not try and generate multiply-add floating point instructions
9381 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9383 @item -msoft-float
9384 @opindex msoft-float
9385 Generate output containing library calls for floating point.
9386 @strong{Warning:} the requisite libraries may not be available.
9388 @item -mieee-compare
9389 @itemx -mno-ieee-compare
9390 @opindex mieee-compare
9391 @opindex mno-ieee-compare
9392 Control whether or not the compiler uses IEEE floating point
9393 comparisons.  These handle correctly the case where the result of a
9394 comparison is unordered.
9395 @strong{Warning:} the requisite kernel support may not be available.
9397 @item -mnobitfield
9398 @opindex mnobitfield
9399 Do not use the bit-field instructions.  On some machines it is faster to
9400 use shifting and masking operations.  This is the default for the pc532.
9402 @item -mbitfield
9403 @opindex mbitfield
9404 Do use the bit-field instructions.  This is the default for all platforms
9405 except the pc532.
9407 @item -mrtd
9408 @opindex mrtd
9409 Use a different function-calling convention, in which functions
9410 that take a fixed number of arguments return pop their
9411 arguments on return with the @code{ret} instruction.
9413 This calling convention is incompatible with the one normally
9414 used on Unix, so you cannot use it if you need to call libraries
9415 compiled with the Unix compiler.
9417 Also, you must provide function prototypes for all functions that
9418 take variable numbers of arguments (including @code{printf});
9419 otherwise incorrect code will be generated for calls to those
9420 functions.
9422 In addition, seriously incorrect code will result if you call a
9423 function with too many arguments.  (Normally, extra arguments are
9424 harmlessly ignored.)
9426 This option takes its name from the 680x0 @code{rtd} instruction.
9429 @item -mregparam
9430 @opindex mregparam
9431 Use a different function-calling convention where the first two arguments
9432 are passed in registers.
9434 This calling convention is incompatible with the one normally
9435 used on Unix, so you cannot use it if you need to call libraries
9436 compiled with the Unix compiler.
9438 @item -mnoregparam
9439 @opindex mnoregparam
9440 Do not pass any arguments in registers.  This is the default for all
9441 targets.
9443 @item -msb
9444 @opindex msb
9445 It is OK to use the sb as an index register which is always loaded with
9446 zero.  This is the default for the pc532-netbsd target.
9448 @item -mnosb
9449 @opindex mnosb
9450 The sb register is not available for use or has not been initialized to
9451 zero by the run time system.  This is the default for all targets except
9452 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9453 @option{-fpic} is set.
9455 @item -mhimem
9456 @opindex mhimem
9457 Many ns32000 series addressing modes use displacements of up to 512MB@.
9458 If an address is above 512MB then displacements from zero can not be used.
9459 This option causes code to be generated which can be loaded above 512MB@.
9460 This may be useful for operating systems or ROM code.
9462 @item -mnohimem
9463 @opindex mnohimem
9464 Assume code will be loaded in the first 512MB of virtual address space.
9465 This is the default for all platforms.
9468 @end table
9470 @node AVR Options
9471 @subsection AVR Options
9472 @cindex AVR Options
9474 These options are defined for AVR implementations:
9476 @table @gcctabopt
9477 @item -mmcu=@var{mcu}
9478 @opindex mmcu
9479 Specify ATMEL AVR instruction set or MCU type.
9481 Instruction set avr1 is for the minimal AVR core, not supported by the C
9482 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9483 attiny11, attiny12, attiny15, attiny28).
9485 Instruction set avr2 (default) is for the classic AVR core with up to
9486 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9487 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9488 at90c8534, at90s8535).
9490 Instruction set avr3 is for the classic AVR core with up to 128K program
9491 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9493 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9494 memory space (MCU types: atmega8, atmega83, atmega85).
9496 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9497 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9498 atmega64, atmega128, at43usb355, at94k).
9500 @item -msize
9501 @opindex msize
9502 Output instruction sizes to the asm file.
9504 @item -minit-stack=@var{N}
9505 @opindex minit-stack
9506 Specify the initial stack address, which may be a symbol or numeric value,
9507 @samp{__stack} is the default.
9509 @item -mno-interrupts
9510 @opindex mno-interrupts
9511 Generated code is not compatible with hardware interrupts.
9512 Code size will be smaller.
9514 @item -mcall-prologues
9515 @opindex mcall-prologues
9516 Functions prologues/epilogues expanded as call to appropriate
9517 subroutines.  Code size will be smaller.
9519 @item -mno-tablejump
9520 @opindex mno-tablejump
9521 Do not generate tablejump insns which sometimes increase code size.
9523 @item -mtiny-stack
9524 @opindex mtiny-stack
9525 Change only the low 8 bits of the stack pointer.
9526 @end table
9528 @node MCore Options
9529 @subsection MCore Options
9530 @cindex MCore options
9532 These are the @samp{-m} options defined for the Motorola M*Core
9533 processors.
9535 @table @gcctabopt
9537 @item -mhardlit
9538 @itemx -mhardlit
9539 @itemx -mno-hardlit
9540 @opindex mhardlit
9541 @opindex mhardlit
9542 @opindex mno-hardlit
9543 Inline constants into the code stream if it can be done in two
9544 instructions or less.
9546 @item -mdiv
9547 @itemx -mdiv
9548 @itemx -mno-div
9549 @opindex mdiv
9550 @opindex mdiv
9551 @opindex mno-div
9552 Use the divide instruction.  (Enabled by default).
9554 @item -mrelax-immediate
9555 @itemx -mrelax-immediate
9556 @itemx -mno-relax-immediate
9557 @opindex mrelax-immediate
9558 @opindex mrelax-immediate
9559 @opindex mno-relax-immediate
9560 Allow arbitrary sized immediates in bit operations.
9562 @item -mwide-bitfields
9563 @itemx -mwide-bitfields
9564 @itemx -mno-wide-bitfields
9565 @opindex mwide-bitfields
9566 @opindex mwide-bitfields
9567 @opindex mno-wide-bitfields
9568 Always treat bit-fields as int-sized.
9570 @item -m4byte-functions
9571 @itemx -m4byte-functions
9572 @itemx -mno-4byte-functions
9573 @opindex m4byte-functions
9574 @opindex m4byte-functions
9575 @opindex mno-4byte-functions
9576 Force all functions to be aligned to a four byte boundary.
9578 @item -mcallgraph-data
9579 @itemx -mcallgraph-data
9580 @itemx -mno-callgraph-data
9581 @opindex mcallgraph-data
9582 @opindex mcallgraph-data
9583 @opindex mno-callgraph-data
9584 Emit callgraph information.
9586 @item -mslow-bytes
9587 @itemx -mslow-bytes
9588 @itemx -mno-slow-bytes
9589 @opindex mslow-bytes
9590 @opindex mslow-bytes
9591 @opindex mno-slow-bytes
9592 Prefer word access when reading byte quantities.
9594 @item -mlittle-endian
9595 @itemx -mlittle-endian
9596 @itemx -mbig-endian
9597 @opindex mlittle-endian
9598 @opindex mlittle-endian
9599 @opindex mbig-endian
9600 Generate code for a little endian target.
9602 @item -m210
9603 @itemx -m210
9604 @itemx -m340
9605 @opindex m210
9606 @opindex m210
9607 @opindex m340
9608 Generate code for the 210 processor.
9609 @end table
9611 @node IA-64 Options
9612 @subsection IA-64 Options
9613 @cindex IA-64 Options
9615 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9617 @table @gcctabopt
9618 @item -mbig-endian
9619 @opindex mbig-endian
9620 Generate code for a big endian target.  This is the default for HP-UX@.
9622 @item -mlittle-endian
9623 @opindex mlittle-endian
9624 Generate code for a little endian target.  This is the default for AIX5
9625 and Linux.
9627 @item -mgnu-as
9628 @itemx -mno-gnu-as
9629 @opindex mgnu-as
9630 @opindex mno-gnu-as
9631 Generate (or don't) code for the GNU assembler.  This is the default.
9632 @c Also, this is the default if the configure option @option{--with-gnu-as}
9633 @c is used.
9635 @item -mgnu-ld
9636 @itemx -mno-gnu-ld
9637 @opindex mgnu-ld
9638 @opindex mno-gnu-ld
9639 Generate (or don't) code for the GNU linker.  This is the default.
9640 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9641 @c is used.
9643 @item -mno-pic
9644 @opindex mno-pic
9645 Generate code that does not use a global pointer register.  The result
9646 is not position independent code, and violates the IA-64 ABI@.
9648 @item -mvolatile-asm-stop
9649 @itemx -mno-volatile-asm-stop
9650 @opindex mvolatile-asm-stop
9651 @opindex mno-volatile-asm-stop
9652 Generate (or don't) a stop bit immediately before and after volatile asm
9653 statements.
9655 @item -mb-step
9656 @opindex mb-step
9657 Generate code that works around Itanium B step errata.
9659 @item -mregister-names
9660 @itemx -mno-register-names
9661 @opindex mregister-names
9662 @opindex mno-register-names
9663 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9664 the stacked registers.  This may make assembler output more readable.
9666 @item -mno-sdata
9667 @itemx -msdata
9668 @opindex mno-sdata
9669 @opindex msdata
9670 Disable (or enable) optimizations that use the small data section.  This may
9671 be useful for working around optimizer bugs.
9673 @item -mconstant-gp
9674 @opindex mconstant-gp
9675 Generate code that uses a single constant global pointer value.  This is
9676 useful when compiling kernel code.
9678 @item -mauto-pic
9679 @opindex mauto-pic
9680 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9681 This is useful when compiling firmware code.
9683 @item -minline-float-divide-min-latency
9684 @opindex minline-float-divide-min-latency
9685 Generate code for inline divides of floating point values
9686 using the minimum latency algorithm.
9688 @item -minline-float-divide-max-throughput
9689 @opindex minline-float-divide-max-throughput
9690 Generate code for inline divides of floating point values
9691 using the maximum throughput algorithm.
9693 @item -minline-int-divide-min-latency
9694 @opindex minline-int-divide-min-latency
9695 Generate code for inline divides of integer values
9696 using the minimum latency algorithm.
9698 @item -minline-int-divide-max-throughput
9699 @opindex minline-int-divide-max-throughput
9700 Generate code for inline divides of integer values
9701 using the maximum throughput algorithm.
9703 @item -mno-dwarf2-asm
9704 @itemx -mdwarf2-asm
9705 @opindex mno-dwarf2-asm
9706 @opindex mdwarf2-asm
9707 Don't (or do) generate assembler code for the DWARF2 line number debugging
9708 info.  This may be useful when not using the GNU assembler.
9710 @item -mfixed-range=@var{register-range}
9711 @opindex mfixed-range
9712 Generate code treating the given register range as fixed registers.
9713 A fixed register is one that the register allocator can not use.  This is
9714 useful when compiling kernel code.  A register range is specified as
9715 two registers separated by a dash.  Multiple register ranges can be
9716 specified separated by a comma.
9718 @item -mearly-stop-bits
9719 @itemx -mno-early-stop-bits
9720 @opindex mearly-stop-bits
9721 @opindex mno-early-stop-bits
9722 Allow stop bits to be placed earlier than immediately preceding the
9723 instruction that triggered the stop bit.  This can improve instruction
9724 scheduling, but does not always do so.
9725 @end table
9727 @node D30V Options
9728 @subsection D30V Options
9729 @cindex D30V Options
9731 These @samp{-m} options are defined for D30V implementations:
9733 @table @gcctabopt
9734 @item -mextmem
9735 @opindex mextmem
9736 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9737 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9738 memory, which starts at location @code{0x80000000}.
9740 @item -mextmemory
9741 @opindex mextmemory
9742 Same as the @option{-mextmem} switch.
9744 @item -monchip
9745 @opindex monchip
9746 Link the @samp{.text} section into onchip text memory, which starts at
9747 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9748 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9749 into onchip data memory, which starts at location @code{0x20000000}.
9751 @item -mno-asm-optimize
9752 @itemx -masm-optimize
9753 @opindex mno-asm-optimize
9754 @opindex masm-optimize
9755 Disable (enable) passing @option{-O} to the assembler when optimizing.
9756 The assembler uses the @option{-O} option to automatically parallelize
9757 adjacent short instructions where possible.
9759 @item -mbranch-cost=@var{n}
9760 @opindex mbranch-cost
9761 Increase the internal costs of branches to @var{n}.  Higher costs means
9762 that the compiler will issue more instructions to avoid doing a branch.
9763 The default is 2.
9765 @item -mcond-exec=@var{n}
9766 @opindex mcond-exec
9767 Specify the maximum number of conditionally executed instructions that
9768 replace a branch.  The default is 4.
9769 @end table
9771 @node S/390 and zSeries Options
9772 @subsection S/390 and zSeries Options
9773 @cindex S/390 and zSeries Options
9775 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9777 @table @gcctabopt
9778 @item -mhard-float
9779 @itemx -msoft-float
9780 @opindex mhard-float
9781 @opindex msoft-float
9782 Use (do not use) the hardware floating-point instructions and registers
9783 for floating-point operations.  When @option{-msoft-float} is specified,
9784 functions in @file{libgcc.a} will be used to perform floating-point
9785 operations.  When @option{-mhard-float} is specified, the compiler
9786 generates IEEE floating-point instructions.  This is the default.
9788 @item -mbackchain
9789 @itemx -mno-backchain
9790 @opindex mbackchain
9791 @opindex mno-backchain
9792 Generate (or do not generate) code which maintains an explicit
9793 backchain within the stack frame that points to the caller's frame.
9794 This is currently needed to allow debugging.  The default is to
9795 generate the backchain.
9797 @item -msmall-exec
9798 @itemx -mno-small-exec
9799 @opindex msmall-exec
9800 @opindex mno-small-exec
9801 Generate (or do not generate) code using the @code{bras} instruction
9802 to do subroutine calls.
9803 This only works reliably if the total executable size does not
9804 exceed 64k.  The default is to use the @code{basr} instruction instead,
9805 which does not have this limitation.
9807 @item -m64
9808 @itemx -m31
9809 @opindex m64
9810 @opindex m31
9811 When @option{-m31} is specified, generate code compliant to the
9812 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9813 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9814 particular to generate 64-bit instructions.  For the @samp{s390}
9815 targets, the default is @option{-m31}, while the @samp{s390x}
9816 targets default to @option{-m64}.
9818 @item -mzarch
9819 @itemx -mesa
9820 @opindex mzarch
9821 @opindex mesa
9822 When @option{-mzarch} is specified, generate code using the 
9823 instructions available on z/Architecture. 
9824 When @option{-mesa} is specified, generate code using the 
9825 instructions available on ESA/390. Note that @option{-mesa} is
9826 not possible with @option{-m64}.
9827 For the @samp{s390} targets, the default is @option{-mesa}, 
9828 while the @samp{s390x} targets default to @option{-mzarch}.
9830 @item -mmvcle
9831 @itemx -mno-mvcle
9832 @opindex mmvcle
9833 @opindex mno-mvcle
9834 Generate (or do not generate) code using the @code{mvcle} instruction
9835 to perform block moves.  When @option{-mno-mvcle} is specified,
9836 use a @code{mvc} loop instead.  This is the default.
9838 @item -mdebug
9839 @itemx -mno-debug
9840 @opindex mdebug
9841 @opindex mno-debug
9842 Print (or do not print) additional debug information when compiling.
9843 The default is to not print debug information.
9845 @item -march=@var{arch}
9846 @opindex march
9847 Generate code that will run on @var{arch}, which is the name of system
9848 representing a certain processor type. Possible values for
9849 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
9851 @item -mtune=@var{arch}
9852 @opindex mtune
9853 Tune to @var{cpu-type} everything applicable about the generated code,
9854  except for the ABI and the set of available instructions. 
9855 The list of @var{arch} values is the same as for @option{-march}.
9857 @end table
9859 @node CRIS Options
9860 @subsection CRIS Options
9861 @cindex CRIS Options
9863 These options are defined specifically for the CRIS ports.
9865 @table @gcctabopt
9866 @item -march=@var{architecture-type}
9867 @itemx -mcpu=@var{architecture-type}
9868 @opindex march
9869 @opindex mcpu
9870 Generate code for the specified architecture.  The choices for
9871 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9872 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9873 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9874 @samp{v10}.
9876 @item -mtune=@var{architecture-type}
9877 @opindex mtune
9878 Tune to @var{architecture-type} everything applicable about the generated
9879 code, except for the ABI and the set of available instructions.  The
9880 choices for @var{architecture-type} are the same as for
9881 @option{-march=@var{architecture-type}}.
9883 @item -mmax-stack-frame=@var{n}
9884 @opindex mmax-stack-frame
9885 Warn when the stack frame of a function exceeds @var{n} bytes.
9887 @item -melinux-stacksize=@var{n}
9888 @opindex melinux-stacksize
9889 Only available with the @samp{cris-axis-aout} target.  Arranges for
9890 indications in the program to the kernel loader that the stack of the
9891 program should be set to @var{n} bytes.
9893 @item -metrax4
9894 @itemx -metrax100
9895 @opindex metrax4
9896 @opindex metrax100
9897 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9898 @option{-march=v3} and @option{-march=v8} respectively.
9900 @item -mpdebug
9901 @opindex mpdebug
9902 Enable CRIS-specific verbose debug-related information in the assembly
9903 code.  This option also has the effect to turn off the @samp{#NO_APP}
9904 formatted-code indicator to the assembler at the beginning of the
9905 assembly file.
9907 @item -mcc-init
9908 @opindex mcc-init
9909 Do not use condition-code results from previous instruction; always emit
9910 compare and test instructions before use of condition codes.
9912 @item -mno-side-effects
9913 @opindex mno-side-effects
9914 Do not emit instructions with side-effects in addressing modes other than
9915 post-increment.
9917 @item -mstack-align
9918 @itemx -mno-stack-align
9919 @itemx -mdata-align
9920 @itemx -mno-data-align
9921 @itemx -mconst-align
9922 @itemx -mno-const-align
9923 @opindex mstack-align
9924 @opindex mno-stack-align
9925 @opindex mdata-align
9926 @opindex mno-data-align
9927 @opindex mconst-align
9928 @opindex mno-const-align
9929 These options (no-options) arranges (eliminate arrangements) for the
9930 stack-frame, individual data and constants to be aligned for the maximum
9931 single data access size for the chosen CPU model.  The default is to
9932 arrange for 32-bit alignment.  ABI details such as structure layout are
9933 not affected by these options.
9935 @item -m32-bit
9936 @itemx -m16-bit
9937 @itemx -m8-bit
9938 @opindex m32-bit
9939 @opindex m16-bit
9940 @opindex m8-bit
9941 Similar to the stack- data- and const-align options above, these options
9942 arrange for stack-frame, writable data and constants to all be 32-bit,
9943 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9945 @item -mno-prologue-epilogue
9946 @itemx -mprologue-epilogue
9947 @opindex mno-prologue-epilogue
9948 @opindex mprologue-epilogue
9949 With @option{-mno-prologue-epilogue}, the normal function prologue and
9950 epilogue that sets up the stack-frame are omitted and no return
9951 instructions or return sequences are generated in the code.  Use this
9952 option only together with visual inspection of the compiled code: no
9953 warnings or errors are generated when call-saved registers must be saved,
9954 or storage for local variable needs to be allocated.
9956 @item -mno-gotplt
9957 @itemx -mgotplt
9958 @opindex mno-gotplt
9959 @opindex mgotplt
9960 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9961 instruction sequences that load addresses for functions from the PLT part
9962 of the GOT rather than (traditional on other architectures) calls to the
9963 PLT.  The default is @option{-mgotplt}.
9965 @item -maout
9966 @opindex maout
9967 Legacy no-op option only recognized with the cris-axis-aout target.
9969 @item -melf
9970 @opindex melf
9971 Legacy no-op option only recognized with the cris-axis-elf and
9972 cris-axis-linux-gnu targets.
9974 @item -melinux
9975 @opindex melinux
9976 Only recognized with the cris-axis-aout target, where it selects a
9977 GNU/linux-like multilib, include files and instruction set for
9978 @option{-march=v8}.
9980 @item -mlinux
9981 @opindex mlinux
9982 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9984 @item -sim
9985 @opindex sim
9986 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9987 to link with input-output functions from a simulator library.  Code,
9988 initialized data and zero-initialized data are allocated consecutively.
9990 @item -sim2
9991 @opindex sim2
9992 Like @option{-sim}, but pass linker options to locate initialized data at
9993 0x40000000 and zero-initialized data at 0x80000000.
9994 @end table
9996 @node MMIX Options
9997 @subsection MMIX Options
9998 @cindex MMIX Options
10000 These options are defined for the MMIX:
10002 @table @gcctabopt
10003 @item -mlibfuncs
10004 @itemx -mno-libfuncs
10005 @opindex mlibfuncs
10006 @opindex mno-libfuncs
10007 Specify that intrinsic library functions are being compiled, passing all
10008 values in registers, no matter the size.
10010 @item -mepsilon
10011 @itemx -mno-epsilon
10012 @opindex mepsilon
10013 @opindex mno-epsilon
10014 Generate floating-point comparison instructions that compare with respect
10015 to the @code{rE} epsilon register.
10017 @item -mabi=mmixware
10018 @itemx -mabi=gnu
10019 @opindex mabi-mmixware
10020 @opindex mabi=gnu
10021 Generate code that passes function parameters and return values that (in
10022 the called function) are seen as registers @code{$0} and up, as opposed to
10023 the GNU ABI which uses global registers @code{$231} and up.
10025 @item -mzero-extend
10026 @itemx -mno-zero-extend
10027 @opindex mzero-extend
10028 @opindex mno-zero-extend
10029 When reading data from memory in sizes shorter than 64 bits, use (do not
10030 use) zero-extending load instructions by default, rather than
10031 sign-extending ones.
10033 @item -mknuthdiv
10034 @itemx -mno-knuthdiv
10035 @opindex mknuthdiv
10036 @opindex mno-knuthdiv
10037 Make the result of a division yielding a remainder have the same sign as
10038 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10039 remainder follows the sign of the dividend.  Both methods are
10040 arithmetically valid, the latter being almost exclusively used.
10042 @item -mtoplevel-symbols
10043 @itemx -mno-toplevel-symbols
10044 @opindex mtoplevel-symbols
10045 @opindex mno-toplevel-symbols
10046 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10047 code can be used with the @code{PREFIX} assembly directive.
10049 @item -melf
10050 @opindex melf
10051 Generate an executable in the ELF format, rather than the default
10052 @samp{mmo} format used by the @command{mmix} simulator.
10054 @item -mbranch-predict
10055 @itemx -mno-branch-predict
10056 @opindex mbranch-predict
10057 @opindex mno-branch-predict
10058 Use (do not use) the probable-branch instructions, when static branch
10059 prediction indicates a probable branch.
10061 @item -mbase-addresses
10062 @itemx -mno-base-addresses
10063 @opindex mbase-addresses
10064 @opindex mno-base-addresses
10065 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10066 base address automatically generates a request (handled by the assembler
10067 and the linker) for a constant to be set up in a global register.  The
10068 register is used for one or more base address requests within the range 0
10069 to 255 from the value held in the register.  The generally leads to short
10070 and fast code, but the number of different data items that can be
10071 addressed is limited.  This means that a program that uses lots of static
10072 data may require @option{-mno-base-addresses}.
10074 @item -msingle-exit
10075 @itemx -mno-single-exit
10076 @opindex msingle-exit
10077 @opindex mno-single-exit
10078 Force (do not force) generated code to have a single exit point in each
10079 function.
10080 @end table
10082 @node PDP-11 Options
10083 @subsection PDP-11 Options
10084 @cindex PDP-11 Options
10086 These options are defined for the PDP-11:
10088 @table @gcctabopt
10089 @item -mfpu
10090 @opindex mfpu
10091 Use hardware FPP floating point.  This is the default.  (FIS floating
10092 point on the PDP-11/40 is not supported.)
10094 @item -msoft-float
10095 @opindex msoft-float
10096 Do not use hardware floating point.
10098 @item -mac0
10099 @opindex mac0
10100 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10102 @item -mno-ac0
10103 @opindex mno-ac0
10104 Return floating-point results in memory.  This is the default.
10106 @item -m40
10107 @opindex m40
10108 Generate code for a PDP-11/40.
10110 @item -m45
10111 @opindex m45
10112 Generate code for a PDP-11/45.  This is the default.
10114 @item -m10
10115 @opindex m10
10116 Generate code for a PDP-11/10.
10118 @item -mbcopy-builtin
10119 @opindex bcopy-builtin
10120 Use inline @code{movstrhi} patterns for copying memory.  This is the
10121 default.
10123 @item -mbcopy
10124 @opindex mbcopy
10125 Do not use inline @code{movstrhi} patterns for copying memory.
10127 @item -mint16
10128 @itemx -mno-int32
10129 @opindex mint16
10130 @opindex mno-int32
10131 Use 16-bit @code{int}.  This is the default.
10133 @item -mint32
10134 @itemx -mno-int16
10135 @opindex mint32
10136 @opindex mno-int16
10137 Use 32-bit @code{int}.
10139 @item -mfloat64
10140 @itemx -mno-float32
10141 @opindex mfloat64
10142 @opindex mno-float32
10143 Use 64-bit @code{float}.  This is the default.
10145 @item -mfloat32
10146 @item -mno-float64
10147 @opindex mfloat32
10148 @opindex mno-float64
10149 Use 32-bit @code{float}.
10151 @item -mabshi
10152 @opindex mabshi
10153 Use @code{abshi2} pattern.  This is the default.
10155 @item -mno-abshi
10156 @opindex mno-abshi
10157 Do not use @code{abshi2} pattern.
10159 @item -mbranch-expensive
10160 @opindex mbranch-expensive
10161 Pretend that branches are expensive.  This is for experimenting with
10162 code generation only.
10164 @item -mbranch-cheap
10165 @opindex mbranch-cheap
10166 Do not pretend that branches are expensive.  This is the default.
10168 @item -msplit
10169 @opindex msplit
10170 Generate code for a system with split I&D.
10172 @item -mno-split
10173 @opindex mno-split
10174 Generate code for a system without split I&D.  This is the default.
10176 @item -munix-asm
10177 @opindex munix-asm
10178 Use Unix assembler syntax.  This is the default when configured for
10179 @samp{pdp11-*-bsd}.
10181 @item -mdec-asm
10182 @opindex mdec-asm
10183 Use DEC assembler syntax.  This is the default when configured for any
10184 PDP-11 target other than @samp{pdp11-*-bsd}.
10185 @end table
10187 @node Xstormy16 Options
10188 @subsection Xstormy16 Options
10189 @cindex Xstormy16 Options
10191 These options are defined for Xstormy16:
10193 @table @gcctabopt
10194 @item -msim
10195 @opindex msim
10196 Choose startup files and linker script suitable for the simulator.
10197 @end table
10199 @node FRV Options
10200 @subsection FRV Options
10201 @cindex FRV Options
10203 @table @gcctabopt
10204 @item -mgpr-32
10205 @opindex mgpr-32
10207 Only use the first 32 general purpose registers.
10209 @item -mgpr-64
10210 @opindex mgpr-64
10212 Use all 64 general purpose registers.
10214 @item -mfpr-32
10215 @opindex mfpr-32
10217 Use only the first 32 floating point registers.
10219 @item -mfpr-64
10220 @opindex mfpr-64
10222 Use all 64 floating point registers
10224 @item -mhard-float
10225 @opindex mhard-float
10227 Use hardware instructions for floating point operations.
10229 @item -msoft-float
10230 @opindex msoft-float
10232 Use library routines for floating point operations.
10234 @item -malloc-cc
10235 @opindex malloc-cc
10237 Dynamically allocate condition code registers.
10239 @item -mfixed-cc
10240 @opindex mfixed-cc
10242 Do not try to dynamically allocate condition code registers, only
10243 use @code{icc0} and @code{fcc0}.
10245 @item -mdword
10246 @opindex mdword
10248 Change ABI to use double word insns.
10250 @item -mno-dword
10251 @opindex mno-dword
10253 Do not use double word instructions.
10255 @item -mdouble
10256 @opindex mdouble
10258 Use floating point double instructions.
10260 @item -mno-double
10261 @opindex mno-double
10263 Do not use floating point double instructions.
10265 @item -mmedia
10266 @opindex mmedia
10268 Use media instructions.
10270 @item -mno-media
10271 @opindex mno-media
10273 Do not use media instructions.
10275 @item -mmuladd
10276 @opindex mmuladd
10278 Use multiply and add/subtract instructions.
10280 @item -mno-muladd
10281 @opindex mno-muladd
10283 Do not use multiply and add/subtract instructions.
10285 @item -mlibrary-pic
10286 @opindex mlibrary-pic
10288 Enable PIC support for building libraries
10290 @item -macc-4
10291 @opindex macc-4
10293 Use only the first four media accumulator registers.
10295 @item -macc-8
10296 @opindex macc-8
10298 Use all eight media accumulator registers.
10300 @item -mpack
10301 @opindex mpack
10303 Pack VLIW instructions.
10305 @item -mno-pack
10306 @opindex mno-pack
10308 Do not pack VLIW instructions.
10310 @item -mno-eflags
10311 @opindex mno-eflags
10313 Do not mark ABI switches in e_flags.
10315 @item -mcond-move
10316 @opindex mcond-move
10318 Enable the use of conditional-move instructions (default).
10320 This switch is mainly for debugging the compiler and will likely be removed
10321 in a future version.
10323 @item -mno-cond-move
10324 @opindex mno-cond-move
10326 Disable the use of conditional-move instructions.
10328 This switch is mainly for debugging the compiler and will likely be removed
10329 in a future version.
10331 @item -mscc
10332 @opindex mscc
10334 Enable the use of conditional set instructions (default).
10336 This switch is mainly for debugging the compiler and will likely be removed
10337 in a future version.
10339 @item -mno-scc
10340 @opindex mno-scc
10342 Disable the use of conditional set instructions.
10344 This switch is mainly for debugging the compiler and will likely be removed
10345 in a future version.
10347 @item -mcond-exec
10348 @opindex mcond-exec
10350 Enable the use of conditional execution (default).
10352 This switch is mainly for debugging the compiler and will likely be removed
10353 in a future version.
10355 @item -mno-cond-exec
10356 @opindex mno-cond-exec
10358 Disable the use of conditional execution.
10360 This switch is mainly for debugging the compiler and will likely be removed
10361 in a future version.
10363 @item -mvliw-branch
10364 @opindex mvliw-branch
10366 Run a pass to pack branches into VLIW instructions (default).
10368 This switch is mainly for debugging the compiler and will likely be removed
10369 in a future version.
10371 @item -mno-vliw-branch
10372 @opindex mno-vliw-branch
10374 Do not run a pass to pack branches into VLIW instructions.
10376 This switch is mainly for debugging the compiler and will likely be removed
10377 in a future version.
10379 @item -mmulti-cond-exec
10380 @opindex mmulti-cond-exec
10382 Enable optimization of @code{&&} and @code{||} in conditional execution
10383 (default).
10385 This switch is mainly for debugging the compiler and will likely be removed
10386 in a future version.
10388 @item -mno-multi-cond-exec
10389 @opindex mno-multi-cond-exec
10391 Disable optimization of @code{&&} and @code{||} in conditional execution.
10393 This switch is mainly for debugging the compiler and will likely be removed
10394 in a future version.
10396 @item -mnested-cond-exec
10397 @opindex mnested-cond-exec
10399 Enable nested conditional execution optimizations (default).
10401 This switch is mainly for debugging the compiler and will likely be removed
10402 in a future version.
10404 @item -mno-nested-cond-exec
10405 @opindex mno-nested-cond-exec
10407 Disable nested conditional execution optimizations.
10409 This switch is mainly for debugging the compiler and will likely be removed
10410 in a future version.
10412 @item -mtomcat-stats
10413 @opindex mtomcat-stats
10415 Cause gas to print out tomcat statistics.
10417 @item -mcpu=@var{cpu}
10418 @opindex mcpu
10420 Select the processor type for which to generate code.  Possible values are
10421 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10422 @samp{frv}.
10424 @end table
10426 @node Xtensa Options
10427 @subsection Xtensa Options
10428 @cindex Xtensa Options
10430 The Xtensa architecture is designed to support many different
10431 configurations.  The compiler's default options can be set to match a
10432 particular Xtensa configuration by copying a configuration file into the
10433 GCC sources when building GCC@.  The options below may be used to
10434 override the default options.
10436 @table @gcctabopt
10437 @item -mbig-endian
10438 @itemx -mlittle-endian
10439 @opindex mbig-endian
10440 @opindex mlittle-endian
10441 Specify big-endian or little-endian byte ordering for the target Xtensa
10442 processor.
10444 @item -mdensity
10445 @itemx -mno-density
10446 @opindex mdensity
10447 @opindex mno-density
10448 Enable or disable use of the optional Xtensa code density instructions.
10450 @item -mmac16
10451 @itemx -mno-mac16
10452 @opindex mmac16
10453 @opindex mno-mac16
10454 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10455 will generate MAC16 instructions from standard C code, with the
10456 limitation that it will use neither the MR register file nor any
10457 instruction that operates on the MR registers.  When this option is
10458 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10459 combination of core instructions and library calls, depending on whether
10460 any other multiplier options are enabled.
10462 @item -mmul16
10463 @itemx -mno-mul16
10464 @opindex mmul16
10465 @opindex mno-mul16
10466 Enable or disable use of the 16-bit integer multiplier option.  When
10467 enabled, the compiler will generate 16-bit multiply instructions for
10468 multiplications of 16 bits or smaller in standard C code.  When this
10469 option is disabled, the compiler will either use 32-bit multiply or
10470 MAC16 instructions if they are available or generate library calls to
10471 perform the multiply operations using shifts and adds.
10473 @item -mmul32
10474 @itemx -mno-mul32
10475 @opindex mmul32
10476 @opindex mno-mul32
10477 Enable or disable use of the 32-bit integer multiplier option.  When
10478 enabled, the compiler will generate 32-bit multiply instructions for
10479 multiplications of 32 bits or smaller in standard C code.  When this
10480 option is disabled, the compiler will generate library calls to perform
10481 the multiply operations using either shifts and adds or 16-bit multiply
10482 instructions if they are available.
10484 @item -mnsa
10485 @itemx -mno-nsa
10486 @opindex mnsa
10487 @opindex mno-nsa
10488 Enable or disable use of the optional normalization shift amount
10489 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10491 @item -mminmax
10492 @itemx -mno-minmax
10493 @opindex mminmax
10494 @opindex mno-minmax
10495 Enable or disable use of the optional minimum and maximum value
10496 instructions.
10498 @item -msext
10499 @itemx -mno-sext
10500 @opindex msext
10501 @opindex mno-sext
10502 Enable or disable use of the optional sign extend (@code{SEXT})
10503 instruction.
10505 @item -mbooleans
10506 @itemx -mno-booleans
10507 @opindex mbooleans
10508 @opindex mno-booleans
10509 Enable or disable support for the boolean register file used by Xtensa
10510 coprocessors.  This is not typically useful by itself but may be
10511 required for other options that make use of the boolean registers (e.g.,
10512 the floating-point option).
10514 @item -mhard-float
10515 @itemx -msoft-float
10516 @opindex mhard-float
10517 @opindex msoft-float
10518 Enable or disable use of the floating-point option.  When enabled, GCC
10519 generates floating-point instructions for 32-bit @code{float}
10520 operations.  When this option is disabled, GCC generates library calls
10521 to emulate 32-bit floating-point operations using integer instructions.
10522 Regardless of this option, 64-bit @code{double} operations are always
10523 emulated with calls to library functions.
10525 @item -mfused-madd
10526 @itemx -mno-fused-madd
10527 @opindex mfused-madd
10528 @opindex mno-fused-madd
10529 Enable or disable use of fused multiply/add and multiply/subtract
10530 instructions in the floating-point option.  This has no effect if the
10531 floating-point option is not also enabled.  Disabling fused multiply/add
10532 and multiply/subtract instructions forces the compiler to use separate
10533 instructions for the multiply and add/subtract operations.  This may be
10534 desirable in some cases where strict IEEE 754-compliant results are
10535 required: the fused multiply add/subtract instructions do not round the
10536 intermediate result, thereby producing results with @emph{more} bits of
10537 precision than specified by the IEEE standard.  Disabling fused multiply
10538 add/subtract instructions also ensures that the program output is not
10539 sensitive to the compiler's ability to combine multiply and add/subtract
10540 operations.
10542 @item -mserialize-volatile
10543 @itemx -mno-serialize-volatile
10544 @opindex mserialize-volatile
10545 @opindex mno-serialize-volatile
10546 When this option is enabled, GCC inserts @code{MEMW} instructions before
10547 @code{volatile} memory references to guarantee sequential consistency.
10548 The default is @option{-mserialize-volatile}.  Use
10549 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10551 @item -mtext-section-literals
10552 @itemx -mno-text-section-literals
10553 @opindex mtext-section-literals
10554 @opindex mno-text-section-literals
10555 Control the treatment of literal pools.  The default is
10556 @option{-mno-text-section-literals}, which places literals in a separate
10557 section in the output file.  This allows the literal pool to be placed
10558 in a data RAM/ROM, and it also allows the linker to combine literal
10559 pools from separate object files to remove redundant literals and
10560 improve code size.  With @option{-mtext-section-literals}, the literals
10561 are interspersed in the text section in order to keep them as close as
10562 possible to their references.  This may be necessary for large assembly
10563 files.
10565 @item -mtarget-align
10566 @itemx -mno-target-align
10567 @opindex mtarget-align
10568 @opindex mno-target-align
10569 When this option is enabled, GCC instructs the assembler to
10570 automatically align instructions to reduce branch penalties at the
10571 expense of some code density.  The assembler attempts to widen density
10572 instructions to align branch targets and the instructions following call
10573 instructions.  If there are not enough preceding safe density
10574 instructions to align a target, no widening will be performed.  The
10575 default is @option{-mtarget-align}.  These options do not affect the
10576 treatment of auto-aligned instructions like @code{LOOP}, which the
10577 assembler will always align, either by widening density instructions or
10578 by inserting no-op instructions.
10580 @item -mlongcalls
10581 @itemx -mno-longcalls
10582 @opindex mlongcalls
10583 @opindex mno-longcalls
10584 When this option is enabled, GCC instructs the assembler to translate
10585 direct calls to indirect calls unless it can determine that the target
10586 of a direct call is in the range allowed by the call instruction.  This
10587 translation typically occurs for calls to functions in other source
10588 files.  Specifically, the assembler translates a direct @code{CALL}
10589 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10590 The default is @option{-mno-longcalls}.  This option should be used in
10591 programs where the call target can potentially be out of range.  This
10592 option is implemented in the assembler, not the compiler, so the
10593 assembly code generated by GCC will still show direct call
10594 instructions---look at the disassembled object code to see the actual
10595 instructions.  Note that the assembler will use an indirect call for
10596 every cross-file call, not just those that really will be out of range.
10597 @end table
10599 @node Code Gen Options
10600 @section Options for Code Generation Conventions
10601 @cindex code generation conventions
10602 @cindex options, code generation
10603 @cindex run-time options
10605 These machine-independent options control the interface conventions
10606 used in code generation.
10608 Most of them have both positive and negative forms; the negative form
10609 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10610 one of the forms is listed---the one which is not the default.  You
10611 can figure out the other form by either removing @samp{no-} or adding
10614 @table @gcctabopt
10615 @item -fbounds-check
10616 @opindex fbounds-check
10617 For front-ends that support it, generate additional code to check that
10618 indices used to access arrays are within the declared range.  This is
10619 currently only supported by the Java and Fortran 77 front-ends, where
10620 this option defaults to true and false respectively.
10622 @item -ftrapv
10623 @opindex ftrapv
10624 This option generates traps for signed overflow on addition, subtraction,
10625 multiplication operations.
10627 @item -fexceptions
10628 @opindex fexceptions
10629 Enable exception handling.  Generates extra code needed to propagate
10630 exceptions.  For some targets, this implies GCC will generate frame
10631 unwind information for all functions, which can produce significant data
10632 size overhead, although it does not affect execution.  If you do not
10633 specify this option, GCC will enable it by default for languages like
10634 C++ which normally require exception handling, and disable it for
10635 languages like C that do not normally require it.  However, you may need
10636 to enable this option when compiling C code that needs to interoperate
10637 properly with exception handlers written in C++.  You may also wish to
10638 disable this option if you are compiling older C++ programs that don't
10639 use exception handling.
10641 @item -fnon-call-exceptions
10642 @opindex fnon-call-exceptions
10643 Generate code that allows trapping instructions to throw exceptions.
10644 Note that this requires platform-specific runtime support that does
10645 not exist everywhere.  Moreover, it only allows @emph{trapping}
10646 instructions to throw exceptions, i.e.@: memory references or floating
10647 point instructions.  It does not allow exceptions to be thrown from
10648 arbitrary signal handlers such as @code{SIGALRM}.
10650 @item -funwind-tables
10651 @opindex funwind-tables
10652 Similar to @option{-fexceptions}, except that it will just generate any needed
10653 static data, but will not affect the generated code in any other way.
10654 You will normally not enable this option; instead, a language processor
10655 that needs this handling would enable it on your behalf.
10657 @item -fasynchronous-unwind-tables
10658 @opindex funwind-tables
10659 Generate unwind table in dwarf2 format, if supported by target machine.  The
10660 table is exact at each instruction boundary, so it can be used for stack
10661 unwinding from asynchronous events (such as debugger or garbage collector).
10663 @item -fpcc-struct-return
10664 @opindex fpcc-struct-return
10665 Return ``short'' @code{struct} and @code{union} values in memory like
10666 longer ones, rather than in registers.  This convention is less
10667 efficient, but it has the advantage of allowing intercallability between
10668 GCC-compiled files and files compiled with other compilers, particularly
10669 the Portable C Compiler (pcc).
10671 The precise convention for returning structures in memory depends
10672 on the target configuration macros.
10674 Short structures and unions are those whose size and alignment match
10675 that of some integer type.
10677 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10678 switch is not binary compatible with code compiled with the
10679 @option{-freg-struct-return} switch.
10680 Use it to conform to a non-default application binary interface.
10682 @item -freg-struct-return
10683 @opindex freg-struct-return
10684 Return @code{struct} and @code{union} values in registers when possible.
10685 This is more efficient for small structures than
10686 @option{-fpcc-struct-return}.
10688 If you specify neither @option{-fpcc-struct-return} nor
10689 @option{-freg-struct-return}, GCC defaults to whichever convention is
10690 standard for the target.  If there is no standard convention, GCC
10691 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10692 the principal compiler.  In those cases, we can choose the standard, and
10693 we chose the more efficient register return alternative.
10695 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10696 switch is not binary compatible with code compiled with the
10697 @option{-fpcc-struct-return} switch.
10698 Use it to conform to a non-default application binary interface.
10700 @item -fshort-enums
10701 @opindex fshort-enums
10702 Allocate to an @code{enum} type only as many bytes as it needs for the
10703 declared range of possible values.  Specifically, the @code{enum} type
10704 will be equivalent to the smallest integer type which has enough room.
10706 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10707 code that is not binary compatible with code generated without that switch.
10708 Use it to conform to a non-default application binary interface.
10710 @item -fshort-double
10711 @opindex fshort-double
10712 Use the same size for @code{double} as for @code{float}.
10714 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10715 code that is not binary compatible with code generated without that switch.
10716 Use it to conform to a non-default application binary interface.
10718 @item -fshort-wchar
10719 @opindex fshort-wchar
10720 Override the underlying type for @samp{wchar_t} to be @samp{short
10721 unsigned int} instead of the default for the target.  This option is
10722 useful for building programs to run under WINE@.
10724 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10725 code that is not binary compatible with code generated without that switch.
10726 Use it to conform to a non-default application binary interface.
10728 @item -fshared-data
10729 @opindex fshared-data
10730 Requests that the data and non-@code{const} variables of this
10731 compilation be shared data rather than private data.  The distinction
10732 makes sense only on certain operating systems, where shared data is
10733 shared between processes running the same program, while private data
10734 exists in one copy per process.
10736 @item -fno-common
10737 @opindex fno-common
10738 In C, allocate even uninitialized global variables in the data section of the
10739 object file, rather than generating them as common blocks.  This has the
10740 effect that if the same variable is declared (without @code{extern}) in
10741 two different compilations, you will get an error when you link them.
10742 The only reason this might be useful is if you wish to verify that the
10743 program will work on other systems which always work this way.
10745 @item -fno-ident
10746 @opindex fno-ident
10747 Ignore the @samp{#ident} directive.
10749 @item -fno-gnu-linker
10750 @opindex fno-gnu-linker
10751 Do not output global initializations (such as C++ constructors and
10752 destructors) in the form used by the GNU linker (on systems where the GNU
10753 linker is the standard method of handling them).  Use this option when
10754 you want to use a non-GNU linker, which also requires using the
10755 @command{collect2} program to make sure the system linker includes
10756 constructors and destructors.  (@command{collect2} is included in the GCC
10757 distribution.)  For systems which @emph{must} use @command{collect2}, the
10758 compiler driver @command{gcc} is configured to do this automatically.
10760 @item -finhibit-size-directive
10761 @opindex finhibit-size-directive
10762 Don't output a @code{.size} assembler directive, or anything else that
10763 would cause trouble if the function is split in the middle, and the
10764 two halves are placed at locations far apart in memory.  This option is
10765 used when compiling @file{crtstuff.c}; you should not need to use it
10766 for anything else.
10768 @item -fverbose-asm
10769 @opindex fverbose-asm
10770 Put extra commentary information in the generated assembly code to
10771 make it more readable.  This option is generally only of use to those
10772 who actually need to read the generated assembly code (perhaps while
10773 debugging the compiler itself).
10775 @option{-fno-verbose-asm}, the default, causes the
10776 extra information to be omitted and is useful when comparing two assembler
10777 files.
10779 @item -fpic
10780 @opindex fpic
10781 @cindex global offset table
10782 @cindex PIC
10783 Generate position-independent code (PIC) suitable for use in a shared
10784 library, if supported for the target machine.  Such code accesses all
10785 constant addresses through a global offset table (GOT)@.  The dynamic
10786 loader resolves the GOT entries when the program starts (the dynamic
10787 loader is not part of GCC; it is part of the operating system).  If
10788 the GOT size for the linked executable exceeds a machine-specific
10789 maximum size, you get an error message from the linker indicating that
10790 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10791 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10792 on the m68k and RS/6000.  The 386 has no such limit.)
10794 Position-independent code requires special support, and therefore works
10795 only on certain machines.  For the 386, GCC supports PIC for System V
10796 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10797 position-independent.
10799 @item -fPIC
10800 @opindex fPIC
10801 If supported for the target machine, emit position-independent code,
10802 suitable for dynamic linking and avoiding any limit on the size of the
10803 global offset table.  This option makes a difference on the m68k, m88k,
10804 and the SPARC.
10806 Position-independent code requires special support, and therefore works
10807 only on certain machines.
10809 @item -ffixed-@var{reg}
10810 @opindex ffixed
10811 Treat the register named @var{reg} as a fixed register; generated code
10812 should never refer to it (except perhaps as a stack pointer, frame
10813 pointer or in some other fixed role).
10815 @var{reg} must be the name of a register.  The register names accepted
10816 are machine-specific and are defined in the @code{REGISTER_NAMES}
10817 macro in the machine description macro file.
10819 This flag does not have a negative form, because it specifies a
10820 three-way choice.
10822 @item -fcall-used-@var{reg}
10823 @opindex fcall-used
10824 Treat the register named @var{reg} as an allocable register that is
10825 clobbered by function calls.  It may be allocated for temporaries or
10826 variables that do not live across a call.  Functions compiled this way
10827 will not save and restore the register @var{reg}.
10829 It is an error to used this flag with the frame pointer or stack pointer.
10830 Use of this flag for other registers that have fixed pervasive roles in
10831 the machine's execution model will produce disastrous results.
10833 This flag does not have a negative form, because it specifies a
10834 three-way choice.
10836 @item -fcall-saved-@var{reg}
10837 @opindex fcall-saved
10838 Treat the register named @var{reg} as an allocable register saved by
10839 functions.  It may be allocated even for temporaries or variables that
10840 live across a call.  Functions compiled this way will save and restore
10841 the register @var{reg} if they use it.
10843 It is an error to used this flag with the frame pointer or stack pointer.
10844 Use of this flag for other registers that have fixed pervasive roles in
10845 the machine's execution model will produce disastrous results.
10847 A different sort of disaster will result from the use of this flag for
10848 a register in which function values may be returned.
10850 This flag does not have a negative form, because it specifies a
10851 three-way choice.
10853 @item -fpack-struct
10854 @opindex fpack-struct
10855 Pack all structure members together without holes.
10857 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10858 code that is not binary compatible with code generated without that switch.
10859 Additionally, it makes the code suboptimal.
10860 Use it to conform to a non-default application binary interface.
10862 @item -finstrument-functions
10863 @opindex finstrument-functions
10864 Generate instrumentation calls for entry and exit to functions.  Just
10865 after function entry and just before function exit, the following
10866 profiling functions will be called with the address of the current
10867 function and its call site.  (On some platforms,
10868 @code{__builtin_return_address} does not work beyond the current
10869 function, so the call site information may not be available to the
10870 profiling functions otherwise.)
10872 @example
10873 void __cyg_profile_func_enter (void *this_fn,
10874                                void *call_site);
10875 void __cyg_profile_func_exit  (void *this_fn,
10876                                void *call_site);
10877 @end example
10879 The first argument is the address of the start of the current function,
10880 which may be looked up exactly in the symbol table.
10882 This instrumentation is also done for functions expanded inline in other
10883 functions.  The profiling calls will indicate where, conceptually, the
10884 inline function is entered and exited.  This means that addressable
10885 versions of such functions must be available.  If all your uses of a
10886 function are expanded inline, this may mean an additional expansion of
10887 code size.  If you use @samp{extern inline} in your C code, an
10888 addressable version of such functions must be provided.  (This is
10889 normally the case anyways, but if you get lucky and the optimizer always
10890 expands the functions inline, you might have gotten away without
10891 providing static copies.)
10893 A function may be given the attribute @code{no_instrument_function}, in
10894 which case this instrumentation will not be done.  This can be used, for
10895 example, for the profiling functions listed above, high-priority
10896 interrupt routines, and any functions from which the profiling functions
10897 cannot safely be called (perhaps signal handlers, if the profiling
10898 routines generate output or allocate memory).
10900 @item -fstack-check
10901 @opindex fstack-check
10902 Generate code to verify that you do not go beyond the boundary of the
10903 stack.  You should specify this flag if you are running in an
10904 environment with multiple threads, but only rarely need to specify it in
10905 a single-threaded environment since stack overflow is automatically
10906 detected on nearly all systems if there is only one stack.
10908 Note that this switch does not actually cause checking to be done; the
10909 operating system must do that.  The switch causes generation of code
10910 to ensure that the operating system sees the stack being extended.
10912 @item -fstack-limit-register=@var{reg}
10913 @itemx -fstack-limit-symbol=@var{sym}
10914 @itemx -fno-stack-limit
10915 @opindex fstack-limit-register
10916 @opindex fstack-limit-symbol
10917 @opindex fno-stack-limit
10918 Generate code to ensure that the stack does not grow beyond a certain value,
10919 either the value of a register or the address of a symbol.  If the stack
10920 would grow beyond the value, a signal is raised.  For most targets,
10921 the signal is raised before the stack overruns the boundary, so
10922 it is possible to catch the signal without taking special precautions.
10924 For instance, if the stack starts at absolute address @samp{0x80000000}
10925 and grows downwards, you can use the flags
10926 @option{-fstack-limit-symbol=__stack_limit} and
10927 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10928 of 128KB@.  Note that this may only work with the GNU linker.
10930 @cindex aliasing of parameters
10931 @cindex parameters, aliased
10932 @item -fargument-alias
10933 @itemx -fargument-noalias
10934 @itemx -fargument-noalias-global
10935 @opindex fargument-alias
10936 @opindex fargument-noalias
10937 @opindex fargument-noalias-global
10938 Specify the possible relationships among parameters and between
10939 parameters and global data.
10941 @option{-fargument-alias} specifies that arguments (parameters) may
10942 alias each other and may alias global storage.@*
10943 @option{-fargument-noalias} specifies that arguments do not alias
10944 each other, but may alias global storage.@*
10945 @option{-fargument-noalias-global} specifies that arguments do not
10946 alias each other and do not alias global storage.
10948 Each language will automatically use whatever option is required by
10949 the language standard.  You should not need to use these options yourself.
10951 @item -fleading-underscore
10952 @opindex fleading-underscore
10953 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10954 change the way C symbols are represented in the object file.  One use
10955 is to help link with legacy assembly code.
10957 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
10958 generate code that is not binary compatible with code generated without that
10959 switch.  Use it to conform to a non-default application binary interface.
10960 Not all targets provide complete support for this switch.
10962 @item -ftls-model=@var{model}
10963 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
10964 The @var{model} argument should be one of @code{global-dynamic},
10965 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
10967 The default without @option{-fpic} is @code{initial-exec}; with
10968 @option{-fpic} the default is @code{global-dynamic}.
10969 @end table
10971 @c man end
10973 @node Environment Variables
10974 @section Environment Variables Affecting GCC
10975 @cindex environment variables
10977 @c man begin ENVIRONMENT
10979 This section describes several environment variables that affect how GCC
10980 operates.  Some of them work by specifying directories or prefixes to use
10981 when searching for various kinds of files.  Some are used to specify other
10982 aspects of the compilation environment.
10984 Note that you can also specify places to search using options such as
10985 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10986 take precedence over places specified using environment variables, which
10987 in turn take precedence over those specified by the configuration of GCC@.
10988 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10989 GNU Compiler Collection (GCC) Internals}.
10991 @table @env
10992 @item LANG
10993 @itemx LC_CTYPE
10994 @c @itemx LC_COLLATE
10995 @itemx LC_MESSAGES
10996 @c @itemx LC_MONETARY
10997 @c @itemx LC_NUMERIC
10998 @c @itemx LC_TIME
10999 @itemx LC_ALL
11000 @findex LANG
11001 @findex LC_CTYPE
11002 @c @findex LC_COLLATE
11003 @findex LC_MESSAGES
11004 @c @findex LC_MONETARY
11005 @c @findex LC_NUMERIC
11006 @c @findex LC_TIME
11007 @findex LC_ALL
11008 @cindex locale
11009 These environment variables control the way that GCC uses
11010 localization information that allow GCC to work with different
11011 national conventions.  GCC inspects the locale categories
11012 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11013 so.  These locale categories can be set to any value supported by your
11014 installation.  A typical value is @samp{en_UK} for English in the United
11015 Kingdom.
11017 The @env{LC_CTYPE} environment variable specifies character
11018 classification.  GCC uses it to determine the character boundaries in
11019 a string; this is needed for some multibyte encodings that contain quote
11020 and escape characters that would otherwise be interpreted as a string
11021 end or escape.
11023 The @env{LC_MESSAGES} environment variable specifies the language to
11024 use in diagnostic messages.
11026 If the @env{LC_ALL} environment variable is set, it overrides the value
11027 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11028 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11029 environment variable.  If none of these variables are set, GCC
11030 defaults to traditional C English behavior.
11032 @item TMPDIR
11033 @findex TMPDIR
11034 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11035 files.  GCC uses temporary files to hold the output of one stage of
11036 compilation which is to be used as input to the next stage: for example,
11037 the output of the preprocessor, which is the input to the compiler
11038 proper.
11040 @item GCC_EXEC_PREFIX
11041 @findex GCC_EXEC_PREFIX
11042 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11043 names of the subprograms executed by the compiler.  No slash is added
11044 when this prefix is combined with the name of a subprogram, but you can
11045 specify a prefix that ends with a slash if you wish.
11047 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11048 an appropriate prefix to use based on the pathname it was invoked with.
11050 If GCC cannot find the subprogram using the specified prefix, it
11051 tries looking in the usual places for the subprogram.
11053 The default value of @env{GCC_EXEC_PREFIX} is
11054 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11055 of @code{prefix} when you ran the @file{configure} script.
11057 Other prefixes specified with @option{-B} take precedence over this prefix.
11059 This prefix is also used for finding files such as @file{crt0.o} that are
11060 used for linking.
11062 In addition, the prefix is used in an unusual way in finding the
11063 directories to search for header files.  For each of the standard
11064 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11065 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11066 replacing that beginning with the specified prefix to produce an
11067 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11068 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11069 These alternate directories are searched first; the standard directories
11070 come next.
11072 @item COMPILER_PATH
11073 @findex COMPILER_PATH
11074 The value of @env{COMPILER_PATH} is a colon-separated list of
11075 directories, much like @env{PATH}.  GCC tries the directories thus
11076 specified when searching for subprograms, if it can't find the
11077 subprograms using @env{GCC_EXEC_PREFIX}.
11079 @item LIBRARY_PATH
11080 @findex LIBRARY_PATH
11081 The value of @env{LIBRARY_PATH} is a colon-separated list of
11082 directories, much like @env{PATH}.  When configured as a native compiler,
11083 GCC tries the directories thus specified when searching for special
11084 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11085 using GCC also uses these directories when searching for ordinary
11086 libraries for the @option{-l} option (but directories specified with
11087 @option{-L} come first).
11089 @item LANG
11090 @findex LANG
11091 @cindex locale definition
11092 This variable is used to pass locale information to the compiler.  One way in
11093 which this information is used is to determine the character set to be used
11094 when character literals, string literals and comments are parsed in C and C++.
11095 When the compiler is configured to allow multibyte characters,
11096 the following values for @env{LANG} are recognized:
11098 @table @samp
11099 @item C-JIS
11100 Recognize JIS characters.
11101 @item C-SJIS
11102 Recognize SJIS characters.
11103 @item C-EUCJP
11104 Recognize EUCJP characters.
11105 @end table
11107 If @env{LANG} is not defined, or if it has some other value, then the
11108 compiler will use mblen and mbtowc as defined by the default locale to
11109 recognize and translate multibyte characters.
11110 @end table
11112 @noindent
11113 Some additional environments variables affect the behavior of the
11114 preprocessor.
11116 @include cppenv.texi
11118 @c man end
11120 @node Precompiled Headers
11121 @section Using Precompiled Headers
11122 @cindex precompiled headers
11123 @cindex speed of compilation
11125 Often large projects have many header files that are included in every
11126 source file.  The time the compiler takes to process these header files
11127 over and over again can account for nearly all of the time required to
11128 build the project.  To make builds faster, GCC allows users to
11129 `precompile' a header file; then, if builds can use the precompiled
11130 header file they will be much faster.
11132 To create a precompiled header file, simply compile it as you would any
11133 other file, if necessary using the @option{-x} option to make the driver
11134 treat it as a C or C++ header file.  You will probably want to use a
11135 tool like @command{make} to keep the precompiled header up-to-date when
11136 the headers it contains change.
11138 A precompiled header file will be searched for when @code{#include} is
11139 seen in the compilation.  As it searches for the included file
11140 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11141 compiler looks for a precompiled header in each directory just before it
11142 looks for the include file in that directory.  The name searched for is
11143 the name specified in the @code{#include} with @samp{.pch} appended.  If
11144 the precompiled header file can't be used, it is ignored.
11146 For instance, if you have @code{#include "all.h"}, and you have
11147 @file{all.h.pch} in the same directory as @file{all.h}, then the
11148 precompiled header file will be used if possible, and the original
11149 header will be used otherwise.
11151 Alternatively, you might decide to put the precompiled header file in a
11152 directory and use @option{-I} to ensure that directory is searched
11153 before (or instead of) the directory containing the original header.
11154 Then, if you want to check that the precompiled header file is always
11155 used, you can put a file of the same name as the original header in this
11156 directory containing an @code{#error} command.
11158 This also works with @option{-include}.  So yet another way to use
11159 precompiled headers, good for projects not designed with precompiled
11160 header files in mind, is to simply take most of the header files used by
11161 a project, include them from another header file, precompile that header
11162 file, and @option{-include} the precompiled header.  If the header files
11163 have guards against multiple inclusion, they will be skipped because
11164 they've already been included (in the precompiled header).
11166 If you need to precompile the same header file for different
11167 languages, targets, or compiler options, you can instead make a
11168 @emph{directory} named like @file{all.h.pch}, and put each precompiled
11169 header in the directory.  (It doesn't matter what you call the files
11170 in the directory, every precompiled header in the directory will be
11171 considered.)  The first precompiled header encountered in the
11172 directory that is valid for this compilation will be used; they're
11173 searched in no particular order.
11175 There are many other possibilities, limited only by your imagination,
11176 good sense, and the constraints of your build system.
11178 A precompiled header file can be used only when these conditions apply:
11180 @itemize
11181 @item
11182 Only one precompiled header can be used in a particular compilation.
11183 @item
11184 A precompiled header can't be used once the first C token is seen.  You
11185 can have preprocessor directives before a precompiled header; you can
11186 even include a precompiled header from inside another header, so long as
11187 there are no C tokens before the @code{#include}.
11188 @item
11189 The precompiled header file must be produced for the same language as
11190 the current compilation.  You can't use a C precompiled header for a C++
11191 compilation.
11192 @item
11193 The precompiled header file must be produced by the same compiler
11194 version and configuration as the current compilation is using.
11195 The easiest way to guarantee this is to use the same compiler binary
11196 for creating and using precompiled headers.
11197 @item
11198 Any macros defined before the precompiled header (including with
11199 @option{-D}) must either be defined in the same way as when the
11200 precompiled header was generated, or must not affect the precompiled
11201 header, which usually means that the they don't appear in the
11202 precompiled header at all.
11203 @item
11204 Certain command-line options must be defined in the same way as when the
11205 precompiled header was generated.  At present, it's not clear which
11206 options are safe to change and which are not; the safest choice is to
11207 use exactly the same options when generating and using the precompiled
11208 header.
11209 @end itemize
11211 For all of these but the last, the compiler will automatically ignore
11212 the precompiled header if the conditions aren't met.  For the last item,
11213 some option changes will cause the precompiled header to be rejected,
11214 but not all incompatible option combinations have yet been found.  If
11215 you find a new incompatible combination, please consider filing a bug
11216 report, see @ref{Bugs}.
11218 @node Running Protoize
11219 @section Running Protoize
11221 The program @code{protoize} is an optional part of GCC@.  You can use
11222 it to add prototypes to a program, thus converting the program to ISO
11223 C in one respect.  The companion program @code{unprotoize} does the
11224 reverse: it removes argument types from any prototypes that are found.
11226 When you run these programs, you must specify a set of source files as
11227 command line arguments.  The conversion programs start out by compiling
11228 these files to see what functions they define.  The information gathered
11229 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11231 After scanning comes actual conversion.  The specified files are all
11232 eligible to be converted; any files they include (whether sources or
11233 just headers) are eligible as well.
11235 But not all the eligible files are converted.  By default,
11236 @code{protoize} and @code{unprotoize} convert only source and header
11237 files in the current directory.  You can specify additional directories
11238 whose files should be converted with the @option{-d @var{directory}}
11239 option.  You can also specify particular files to exclude with the
11240 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11241 directory name matches one of the specified directory names, and its
11242 name within the directory has not been excluded.
11244 Basic conversion with @code{protoize} consists of rewriting most
11245 function definitions and function declarations to specify the types of
11246 the arguments.  The only ones not rewritten are those for varargs
11247 functions.
11249 @code{protoize} optionally inserts prototype declarations at the
11250 beginning of the source file, to make them available for any calls that
11251 precede the function's definition.  Or it can insert prototype
11252 declarations with block scope in the blocks where undeclared functions
11253 are called.
11255 Basic conversion with @code{unprotoize} consists of rewriting most
11256 function declarations to remove any argument types, and rewriting
11257 function definitions to the old-style pre-ISO form.
11259 Both conversion programs print a warning for any function declaration or
11260 definition that they can't convert.  You can suppress these warnings
11261 with @option{-q}.
11263 The output from @code{protoize} or @code{unprotoize} replaces the
11264 original source file.  The original file is renamed to a name ending
11265 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11266 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11267 for DOS) file already exists, then the source file is simply discarded.
11269 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11270 scan the program and collect information about the functions it uses.
11271 So neither of these programs will work until GCC is installed.
11273 Here is a table of the options you can use with @code{protoize} and
11274 @code{unprotoize}.  Each option works with both programs unless
11275 otherwise stated.
11277 @table @code
11278 @item -B @var{directory}
11279 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11280 usual directory (normally @file{/usr/local/lib}).  This file contains
11281 prototype information about standard system functions.  This option
11282 applies only to @code{protoize}.
11284 @item -c @var{compilation-options}
11285 Use @var{compilation-options} as the options when running @command{gcc} to
11286 produce the @samp{.X} files.  The special option @option{-aux-info} is
11287 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11289 Note that the compilation options must be given as a single argument to
11290 @code{protoize} or @code{unprotoize}.  If you want to specify several
11291 @command{gcc} options, you must quote the entire set of compilation options
11292 to make them a single word in the shell.
11294 There are certain @command{gcc} arguments that you cannot use, because they
11295 would produce the wrong kind of output.  These include @option{-g},
11296 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11297 the @var{compilation-options}, they are ignored.
11299 @item -C
11300 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11301 systems) instead of @samp{.c}.  This is convenient if you are converting
11302 a C program to C++.  This option applies only to @code{protoize}.
11304 @item -g
11305 Add explicit global declarations.  This means inserting explicit
11306 declarations at the beginning of each source file for each function
11307 that is called in the file and was not declared.  These declarations
11308 precede the first function definition that contains a call to an
11309 undeclared function.  This option applies only to @code{protoize}.
11311 @item -i @var{string}
11312 Indent old-style parameter declarations with the string @var{string}.
11313 This option applies only to @code{protoize}.
11315 @code{unprotoize} converts prototyped function definitions to old-style
11316 function definitions, where the arguments are declared between the
11317 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11318 uses five spaces as the indentation.  If you want to indent with just
11319 one space instead, use @option{-i " "}.
11321 @item -k
11322 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11323 is finished.
11325 @item -l
11326 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11327 a prototype declaration for each function in each block which calls the
11328 function without any declaration.  This option applies only to
11329 @code{protoize}.
11331 @item -n
11332 Make no real changes.  This mode just prints information about the conversions
11333 that would have been done without @option{-n}.
11335 @item -N
11336 Make no @samp{.save} files.  The original files are simply deleted.
11337 Use this option with caution.
11339 @item -p @var{program}
11340 Use the program @var{program} as the compiler.  Normally, the name
11341 @file{gcc} is used.
11343 @item -q
11344 Work quietly.  Most warnings are suppressed.
11346 @item -v
11347 Print the version number, just like @option{-v} for @command{gcc}.
11348 @end table
11350 If you need special compiler options to compile one of your program's
11351 source files, then you should generate that file's @samp{.X} file
11352 specially, by running @command{gcc} on that source file with the
11353 appropriate options and the option @option{-aux-info}.  Then run
11354 @code{protoize} on the entire set of files.  @code{protoize} will use
11355 the existing @samp{.X} file because it is newer than the source file.
11356 For example:
11358 @example
11359 gcc -Dfoo=bar file1.c -aux-info file1.X
11360 protoize *.c
11361 @end example
11363 @noindent
11364 You need to include the special files along with the rest in the
11365 @code{protoize} command, even though their @samp{.X} files already
11366 exist, because otherwise they won't get converted.
11368 @xref{Protoize Caveats}, for more information on how to use
11369 @code{protoize} successfully.