FSF GCC merge 02/23/03
[official-gcc.git] / gcc / doc / invoke.texi
blobff9a9a7642e31b88f9d35f60f86f6e63a32a3250
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  -fsched2-use-superblocks @gol
291 -fsched2-use-traces  -fsignaling-nans @gol
292 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
293 -fstrength-reduce  -fstrict-aliasing  -ftracer -fthread-jumps @gol
294 -funit-at-a-time -funroll-all-loops  -funroll-loops  -funswitch-loops @gol
295 --param @var{name}=@var{value}
296 -O  -O0  -O1  -O2  -O3  -Os}
298 @item Preprocessor Options
299 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
300 @gccoptlist{
301 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
302 -C  -dD  -dI  -dM  -dN @gol
303 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
304 -idirafter @var{dir} @gol
305 -include @var{file}  -imacros @var{file} @gol
306 -iprefix @var{file}  -iwithprefix @var{dir} @gol
307 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
308 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
309 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} -Xpreprocessor @var{option}}
311 @item Assembler Option
312 @xref{Assembler Options,,Passing Options to the Assembler}.
313 @gccoptlist{
314 -Wa,@var{option} -Xassembler @var{option}}
316 @item Linker Options
317 @xref{Link Options,,Options for Linking}.
318 @gccoptlist{
319 @var{object-file-name}  -l@var{library} @gol
320 -nostartfiles  -nodefaultlibs  -nostdlib @gol
321 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
322 -Wl,@var{option}  -Xlinker @var{option} @gol
323 -u @var{symbol}}
325 @item Directory Options
326 @xref{Directory Options,,Options for Directory Search}.
327 @gccoptlist{
328 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
330 @item Target Options
331 @c I wrote this xref this way to avoid overfull hbox. -- rms
332 @xref{Target Options}.
333 @gccoptlist{
334 -V @var{version} -b @var{machine}}
336 @item Machine Dependent Options
337 @xref{Submodel Options,,Hardware Models and Configurations}.
339 @emph{M680x0 Options}
340 @gccoptlist{
341 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
342 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
343 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
344 -malign-int  -mstrict-align}
346 @emph{M68hc1x Options}
347 @gccoptlist{
348 -m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
349 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
350 -msoft-reg-count=@var{count}}
352 @emph{VAX Options}
353 @gccoptlist{
354 -mg  -mgnu  -munix}
356 @emph{SPARC Options}
357 @gccoptlist{
358 -mcpu=@var{cpu-type} @gol
359 -mtune=@var{cpu-type} @gol
360 -mcmodel=@var{code-model} @gol
361 -m32  -m64 @gol
362 -mapp-regs  -mbroken-saverestore  -mcypress @gol
363 -mfaster-structs  -mflat @gol
364 -mfpu  -mhard-float  -mhard-quad-float @gol
365 -mimpure-text  -mlive-g0  -mno-app-regs @gol
366 -mno-faster-structs  -mno-flat  -mno-fpu @gol
367 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
368 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
369 -msupersparc  -munaligned-doubles  -mv8}
371 @emph{ARM Options}
372 @gccoptlist{
373 -mapcs-frame  -mno-apcs-frame @gol
374 -mapcs-26  -mapcs-32 @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -malignment-traps  -mno-alignment-traps @gol
381 -msoft-float  -mhard-float  -mfpe @gol
382 -mthumb-interwork  -mno-thumb-interwork @gol
383 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
384 -mstructure-size-boundary=@var{n} @gol
385 -mabort-on-noreturn @gol
386 -mlong-calls  -mno-long-calls @gol
387 -msingle-pic-base  -mno-single-pic-base @gol
388 -mpic-register=@var{reg} @gol
389 -mnop-fun-dllimport @gol
390 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
391 -mpoke-function-name @gol
392 -mthumb  -marm @gol
393 -mtpcs-frame  -mtpcs-leaf-frame @gol
394 -mcaller-super-interworking  -mcallee-super-interworking }
396 @emph{MN10200 Options}
397 @gccoptlist{
398 -mrelax}
400 @emph{MN10300 Options}
401 @gccoptlist{
402 -mmult-bug  -mno-mult-bug @gol
403 -mam33  -mno-am33 @gol
404 -mno-crt0  -mrelax}
406 @emph{M32R/D Options}
407 @gccoptlist{
408 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
409 -G @var{num}}
411 @emph{M88K Options}
412 @gccoptlist{
413 -m88000  -m88100  -m88110  -mbig-pic @gol
414 -mcheck-zero-division  -mhandle-large-shift @gol
415 -midentify-revision  -mno-check-zero-division @gol
416 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
417 -mno-optimize-arg-area  -mno-serialize-volatile @gol
418 -mno-underscores  -mocs-debug-info @gol
419 -mocs-frame-position  -moptimize-arg-area @gol
420 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
421 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
422 -mversion-03.00  -mwarn-passed-structs}
424 @emph{RS/6000 and PowerPC Options}
425 @gccoptlist{
426 -mcpu=@var{cpu-type} @gol
427 -mtune=@var{cpu-type} @gol
428 -mpower  -mno-power  -mpower2  -mno-power2 @gol
429 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
430 -maltivec -mno-altivec @gol
431 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
432 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
433 -mnew-mnemonics  -mold-mnemonics @gol
434 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
435 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
436 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
437 -mstring  -mno-string  -mupdate  -mno-update @gol
438 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
439 -mstrict-align  -mno-strict-align  -mrelocatable @gol
440 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
441 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
442 -mcall-aix -mcall-sysv -mcall-netbsd @gol
443 -maix-struct-return -msvr4-struct-return @gol
444 -mabi=altivec -mabi=no-altivec @gol
445 -mabi=spe -mabi=no-spe @gol
446 -misel=yes -misel=no @gol
447 -mprototype  -mno-prototype @gol
448 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
449 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
451 @emph{Darwin Options}
452 @gccoptlist{
453 -all_load -allowable_client -arch -arch_errors_fatal @gol
454 -arch_only -bind_at_load -bundle -bundle_loader @gol
455 -client_name -compatibility_version -current_version @gol
456 -dependency-file -dylib_file -dylinker_install_name @gol
457 -dynamic -dynamiclib -exported_symbols_list @gol
458 -filelist -flat_namespace -force_cpusubtype_ALL @gol
459 -force_flat_namespace -headerpad_max_install_names @gol
460 -image_base -init -install_name -keep_private_externs @gol
461 -multi_module -multiply_defined -multiply_defined_unused @gol
462 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
463 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
464 -private_bundle -read_only_relocs -sectalign @gol
465 -sectobjectsymbols -whyload -seg1addr @gol
466 -sectcreate -sectobjectsymbols -sectorder @gol
467 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
468 -segprot -segs_read_only_addr -segs_read_write_addr @gol
469 -single_module -static -sub_library -sub_umbrella @gol
470 -twolevel_namespace -umbrella -undefined @gol
471 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
473 @emph{RT Options}
474 @gccoptlist{
475 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
476 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
477 -mminimum-fp-blocks  -mnohc-struct-return}
479 @emph{MIPS Options}
480 @gccoptlist{
481 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
482 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
483 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
484 -mgas  -mgp32  -mgp64 @gol
485 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
486 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
487 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
488 -mmips-as  -mmips-tfile  -mno-abicalls @gol
489 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
490 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
491 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
492 -mrnames  -msoft-float @gol
493 -m4650  -msingle-float  -mmad @gol
494 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
495 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
496 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
497 -mbranch-likely -mno-branch-likely}
499 @emph{i386 and x86-64 Options}
500 @gccoptlist{
501 -mtune=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
502 -masm=@var{dialect}  -mno-fancy-math-387 @gol
503 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
504 -mno-wide-multiply  -mrtd  -malign-double @gol
505 -mpreferred-stack-boundary=@var{num} @gol
506 -mmmx  -msse -msse2 -m3dnow @gol
507 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
508 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
509 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
510 -mno-red-zone@gol
511 -mcmodel=@var{code-model} @gol
512 -m32 -m64}
514 @emph{HPPA Options}
515 @gccoptlist{
516 -march=@var{architecture-type} @gol
517 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
518 -mfast-indirect-calls  -mgas  -mgnu-ld -mhp-ld @gol
519 -mjump-in-delay -mlinker-opt -mlong-calls @gol
520 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
521 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
522 -mno-jump-in-delay  -mno-long-load-store @gol
523 -mno-portable-runtime  -mno-soft-float @gol
524 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
525 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
526 -mschedule=@var{cpu-type}  -mspace-regs -msio -mwsio}
528 @emph{Intel 960 Options}
529 @gccoptlist{
530 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
531 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
532 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
533 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
534 -mno-complex-addr  -mno-leaf-procedures @gol
535 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
536 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
537 -mtail-call}
539 @emph{DEC Alpha Options}
540 @gccoptlist{
541 -mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
542 -mieee  -mieee-with-inexact  -mieee-conformant @gol
543 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
544 -mtrap-precision=@var{mode}  -mbuild-constants @gol
545 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
546 -mbwx  -mmax  -mfix  -mcix @gol
547 -mfloat-vax  -mfloat-ieee @gol
548 -mexplicit-relocs  -msmall-data  -mlarge-data -msmall-text -mlarge-text @gol
549 -mmemory-latency=@var{time}}
551 @emph{DEC Alpha/VMS Options}
552 @gccoptlist{
553 -mvms-return-codes}
555 @emph{H8/300 Options}
556 @gccoptlist{
557 -mrelax  -mh  -ms  -mn  -mint32  -malign-300}
559 @emph{SH Options}
560 @gccoptlist{
561 -m1  -m2  -m2e  -m3  -m3e @gol
562 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
563 -m5-64media -m5-64media-nofpu @gol
564 -m5-32media -m5-32media-nofpu @gol
565 -m5-compact -m5-compact-nofpu @gol
566 -mb  -ml  -mdalign  -mrelax @gol
567 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
568 -mieee  -misize  -mpadstruct  -mspace @gol
569 -mprefergot  -musermode}
571 @emph{System V Options}
572 @gccoptlist{
573 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
575 @emph{ARC Options}
576 @gccoptlist{
577 -EB  -EL @gol
578 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
579 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
581 @emph{TMS320C3x/C4x Options}
582 @gccoptlist{
583 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
584 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
585 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
586 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
588 @emph{V850 Options}
589 @gccoptlist{
590 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
591 -mprolog-function  -mno-prolog-function  -mspace @gol
592 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
593 -mapp-regs -mno-app-regs @gol
594 -mdisable-callt -mno-disable-callt @gol
595 -mv850e @gol
596 -mv850  -mbig-switch}
598 @emph{NS32K Options}
599 @gccoptlist{
600 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
601 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
602 -mregparam  -mnoregparam  -msb  -mnosb @gol
603 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
605 @emph{AVR Options}
606 @gccoptlist{
607 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
608 -mcall-prologues  -mno-tablejump  -mtiny-stack}
610 @emph{MCore Options}
611 @gccoptlist{
612 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
613 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
614 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
615 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
616 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
618 @emph{MMIX Options}
619 @gccoptlist{
620 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
621 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
622 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
623 -mno-base-addresses -msingle-exit -mno-single-exit}
625 @emph{IA-64 Options}
626 @gccoptlist{
627 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
628 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
629 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
630 -minline-float-divide-max-throughput -minline-int-divide-min-latency @gol
631 -minline-int-divide-max-throughput -mno-dwarf2-asm @gol
632 -mfixed-range=@var{register-range}}
634 @emph{D30V Options}
635 @gccoptlist{
636 -mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
637 -masm-optimize -mbranch-cost=@var{n} -mcond-exec=@var{n}}
639 @emph{S/390 and zSeries Options}
640 @gccoptlist{
641 -mtune=@var{cpu-type} -march=@var{cpu-type} @gol
642 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
643 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
644 -m64 -m31 -mdebug -mno-debug -mesa -mzarch}
646 @emph{CRIS Options}
647 @gccoptlist{
648 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
649 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
650 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
651 -mstack-align -mdata-align -mconst-align @gol
652 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
653 -melf -maout -melinux -mlinux -sim -sim2}
655 @emph{PDP-11 Options}
656 @gccoptlist{
657 -mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
658 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
659 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
660 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
661 -mbranch-expensive  -mbranch-cheap @gol
662 -msplit  -mno-split  -munix-asm  -mdec-asm}
664 @emph{Xstormy16 Options}
665 @gccoptlist{
666 -msim}
668 @emph{Xtensa Options}
669 @gccoptlist{
670 -mbig-endian -mlittle-endian @gol
671 -mdensity -mno-density @gol
672 -mmac16 -mno-mac16 @gol
673 -mmul16 -mno-mul16 @gol
674 -mmul32 -mno-mul32 @gol
675 -mnsa -mno-nsa @gol
676 -mminmax -mno-minmax @gol
677 -msext -mno-sext @gol
678 -mbooleans -mno-booleans @gol
679 -mhard-float -msoft-float @gol
680 -mfused-madd -mno-fused-madd @gol
681 -mserialize-volatile -mno-serialize-volatile @gol
682 -mtext-section-literals -mno-text-section-literals @gol
683 -mtarget-align -mno-target-align @gol
684 -mlongcalls -mno-longcalls}
686 @emph{FRV Options}
687 @gccoptlist{
688 -mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 -mhard-float -msoft-float @gol
689 -malloc-cc -mfixed-cc -mdword -mno-dword -mdouble -mno-double @gol
690 -mmedia -mno-media -mmuladd -mno-muladd -mlibrary-pic -macc-4 @gol
691 -macc-8 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
692 -mscc -mno-scc -mcond-exec -mno-cond-exec -mvliw-branch -mno-vliw-branch @gol
693 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
694 -mno-nested-cond-exec -mtomcat-stats @gol
695 -mcpu=@var{cpu}}
699 @item Code Generation Options
700 @xref{Code Gen Options,,Options for Code Generation Conventions}.
701 @gccoptlist{
702 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
703 -ffixed-@var{reg} -fexceptions @gol
704 -fnon-call-exceptions  -funwind-tables @gol
705 -fasynchronous-unwind-tables @gol
706 -finhibit-size-directive  -finstrument-functions @gol
707 -fno-common  -fno-ident  -fno-gnu-linker @gol
708 -fpcc-struct-return  -fpic  -fPIC @gol
709 -freg-struct-return  -fshared-data  -fshort-enums @gol
710 -fshort-double  -fshort-wchar @gol
711 -fverbose-asm  -fpack-struct  -fstack-check @gol
712 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
713 -fargument-alias  -fargument-noalias @gol
714 -fargument-noalias-global  -fleading-underscore @gol
715 -ftls-model=@var{model} @gol
716 -ftrapv -fbounds-check}
717 @end table
719 @menu
720 * Overall Options::     Controlling the kind of output:
721                         an executable, object files, assembler files,
722                         or preprocessed source.
723 * C Dialect Options::   Controlling the variant of C language compiled.
724 * C++ Dialect Options:: Variations on C++.
725 * Objective-C Dialect Options:: Variations on Objective-C.
726 * Language Independent Options:: Controlling how diagnostics should be
727                         formatted.
728 * Warning Options::     How picky should the compiler be?
729 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
730 * Optimize Options::    How much optimization?
731 * Preprocessor Options:: Controlling header files and macro definitions.
732                          Also, getting dependency information for Make.
733 * Assembler Options::   Passing options to the assembler.
734 * Link Options::        Specifying libraries and so on.
735 * Directory Options::   Where to find header files and libraries.
736                         Where to find the compiler executable files.
737 * Spec Files::          How to pass switches to sub-processes.
738 * Target Options::      Running a cross-compiler, or an old version of GCC.
739 @end menu
741 @node Overall Options
742 @section Options Controlling the Kind of Output
744 Compilation can involve up to four stages: preprocessing, compilation
745 proper, assembly and linking, always in that order.  The first three
746 stages apply to an individual source file, and end by producing an
747 object file; linking combines all the object files (those newly
748 compiled, and those specified as input) into an executable file.
750 @cindex file name suffix
751 For any given input file, the file name suffix determines what kind of
752 compilation is done:
754 @table @gcctabopt
755 @item @var{file}.c
756 C source code which must be preprocessed.
758 @item @var{file}.i
759 C source code which should not be preprocessed.
761 @item @var{file}.ii
762 C++ source code which should not be preprocessed.
764 @item @var{file}.m
765 Objective-C source code.  Note that you must link with the library
766 @file{libobjc.a} to make an Objective-C program work.
768 @item @var{file}.mi
769 Objective-C source code which should not be preprocessed.
771 @item @var{file}.h
772 C or C++ header file to be turned into a precompiled header.
774 @item @var{file}.cc
775 @itemx @var{file}.cp
776 @itemx @var{file}.cxx
777 @itemx @var{file}.cpp
778 @itemx @var{file}.CPP
779 @itemx @var{file}.c++
780 @itemx @var{file}.C
781 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
782 the last two letters must both be literally @samp{x}.  Likewise,
783 @samp{.C} refers to a literal capital C@.
785 @item @var{file}.hh
786 @itemx @var{file}.H
787 C++ header file to be turned into a precompiled header.
789 @item @var{file}.f
790 @itemx @var{file}.for
791 @itemx @var{file}.FOR
792 Fortran source code which should not be preprocessed.
794 @item @var{file}.F
795 @itemx @var{file}.fpp
796 @itemx @var{file}.FPP
797 Fortran source code which must be preprocessed (with the traditional
798 preprocessor).
800 @item @var{file}.r
801 Fortran source code which must be preprocessed with a RATFOR
802 preprocessor (not included with GCC)@.
804 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
805 Using and Porting GNU Fortran}, for more details of the handling of
806 Fortran input files.
808 @c FIXME: Descriptions of Java file types.
809 @c @var{file}.java
810 @c @var{file}.class
811 @c @var{file}.zip
812 @c @var{file}.jar
814 @item @var{file}.ads
815 Ada source code file which contains a library unit declaration (a
816 declaration of a package, subprogram, or generic, or a generic
817 instantiation), or a library unit renaming declaration (a package,
818 generic, or subprogram renaming declaration).  Such files are also
819 called @dfn{specs}.
821 @itemx @var{file}.adb
822 Ada source code file containing a library unit body (a subprogram or
823 package body).  Such files are also called @dfn{bodies}.
825 @c GCC also knows about some suffixes for languages not yet included:
826 @c Pascal:
827 @c @var{file}.p
828 @c @var{file}.pas
830 @item @var{file}.s
831 Assembler code.
833 @item @var{file}.S
834 Assembler code which must be preprocessed.
836 @item @var{other}
837 An object file to be fed straight into linking.
838 Any file name with no recognized suffix is treated this way.
839 @end table
841 @opindex x
842 You can specify the input language explicitly with the @option{-x} option:
844 @table @gcctabopt
845 @item -x @var{language}
846 Specify explicitly the @var{language} for the following input files
847 (rather than letting the compiler choose a default based on the file
848 name suffix).  This option applies to all following input files until
849 the next @option{-x} option.  Possible values for @var{language} are:
850 @example
851 c  c-header  cpp-output
852 c++  c++-header  c++-cpp-output
853 objective-c  objc-cpp-output
854 assembler  assembler-with-cpp
856 f77  f77-cpp-input  ratfor
857 java
858 treelang
859 @end example
861 @item -x none
862 Turn off any specification of a language, so that subsequent files are
863 handled according to their file name suffixes (as they are if @option{-x}
864 has not been used at all).
866 @item -pass-exit-codes
867 @opindex pass-exit-codes
868 Normally the @command{gcc} program will exit with the code of 1 if any
869 phase of the compiler returns a non-success return code.  If you specify
870 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
871 numerically highest error produced by any phase that returned an error
872 indication.
873 @end table
875 If you only want some of the stages of compilation, you can use
876 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
877 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
878 @command{gcc} is to stop.  Note that some combinations (for example,
879 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
881 @table @gcctabopt
882 @item -c
883 @opindex c
884 Compile or assemble the source files, but do not link.  The linking
885 stage simply is not done.  The ultimate output is in the form of an
886 object file for each source file.
888 By default, the object file name for a source file is made by replacing
889 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
891 Unrecognized input files, not requiring compilation or assembly, are
892 ignored.
894 @item -S
895 @opindex S
896 Stop after the stage of compilation proper; do not assemble.  The output
897 is in the form of an assembler code file for each non-assembler input
898 file specified.
900 By default, the assembler file name for a source file is made by
901 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
903 Input files that don't require compilation are ignored.
905 @item -E
906 @opindex E
907 Stop after the preprocessing stage; do not run the compiler proper.  The
908 output is in the form of preprocessed source code, which is sent to the
909 standard output.
911 Input files which don't require preprocessing are ignored.
913 @cindex output file option
914 @item -o @var{file}
915 @opindex o
916 Place output in file @var{file}.  This applies regardless to whatever
917 sort of output is being produced, whether it be an executable file,
918 an object file, an assembler file or preprocessed C code.
920 Since only one output file can be specified, it does not make sense to
921 use @option{-o} when compiling more than one input file, unless you are
922 producing an executable file as output.
924 If @option{-o} is not specified, the default is to put an executable file
925 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
926 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
927 all preprocessed C source on standard output.
929 @item -v
930 @opindex v
931 Print (on standard error output) the commands executed to run the stages
932 of compilation.  Also print the version number of the compiler driver
933 program and of the preprocessor and the compiler proper.
935 @item -###
936 @opindex ###
937 Like @option{-v} except the commands are not executed and all command
938 arguments are quoted.  This is useful for shell scripts to capture the
939 driver-generated command lines.
941 @item -pipe
942 @opindex pipe
943 Use pipes rather than temporary files for communication between the
944 various stages of compilation.  This fails to work on some systems where
945 the assembler is unable to read from a pipe; but the GNU assembler has
946 no trouble.
948 @item --help
949 @opindex help
950 Print (on the standard output) a description of the command line options
951 understood by @command{gcc}.  If the @option{-v} option is also specified
952 then @option{--help} will also be passed on to the various processes
953 invoked by @command{gcc}, so that they can display the command line options
954 they accept.  If the @option{-Wextra} option is also specified then command
955 line options which have no documentation associated with them will also
956 be displayed.
958 @item --target-help
959 @opindex target-help
960 Print (on the standard output) a description of target specific command
961 line options for each tool.
963 @item --version
964 @opindex version
965 Display the version number and copyrights of the invoked GCC.
966 @end table
968 @node Invoking G++
969 @section Compiling C++ Programs
971 @cindex suffixes for C++ source
972 @cindex C++ source file suffixes
973 C++ source files conventionally use one of the suffixes @samp{.C},
974 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
975 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
976 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
977 files with these names and compiles them as C++ programs even if you
978 call the compiler the same way as for compiling C programs (usually
979 with the name @command{gcc}).
981 @findex g++
982 @findex c++
983 However, C++ programs often require class libraries as well as a
984 compiler that understands the C++ language---and under some
985 circumstances, you might want to compile programs or header files from
986 standard input, or otherwise without a suffix that flags them as C++
987 programs.  You might also like to precompile a C header file with a
988 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
989 program that calls GCC with the default language set to C++, and
990 automatically specifies linking against the C++ library.  On many
991 systems, @command{g++} is also installed with the name @command{c++}.
993 @cindex invoking @command{g++}
994 When you compile C++ programs, you may specify many of the same
995 command-line options that you use for compiling programs in any
996 language; or command-line options meaningful for C and related
997 languages; or options that are meaningful only for C++ programs.
998 @xref{C Dialect Options,,Options Controlling C Dialect}, for
999 explanations of options for languages related to C@.
1000 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1001 explanations of options that are meaningful only for C++ programs.
1003 @node C Dialect Options
1004 @section Options Controlling C Dialect
1005 @cindex dialect options
1006 @cindex language dialect options
1007 @cindex options, dialect
1009 The following options control the dialect of C (or languages derived
1010 from C, such as C++ and Objective-C) that the compiler accepts:
1012 @table @gcctabopt
1013 @cindex ANSI support
1014 @cindex ISO support
1015 @item -ansi
1016 @opindex ansi
1017 In C mode, support all ISO C90 programs.  In C++ mode,
1018 remove GNU extensions that conflict with ISO C++.
1020 This turns off certain features of GCC that are incompatible with ISO
1021 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1022 such as the @code{asm} and @code{typeof} keywords, and
1023 predefined macros such as @code{unix} and @code{vax} that identify the
1024 type of system you are using.  It also enables the undesirable and
1025 rarely used ISO trigraph feature.  For the C compiler,
1026 it disables recognition of C++ style @samp{//} comments as well as
1027 the @code{inline} keyword.
1029 The alternate keywords @code{__asm__}, @code{__extension__},
1030 @code{__inline__} and @code{__typeof__} continue to work despite
1031 @option{-ansi}.  You would not want to use them in an ISO C program, of
1032 course, but it is useful to put them in header files that might be included
1033 in compilations done with @option{-ansi}.  Alternate predefined macros
1034 such as @code{__unix__} and @code{__vax__} are also available, with or
1035 without @option{-ansi}.
1037 The @option{-ansi} option does not cause non-ISO programs to be
1038 rejected gratuitously.  For that, @option{-pedantic} is required in
1039 addition to @option{-ansi}.  @xref{Warning Options}.
1041 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1042 option is used.  Some header files may notice this macro and refrain
1043 from declaring certain functions or defining certain macros that the
1044 ISO standard doesn't call for; this is to avoid interfering with any
1045 programs that might use these names for other things.
1047 Functions which would normally be built in but do not have semantics
1048 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1049 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1050 built-in functions provided by GCC}, for details of the functions
1051 affected.
1053 @item -std=
1054 @opindex std
1055 Determine the language standard.  This option is currently only
1056 supported when compiling C or C++.  A value for this option must be
1057 provided; possible values are
1059 @table @samp
1060 @item c89
1061 @itemx iso9899:1990
1062 ISO C90 (same as @option{-ansi}).
1064 @item iso9899:199409
1065 ISO C90 as modified in amendment 1.
1067 @item c99
1068 @itemx c9x
1069 @itemx iso9899:1999
1070 @itemx iso9899:199x
1071 ISO C99.  Note that this standard is not yet fully supported; see
1072 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1073 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1075 @item gnu89
1076 Default, ISO C90 plus GNU extensions (including some C99 features).
1078 @item gnu99
1079 @item gnu9x
1080 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1081 this will become the default.  The name @samp{gnu9x} is deprecated.
1083 @item c++98
1084 The 1998 ISO C++ standard plus amendments.
1086 @item gnu++98
1087 The same as @option{-std=c++98} plus GNU extensions.  This is the
1088 default for C++ code.
1089 @end table
1091 Even when this option is not specified, you can still use some of the
1092 features of newer standards in so far as they do not conflict with
1093 previous C standards.  For example, you may use @code{__restrict__} even
1094 when @option{-std=c99} is not specified.
1096 The @option{-std} options specifying some version of ISO C have the same
1097 effects as @option{-ansi}, except that features that were not in ISO C90
1098 but are in the specified version (for example, @samp{//} comments and
1099 the @code{inline} keyword in ISO C99) are not disabled.
1101 @xref{Standards,,Language Standards Supported by GCC}, for details of
1102 these standard versions.
1104 @item -aux-info @var{filename}
1105 @opindex aux-info
1106 Output to the given filename prototyped declarations for all functions
1107 declared and/or defined in a translation unit, including those in header
1108 files.  This option is silently ignored in any language other than C@.
1110 Besides declarations, the file indicates, in comments, the origin of
1111 each declaration (source file and line), whether the declaration was
1112 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1113 @samp{O} for old, respectively, in the first character after the line
1114 number and the colon), and whether it came from a declaration or a
1115 definition (@samp{C} or @samp{F}, respectively, in the following
1116 character).  In the case of function definitions, a K&R-style list of
1117 arguments followed by their declarations is also provided, inside
1118 comments, after the declaration.
1120 @item -fno-asm
1121 @opindex fno-asm
1122 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1123 keyword, so that code can use these words as identifiers.  You can use
1124 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1125 instead.  @option{-ansi} implies @option{-fno-asm}.
1127 In C++, this switch only affects the @code{typeof} keyword, since
1128 @code{asm} and @code{inline} are standard keywords.  You may want to
1129 use the @option{-fno-gnu-keywords} flag instead, which has the same
1130 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1131 switch only affects the @code{asm} and @code{typeof} keywords, since
1132 @code{inline} is a standard keyword in ISO C99.
1134 @item -fno-builtin
1135 @itemx -fno-builtin-@var{function}
1136 @opindex fno-builtin
1137 @cindex built-in functions
1138 Don't recognize built-in functions that do not begin with
1139 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1140 functions provided by GCC}, for details of the functions affected,
1141 including those which are not built-in functions when @option{-ansi} or
1142 @option{-std} options for strict ISO C conformance are used because they
1143 do not have an ISO standard meaning.
1145 GCC normally generates special code to handle certain built-in functions
1146 more efficiently; for instance, calls to @code{alloca} may become single
1147 instructions that adjust the stack directly, and calls to @code{memcpy}
1148 may become inline copy loops.  The resulting code is often both smaller
1149 and faster, but since the function calls no longer appear as such, you
1150 cannot set a breakpoint on those calls, nor can you change the behavior
1151 of the functions by linking with a different library.
1153 With the @option{-fno-builtin-@var{function}} option
1154 only the built-in function @var{function} is
1155 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1156 function is named this is not built-in in this version of GCC, this
1157 option is ignored.  There is no corresponding
1158 @option{-fbuiltin-@var{function}} option; if you wish to enable
1159 built-in functions selectively when using @option{-fno-builtin} or
1160 @option{-ffreestanding}, you may define macros such as:
1162 @smallexample
1163 #define abs(n)          __builtin_abs ((n))
1164 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1165 @end smallexample
1167 @item -fhosted
1168 @opindex fhosted
1169 @cindex hosted environment
1171 Assert that compilation takes place in a hosted environment.  This implies
1172 @option{-fbuiltin}.  A hosted environment is one in which the
1173 entire standard library is available, and in which @code{main} has a return
1174 type of @code{int}.  Examples are nearly everything except a kernel.
1175 This is equivalent to @option{-fno-freestanding}.
1177 @item -ffreestanding
1178 @opindex ffreestanding
1179 @cindex hosted environment
1181 Assert that compilation takes place in a freestanding environment.  This
1182 implies @option{-fno-builtin}.  A freestanding environment
1183 is one in which the standard library may not exist, and program startup may
1184 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1185 This is equivalent to @option{-fno-hosted}.
1187 @xref{Standards,,Language Standards Supported by GCC}, for details of
1188 freestanding and hosted environments.
1190 @item -fms-extensions
1191 @opindex fms-extensions
1192 Accept some non-standard constructs used in Microsoft header files.
1194 @item -trigraphs
1195 @opindex trigraphs
1196 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1197 options for strict ISO C conformance) implies @option{-trigraphs}.
1199 @cindex traditional C language
1200 @cindex C language, traditional
1201 @item -traditional
1202 @itemx -traditional-cpp
1203 @opindex traditional-cpp
1204 @opindex traditional
1205 Formerly, these options caused GCC to attempt to emulate a pre-standard
1206 C compiler.  They are now only supported with the @option{-E} switch.
1207 The preprocessor continues to support a pre-standard mode.  See the GNU
1208 CPP manual for details.
1210 @item -fcond-mismatch
1211 @opindex fcond-mismatch
1212 Allow conditional expressions with mismatched types in the second and
1213 third arguments.  The value of such an expression is void.  This option
1214 is not supported for C++.
1216 @item -funsigned-char
1217 @opindex funsigned-char
1218 Let the type @code{char} be unsigned, like @code{unsigned char}.
1220 Each kind of machine has a default for what @code{char} should
1221 be.  It is either like @code{unsigned char} by default or like
1222 @code{signed char} by default.
1224 Ideally, a portable program should always use @code{signed char} or
1225 @code{unsigned char} when it depends on the signedness of an object.
1226 But many programs have been written to use plain @code{char} and
1227 expect it to be signed, or expect it to be unsigned, depending on the
1228 machines they were written for.  This option, and its inverse, let you
1229 make such a program work with the opposite default.
1231 The type @code{char} is always a distinct type from each of
1232 @code{signed char} or @code{unsigned char}, even though its behavior
1233 is always just like one of those two.
1235 @item -fsigned-char
1236 @opindex fsigned-char
1237 Let the type @code{char} be signed, like @code{signed char}.
1239 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1240 the negative form of @option{-funsigned-char}.  Likewise, the option
1241 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1243 @item -fsigned-bitfields
1244 @itemx -funsigned-bitfields
1245 @itemx -fno-signed-bitfields
1246 @itemx -fno-unsigned-bitfields
1247 @opindex fsigned-bitfields
1248 @opindex funsigned-bitfields
1249 @opindex fno-signed-bitfields
1250 @opindex fno-unsigned-bitfields
1251 These options control whether a bit-field is signed or unsigned, when the
1252 declaration does not use either @code{signed} or @code{unsigned}.  By
1253 default, such a bit-field is signed, because this is consistent: the
1254 basic integer types such as @code{int} are signed types.
1256 @item -fwritable-strings
1257 @opindex fwritable-strings
1258 Store string constants in the writable data segment and don't uniquize
1259 them.  This is for compatibility with old programs which assume they can
1260 write into string constants.
1262 Writing into string constants is a very bad idea; ``constants'' should
1263 be constant.
1264 @end table
1266 @node C++ Dialect Options
1267 @section Options Controlling C++ Dialect
1269 @cindex compiler options, C++
1270 @cindex C++ options, command line
1271 @cindex options, C++
1272 This section describes the command-line options that are only meaningful
1273 for C++ programs; but you can also use most of the GNU compiler options
1274 regardless of what language your program is in.  For example, you
1275 might compile a file @code{firstClass.C} like this:
1277 @example
1278 g++ -g -frepo -O -c firstClass.C
1279 @end example
1281 @noindent
1282 In this example, only @option{-frepo} is an option meant
1283 only for C++ programs; you can use the other options with any
1284 language supported by GCC@.
1286 Here is a list of options that are @emph{only} for compiling C++ programs:
1288 @table @gcctabopt
1290 @item -fabi-version=@var{n}
1291 @opindex fabi-version
1292 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1293 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1294 version that conforms most closely to the C++ ABI specification.
1295 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1296 fixed.
1298 The default is version 1.
1300 @item -fno-access-control
1301 @opindex fno-access-control
1302 Turn off all access checking.  This switch is mainly useful for working
1303 around bugs in the access control code.
1305 @item -fcheck-new
1306 @opindex fcheck-new
1307 Check that the pointer returned by @code{operator new} is non-null
1308 before attempting to modify the storage allocated.  The current Working
1309 Paper requires that @code{operator new} never return a null pointer, so
1310 this check is normally unnecessary.
1312 An alternative to using this option is to specify that your
1313 @code{operator new} does not throw any exceptions; if you declare it
1314 @samp{throw()}, G++ will check the return value.  See also @samp{new
1315 (nothrow)}.
1317 @item -fconserve-space
1318 @opindex fconserve-space
1319 Put uninitialized or runtime-initialized global variables into the
1320 common segment, as C does.  This saves space in the executable at the
1321 cost of not diagnosing duplicate definitions.  If you compile with this
1322 flag and your program mysteriously crashes after @code{main()} has
1323 completed, you may have an object that is being destroyed twice because
1324 two definitions were merged.
1326 This option is no longer useful on most targets, now that support has
1327 been added for putting variables into BSS without making them common.
1329 @item -fno-const-strings
1330 @opindex fno-const-strings
1331 Give string constants type @code{char *} instead of type @code{const
1332 char *}.  By default, G++ uses type @code{const char *} as required by
1333 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1334 actually modify the value of a string constant, unless you also use
1335 @option{-fwritable-strings}.
1337 This option might be removed in a future release of G++.  For maximum
1338 portability, you should structure your code so that it works with
1339 string constants that have type @code{const char *}.
1341 @item -fdollars-in-identifiers
1342 @opindex fdollars-in-identifiers
1343 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1344 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1345 @samp{$} by default on most target systems, but there are a few exceptions.)
1346 Traditional C allowed the character @samp{$} to form part of
1347 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1349 @item -fno-elide-constructors
1350 @opindex fno-elide-constructors
1351 The C++ standard allows an implementation to omit creating a temporary
1352 which is only used to initialize another object of the same type.
1353 Specifying this option disables that optimization, and forces G++ to
1354 call the copy constructor in all cases.
1356 @item -fno-enforce-eh-specs
1357 @opindex fno-enforce-eh-specs
1358 Don't check for violation of exception specifications at runtime.  This
1359 option violates the C++ standard, but may be useful for reducing code
1360 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1361 will still optimize based on the exception specifications.
1363 @item -fexternal-templates
1364 @opindex fexternal-templates
1366 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1367 template instantiation; template instances are emitted or not according
1368 to the location of the template definition.  @xref{Template
1369 Instantiation}, for more information.
1371 This option is deprecated.
1373 @item -falt-external-templates
1374 @opindex falt-external-templates
1375 Similar to @option{-fexternal-templates}, but template instances are
1376 emitted or not according to the place where they are first instantiated.
1377 @xref{Template Instantiation}, for more information.
1379 This option is deprecated.
1381 @item -ffor-scope
1382 @itemx -fno-for-scope
1383 @opindex ffor-scope
1384 @opindex fno-for-scope
1385 If @option{-ffor-scope} is specified, the scope of variables declared in
1386 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1387 as specified by the C++ standard.
1388 If @option{-fno-for-scope} is specified, the scope of variables declared in
1389 a @i{for-init-statement} extends to the end of the enclosing scope,
1390 as was the case in old versions of G++, and other (traditional)
1391 implementations of C++.
1393 The default if neither flag is given to follow the standard,
1394 but to allow and give a warning for old-style code that would
1395 otherwise be invalid, or have different behavior.
1397 @item -fno-gnu-keywords
1398 @opindex fno-gnu-keywords
1399 Do not recognize @code{typeof} as a keyword, so that code can use this
1400 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1401 @option{-ansi} implies @option{-fno-gnu-keywords}.
1403 @item -fno-implicit-templates
1404 @opindex fno-implicit-templates
1405 Never emit code for non-inline templates which are instantiated
1406 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1407 @xref{Template Instantiation}, for more information.
1409 @item -fno-implicit-inline-templates
1410 @opindex fno-implicit-inline-templates
1411 Don't emit code for implicit instantiations of inline templates, either.
1412 The default is to handle inlines differently so that compiles with and
1413 without optimization will need the same set of explicit instantiations.
1415 @item -fno-implement-inlines
1416 @opindex fno-implement-inlines
1417 To save space, do not emit out-of-line copies of inline functions
1418 controlled by @samp{#pragma implementation}.  This will cause linker
1419 errors if these functions are not inlined everywhere they are called.
1421 @item -fms-extensions
1422 @opindex fms-extensions
1423 Disable pedantic warnings about constructs used in MFC, such as implicit
1424 int and getting a pointer to member function via non-standard syntax.
1426 @item -fno-nonansi-builtins
1427 @opindex fno-nonansi-builtins
1428 Disable built-in declarations of functions that are not mandated by
1429 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1430 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1432 @item -fno-operator-names
1433 @opindex fno-operator-names
1434 Do not treat the operator name keywords @code{and}, @code{bitand},
1435 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1436 synonyms as keywords.
1438 @item -fno-optional-diags
1439 @opindex fno-optional-diags
1440 Disable diagnostics that the standard says a compiler does not need to
1441 issue.  Currently, the only such diagnostic issued by G++ is the one for
1442 a name having multiple meanings within a class.
1444 @item -fpermissive
1445 @opindex fpermissive
1446 Downgrade messages about nonconformant code from errors to warnings.  By
1447 default, G++ effectively sets @option{-pedantic-errors} without
1448 @option{-pedantic}; this option reverses that.  This behavior and this
1449 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1451 @item -frepo
1452 @opindex frepo
1453 Enable automatic template instantiation at link time.  This option also
1454 implies @option{-fno-implicit-templates}.  @xref{Template
1455 Instantiation}, for more information.
1457 @item -fno-rtti
1458 @opindex fno-rtti
1459 Disable generation of information about every class with virtual
1460 functions for use by the C++ runtime type identification features
1461 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1462 of the language, you can save some space by using this flag.  Note that
1463 exception handling uses the same information, but it will generate it as
1464 needed.
1466 @item -fstats
1467 @opindex fstats
1468 Emit statistics about front-end processing at the end of the compilation.
1469 This information is generally only useful to the G++ development team.
1471 @item -ftemplate-depth-@var{n}
1472 @opindex ftemplate-depth
1473 Set the maximum instantiation depth for template classes to @var{n}.
1474 A limit on the template instantiation depth is needed to detect
1475 endless recursions during template class instantiation.  ANSI/ISO C++
1476 conforming programs must not rely on a maximum depth greater than 17.
1478 @item -fuse-cxa-atexit
1479 @opindex fuse-cxa-atexit
1480 Register destructors for objects with static storage duration with the
1481 @code{__cxa_atexit} function rather than the @code{atexit} function.
1482 This option is required for fully standards-compliant handling of static
1483 destructors, but will only work if your C library supports
1484 @code{__cxa_atexit}.
1486 @item -fvtable-gc
1487 @opindex fvtable-gc
1488 Emit special relocations for vtables and virtual function references
1489 so that the linker can identify unused virtual functions and zero out
1490 vtable slots that refer to them.  This is most useful with
1491 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1492 also discard the functions themselves.
1494 This optimization requires GNU as and GNU ld.  Not all systems support
1495 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1497 @item -fno-weak
1498 @opindex fno-weak
1499 Do not use weak symbol support, even if it is provided by the linker.
1500 By default, G++ will use weak symbols if they are available.  This
1501 option exists only for testing, and should not be used by end-users;
1502 it will result in inferior code and has no benefits.  This option may
1503 be removed in a future release of G++.
1505 @item -nostdinc++
1506 @opindex nostdinc++
1507 Do not search for header files in the standard directories specific to
1508 C++, but do still search the other standard directories.  (This option
1509 is used when building the C++ library.)
1510 @end table
1512 In addition, these optimization, warning, and code generation options
1513 have meanings only for C++ programs:
1515 @table @gcctabopt
1516 @item -fno-default-inline
1517 @opindex fno-default-inline
1518 Do not assume @samp{inline} for functions defined inside a class scope.
1519 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1520 functions will have linkage like inline functions; they just won't be
1521 inlined by default.
1523 @item -Wabi @r{(C++ only)}
1524 @opindex Wabi
1525 Warn when G++ generates code that is probably not compatible with the
1526 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1527 all such cases, there are probably some cases that are not warned about, 
1528 even though G++ is generating incompatible code.  There may also be
1529 cases where warnings are emitted even though the code that is generated
1530 will be compatible.
1532 You should rewrite your code to avoid these warnings if you are
1533 concerned about the fact that code generated by G++ may not be binary
1534 compatible with code generated by other compilers.
1536 The known incompatibilities at this point include:
1538 @itemize @bullet
1540 @item
1541 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1542 pack data into the same byte as a base class.  For example:
1544 @smallexample
1545 struct A @{ virtual void f(); int f1 : 1; @};
1546 struct B : public A @{ int f2 : 1; @};
1547 @end smallexample
1549 @noindent
1550 In this case, G++ will place @code{B::f2} into the same byte
1551 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1552 by explicitly padding @code{A} so that its size is a multiple of the
1553 byte size on your platform; that will cause G++ and other compilers to
1554 layout @code{B} identically.
1556 @item
1557 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1558 tail padding when laying out virtual bases.  For example:
1560 @smallexample
1561 struct A @{ virtual void f(); char c1; @};
1562 struct B @{ B(); char c2; @};
1563 struct C : public A, public virtual B @{@};
1564 @end smallexample
1566 @noindent
1567 In this case, G++ will not place @code{B} into the tail-padding for
1568 @code{A}; other compilers will.  You can avoid this problem by
1569 explicitly padding @code{A} so that its size is a multiple of its
1570 alignment (ignoring virtual base classes); that will cause G++ and other
1571 compilers to layout @code{C} identically.
1573 @item
1574 Incorrect handling of bit-fields with declared widths greater than that
1575 of their underlying types, when the bit-fields appear in a union.  For
1576 example:
1578 @smallexample
1579 union U @{ int i : 4096; @};
1580 @end smallexample
1582 @noindent
1583 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1584 union too small by the number of bits in an @code{int}.
1586 @item
1587 Empty classes can be placed at incorrect offsets.  For example:
1589 @smallexample
1590 struct A @{@};
1592 struct B @{
1593   A a;
1594   virtual void f ();
1597 struct C : public B, public A @{@};
1598 @end smallexample
1600 @noindent
1601 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1602 it should be placed at offset zero.  G++ mistakenly believes that the
1603 @code{A} data member of @code{B} is already at offset zero.
1605 @item
1606 Names of template functions whose types involve @code{typename} or
1607 template template parameters can be mangled incorrectly.
1609 @smallexample
1610 template <typename Q>
1611 void f(typename Q::X) @{@}
1613 template <template <typename> class Q>
1614 void f(typename Q<int>::X) @{@}
1615 @end smallexample
1617 @noindent
1618 Instantiations of these templates may be mangled incorrectly.
1620 @end itemize
1622 @item -Wctor-dtor-privacy @r{(C++ only)}
1623 @opindex Wctor-dtor-privacy
1624 Warn when a class seems unusable, because all the constructors or
1625 destructors in a class are private and the class has no friends or
1626 public static member functions.  This warning is enabled by default.
1628 @item -Wnon-virtual-dtor @r{(C++ only)}
1629 @opindex Wnon-virtual-dtor
1630 Warn when a class declares a non-virtual destructor that should probably
1631 be virtual, because it looks like the class will be used polymorphically.
1632 This warning is enabled by @option{-Wall}.
1634 @item -Wreorder @r{(C++ only)}
1635 @opindex Wreorder
1636 @cindex reordering, warning
1637 @cindex warning for reordering of member initializers
1638 Warn when the order of member initializers given in the code does not
1639 match the order in which they must be executed.  For instance:
1641 @smallexample
1642 struct A @{
1643   int i;
1644   int j;
1645   A(): j (0), i (1) @{ @}
1647 @end smallexample
1649 Here the compiler will warn that the member initializers for @samp{i}
1650 and @samp{j} will be rearranged to match the declaration order of the
1651 members.  This warning is enabled by @option{-Wall}.
1652 @end table
1654 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1656 @table @gcctabopt
1657 @item -Weffc++ @r{(C++ only)}
1658 @opindex Weffc++
1659 Warn about violations of the following style guidelines from Scott Meyers'
1660 @cite{Effective C++} book:
1662 @itemize @bullet
1663 @item
1664 Item 11:  Define a copy constructor and an assignment operator for classes
1665 with dynamically allocated memory.
1667 @item
1668 Item 12:  Prefer initialization to assignment in constructors.
1670 @item
1671 Item 14:  Make destructors virtual in base classes.
1673 @item
1674 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1676 @item
1677 Item 23:  Don't try to return a reference when you must return an object.
1679 @end itemize
1681 and about violations of the following style guidelines from Scott Meyers'
1682 @cite{More Effective C++} book:
1684 @itemize @bullet
1685 @item
1686 Item 6:  Distinguish between prefix and postfix forms of increment and
1687 decrement operators.
1689 @item
1690 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1692 @end itemize
1694 If you use this option, you should be aware that the standard library
1695 headers do not obey all of these guidelines; you can use @samp{grep -v}
1696 to filter out those warnings.
1698 @item -Wno-deprecated @r{(C++ only)}
1699 @opindex Wno-deprecated
1700 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1702 @item -Wno-non-template-friend @r{(C++ only)}
1703 @opindex Wno-non-template-friend
1704 Disable warnings when non-templatized friend functions are declared
1705 within a template.  With the advent of explicit template specification
1706 support in G++, if the name of the friend is an unqualified-id (i.e.,
1707 @samp{friend foo(int)}), the C++ language specification demands that the
1708 friend declare or define an ordinary, nontemplate function.  (Section
1709 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1710 could be interpreted as a particular specialization of a templatized
1711 function.  Because this non-conforming behavior is no longer the default
1712 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1713 check existing code for potential trouble spots, and is on by default.
1714 This new compiler behavior can be turned off with
1715 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1716 but disables the helpful warning.
1718 @item -Wold-style-cast @r{(C++ only)}
1719 @opindex Wold-style-cast
1720 Warn if an old-style (C-style) cast to a non-void type is used within
1721 a C++ program.  The new-style casts (@samp{static_cast},
1722 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1723 unintended effects, and much easier to grep for.
1725 @item -Woverloaded-virtual @r{(C++ only)}
1726 @opindex Woverloaded-virtual
1727 @cindex overloaded virtual fn, warning
1728 @cindex warning for overloaded virtual fn
1729 Warn when a function declaration hides virtual functions from a
1730 base class.  For example, in:
1732 @smallexample
1733 struct A @{
1734   virtual void f();
1737 struct B: public A @{
1738   void f(int);
1740 @end smallexample
1742 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1743 like this:
1745 @smallexample
1746 B* b;
1747 b->f();
1748 @end smallexample
1750 will fail to compile.
1752 @item -Wno-pmf-conversions @r{(C++ only)}
1753 @opindex Wno-pmf-conversions
1754 Disable the diagnostic for converting a bound pointer to member function
1755 to a plain pointer.
1757 @item -Wsign-promo @r{(C++ only)}
1758 @opindex Wsign-promo
1759 Warn when overload resolution chooses a promotion from unsigned or
1760 enumeral type to a signed type over a conversion to an unsigned type of
1761 the same size.  Previous versions of G++ would try to preserve
1762 unsignedness, but the standard mandates the current behavior.
1764 @item -Wsynth @r{(C++ only)}
1765 @opindex Wsynth
1766 @cindex warning for synthesized methods
1767 @cindex synthesized methods, warning
1768 Warn when G++'s synthesis behavior does not match that of cfront.  For
1769 instance:
1771 @smallexample
1772 struct A @{
1773   operator int ();
1774   A& operator = (int);
1777 main ()
1779   A a,b;
1780   a = b;
1782 @end smallexample
1784 In this example, G++ will synthesize a default @samp{A& operator =
1785 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1786 @end table
1788 @node Objective-C Dialect Options
1789 @section Options Controlling Objective-C Dialect
1791 @cindex compiler options, Objective-C
1792 @cindex Objective-C options, command line
1793 @cindex options, Objective-C
1794 This section describes the command-line options that are only meaningful
1795 for Objective-C programs; but you can also use most of the GNU compiler
1796 options regardless of what language your program is in.  For example,
1797 you might compile a file @code{some_class.m} like this:
1799 @example
1800 gcc -g -fgnu-runtime -O -c some_class.m
1801 @end example
1803 @noindent
1804 In this example, only @option{-fgnu-runtime} is an option meant only for
1805 Objective-C programs; you can use the other options with any language
1806 supported by GCC@.
1808 Here is a list of options that are @emph{only} for compiling Objective-C
1809 programs:
1811 @table @gcctabopt
1812 @item -fconstant-string-class=@var{class-name}
1813 @opindex fconstant-string-class
1814 Use @var{class-name} as the name of the class to instantiate for each
1815 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1816 class name is @code{NXConstantString}.
1818 @item -fgnu-runtime
1819 @opindex fgnu-runtime
1820 Generate object code compatible with the standard GNU Objective-C
1821 runtime.  This is the default for most types of systems.
1823 @item -fnext-runtime
1824 @opindex fnext-runtime
1825 Generate output compatible with the NeXT runtime.  This is the default
1826 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1827 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1828 used.
1830 @item -gen-decls
1831 @opindex gen-decls
1832 Dump interface declarations for all classes seen in the source file to a
1833 file named @file{@var{sourcename}.decl}.
1835 @item -Wno-protocol
1836 @opindex Wno-protocol
1837 If a class is declared to implement a protocol, a warning is issued for
1838 every method in the protocol that is not implemented by the class.  The
1839 default behavior is to issue a warning for every method not explicitly
1840 implemented in the class, even if a method implementation is inherited
1841 from the superclass.  If you use the @code{-Wno-protocol} option, then
1842 methods inherited from the superclass are considered to be implemented,
1843 and no warning is issued for them.
1845 @item -Wselector
1846 @opindex Wselector
1847 Warn if multiple methods of different types for the same selector are
1848 found during compilation.  The check is performed on the list of methods
1849 in the final stage of compilation.  Additionally, a check is performed
1850 that for each selector appearing in a @code{@@selector(@dots{})}
1851 expression, a corresponding method with that selector has been found
1852 during compilation.  Because these checks scan the method table only at
1853 the end of compilation, these warnings are not produced if the final
1854 stage of compilation is not reached, for example because an error is
1855 found during compilation, or because the @code{-fsyntax-only} option is
1856 being used.
1858 @item -Wundeclared-selector
1859 @opindex Wundeclared-selector
1860 Warn if a @code{@@selector(@dots{})} expression referring to an
1861 undeclared selector is found.  A selector is considered undeclared if no
1862 method with that name has been declared (explicitly, in an
1863 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1864 an @code{@@implementation} section) before the
1865 @code{@@selector(@dots{})} expression.  This option always performs its
1866 checks as soon as a @code{@@selector(@dots{})} expression is found
1867 (while @code{-Wselector} only performs its checks in the final stage of
1868 compilation), and so additionally enforces the coding style convention
1869 that methods and selectors must be declared before being used.
1871 @c not documented because only avail via -Wp
1872 @c @item -print-objc-runtime-info
1874 @end table
1876 @node Language Independent Options
1877 @section Options to Control Diagnostic Messages Formatting
1878 @cindex options to control diagnostics formatting
1879 @cindex diagnostic messages
1880 @cindex message formatting
1882 Traditionally, diagnostic messages have been formatted irrespective of
1883 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1884 below can be used to control the diagnostic messages formatting
1885 algorithm, e.g.@: how many characters per line, how often source location
1886 information should be reported.  Right now, only the C++ front end can
1887 honor these options.  However it is expected, in the near future, that
1888 the remaining front ends would be able to digest them correctly.
1890 @table @gcctabopt
1891 @item -fmessage-length=@var{n}
1892 @opindex fmessage-length
1893 Try to format error messages so that they fit on lines of about @var{n}
1894 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1895 the front ends supported by GCC@.  If @var{n} is zero, then no
1896 line-wrapping will be done; each error message will appear on a single
1897 line.
1899 @opindex fdiagnostics-show-location
1900 @item -fdiagnostics-show-location=once
1901 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1902 reporter to emit @emph{once} source location information; that is, in
1903 case the message is too long to fit on a single physical line and has to
1904 be wrapped, the source location won't be emitted (as prefix) again,
1905 over and over, in subsequent continuation lines.  This is the default
1906 behavior.
1908 @item -fdiagnostics-show-location=every-line
1909 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1910 messages reporter to emit the same source location information (as
1911 prefix) for physical lines that result from the process of breaking
1912 a message which is too long to fit on a single line.
1914 @end table
1916 @node Warning Options
1917 @section Options to Request or Suppress Warnings
1918 @cindex options to control warnings
1919 @cindex warning messages
1920 @cindex messages, warning
1921 @cindex suppressing warnings
1923 Warnings are diagnostic messages that report constructions which
1924 are not inherently erroneous but which are risky or suggest there
1925 may have been an error.
1927 You can request many specific warnings with options beginning @samp{-W},
1928 for example @option{-Wimplicit} to request warnings on implicit
1929 declarations.  Each of these specific warning options also has a
1930 negative form beginning @samp{-Wno-} to turn off warnings;
1931 for example, @option{-Wno-implicit}.  This manual lists only one of the
1932 two forms, whichever is not the default.
1934 The following options control the amount and kinds of warnings produced
1935 by GCC; for further, language-specific options also refer to
1936 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1938 @table @gcctabopt
1939 @cindex syntax checking
1940 @item -fsyntax-only
1941 @opindex fsyntax-only
1942 Check the code for syntax errors, but don't do anything beyond that.
1944 @item -pedantic
1945 @opindex pedantic
1946 Issue all the warnings demanded by strict ISO C and ISO C++;
1947 reject all programs that use forbidden extensions, and some other
1948 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1949 version of the ISO C standard specified by any @option{-std} option used.
1951 Valid ISO C and ISO C++ programs should compile properly with or without
1952 this option (though a rare few will require @option{-ansi} or a
1953 @option{-std} option specifying the required version of ISO C)@.  However,
1954 without this option, certain GNU extensions and traditional C and C++
1955 features are supported as well.  With this option, they are rejected.
1957 @option{-pedantic} does not cause warning messages for use of the
1958 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1959 warnings are also disabled in the expression that follows
1960 @code{__extension__}.  However, only system header files should use
1961 these escape routes; application programs should avoid them.
1962 @xref{Alternate Keywords}.
1964 Some users try to use @option{-pedantic} to check programs for strict ISO
1965 C conformance.  They soon find that it does not do quite what they want:
1966 it finds some non-ISO practices, but not all---only those for which
1967 ISO C @emph{requires} a diagnostic, and some others for which
1968 diagnostics have been added.
1970 A feature to report any failure to conform to ISO C might be useful in
1971 some instances, but would require considerable additional work and would
1972 be quite different from @option{-pedantic}.  We don't have plans to
1973 support such a feature in the near future.
1975 Where the standard specified with @option{-std} represents a GNU
1976 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1977 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1978 extended dialect is based.  Warnings from @option{-pedantic} are given
1979 where they are required by the base standard.  (It would not make sense
1980 for such warnings to be given only for features not in the specified GNU
1981 C dialect, since by definition the GNU dialects of C include all
1982 features the compiler supports with the given option, and there would be
1983 nothing to warn about.)
1985 @item -pedantic-errors
1986 @opindex pedantic-errors
1987 Like @option{-pedantic}, except that errors are produced rather than
1988 warnings.
1990 @item -w
1991 @opindex w
1992 Inhibit all warning messages.
1994 @item -Wno-import
1995 @opindex Wno-import
1996 Inhibit warning messages about the use of @samp{#import}.
1998 @item -Wchar-subscripts
1999 @opindex Wchar-subscripts
2000 Warn if an array subscript has type @code{char}.  This is a common cause
2001 of error, as programmers often forget that this type is signed on some
2002 machines.
2004 @item -Wcomment
2005 @opindex Wcomment
2006 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2007 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2009 @item -Wformat
2010 @opindex Wformat
2011 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2012 the arguments supplied have types appropriate to the format string
2013 specified, and that the conversions specified in the format string make
2014 sense.  This includes standard functions, and others specified by format
2015 attributes (@pxref{Function Attributes}), in the @code{printf},
2016 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2017 not in the C standard) families.
2019 The formats are checked against the format features supported by GNU
2020 libc version 2.2.  These include all ISO C90 and C99 features, as well
2021 as features from the Single Unix Specification and some BSD and GNU
2022 extensions.  Other library implementations may not support all these
2023 features; GCC does not support warning about features that go beyond a
2024 particular library's limitations.  However, if @option{-pedantic} is used
2025 with @option{-Wformat}, warnings will be given about format features not
2026 in the selected standard version (but not for @code{strfmon} formats,
2027 since those are not in any version of the C standard).  @xref{C Dialect
2028 Options,,Options Controlling C Dialect}.
2030 Since @option{-Wformat} also checks for null format arguments for
2031 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2033 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2034 aspects of format checking, the options @option{-Wno-format-y2k},
2035 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2036 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2037 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2039 @item -Wno-format-y2k
2040 @opindex Wno-format-y2k
2041 If @option{-Wformat} is specified, do not warn about @code{strftime}
2042 formats which may yield only a two-digit year.
2044 @item -Wno-format-extra-args
2045 @opindex Wno-format-extra-args
2046 If @option{-Wformat} is specified, do not warn about excess arguments to a
2047 @code{printf} or @code{scanf} format function.  The C standard specifies
2048 that such arguments are ignored.
2050 Where the unused arguments lie between used arguments that are
2051 specified with @samp{$} operand number specifications, normally
2052 warnings are still given, since the implementation could not know what
2053 type to pass to @code{va_arg} to skip the unused arguments.  However,
2054 in the case of @code{scanf} formats, this option will suppress the
2055 warning if the unused arguments are all pointers, since the Single
2056 Unix Specification says that such unused arguments are allowed.
2058 @item -Wno-format-zero-length
2059 @opindex Wno-format-zero-length
2060 If @option{-Wformat} is specified, do not warn about zero-length formats.
2061 The C standard specifies that zero-length formats are allowed.
2063 @item -Wformat-nonliteral
2064 @opindex Wformat-nonliteral
2065 If @option{-Wformat} is specified, also warn if the format string is not a
2066 string literal and so cannot be checked, unless the format function
2067 takes its format arguments as a @code{va_list}.
2069 @item -Wformat-security
2070 @opindex Wformat-security
2071 If @option{-Wformat} is specified, also warn about uses of format
2072 functions that represent possible security problems.  At present, this
2073 warns about calls to @code{printf} and @code{scanf} functions where the
2074 format string is not a string literal and there are no format arguments,
2075 as in @code{printf (foo);}.  This may be a security hole if the format
2076 string came from untrusted input and contains @samp{%n}.  (This is
2077 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2078 in future warnings may be added to @option{-Wformat-security} that are not
2079 included in @option{-Wformat-nonliteral}.)
2081 @item -Wformat=2
2082 @opindex Wformat=2
2083 Enable @option{-Wformat} plus format checks not included in
2084 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2085 -Wformat-nonliteral -Wformat-security}.
2087 @item -Wnonnull
2088 @opindex Wnonnull
2089 Enable warning about passing a null pointer for arguments marked as
2090 requiring a non-null value by the @code{nonnull} function attribute.
2092 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2093 can be disabled with the @option{-Wno-nonnull} option.
2095 @item -Wimplicit-int
2096 @opindex Wimplicit-int
2097 Warn when a declaration does not specify a type.
2099 @item -Wimplicit-function-declaration
2100 @itemx -Werror-implicit-function-declaration
2101 @opindex Wimplicit-function-declaration
2102 @opindex Werror-implicit-function-declaration
2103 Give a warning (or error) whenever a function is used before being
2104 declared.
2106 @item -Wimplicit
2107 @opindex Wimplicit
2108 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2110 @item -Wmain
2111 @opindex Wmain
2112 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2113 function with external linkage, returning int, taking either zero
2114 arguments, two, or three arguments of appropriate types.
2116 @item -Wmissing-braces
2117 @opindex Wmissing-braces
2118 Warn if an aggregate or union initializer is not fully bracketed.  In
2119 the following example, the initializer for @samp{a} is not fully
2120 bracketed, but that for @samp{b} is fully bracketed.
2122 @smallexample
2123 int a[2][2] = @{ 0, 1, 2, 3 @};
2124 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2125 @end smallexample
2127 @item -Wparentheses
2128 @opindex Wparentheses
2129 Warn if parentheses are omitted in certain contexts, such
2130 as when there is an assignment in a context where a truth value
2131 is expected, or when operators are nested whose precedence people
2132 often get confused about.
2134 Also warn about constructions where there may be confusion to which
2135 @code{if} statement an @code{else} branch belongs.  Here is an example of
2136 such a case:
2138 @smallexample
2139 @group
2141   if (a)
2142     if (b)
2143       foo ();
2144   else
2145     bar ();
2147 @end group
2148 @end smallexample
2150 In C, every @code{else} branch belongs to the innermost possible @code{if}
2151 statement, which in this example is @code{if (b)}.  This is often not
2152 what the programmer expected, as illustrated in the above example by
2153 indentation the programmer chose.  When there is the potential for this
2154 confusion, GCC will issue a warning when this flag is specified.
2155 To eliminate the warning, add explicit braces around the innermost
2156 @code{if} statement so there is no way the @code{else} could belong to
2157 the enclosing @code{if}.  The resulting code would look like this:
2159 @smallexample
2160 @group
2162   if (a)
2163     @{
2164       if (b)
2165         foo ();
2166       else
2167         bar ();
2168     @}
2170 @end group
2171 @end smallexample
2173 @item -Wsequence-point
2174 @opindex Wsequence-point
2175 Warn about code that may have undefined semantics because of violations
2176 of sequence point rules in the C standard.
2178 The C standard defines the order in which expressions in a C program are
2179 evaluated in terms of @dfn{sequence points}, which represent a partial
2180 ordering between the execution of parts of the program: those executed
2181 before the sequence point, and those executed after it.  These occur
2182 after the evaluation of a full expression (one which is not part of a
2183 larger expression), after the evaluation of the first operand of a
2184 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2185 function is called (but after the evaluation of its arguments and the
2186 expression denoting the called function), and in certain other places.
2187 Other than as expressed by the sequence point rules, the order of
2188 evaluation of subexpressions of an expression is not specified.  All
2189 these rules describe only a partial order rather than a total order,
2190 since, for example, if two functions are called within one expression
2191 with no sequence point between them, the order in which the functions
2192 are called is not specified.  However, the standards committee have
2193 ruled that function calls do not overlap.
2195 It is not specified when between sequence points modifications to the
2196 values of objects take effect.  Programs whose behavior depends on this
2197 have undefined behavior; the C standard specifies that ``Between the
2198 previous and next sequence point an object shall have its stored value
2199 modified at most once by the evaluation of an expression.  Furthermore,
2200 the prior value shall be read only to determine the value to be
2201 stored.''.  If a program breaks these rules, the results on any
2202 particular implementation are entirely unpredictable.
2204 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2205 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2206 diagnosed by this option, and it may give an occasional false positive
2207 result, but in general it has been found fairly effective at detecting
2208 this sort of problem in programs.
2210 The present implementation of this option only works for C programs.  A
2211 future implementation may also work for C++ programs.
2213 The C standard is worded confusingly, therefore there is some debate
2214 over the precise meaning of the sequence point rules in subtle cases.
2215 Links to discussions of the problem, including proposed formal
2216 definitions, may be found on our readings page, at
2217 @w{@uref{http://gcc.gnu.org/readings.html}}.
2219 @item -Wreturn-type
2220 @opindex Wreturn-type
2221 Warn whenever a function is defined with a return-type that defaults to
2222 @code{int}.  Also warn about any @code{return} statement with no
2223 return-value in a function whose return-type is not @code{void}.
2225 For C++, a function without return type always produces a diagnostic
2226 message, even when @option{-Wno-return-type} is specified.  The only
2227 exceptions are @samp{main} and functions defined in system headers.
2229 @item -Wswitch
2230 @opindex Wswitch
2231 Warn whenever a @code{switch} statement has an index of enumeral type
2232 and lacks a @code{case} for one or more of the named codes of that
2233 enumeration.  (The presence of a @code{default} label prevents this
2234 warning.)  @code{case} labels outside the enumeration range also
2235 provoke warnings when this option is used.
2237 @item -Wswitch-default
2238 @opindex Wswitch-switch
2239 Warn whenever a @code{switch} statement does not have a @code{default}
2240 case.
2242 @item -Wswitch-enum
2243 @opindex Wswitch-enum
2244 Warn whenever a @code{switch} statement has an index of enumeral type
2245 and lacks a @code{case} for one or more of the named codes of that
2246 enumeration.  @code{case} labels outside the enumeration range also
2247 provoke warnings when this option is used.
2249 @item -Wtrigraphs
2250 @opindex Wtrigraphs
2251 Warn if any trigraphs are encountered that might change the meaning of
2252 the program (trigraphs within comments are not warned about).
2254 @item -Wunused-function
2255 @opindex Wunused-function
2256 Warn whenever a static function is declared but not defined or a
2257 non\-inline static function is unused.
2259 @item -Wunused-label
2260 @opindex Wunused-label
2261 Warn whenever a label is declared but not used.
2263 To suppress this warning use the @samp{unused} attribute
2264 (@pxref{Variable Attributes}).
2266 @item -Wunused-parameter
2267 @opindex Wunused-parameter
2268 Warn whenever a function parameter is unused aside from its declaration.
2270 To suppress this warning use the @samp{unused} attribute
2271 (@pxref{Variable Attributes}).
2273 @item -Wunused-variable
2274 @opindex Wunused-variable
2275 Warn whenever a local variable or non-constant static variable is unused
2276 aside from its declaration
2278 To suppress this warning use the @samp{unused} attribute
2279 (@pxref{Variable Attributes}).
2281 @item -Wunused-value
2282 @opindex Wunused-value
2283 Warn whenever a statement computes a result that is explicitly not used.
2285 To suppress this warning cast the expression to @samp{void}.
2287 @item -Wunused
2288 @opindex Wunused
2289 All the above @option{-Wunused} options combined.
2291 In order to get a warning about an unused function parameter, you must
2292 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2293 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2295 @item -Wuninitialized
2296 @opindex Wuninitialized
2297 Warn if an automatic variable is used without first being initialized or
2298 if a variable may be clobbered by a @code{setjmp} call.
2300 These warnings are possible only in optimizing compilation,
2301 because they require data flow information that is computed only
2302 when optimizing.  If you don't specify @option{-O}, you simply won't
2303 get these warnings.
2305 These warnings occur only for variables that are candidates for
2306 register allocation.  Therefore, they do not occur for a variable that
2307 is declared @code{volatile}, or whose address is taken, or whose size
2308 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2309 structures, unions or arrays, even when they are in registers.
2311 Note that there may be no warning about a variable that is used only
2312 to compute a value that itself is never used, because such
2313 computations may be deleted by data flow analysis before the warnings
2314 are printed.
2316 These warnings are made optional because GCC is not smart
2317 enough to see all the reasons why the code might be correct
2318 despite appearing to have an error.  Here is one example of how
2319 this can happen:
2321 @smallexample
2322 @group
2324   int x;
2325   switch (y)
2326     @{
2327     case 1: x = 1;
2328       break;
2329     case 2: x = 4;
2330       break;
2331     case 3: x = 5;
2332     @}
2333   foo (x);
2335 @end group
2336 @end smallexample
2338 @noindent
2339 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2340 always initialized, but GCC doesn't know this.  Here is
2341 another common case:
2343 @smallexample
2345   int save_y;
2346   if (change_y) save_y = y, y = new_y;
2347   @dots{}
2348   if (change_y) y = save_y;
2350 @end smallexample
2352 @noindent
2353 This has no bug because @code{save_y} is used only if it is set.
2355 @cindex @code{longjmp} warnings
2356 This option also warns when a non-volatile automatic variable might be
2357 changed by a call to @code{longjmp}.  These warnings as well are possible
2358 only in optimizing compilation.
2360 The compiler sees only the calls to @code{setjmp}.  It cannot know
2361 where @code{longjmp} will be called; in fact, a signal handler could
2362 call it at any point in the code.  As a result, you may get a warning
2363 even when there is in fact no problem because @code{longjmp} cannot
2364 in fact be called at the place which would cause a problem.
2366 Some spurious warnings can be avoided if you declare all the functions
2367 you use that never return as @code{noreturn}.  @xref{Function
2368 Attributes}.
2370 @item -Wunknown-pragmas
2371 @opindex Wunknown-pragmas
2372 @cindex warning for unknown pragmas
2373 @cindex unknown pragmas, warning
2374 @cindex pragmas, warning of unknown
2375 Warn when a #pragma directive is encountered which is not understood by
2376 GCC@.  If this command line option is used, warnings will even be issued
2377 for unknown pragmas in system header files.  This is not the case if
2378 the warnings were only enabled by the @option{-Wall} command line option.
2380 @item -Wstrict-aliasing
2381 @opindex Wstrict-aliasing
2382 This option is only active when @option{-fstrict-aliasing} is active.
2383 It warns about code which might break the strict aliasing rules that the
2384 compiler is using for optimization. The warning does not catch all
2385 cases, but does attempt to catch the more common pitfalls. It is
2386 included in @option{-Wall}.
2388 @item -Wall
2389 @opindex Wall
2390 All of the above @samp{-W} options combined.  This enables all the
2391 warnings about constructions that some users consider questionable, and
2392 that are easy to avoid (or modify to prevent the warning), even in
2393 conjunction with macros.  This also enables some language-specific
2394 warnings described in @ref{C++ Dialect Options} and
2395 @ref{Objective-C Dialect Options}.
2396 @end table
2398 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2399 Some of them warn about constructions that users generally do not
2400 consider questionable, but which occasionally you might wish to check
2401 for; others warn about constructions that are necessary or hard to avoid
2402 in some cases, and there is no simple way to modify the code to suppress
2403 the warning.
2405 @table @gcctabopt
2406 @item -Wextra
2407 @opindex W
2408 @opindex Wextra
2409 (This option used to be called @option{-W}.  The older name is still
2410 supported, but the newer name is more descriptive.)  Print extra warning
2411 messages for these events:
2413 @itemize @bullet
2414 @item
2415 A function can return either with or without a value.  (Falling
2416 off the end of the function body is considered returning without
2417 a value.)  For example, this function would evoke such a
2418 warning:
2420 @smallexample
2421 @group
2422 foo (a)
2424   if (a > 0)
2425     return a;
2427 @end group
2428 @end smallexample
2430 @item
2431 An expression-statement or the left-hand side of a comma expression
2432 contains no side effects.
2433 To suppress the warning, cast the unused expression to void.
2434 For example, an expression such as @samp{x[i,j]} will cause a warning,
2435 but @samp{x[(void)i,j]} will not.
2437 @item
2438 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2440 @item
2441 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2442 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2443 that of ordinary mathematical notation.
2445 @item
2446 Storage-class specifiers like @code{static} are not the first things in
2447 a declaration.  According to the C Standard, this usage is obsolescent.
2449 @item
2450 The return type of a function has a type qualifier such as @code{const}.
2451 Such a type qualifier has no effect, since the value returned by a
2452 function is not an lvalue.  (But don't warn about the GNU extension of
2453 @code{volatile void} return types.  That extension will be warned about
2454 if @option{-pedantic} is specified.)
2456 @item
2457 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2458 arguments.
2460 @item
2461 A comparison between signed and unsigned values could produce an
2462 incorrect result when the signed value is converted to unsigned.
2463 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2465 @item
2466 An aggregate has an initializer which does not initialize all members.
2467 For example, the following code would cause such a warning, because
2468 @code{x.h} would be implicitly initialized to zero:
2470 @smallexample
2471 struct s @{ int f, g, h; @};
2472 struct s x = @{ 3, 4 @};
2473 @end smallexample
2475 @item
2476 A function parameter is declared without a type specifier in K&R-style
2477 functions:
2479 @smallexample
2480 void foo(bar) @{ @}
2481 @end smallexample
2483 @item
2484 An empty body occurs in an @samp{if} or @samp{else} statement.
2486 @item
2487 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2488 @samp{>}, or @samp{>=}.
2490 @item
2491 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2493 @item
2494 Any of several floating-point events that often indicate errors, such as
2495 overflow, underflow, loss of precision, etc.
2497 @item @r{(C++ only)}
2498 An enumerator and a non-enumerator both appear in a conditional expression.
2500 @item @r{(C++ only)}
2501 A non-static reference or non-static @samp{const} member appears in a
2502 class without constructors.
2504 @item @r{(C++ only)}
2505 Ambiguous virtual bases.
2507 @item @r{(C++ only)}
2508 Subscripting an array which has been declared @samp{register}.
2510 @item @r{(C++ only)}
2511 Taking the address of a variable which has been declared @samp{register}.
2513 @item @r{(C++ only)}
2514 A base class is not initialized in a derived class' copy constrcutor.
2515 @end itemize
2517 @item -Wno-div-by-zero
2518 @opindex Wno-div-by-zero
2519 @opindex Wdiv-by-zero
2520 Do not warn about compile-time integer division by zero.  Floating point
2521 division by zero is not warned about, as it can be a legitimate way of
2522 obtaining infinities and NaNs.
2524 @item -Wsystem-headers
2525 @opindex Wsystem-headers
2526 @cindex warnings from system headers
2527 @cindex system headers, warnings from
2528 Print warning messages for constructs found in system header files.
2529 Warnings from system headers are normally suppressed, on the assumption
2530 that they usually do not indicate real problems and would only make the
2531 compiler output harder to read.  Using this command line option tells
2532 GCC to emit warnings from system headers as if they occurred in user
2533 code.  However, note that using @option{-Wall} in conjunction with this
2534 option will @emph{not} warn about unknown pragmas in system
2535 headers---for that, @option{-Wunknown-pragmas} must also be used.
2537 @item -Wfloat-equal
2538 @opindex Wfloat-equal
2539 Warn if floating point values are used in equality comparisons.
2541 The idea behind this is that sometimes it is convenient (for the
2542 programmer) to consider floating-point values as approximations to
2543 infinitely precise real numbers.  If you are doing this, then you need
2544 to compute (by analyzing the code, or in some other way) the maximum or
2545 likely maximum error that the computation introduces, and allow for it
2546 when performing comparisons (and when producing output, but that's a
2547 different problem).  In particular, instead of testing for equality, you
2548 would check to see whether the two values have ranges that overlap; and
2549 this is done with the relational operators, so equality comparisons are
2550 probably mistaken.
2552 @item -Wtraditional @r{(C only)}
2553 @opindex Wtraditional
2554 Warn about certain constructs that behave differently in traditional and
2555 ISO C@.  Also warn about ISO C constructs that have no traditional C
2556 equivalent, and/or problematic constructs which should be avoided.
2558 @itemize @bullet
2559 @item
2560 Macro parameters that appear within string literals in the macro body.
2561 In traditional C macro replacement takes place within string literals,
2562 but does not in ISO C@.
2564 @item
2565 In traditional C, some preprocessor directives did not exist.
2566 Traditional preprocessors would only consider a line to be a directive
2567 if the @samp{#} appeared in column 1 on the line.  Therefore
2568 @option{-Wtraditional} warns about directives that traditional C
2569 understands but would ignore because the @samp{#} does not appear as the
2570 first character on the line.  It also suggests you hide directives like
2571 @samp{#pragma} not understood by traditional C by indenting them.  Some
2572 traditional implementations would not recognize @samp{#elif}, so it
2573 suggests avoiding it altogether.
2575 @item
2576 A function-like macro that appears without arguments.
2578 @item
2579 The unary plus operator.
2581 @item
2582 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2583 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2584 constants.)  Note, these suffixes appear in macros defined in the system
2585 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2586 Use of these macros in user code might normally lead to spurious
2587 warnings, however gcc's integrated preprocessor has enough context to
2588 avoid warning in these cases.
2590 @item
2591 A function declared external in one block and then used after the end of
2592 the block.
2594 @item
2595 A @code{switch} statement has an operand of type @code{long}.
2597 @item
2598 A non-@code{static} function declaration follows a @code{static} one.
2599 This construct is not accepted by some traditional C compilers.
2601 @item
2602 The ISO type of an integer constant has a different width or
2603 signedness from its traditional type.  This warning is only issued if
2604 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2605 typically represent bit patterns, are not warned about.
2607 @item
2608 Usage of ISO string concatenation is detected.
2610 @item
2611 Initialization of automatic aggregates.
2613 @item
2614 Identifier conflicts with labels.  Traditional C lacks a separate
2615 namespace for labels.
2617 @item
2618 Initialization of unions.  If the initializer is zero, the warning is
2619 omitted.  This is done under the assumption that the zero initializer in
2620 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2621 initializer warnings and relies on default initialization to zero in the
2622 traditional C case.
2624 @item
2625 Conversions by prototypes between fixed/floating point values and vice
2626 versa.  The absence of these prototypes when compiling with traditional
2627 C would cause serious problems.  This is a subset of the possible
2628 conversion warnings, for the full set use @option{-Wconversion}.
2630 @item
2631 Use of ISO C style function definitions.  This warning intentionally is
2632 @emph{not} issued for prototype declarations or variadic functions
2633 because these ISO C features will appear in your code when using
2634 libiberty's traditional C compatibility macros, @code{PARAMS} and
2635 @code{VPARAMS}.  This warning is also bypassed for nested functions
2636 because that feature is already a gcc extension and thus not relevant to
2637 traditional C compatibility.
2638 @end itemize
2640 @item -Wundef
2641 @opindex Wundef
2642 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2644 @item -Wendif-labels
2645 @opindex Wendif-labels
2646 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2648 @item -Wshadow
2649 @opindex Wshadow
2650 Warn whenever a local variable shadows another local variable, parameter or
2651 global variable or whenever a built-in function is shadowed.
2653 @item -Wlarger-than-@var{len}
2654 @opindex Wlarger-than
2655 Warn whenever an object of larger than @var{len} bytes is defined.
2657 @item -Wpointer-arith
2658 @opindex Wpointer-arith
2659 Warn about anything that depends on the ``size of'' a function type or
2660 of @code{void}.  GNU C assigns these types a size of 1, for
2661 convenience in calculations with @code{void *} pointers and pointers
2662 to functions.
2664 @item -Wbad-function-cast @r{(C only)}
2665 @opindex Wbad-function-cast
2666 Warn whenever a function call is cast to a non-matching type.
2667 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2669 @item -Wcast-qual
2670 @opindex Wcast-qual
2671 Warn whenever a pointer is cast so as to remove a type qualifier from
2672 the target type.  For example, warn if a @code{const char *} is cast
2673 to an ordinary @code{char *}.
2675 @item -Wcast-align
2676 @opindex Wcast-align
2677 Warn whenever a pointer is cast such that the required alignment of the
2678 target is increased.  For example, warn if a @code{char *} is cast to
2679 an @code{int *} on machines where integers can only be accessed at
2680 two- or four-byte boundaries.
2682 @item -Wwrite-strings
2683 @opindex Wwrite-strings
2684 When compiling C, give string constants the type @code{const
2685 char[@var{length}]} so that
2686 copying the address of one into a non-@code{const} @code{char *}
2687 pointer will get a warning; when compiling C++, warn about the
2688 deprecated conversion from string constants to @code{char *}.
2689 These warnings will help you find at
2690 compile time code that can try to write into a string constant, but
2691 only if you have been very careful about using @code{const} in
2692 declarations and prototypes.  Otherwise, it will just be a nuisance;
2693 this is why we did not make @option{-Wall} request these warnings.
2695 @item -Wconversion
2696 @opindex Wconversion
2697 Warn if a prototype causes a type conversion that is different from what
2698 would happen to the same argument in the absence of a prototype.  This
2699 includes conversions of fixed point to floating and vice versa, and
2700 conversions changing the width or signedness of a fixed point argument
2701 except when the same as the default promotion.
2703 Also, warn if a negative integer constant expression is implicitly
2704 converted to an unsigned type.  For example, warn about the assignment
2705 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2706 casts like @code{(unsigned) -1}.
2708 @item -Wsign-compare
2709 @opindex Wsign-compare
2710 @cindex warning for comparison of signed and unsigned values
2711 @cindex comparison of signed and unsigned values, warning
2712 @cindex signed and unsigned values, comparison warning
2713 Warn when a comparison between signed and unsigned values could produce
2714 an incorrect result when the signed value is converted to unsigned.
2715 This warning is also enabled by @option{-Wextra}; to get the other warnings
2716 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2718 @item -Waggregate-return
2719 @opindex Waggregate-return
2720 Warn if any functions that return structures or unions are defined or
2721 called.  (In languages where you can return an array, this also elicits
2722 a warning.)
2724 @item -Wstrict-prototypes @r{(C only)}
2725 @opindex Wstrict-prototypes
2726 Warn if a function is declared or defined without specifying the
2727 argument types.  (An old-style function definition is permitted without
2728 a warning if preceded by a declaration which specifies the argument
2729 types.)
2731 @item -Wmissing-prototypes @r{(C only)}
2732 @opindex Wmissing-prototypes
2733 Warn if a global function is defined without a previous prototype
2734 declaration.  This warning is issued even if the definition itself
2735 provides a prototype.  The aim is to detect global functions that fail
2736 to be declared in header files.
2738 @item -Wmissing-declarations
2739 @opindex Wmissing-declarations
2740 Warn if a global function is defined without a previous declaration.
2741 Do so even if the definition itself provides a prototype.
2742 Use this option to detect global functions that are not declared in
2743 header files.
2745 @item -Wmissing-noreturn
2746 @opindex Wmissing-noreturn
2747 Warn about functions which might be candidates for attribute @code{noreturn}.
2748 Note these are only possible candidates, not absolute ones.  Care should
2749 be taken to manually verify functions actually do not ever return before
2750 adding the @code{noreturn} attribute, otherwise subtle code generation
2751 bugs could be introduced.  You will not get a warning for @code{main} in
2752 hosted C environments.
2754 @item -Wmissing-format-attribute
2755 @opindex Wmissing-format-attribute
2756 @opindex Wformat
2757 If @option{-Wformat} is enabled, also warn about functions which might be
2758 candidates for @code{format} attributes.  Note these are only possible
2759 candidates, not absolute ones.  GCC will guess that @code{format}
2760 attributes might be appropriate for any function that calls a function
2761 like @code{vprintf} or @code{vscanf}, but this might not always be the
2762 case, and some functions for which @code{format} attributes are
2763 appropriate may not be detected.  This option has no effect unless
2764 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2766 @item -Wno-multichar
2767 @opindex Wno-multichar
2768 @opindex Wmultichar
2769 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2770 Usually they indicate a typo in the user's code, as they have
2771 implementation-defined values, and should not be used in portable code.
2773 @item -Wno-deprecated-declarations
2774 @opindex Wno-deprecated-declarations
2775 Do not warn about uses of functions, variables, and types marked as
2776 deprecated by using the @code{deprecated} attribute.
2777 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2778 @pxref{Type Attributes}.)
2780 @item -Wpacked
2781 @opindex Wpacked
2782 Warn if a structure is given the packed attribute, but the packed
2783 attribute has no effect on the layout or size of the structure.
2784 Such structures may be mis-aligned for little benefit.  For
2785 instance, in this code, the variable @code{f.x} in @code{struct bar}
2786 will be misaligned even though @code{struct bar} does not itself
2787 have the packed attribute:
2789 @smallexample
2790 @group
2791 struct foo @{
2792   int x;
2793   char a, b, c, d;
2794 @} __attribute__((packed));
2795 struct bar @{
2796   char z;
2797   struct foo f;
2799 @end group
2800 @end smallexample
2802 @item -Wpadded
2803 @opindex Wpadded
2804 Warn if padding is included in a structure, either to align an element
2805 of the structure or to align the whole structure.  Sometimes when this
2806 happens it is possible to rearrange the fields of the structure to
2807 reduce the padding and so make the structure smaller.
2809 @item -Wredundant-decls
2810 @opindex Wredundant-decls
2811 Warn if anything is declared more than once in the same scope, even in
2812 cases where multiple declaration is valid and changes nothing.
2814 @item -Wnested-externs @r{(C only)}
2815 @opindex Wnested-externs
2816 Warn if an @code{extern} declaration is encountered within a function.
2818 @item -Wunreachable-code
2819 @opindex Wunreachable-code
2820 Warn if the compiler detects that code will never be executed.
2822 This option is intended to warn when the compiler detects that at
2823 least a whole line of source code will never be executed, because
2824 some condition is never satisfied or because it is after a
2825 procedure that never returns.
2827 It is possible for this option to produce a warning even though there
2828 are circumstances under which part of the affected line can be executed,
2829 so care should be taken when removing apparently-unreachable code.
2831 For instance, when a function is inlined, a warning may mean that the
2832 line is unreachable in only one inlined copy of the function.
2834 This option is not made part of @option{-Wall} because in a debugging
2835 version of a program there is often substantial code which checks
2836 correct functioning of the program and is, hopefully, unreachable
2837 because the program does work.  Another common use of unreachable
2838 code is to provide behavior which is selectable at compile-time.
2840 @item -Winline
2841 @opindex Winline
2842 Warn if a function can not be inlined and it was declared as inline.
2844 @item -Winvalid-pch
2845 @opindex Winvalid-pch
2846 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2847 the search path but can't be used.
2849 @item -Wlong-long
2850 @opindex Wlong-long
2851 @opindex Wno-long-long
2852 Warn if @samp{long long} type is used.  This is default.  To inhibit
2853 the warning messages, use @option{-Wno-long-long}.  Flags
2854 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2855 only when @option{-pedantic} flag is used.
2857 @item -Wdisabled-optimization
2858 @opindex Wdisabled-optimization
2859 Warn if a requested optimization pass is disabled.  This warning does
2860 not generally indicate that there is anything wrong with your code; it
2861 merely indicates that GCC's optimizers were unable to handle the code
2862 effectively.  Often, the problem is that your code is too big or too
2863 complex; GCC will refuse to optimize programs when the optimization
2864 itself is likely to take inordinate amounts of time.
2866 @item -Werror
2867 @opindex Werror
2868 Make all warnings into errors.
2869 @end table
2871 @node Debugging Options
2872 @section Options for Debugging Your Program or GCC
2873 @cindex options, debugging
2874 @cindex debugging information options
2876 GCC has various special options that are used for debugging
2877 either your program or GCC:
2879 @table @gcctabopt
2880 @item -g
2881 @opindex g
2882 Produce debugging information in the operating system's native format
2883 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2884 information.
2886 On most systems that use stabs format, @option{-g} enables use of extra
2887 debugging information that only GDB can use; this extra information
2888 makes debugging work better in GDB but will probably make other debuggers
2889 crash or
2890 refuse to read the program.  If you want to control for certain whether
2891 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2892 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2893 or @option{-gvms} (see below).
2895 Unlike most other C compilers, GCC allows you to use @option{-g} with
2896 @option{-O}.  The shortcuts taken by optimized code may occasionally
2897 produce surprising results: some variables you declared may not exist
2898 at all; flow of control may briefly move where you did not expect it;
2899 some statements may not be executed because they compute constant
2900 results or their values were already at hand; some statements may
2901 execute in different places because they were moved out of loops.
2903 Nevertheless it proves possible to debug optimized output.  This makes
2904 it reasonable to use the optimizer for programs that might have bugs.
2906 The following options are useful when GCC is generated with the
2907 capability for more than one debugging format.
2909 @item -ggdb
2910 @opindex ggdb
2911 Produce debugging information for use by GDB@.  This means to use the
2912 most expressive format available (DWARF 2, stabs, or the native format
2913 if neither of those are supported), including GDB extensions if at all
2914 possible.
2916 @item -gstabs
2917 @opindex gstabs
2918 Produce debugging information in stabs format (if that is supported),
2919 without GDB extensions.  This is the format used by DBX on most BSD
2920 systems.  On MIPS, Alpha and System V Release 4 systems this option
2921 produces stabs debugging output which is not understood by DBX or SDB@.
2922 On System V Release 4 systems this option requires the GNU assembler.
2924 @item -gstabs+
2925 @opindex gstabs+
2926 Produce debugging information in stabs format (if that is supported),
2927 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2928 use of these extensions is likely to make other debuggers crash or
2929 refuse to read the program.
2931 @item -gcoff
2932 @opindex gcoff
2933 Produce debugging information in COFF format (if that is supported).
2934 This is the format used by SDB on most System V systems prior to
2935 System V Release 4.
2937 @item -gxcoff
2938 @opindex gxcoff
2939 Produce debugging information in XCOFF format (if that is supported).
2940 This is the format used by the DBX debugger on IBM RS/6000 systems.
2942 @item -gxcoff+
2943 @opindex gxcoff+
2944 Produce debugging information in XCOFF format (if that is supported),
2945 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2946 use of these extensions is likely to make other debuggers crash or
2947 refuse to read the program, and may cause assemblers other than the GNU
2948 assembler (GAS) to fail with an error.
2950 @item -gdwarf
2951 @opindex gdwarf
2952 Produce debugging information in DWARF version 1 format (if that is
2953 supported).  This is the format used by SDB on most System V Release 4
2954 systems.
2956 This option is deprecated.
2958 @item -gdwarf+
2959 @opindex gdwarf+
2960 Produce debugging information in DWARF version 1 format (if that is
2961 supported), using GNU extensions understood only by the GNU debugger
2962 (GDB)@.  The use of these extensions is likely to make other debuggers
2963 crash or refuse to read the program.
2965 This option is deprecated.
2967 @item -gdwarf-2
2968 @opindex gdwarf-2
2969 Produce debugging information in DWARF version 2 format (if that is
2970 supported).  This is the format used by DBX on IRIX 6.
2972 @item -gvms
2973 @opindex gvms
2974 Produce debugging information in VMS debug format (if that is
2975 supported).  This is the format used by DEBUG on VMS systems.
2977 @item -g@var{level}
2978 @itemx -ggdb@var{level}
2979 @itemx -gstabs@var{level}
2980 @itemx -gcoff@var{level}
2981 @itemx -gxcoff@var{level}
2982 @itemx -gvms@var{level}
2983 Request debugging information and also use @var{level} to specify how
2984 much information.  The default level is 2.
2986 Level 1 produces minimal information, enough for making backtraces in
2987 parts of the program that you don't plan to debug.  This includes
2988 descriptions of functions and external variables, but no information
2989 about local variables and no line numbers.
2991 Level 3 includes extra information, such as all the macro definitions
2992 present in the program.  Some debuggers support macro expansion when
2993 you use @option{-g3}.
2995 Note that in order to avoid confusion between DWARF1 debug level 2,
2996 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2997 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2998 option to change the debug level for DWARF1 or DWARF2.
3000 @item -feliminate-dwarf2-dups
3001 @opindex feliminate-dwarf2-dups
3002 Compress DWARF2 debugging information by eliminating duplicated
3003 information about each symbol.  This option only makes sense when
3004 generating DWARF2 debugging information with @option{-gdwarf-2}.
3006 @cindex @command{prof}
3007 @item -p
3008 @opindex p
3009 Generate extra code to write profile information suitable for the
3010 analysis program @command{prof}.  You must use this option when compiling
3011 the source files you want data about, and you must also use it when
3012 linking.
3014 @cindex @command{gprof}
3015 @item -pg
3016 @opindex pg
3017 Generate extra code to write profile information suitable for the
3018 analysis program @command{gprof}.  You must use this option when compiling
3019 the source files you want data about, and you must also use it when
3020 linking.
3022 @item -Q
3023 @opindex Q
3024 Makes the compiler print out each function name as it is compiled, and
3025 print some statistics about each pass when it finishes.
3027 @item -ftime-report
3028 @opindex ftime-report
3029 Makes the compiler print some statistics about the time consumed by each
3030 pass when it finishes.
3032 @item -fmem-report
3033 @opindex fmem-report
3034 Makes the compiler print some statistics about permanent memory
3035 allocation when it finishes.
3037 @item -fprofile-arcs
3038 @opindex fprofile-arcs
3039 Add code so that program flow @dfn{arcs} are instrumented.  During
3040 execution the program records how many times each branch and call is
3041 executed and how many times it is taken or returns.  When the compiled
3042 program exits it saves this data to a file called
3043 @file{@var{auxname}.da} for each source file. The data may be used for
3044 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3045 test coverage analysis (@option{-ftest-coverage}). Each object file's
3046 @var{auxname} is generated from the name of the output file, if
3047 explicitly specified and it is not the final executable, otherwise it is
3048 the basename of the source file. In both cases any suffix is removed
3049 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3050 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3052 @itemize
3054 @item
3055 Compile the source files with @option{-fprofile-arcs} plus optimization
3056 and code generation options. For test coverage analysis, use the
3057 additional @option{-ftest-coverage} option. You do not need to profile
3058 every source file in a program.
3060 @item
3061 Link your object files as normal.
3063 @item
3064 Run the program on a representative workload to generate the arc profile
3065 information. This may be repeated any number of times.
3067 @item
3068 For profile-directed optimizations, compile the source files again with
3069 the same optimization and code generation options plus
3070 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3071 Control Optimization}).
3073 @item
3074 For test coverage analysis, use @command{gcov} to produce human readable
3075 information from the @file{.bbg} and @file{.da} files. Refer to the
3076 @command{gcov} documentation for further information.
3078 @end itemize
3080 With @option{-fprofile-arcs}, for each function of your program GCC
3081 creates a program flow graph, then finds a spanning tree for the graph.
3082 Only arcs that are not on the spanning tree have to be instrumented: the
3083 compiler adds code to count the number of times that these arcs are
3084 executed.  When an arc is the only exit or only entrance to a block, the
3085 instrumentation code can be added to the block; otherwise, a new basic
3086 block must be created to hold the instrumentation code.
3088 @need 2000
3089 @item -ftest-coverage
3090 @opindex ftest-coverage
3091 Produce a graph file that the @command{gcov} code-coverage utility
3092 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3093 show program coverage. Each source file's data file is called
3094 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3095 above for a description of @var{auxname} and instructions on how to
3096 generate test coverage data. Coverage data will match the source files
3097 more closely, if you do not optimize.
3099 @item -d@var{letters}
3100 @opindex d
3101 Says to make debugging dumps during compilation at times specified by
3102 @var{letters}.  This is used for debugging the compiler.  The file names
3103 for most of the dumps are made by appending a pass number and a word to
3104 the @var{dumpname}. @var{dumpname} is generated from the name of the
3105 output file, if explicitly specified and it is not an executable,
3106 otherwise it is the basename of the source file. In both cases any
3107 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3108 Here are the possible letters for use in @var{letters}, and their
3109 meanings:
3111 @table @samp
3112 @item A
3113 @opindex dA
3114 Annotate the assembler output with miscellaneous debugging information.
3115 @item b
3116 @opindex db
3117 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3118 @item B
3119 @opindex dB
3120 Dump after block reordering, to @file{@var{file}.32.bbro}.
3121 @item c
3122 @opindex dc
3123 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3124 @item C
3125 @opindex dC
3126 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3127 @item d
3128 @opindex dd
3129 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3130 @item D
3131 @opindex dD
3132 Dump all macro definitions, at the end of preprocessing, in addition to
3133 normal output.
3134 @item e
3135 @opindex de
3136 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3137 @file{@var{file}.07.ussa}.
3138 @item E
3139 @opindex dE
3140 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3141 @item f
3142 @opindex df
3143 Dump after life analysis, to @file{@var{file}.18.life}.
3144 @item F
3145 @opindex dF
3146 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3147 @item g
3148 @opindex dg
3149 Dump after global register allocation, to @file{@var{file}.24.greg}.
3150 @item h
3151 @opindex dh
3152 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3153 @item k
3154 @opindex dk
3155 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3156 @item o
3157 @opindex do
3158 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3159 @item G
3160 @opindex dG
3161 Dump after GCSE, to @file{@var{file}.11.gcse}.
3162 @item i
3163 @opindex di
3164 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3165 @item j
3166 @opindex dj
3167 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3168 @item k
3169 @opindex dk
3170 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3171 @item l
3172 @opindex dl
3173 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3174 @item L
3175 @opindex dL
3176 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3177 @file{@var{file}.18.loop2}.
3178 @item M
3179 @opindex dM
3180 Dump after performing the machine dependent reorganization pass, to
3181 @file{@var{file}.33.mach}.
3182 @item n
3183 @opindex dn
3184 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3185 @item N
3186 @opindex dN
3187 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3188 @item r
3189 @opindex dr
3190 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3191 @item R
3192 @opindex dR
3193 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3194 @item s
3195 @opindex ds
3196 Dump after CSE (including the jump optimization that sometimes follows
3197 CSE), to @file{@var{file}.09.cse}.
3198 @item S
3199 @opindex dS
3200 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3201 @item t
3202 @opindex dt
3203 Dump after the second CSE pass (including the jump optimization that
3204 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3205 @item u
3206 @opindex du
3207 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3208 @item w
3209 @opindex dw
3210 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3211 @item X
3212 @opindex dX
3213 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3214 @item z
3215 @opindex dz
3216 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3217 @item a
3218 @opindex da
3219 Produce all the dumps listed above.
3220 @item H
3221 @opindex dH
3222 Produce a core dump whenever an error occurs.
3223 @item m
3224 @opindex dm
3225 Print statistics on memory usage, at the end of the run, to
3226 standard error.
3227 @item p
3228 @opindex dp
3229 Annotate the assembler output with a comment indicating which
3230 pattern and alternative was used.  The length of each instruction is
3231 also printed.
3232 @item P
3233 @opindex dP
3234 Dump the RTL in the assembler output as a comment before each instruction.
3235 Also turns on @option{-dp} annotation.
3236 @item v
3237 @opindex dv
3238 For each of the other indicated dump files (except for
3239 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3240 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3241 @item x
3242 @opindex dx
3243 Just generate RTL for a function instead of compiling it.  Usually used
3244 with @samp{r}.
3245 @item y
3246 @opindex dy
3247 Dump debugging information during parsing, to standard error.
3248 @end table
3250 @item -fdump-unnumbered
3251 @opindex fdump-unnumbered
3252 When doing debugging dumps (see @option{-d} option above), suppress instruction
3253 numbers and line number note output.  This makes it more feasible to
3254 use diff on debugging dumps for compiler invocations with different
3255 options, in particular with and without @option{-g}.
3257 @item -fdump-translation-unit @r{(C and C++ only)}
3258 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3259 @opindex fdump-translation-unit
3260 Dump a representation of the tree structure for the entire translation
3261 unit to a file.  The file name is made by appending @file{.tu} to the
3262 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3263 controls the details of the dump as described for the
3264 @option{-fdump-tree} options.
3266 @item -fdump-class-hierarchy @r{(C++ only)}
3267 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3268 @opindex fdump-class-hierarchy
3269 Dump a representation of each class's hierarchy and virtual function
3270 table layout to a file.  The file name is made by appending @file{.class}
3271 to the source file name.  If the @samp{-@var{options}} form is used,
3272 @var{options} controls the details of the dump as described for the
3273 @option{-fdump-tree} options.
3275 @item -fdump-tree-@var{switch} @r{(C++ only)}
3276 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3277 @opindex fdump-tree
3278 Control the dumping at various stages of processing the intermediate
3279 language tree to a file.  The file name is generated by appending a switch
3280 specific suffix to the source file name.  If the @samp{-@var{options}}
3281 form is used, @var{options} is a list of @samp{-} separated options that
3282 control the details of the dump. Not all options are applicable to all
3283 dumps, those which are not meaningful will be ignored. The following
3284 options are available
3286 @table @samp
3287 @item address
3288 Print the address of each node.  Usually this is not meaningful as it
3289 changes according to the environment and source file. Its primary use
3290 is for tying up a dump file with a debug environment.
3291 @item slim
3292 Inhibit dumping of members of a scope or body of a function merely
3293 because that scope has been reached. Only dump such items when they
3294 are directly reachable by some other path.
3295 @item all
3296 Turn on all options.
3297 @end table
3299 The following tree dumps are possible:
3300 @table @samp
3301 @item original
3302 Dump before any tree based optimization, to @file{@var{file}.original}.
3303 @item optimized
3304 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3305 @item inlined
3306 Dump after function inlining, to @file{@var{file}.inlined}.
3307 @end table
3309 @item -fsched-verbose=@var{n}
3310 @opindex fsched-verbose
3311 On targets that use instruction scheduling, this option controls the
3312 amount of debugging output the scheduler prints.  This information is
3313 written to standard error, unless @option{-dS} or @option{-dR} is
3314 specified, in which case it is output to the usual dump
3315 listing file, @file{.sched} or @file{.sched2} respectively.  However
3316 for @var{n} greater than nine, the output is always printed to standard
3317 error.
3319 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3320 same information as @option{-dRS}.  For @var{n} greater than one, it
3321 also output basic block probabilities, detailed ready list information
3322 and unit/insn info.  For @var{n} greater than two, it includes RTL
3323 at abort point, control-flow and regions info.  And for @var{n} over
3324 four, @option{-fsched-verbose} also includes dependence info.
3326 @item -save-temps
3327 @opindex save-temps
3328 Store the usual ``temporary'' intermediate files permanently; place them
3329 in the current directory and name them based on the source file.  Thus,
3330 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3331 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3332 preprocessed @file{foo.i} output file even though the compiler now
3333 normally uses an integrated preprocessor.
3335 @item -time
3336 @opindex time
3337 Report the CPU time taken by each subprocess in the compilation
3338 sequence.  For C source files, this is the compiler proper and assembler
3339 (plus the linker if linking is done).  The output looks like this:
3341 @smallexample
3342 # cc1 0.12 0.01
3343 # as 0.00 0.01
3344 @end smallexample
3346 The first number on each line is the ``user time,'' that is time spent
3347 executing the program itself.  The second number is ``system time,''
3348 time spent executing operating system routines on behalf of the program.
3349 Both numbers are in seconds.
3351 @item -print-file-name=@var{library}
3352 @opindex print-file-name
3353 Print the full absolute name of the library file @var{library} that
3354 would be used when linking---and don't do anything else.  With this
3355 option, GCC does not compile or link anything; it just prints the
3356 file name.
3358 @item -print-multi-directory
3359 @opindex print-multi-directory
3360 Print the directory name corresponding to the multilib selected by any
3361 other switches present in the command line.  This directory is supposed
3362 to exist in @env{GCC_EXEC_PREFIX}.
3364 @item -print-multi-lib
3365 @opindex print-multi-lib
3366 Print the mapping from multilib directory names to compiler switches
3367 that enable them.  The directory name is separated from the switches by
3368 @samp{;}, and each switch starts with an @samp{@@} instead of the
3369 @samp{-}, without spaces between multiple switches.  This is supposed to
3370 ease shell-processing.
3372 @item -print-prog-name=@var{program}
3373 @opindex print-prog-name
3374 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3376 @item -print-libgcc-file-name
3377 @opindex print-libgcc-file-name
3378 Same as @option{-print-file-name=libgcc.a}.
3380 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3381 but you do want to link with @file{libgcc.a}.  You can do
3383 @example
3384 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3385 @end example
3387 @item -print-search-dirs
3388 @opindex print-search-dirs
3389 Print the name of the configured installation directory and a list of
3390 program and library directories gcc will search---and don't do anything else.
3392 This is useful when gcc prints the error message
3393 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3394 To resolve this you either need to put @file{cpp0} and the other compiler
3395 components where gcc expects to find them, or you can set the environment
3396 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3397 Don't forget the trailing '/'.
3398 @xref{Environment Variables}.
3400 @item -dumpmachine
3401 @opindex dumpmachine
3402 Print the compiler's target machine (for example,
3403 @samp{i686-pc-linux-gnu})---and don't do anything else.
3405 @item -dumpversion
3406 @opindex dumpversion
3407 Print the compiler version (for example, @samp{3.0})---and don't do
3408 anything else.
3410 @item -dumpspecs
3411 @opindex dumpspecs
3412 Print the compiler's built-in specs---and don't do anything else.  (This
3413 is used when GCC itself is being built.)  @xref{Spec Files}.
3414 @end table
3416 @node Optimize Options
3417 @section Options That Control Optimization
3418 @cindex optimize options
3419 @cindex options, optimization
3421 These options control various sorts of optimizations.
3423 Without any optimization option, the compiler's goal is to reduce the
3424 cost of compilation and to make debugging produce the expected
3425 results.  Statements are independent: if you stop the program with a
3426 breakpoint between statements, you can then assign a new value to any
3427 variable or change the program counter to any other statement in the
3428 function and get exactly the results you would expect from the source
3429 code.
3431 Turning on optimization flags makes the compiler attempt to improve
3432 the performance and/or code size at the expense of compilation time
3433 and possibly the ability to debug the program.
3435 Not all optimizations are controlled directly by a flag.  Only
3436 optimizations that have a flag are listed.
3438 @table @gcctabopt
3439 @item -O
3440 @itemx -O1
3441 @opindex O
3442 @opindex O1
3443 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3444 more memory for a large function.
3446 With @option{-O}, the compiler tries to reduce code size and execution
3447 time, without performing any optimizations that take a great deal of
3448 compilation time.
3450 @option{-O} turns on the following optimization flags: 
3451 @gccoptlist{-fdefer-pop 
3452 -fmerge-constants
3453 -fthread-jumps
3454 -floop-optimize
3455 -fcrossjumping
3456 -fif-conversion
3457 -fif-conversion2
3458 -fdelayed-branch
3459 -fguess-branch-probability
3460 -fcprop-registers}
3462 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3463 where doing so does not interfere with debugging.
3465 @item -O2
3466 @opindex O2
3467 Optimize even more.  GCC performs nearly all supported optimizations
3468 that do not involve a space-speed tradeoff.  The compiler does not
3469 perform loop unrolling or function inlining when you specify @option{-O2}.
3470 As compared to @option{-O}, this option increases both compilation time
3471 and the performance of the generated code.
3473 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3474 also turns on the following optimization flags:
3475 @gccoptlist{-fforce-mem
3476 -foptimize-sibling-calls
3477 -fstrength-reduce
3478 -fcse-follow-jumps  -fcse-skip-blocks
3479 -frerun-cse-after-loop  -frerun-loop-opt
3480 -fgcse   -fgcse-lm   -fgcse-sm
3481 -fdelete-null-pointer-checks
3482 -fexpensive-optimizations
3483 -fregmove
3484 -fschedule-insns  -fschedule-insns2
3485 -fsched-interblock -fsched-spec
3486 -fcaller-saves
3487 -fpeephole2
3488 -freorder-blocks  -freorder-functions
3489 -fstrict-aliasing
3490 -falign-functions  -falign-jumps
3491 -falign-loops  -falign-labels}
3493 Please note the warning under @option{-fgcse} about
3494 invoking @option{-O2} on programs that use computed gotos.
3496 @item -O3
3497 @opindex O3
3498 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3499 @option{-O2} and also turns on the @option{-finline-functions} and
3500 @option{-frename-registers} options.
3502 @item -O0
3503 @opindex O0
3504 Do not optimize.  This is the default.
3506 @item -Os
3507 @opindex Os
3508 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3509 do not typically increase code size.  It also performs further
3510 optimizations designed to reduce code size.
3512 @option{-Os} disables the following optimization flags:
3513 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops
3514 -falign-labels  -freorder-blocks -fprefetch-loop-arrays}
3516 If you use multiple @option{-O} options, with or without level numbers,
3517 the last such option is the one that is effective.
3518 @end table
3520 Options of the form @option{-f@var{flag}} specify machine-independent
3521 flags.  Most flags have both positive and negative forms; the negative
3522 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3523 below, only one of the forms is listed---the one you typically will
3524 use.  You can figure out the other form by either removing @samp{no-}
3525 or adding it.
3527 The following options control specific optimizations.  They are either
3528 activated by @option{-O} options or are related to ones that are.  You
3529 can use the following flags in the rare cases when ``fine-tuning'' of
3530 optimizations to be performed is desired.
3532 @table @gcctabopt
3533 @item -fno-default-inline
3534 @opindex fno-default-inline
3535 Do not make member functions inline by default merely because they are
3536 defined inside the class scope (C++ only).  Otherwise, when you specify
3537 @w{@option{-O}}, member functions defined inside class scope are compiled
3538 inline by default; i.e., you don't need to add @samp{inline} in front of
3539 the member function name.
3541 @item -fno-defer-pop
3542 @opindex fno-defer-pop
3543 Always pop the arguments to each function call as soon as that function
3544 returns.  For machines which must pop arguments after a function call,
3545 the compiler normally lets arguments accumulate on the stack for several
3546 function calls and pops them all at once.
3548 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3550 @item -fforce-mem
3551 @opindex fforce-mem
3552 Force memory operands to be copied into registers before doing
3553 arithmetic on them.  This produces better code by making all memory
3554 references potential common subexpressions.  When they are not common
3555 subexpressions, instruction combination should eliminate the separate
3556 register-load.
3558 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3560 @item -fforce-addr
3561 @opindex fforce-addr
3562 Force memory address constants to be copied into registers before
3563 doing arithmetic on them.  This may produce better code just as
3564 @option{-fforce-mem} may.
3566 @item -fomit-frame-pointer
3567 @opindex fomit-frame-pointer
3568 Don't keep the frame pointer in a register for functions that
3569 don't need one.  This avoids the instructions to save, set up and
3570 restore frame pointers; it also makes an extra register available
3571 in many functions.  @strong{It also makes debugging impossible on
3572 some machines.}
3574 On some machines, such as the VAX, this flag has no effect, because
3575 the standard calling sequence automatically handles the frame pointer
3576 and nothing is saved by pretending it doesn't exist.  The
3577 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3578 whether a target machine supports this flag.  @xref{Registers,,Register
3579 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3581 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3583 @item -foptimize-sibling-calls
3584 @opindex foptimize-sibling-calls
3585 Optimize sibling and tail recursive calls.
3587 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3589 @item -fno-inline
3590 @opindex fno-inline
3591 Don't pay attention to the @code{inline} keyword.  Normally this option
3592 is used to keep the compiler from expanding any functions inline.
3593 Note that if you are not optimizing, no functions can be expanded inline.
3595 @item -finline-functions
3596 @opindex finline-functions
3597 Integrate all simple functions into their callers.  The compiler
3598 heuristically decides which functions are simple enough to be worth
3599 integrating in this way.
3601 If all calls to a given function are integrated, and the function is
3602 declared @code{static}, then the function is normally not output as
3603 assembler code in its own right.
3605 Enabled at level @option{-O3}.
3607 @item -finline-limit=@var{n}
3608 @opindex finline-limit
3609 By default, gcc limits the size of functions that can be inlined.  This flag
3610 allows the control of this limit for functions that are explicitly marked as
3611 inline (i.e., marked with the inline keyword or defined within the class
3612 definition in c++).  @var{n} is the size of functions that can be inlined in
3613 number of pseudo instructions (not counting parameter handling).  The default
3614 value of @var{n} is 600.
3615 Increasing this value can result in more inlined code at
3616 the cost of compilation time and memory consumption.  Decreasing usually makes
3617 the compilation faster and less code will be inlined (which presumably
3618 means slower programs).  This option is particularly useful for programs that
3619 use inlining heavily such as those based on recursive templates with C++.
3621 @emph{Note:} pseudo instruction represents, in this particular context, an
3622 abstract measurement of function's size.  In no way, it represents a count
3623 of assembly instructions and as such its exact meaning might change from one
3624 release to an another.
3626 @item -fkeep-inline-functions
3627 @opindex fkeep-inline-functions
3628 Even if all calls to a given function are integrated, and the function
3629 is declared @code{static}, nevertheless output a separate run-time
3630 callable version of the function.  This switch does not affect
3631 @code{extern inline} functions.
3633 @item -fkeep-static-consts
3634 @opindex fkeep-static-consts
3635 Emit variables declared @code{static const} when optimization isn't turned
3636 on, even if the variables aren't referenced.
3638 GCC enables this option by default.  If you want to force the compiler to
3639 check if the variable was referenced, regardless of whether or not
3640 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3642 @item -fmerge-constants
3643 Attempt to merge identical constants (string constants and floating point
3644 constants) across compilation units.
3646 This option is the default for optimized compilation if the assembler and
3647 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3648 behavior.
3650 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3652 @item -fmerge-all-constants
3653 Attempt to merge identical constants and identical variables.
3655 This option implies @option{-fmerge-constants}.  In addition to
3656 @option{-fmerge-constants} this considers e.g. even constant initialized
3657 arrays or initialized constant variables with integral or floating point
3658 types.  Languages like C or C++ require each non-automatic variable to
3659 have distinct location, so using this option will result in non-conforming
3660 behavior.
3662 @item -fnew-ra
3663 @opindex fnew-ra
3664 Use a graph coloring register allocator.  Currently this option is meant
3665 for testing, so we are interested to hear about miscompilations with
3666 @option{-fnew-ra}.
3668 @item -fno-branch-count-reg
3669 @opindex fno-branch-count-reg
3670 Do not use ``decrement and branch'' instructions on a count register,
3671 but instead generate a sequence of instructions that decrement a
3672 register, compare it against zero, then branch based upon the result.
3673 This option is only meaningful on architectures that support such
3674 instructions, which include x86, PowerPC, IA-64 and S/390.
3676 The default is @option{-fbranch-count-reg}, enabled when
3677 @option{-fstrength-reduce} is enabled.
3679 @item -fno-function-cse
3680 @opindex fno-function-cse
3681 Do not put function addresses in registers; make each instruction that
3682 calls a constant function contain the function's address explicitly.
3684 This option results in less efficient code, but some strange hacks
3685 that alter the assembler output may be confused by the optimizations
3686 performed when this option is not used.
3688 The default is @option{-ffunction-cse}
3690 @item -fno-zero-initialized-in-bss
3691 @opindex fno-zero-initialized-in-bss
3692 If the target supports a BSS section, GCC by default puts variables that
3693 are initialized to zero into BSS@.  This can save space in the resulting
3694 code.
3696 This option turns off this behavior because some programs explicitly
3697 rely on variables going to the data section.  E.g., so that the
3698 resulting executable can find the beginning of that section and/or make
3699 assumptions based on that.
3701 The default is @option{-fzero-initialized-in-bss}.
3703 @item -fstrength-reduce
3704 @opindex fstrength-reduce
3705 Perform the optimizations of loop strength reduction and
3706 elimination of iteration variables.
3708 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3710 @item -fthread-jumps
3711 @opindex fthread-jumps
3712 Perform optimizations where we check to see if a jump branches to a
3713 location where another comparison subsumed by the first is found.  If
3714 so, the first branch is redirected to either the destination of the
3715 second branch or a point immediately following it, depending on whether
3716 the condition is known to be true or false.
3718 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3720 @item -fcse-follow-jumps
3721 @opindex fcse-follow-jumps
3722 In common subexpression elimination, scan through jump instructions
3723 when the target of the jump is not reached by any other path.  For
3724 example, when CSE encounters an @code{if} statement with an
3725 @code{else} clause, CSE will follow the jump when the condition
3726 tested is false.
3728 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3730 @item -fcse-skip-blocks
3731 @opindex fcse-skip-blocks
3732 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3733 follow jumps which conditionally skip over blocks.  When CSE
3734 encounters a simple @code{if} statement with no else clause,
3735 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3736 body of the @code{if}.
3738 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3740 @item -frerun-cse-after-loop
3741 @opindex frerun-cse-after-loop
3742 Re-run common subexpression elimination after loop optimizations has been
3743 performed.
3745 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3747 @item -frerun-loop-opt
3748 @opindex frerun-loop-opt
3749 Run the loop optimizer twice.
3751 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3753 @item -fgcse
3754 @opindex fgcse
3755 Perform a global common subexpression elimination pass.
3756 This pass also performs global constant and copy propagation.
3758 @emph{Note:} When compiling a program using computed gotos, a GCC
3759 extension, you may get better runtime performance if you disable
3760 the global common subexpression elimination pass by adding
3761 @option{-fno-gcse} to the command line.
3763 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3765 @item -fgcse-lm
3766 @opindex fgcse-lm
3767 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3768 attempt to move loads which are only killed by stores into themselves.  This
3769 allows a loop containing a load/store sequence to be changed to a load outside
3770 the loop, and a copy/store within the loop.
3772 Enabled by default when gcse is enabled.
3774 @item -fgcse-sm
3775 @opindex fgcse-sm
3776 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3777 subexpression elimination.  This pass will attempt to move stores out of loops.
3778 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3779 can be changed to a load before the loop and a store after the loop.
3781 Enabled by default when gcse is enabled.
3783 @item -floop-optimize
3784 @opindex floop-optimize
3785 Perform loop optimizations: move constant expressions out of loops, simplify
3786 exit test conditions and optionally do strength-reduction and loop unrolling as
3787 well.
3789 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3791 @item -fcrossjumping
3792 @opindex crossjumping
3793 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3794 resulting code may or may not perform better than without cross-jumping.
3796 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3798 @item -fif-conversion
3799 @opindex if-conversion
3800 Attempt to transform conditional jumps into branch-less equivalents.  This
3801 include use of conditional moves, min, max, set flags and abs instructions, and
3802 some tricks doable by standard arithmetics.  The use of conditional execution
3803 on chips where it is available is controlled by @code{if-conversion2}.
3805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3807 @item -fif-conversion2
3808 @opindex if-conversion2
3809 Use conditional execution (where available) to transform conditional jumps into
3810 branch-less equivalents.
3812 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3814 @item -fdelete-null-pointer-checks
3815 @opindex fdelete-null-pointer-checks
3816 Use global dataflow analysis to identify and eliminate useless checks
3817 for null pointers.  The compiler assumes that dereferencing a null
3818 pointer would have halted the program.  If a pointer is checked after
3819 it has already been dereferenced, it cannot be null.
3821 In some environments, this assumption is not true, and programs can
3822 safely dereference null pointers.  Use
3823 @option{-fno-delete-null-pointer-checks} to disable this optimization
3824 for programs which depend on that behavior.
3826 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3828 @item -fexpensive-optimizations
3829 @opindex fexpensive-optimizations
3830 Perform a number of minor optimizations that are relatively expensive.
3832 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3834 @item -foptimize-register-move
3835 @itemx -fregmove
3836 @opindex foptimize-register-move
3837 @opindex fregmove
3838 Attempt to reassign register numbers in move instructions and as
3839 operands of other simple instructions in order to maximize the amount of
3840 register tying.  This is especially helpful on machines with two-operand
3841 instructions.
3843 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3844 optimization.
3846 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3848 @item -fdelayed-branch
3849 @opindex fdelayed-branch
3850 If supported for the target machine, attempt to reorder instructions
3851 to exploit instruction slots available after delayed branch
3852 instructions.
3854 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3856 @item -fschedule-insns
3857 @opindex fschedule-insns
3858 If supported for the target machine, attempt to reorder instructions to
3859 eliminate execution stalls due to required data being unavailable.  This
3860 helps machines that have slow floating point or memory load instructions
3861 by allowing other instructions to be issued until the result of the load
3862 or floating point instruction is required.
3864 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3866 @item -fschedule-insns2
3867 @opindex fschedule-insns2
3868 Similar to @option{-fschedule-insns}, but requests an additional pass of
3869 instruction scheduling after register allocation has been done.  This is
3870 especially useful on machines with a relatively small number of
3871 registers and where memory load instructions take more than one cycle.
3873 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3875 @item -fno-sched-interblock
3876 @opindex fno-sched-interblock
3877 Don't schedule instructions across basic blocks.  This is normally
3878 enabled by default when scheduling before register allocation, i.e.@:
3879 with @option{-fschedule-insns} or at @option{-O2} or higher.
3881 @item -fno-sched-spec
3882 @opindex fno-sched-spec
3883 Don't allow speculative motion of non-load instructions.  This is normally
3884 enabled by default when scheduling before register allocation, i.e.@:
3885 with @option{-fschedule-insns} or at @option{-O2} or higher.
3887 @item -fsched-spec-load
3888 @opindex fsched-spec-load
3889 Allow speculative motion of some load instructions.  This only makes
3890 sense when scheduling before register allocation, i.e.@: with
3891 @option{-fschedule-insns} or at @option{-O2} or higher.
3893 @item -fsched-spec-load-dangerous
3894 @opindex fsched-spec-load-dangerous
3895 Allow speculative motion of more load instructions.  This only makes
3896 sense when scheduling before register allocation, i.e.@: with
3897 @option{-fschedule-insns} or at @option{-O2} or higher.
3899 @item -fsched2-use-superblocks
3900 @opindex fsched2-use-superblocks
3901 When schedulilng after register allocation, do use superblock scheduling
3902 algorithm.  Superblock scheduling allows motion acress basic block boundaries
3903 resulting on faster schedules.  This option is experimental, as not all machine
3904 descriptions used by GCC model the CPU closely enought to avoid unreliable
3905 results from the algorithm. 
3907 This only makes sense when scheduling after register allocation, i.e.@: with
3908 @option{-fschedule-insns2} or at @option{-O2} or higher.
3910 @item -fsched2-use-traces
3911 @opindex fsched2-use-traces
3912 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3913 allocation and additionally perform code duplication in order to increase the
3914 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3915 trace formation.
3917 This mode should produce faster but singificantly longer programs.  Also
3918 without @code{-fbranch-probabilities} the traces constructed may not match the
3919 reality and hurt the performance.  This only makes
3920 sense when scheduling after register allocation, i.e.@: with
3921 @option{-fschedule-insns2} or at @option{-O2} or higher.
3923 @item -fcaller-saves
3924 @opindex fcaller-saves
3925 Enable values to be allocated in registers that will be clobbered by
3926 function calls, by emitting extra instructions to save and restore the
3927 registers around such calls.  Such allocation is done only when it
3928 seems to result in better code than would otherwise be produced.
3930 This option is always enabled by default on certain machines, usually
3931 those which have no call-preserved registers to use instead.
3933 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3935 @item -fmove-all-movables
3936 @opindex fmove-all-movables
3937 Forces all invariant computations in loops to be moved
3938 outside the loop.
3940 @item -freduce-all-givs
3941 @opindex freduce-all-givs
3942 Forces all general-induction variables in loops to be
3943 strength-reduced.
3945 @emph{Note:} When compiling programs written in Fortran,
3946 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3947 by default when you use the optimizer.
3949 These options may generate better or worse code; results are highly
3950 dependent on the structure of loops within the source code.
3952 These two options are intended to be removed someday, once
3953 they have helped determine the efficacy of various
3954 approaches to improving loop optimizations.
3956 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3957 know how use of these options affects
3958 the performance of your production code.
3959 We're very interested in code that runs @emph{slower}
3960 when these options are @emph{enabled}.
3962 @item -fno-peephole
3963 @itemx -fno-peephole2
3964 @opindex fno-peephole
3965 @opindex fno-peephole2
3966 Disable any machine-specific peephole optimizations.  The difference
3967 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3968 are implemented in the compiler; some targets use one, some use the
3969 other, a few use both.
3971 @option{-fpeephole} is enabled by default.
3972 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3974 @item -fno-guess-branch-probability
3975 @opindex fno-guess-branch-probability
3976 Do not guess branch probabilities using a randomized model.
3978 Sometimes gcc will opt to use a randomized model to guess branch
3979 probabilities, when none are available from either profiling feedback
3980 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3981 different runs of the compiler on the same program may produce different
3982 object code.
3984 In a hard real-time system, people don't want different runs of the
3985 compiler to produce code that has different behavior; minimizing
3986 non-determinism is of paramount import.  This switch allows users to
3987 reduce non-determinism, possibly at the expense of inferior
3988 optimization.
3990 The default is @option{-fguess-branch-probability} at levels
3991 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3993 @item -freorder-blocks
3994 @opindex freorder-blocks
3995 Reorder basic blocks in the compiled function in order to reduce number of
3996 taken branches and improve code locality.
3998 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4000 @item -freorder-functions
4001 @opindex freorder-functions
4002 Reorder basic blocks in the compiled function in order to reduce number of
4003 taken branches and improve code locality. This is implemented by using special
4004 subsections @code{text.hot} for most frequently executed functions and
4005 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4006 the linker so object file format must support named sections and linker must
4007 place them in a reasonable way.
4009 Also profile feedback must be available in to make this option effective.  See
4010 @option{-fprofile-arcs} for details.
4012 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4014 @item -fstrict-aliasing
4015 @opindex fstrict-aliasing
4016 Allows the compiler to assume the strictest aliasing rules applicable to
4017 the language being compiled.  For C (and C++), this activates
4018 optimizations based on the type of expressions.  In particular, an
4019 object of one type is assumed never to reside at the same address as an
4020 object of a different type, unless the types are almost the same.  For
4021 example, an @code{unsigned int} can alias an @code{int}, but not a
4022 @code{void*} or a @code{double}.  A character type may alias any other
4023 type.
4025 Pay special attention to code like this:
4026 @example
4027 union a_union @{
4028   int i;
4029   double d;
4032 int f() @{
4033   a_union t;
4034   t.d = 3.0;
4035   return t.i;
4037 @end example
4038 The practice of reading from a different union member than the one most
4039 recently written to (called ``type-punning'') is common.  Even with
4040 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4041 is accessed through the union type.  So, the code above will work as
4042 expected.  However, this code might not:
4043 @example
4044 int f() @{
4045   a_union t;
4046   int* ip;
4047   t.d = 3.0;
4048   ip = &t.i;
4049   return *ip;
4051 @end example
4053 Every language that wishes to perform language-specific alias analysis
4054 should define a function that computes, given an @code{tree}
4055 node, an alias set for the node.  Nodes in different alias sets are not
4056 allowed to alias.  For an example, see the C front-end function
4057 @code{c_get_alias_set}.
4059 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4061 @item -falign-functions
4062 @itemx -falign-functions=@var{n}
4063 @opindex falign-functions
4064 Align the start of functions to the next power-of-two greater than
4065 @var{n}, skipping up to @var{n} bytes.  For instance,
4066 @option{-falign-functions=32} aligns functions to the next 32-byte
4067 boundary, but @option{-falign-functions=24} would align to the next
4068 32-byte boundary only if this can be done by skipping 23 bytes or less.
4070 @option{-fno-align-functions} and @option{-falign-functions=1} are
4071 equivalent and mean that functions will not be aligned.
4073 Some assemblers only support this flag when @var{n} is a power of two;
4074 in that case, it is rounded up.
4076 If @var{n} is not specified, use a machine-dependent default.
4078 Enabled at levels @option{-O2}, @option{-O3}.
4080 @item -falign-labels
4081 @itemx -falign-labels=@var{n}
4082 @opindex falign-labels
4083 Align all branch targets to a power-of-two boundary, skipping up to
4084 @var{n} bytes like @option{-falign-functions}.  This option can easily
4085 make code slower, because it must insert dummy operations for when the
4086 branch target is reached in the usual flow of the code.
4088 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4089 are greater than this value, then their values are used instead.
4091 If @var{n} is not specified, use a machine-dependent default which is
4092 very likely to be @samp{1}, meaning no alignment.
4094 Enabled at levels @option{-O2}, @option{-O3}.
4096 @item -falign-loops
4097 @itemx -falign-loops=@var{n}
4098 @opindex falign-loops
4099 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4100 like @option{-falign-functions}.  The hope is that the loop will be
4101 executed many times, which will make up for any execution of the dummy
4102 operations.
4104 If @var{n} is not specified, use a machine-dependent default.
4106 Enabled at levels @option{-O2}, @option{-O3}.
4108 @item -falign-jumps
4109 @itemx -falign-jumps=@var{n}
4110 @opindex falign-jumps
4111 Align branch targets to a power-of-two boundary, for branch targets
4112 where the targets can only be reached by jumping, skipping up to @var{n}
4113 bytes like @option{-falign-functions}.  In this case, no dummy operations
4114 need be executed.
4116 If @var{n} is not specified, use a machine-dependent default.
4118 Enabled at levels @option{-O2}, @option{-O3}.
4120 @item -frename-registers
4121 @opindex frename-registers
4122 Attempt to avoid false dependencies in scheduled code by making use
4123 of registers left over after register allocation.  This optimization
4124 will most benefit processors with lots of registers.  It can, however,
4125 make debugging impossible, since variables will no longer stay in
4126 a ``home register''.
4128 Enabled at levels @option{-O3}.
4130 @item -fno-cprop-registers
4131 @opindex fno-cprop-registers
4132 After register allocation and post-register allocation instruction splitting,
4133 we perform a copy-propagation pass to try to reduce scheduling dependencies
4134 and occasionally eliminate the copy.
4136 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4138 @end table
4140 The following options control compiler behavior regarding floating
4141 point arithmetic.  These options trade off between speed and
4142 correctness.  All must be specifically enabled.
4144 @table @gcctabopt
4145 @item -ffloat-store
4146 @opindex ffloat-store
4147 Do not store floating point variables in registers, and inhibit other
4148 options that might change whether a floating point value is taken from a
4149 register or memory.
4151 @cindex floating point precision
4152 This option prevents undesirable excess precision on machines such as
4153 the 68000 where the floating registers (of the 68881) keep more
4154 precision than a @code{double} is supposed to have.  Similarly for the
4155 x86 architecture.  For most programs, the excess precision does only
4156 good, but a few programs rely on the precise definition of IEEE floating
4157 point.  Use @option{-ffloat-store} for such programs, after modifying
4158 them to store all pertinent intermediate computations into variables.
4160 @item -ffast-math
4161 @opindex ffast-math
4162 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4163 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4164 @option{-fno-signaling-nans}.
4166 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4168 This option should never be turned on by any @option{-O} option since
4169 it can result in incorrect output for programs which depend on
4170 an exact implementation of IEEE or ISO rules/specifications for
4171 math functions.
4173 @item -fno-math-errno
4174 @opindex fno-math-errno
4175 Do not set ERRNO after calling math functions that are executed
4176 with a single instruction, e.g., sqrt.  A program that relies on
4177 IEEE exceptions for math error handling may want to use this flag
4178 for speed while maintaining IEEE arithmetic compatibility.
4180 This option should never be turned on by any @option{-O} option since
4181 it can result in incorrect output for programs which depend on
4182 an exact implementation of IEEE or ISO rules/specifications for
4183 math functions.
4185 The default is @option{-fmath-errno}.
4187 @item -funsafe-math-optimizations
4188 @opindex funsafe-math-optimizations
4189 Allow optimizations for floating-point arithmetic that (a) assume
4190 that arguments and results are valid and (b) may violate IEEE or
4191 ANSI standards.  When used at link-time, it may include libraries
4192 or startup files that change the default FPU control word or other
4193 similar optimizations.
4195 This option should never be turned on by any @option{-O} option since
4196 it can result in incorrect output for programs which depend on
4197 an exact implementation of IEEE or ISO rules/specifications for
4198 math functions.
4200 The default is @option{-fno-unsafe-math-optimizations}.
4202 @item -ffinite-math-only
4203 @opindex ffinite-math-only
4204 Allow optimizations for floating-point arithmetic that assume
4205 that arguments and results are not NaNs or +-Infs.
4207 This option should never be turned on by any @option{-O} option since
4208 it can result in incorrect output for programs which depend on
4209 an exact implementation of IEEE or ISO rules/specifications.
4211 The default is @option{-fno-finite-math-only}.
4213 @item -fno-trapping-math
4214 @opindex fno-trapping-math
4215 Compile code assuming that floating-point operations cannot generate
4216 user-visible traps.  These traps include division by zero, overflow,
4217 underflow, inexact result and invalid operation.  This option implies
4218 @option{-fno-signaling-nans}.  Setting this option may allow faster
4219 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4221 This option should never be turned on by any @option{-O} option since
4222 it can result in incorrect output for programs which depend on
4223 an exact implementation of IEEE or ISO rules/specifications for
4224 math functions.
4226 The default is @option{-ftrapping-math}.
4228 @item -fsignaling-nans
4229 @opindex fsignaling-nans
4230 Compile code assuming that IEEE signaling NaNs may generate user-visible
4231 traps during floating-point operations.  Setting this option disables
4232 optimizations that may change the number of exceptions visible with
4233 signaling NaNs.  This option implies @option{-ftrapping-math}.
4235 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4236 be defined.
4238 The default is @option{-fno-signaling-nans}.
4240 This option is experimental and does not currently guarantee to
4241 disable all GCC optimizations that affect signaling NaN behavior.
4243 @item -fsingle-precision-constant
4244 @opindex fsingle-precision-constant
4245 Treat floating point constant as single precision constant instead of
4246 implicitly converting it to double precision constant.
4249 @end table
4251 The following options control optimizations that may improve
4252 performance, but are not enabled by any @option{-O} options.  This
4253 section includes experimental options that may produce broken code.
4255 @table @gcctabopt
4256 @item -fbranch-probabilities
4257 @opindex fbranch-probabilities
4258 After running a program compiled with @option{-fprofile-arcs}
4259 (@pxref{Debugging Options,, Options for Debugging Your Program or
4260 @command{gcc}}), you can compile it a second time using
4261 @option{-fbranch-probabilities}, to improve optimizations based on
4262 the number of times each branch was taken.  When the program
4263 compiled with @option{-fprofile-arcs} exits it saves arc execution
4264 counts to a file called @file{@var{sourcename}.da} for each source
4265 file  The information in this data file is very dependent on the
4266 structure of the generated code, so you must use the same source code
4267 and the same optimization options for both compilations.
4269 With @option{-fbranch-probabilities}, GCC puts a 
4270 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4271 These can be used to improve optimization.  Currently, they are only
4272 used in one place: in @file{reorg.c}, instead of guessing which path a
4273 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4274 exactly determine which path is taken more often.
4276 @item -fnew-ra
4277 @opindex fnew-ra
4278 Use a graph coloring register allocator.  Currently this option is meant
4279 for testing, so we are interested to hear about miscompilations with
4280 @option{-fnew-ra}.
4282 @item -ftracer
4283 @opindex ftracer
4284 Perform tail duplication to enlarge superblock size. This transformation
4285 simplifies the control flow of the function allowing other optimizations to do
4286 better job.
4288 @item -funit-at-a-time
4289 @opindex funit-at-a-time
4290 Parse the whole compilation unit before starting to produce code.  This allows some
4291 extra optimizations to take place but consumes more memory.
4293 @item -funroll-loops
4294 @opindex funroll-loops
4295 Unroll loops whose number of iterations can be determined at compile
4296 time or upon entry to the loop.  @option{-funroll-loops} implies both
4297 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4298 option makes code larger, and may or may not make it run faster.
4300 @item -funroll-all-loops
4301 @opindex funroll-all-loops
4302 Unroll all loops, even if their number of iterations is uncertain when
4303 the loop is entered.  This usually makes programs run more slowly.
4304 @option{-funroll-all-loops} implies the same options as
4305 @option{-funroll-loops},
4307 @item -funswitch-loops
4308 @opindex funswitch-loops
4309 Move branches with loop invariant conditions out of the loop, with duplicates
4310 of the loop on both branches (modified according to result of the condition).
4312 @item -fprefetch-loop-arrays
4313 @opindex fprefetch-loop-arrays
4314 If supported by the target machine, generate instructions to prefetch
4315 memory to improve the performance of loops that access large arrays.
4317 Disabled at level @option{-Os}.
4319 @item -ffunction-sections
4320 @itemx -fdata-sections
4321 @opindex ffunction-sections
4322 @opindex fdata-sections
4323 Place each function or data item into its own section in the output
4324 file if the target supports arbitrary sections.  The name of the
4325 function or the name of the data item determines the section's name
4326 in the output file.
4328 Use these options on systems where the linker can perform optimizations
4329 to improve locality of reference in the instruction space.  HPPA
4330 processors running HP-UX and SPARC processors running Solaris 2 have
4331 linkers with such optimizations.  Other systems using the ELF object format
4332 as well as AIX may have these optimizations in the future.
4334 Only use these options when there are significant benefits from doing
4335 so.  When you specify these options, the assembler and linker will
4336 create larger object and executable files and will also be slower.
4337 You will not be able to use @code{gprof} on all systems if you
4338 specify this option and you may have problems with debugging if
4339 you specify both this option and @option{-g}.
4341 @item -fssa
4342 @opindex fssa
4343 Perform optimizations in static single assignment form.  Each function's
4344 flow graph is translated into SSA form, optimizations are performed, and
4345 the flow graph is translated back from SSA form.  Users should not
4346 specify this option, since it is not yet ready for production use.
4348 @item -fssa-ccp
4349 @opindex fssa-ccp
4350 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4351 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4353 @item -fssa-dce
4354 @opindex fssa-dce
4355 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4356 Like @option{-fssa}, this is an experimental feature.
4361 @item --param @var{name}=@var{value}
4362 @opindex param
4363 In some places, GCC uses various constants to control the amount of
4364 optimization that is done.  For example, GCC will not inline functions
4365 that contain more that a certain number of instructions.  You can
4366 control some of these constants on the command-line using the
4367 @option{--param} option.
4369 In each case, the @var{value} is an integer.  The allowable choices for
4370 @var{name} are given in the following table:
4372 @table @gcctabopt
4373 @item max-crossjump-edges
4374 The maximum number of incoming edges to consider for crossjumping.
4375 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4376 the number of edges incoming to each block.  Increasing values mean
4377 more aggressive optimization, making the compile time increase with
4378 probably small improvement in executable size.
4380 @item max-delay-slot-insn-search
4381 The maximum number of instructions to consider when looking for an
4382 instruction to fill a delay slot.  If more than this arbitrary number of
4383 instructions is searched, the time savings from filling the delay slot
4384 will be minimal so stop searching.  Increasing values mean more
4385 aggressive optimization, making the compile time increase with probably
4386 small improvement in executable run time.
4388 @item max-delay-slot-live-search
4389 When trying to fill delay slots, the maximum number of instructions to
4390 consider when searching for a block with valid live register
4391 information.  Increasing this arbitrarily chosen value means more
4392 aggressive optimization, increasing the compile time.  This parameter
4393 should be removed when the delay slot code is rewritten to maintain the
4394 control-flow graph.
4396 @item max-gcse-memory
4397 The approximate maximum amount of memory that will be allocated in
4398 order to perform the global common subexpression elimination
4399 optimization.  If more memory than specified is required, the
4400 optimization will not be done.
4402 @item max-gcse-passes
4403 The maximum number of passes of GCSE to run.
4405 @item max-pending-list-length
4406 The maximum number of pending dependencies scheduling will allow
4407 before flushing the current state and starting over.  Large functions
4408 with few branches or calls can create excessively large lists which
4409 needlessly consume memory and resources.
4411 @item max-inline-insns
4412 If an function contains more than this many instructions, it
4413 will not be inlined.  This option is precisely equivalent to
4414 @option{-finline-limit}.
4416 @item max-unrolled-insns
4417 The maximum number of instructions that a loop should have if that loop
4418 is unrolled, and if the loop is unrolled, it determines how many times
4419 the loop code is unrolled.
4421 @item max-unswitch-insns
4422 The maximum number of insns of an unswitched loop.
4424 @item max-unswitch-level
4425 The maximum number of branches unswitched in a single loop.
4427 @item hot-bb-count-fraction
4428 Select fraction of the maximal count of repetitions of basic block in program
4429 given basic block needs to have to be considered hot.
4431 @item hot-bb-frequency-fraction
4432 Select fraction of the maximal frequency of executions of basic block in
4433 function given basic block needs to have to be considered hot
4435 @item tracer-dynamic-coverage
4436 @itemx tracer-dynamic-coverage-feedback
4438 This value is used to limit superblock formation once the given percentage of
4439 executed instructions is covered.  This limits unnecessary code size
4440 expansion.
4442 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4443 feedback is available.  The real profiles (as opposed to statically estimated
4444 ones) are much less balanced allowing the threshold to be larger value.
4446 @item tracer-max-code-growth
4447 Stop tail duplication once code growth has reached given percentage.  This is
4448 rather hokey argument, as most of the duplicates will be eliminated later in
4449 cross jumping, so it may be set to much higher values than is the desired code
4450 growth.
4452 @item tracer-min-branch-ratio
4454 Stop reverse growth when the reverse probability of best edge is less than this
4455 threshold (in percent).
4457 @item tracer-min-branch-ratio
4458 @itemx tracer-min-branch-ratio-feedback
4460 Stop forward growth if the best edge do have probability lower than this
4461 threshold.
4463 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4464 compilation for profile feedback and one for compilation without.  The value
4465 for compilation with profile feedback needs to be more conservative (higher) in
4466 order to make tracer effective.
4468 @item ggc-min-expand
4470 GCC uses a garbage collector to manage its own memory allocation.  This
4471 parameter specifies the minimum percentage by which the garbage
4472 collector's heap should be allowed to expand between collections.
4473 Tuning this may improve compilation speed; it has no effect on code
4474 generation.
4476 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4477 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4478 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4479 GCC is not able to calculate RAM on a particular platform, the lower
4480 bound of 30% is used.  Setting this parameter and
4481 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4482 every opportunity.  This is extremely slow, but can be useful for
4483 debugging.
4485 @item ggc-min-heapsize
4487 Minimum size of the garbage collector's heap before it begins bothering
4488 to collect garbage.  The first collection occurs after the heap expands
4489 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4490 tuning this may improve compilation speed, and has no effect on code
4491 generation.
4493 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4494 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4495 available, the notion of "RAM" is the smallest of actual RAM,
4496 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4497 RAM on a particular platform, the lower bound is used.  Setting this
4498 parameter very large effectively disables garbage collection.  Setting
4499 this parameter and @option{ggc-min-expand} to zero causes a full
4500 collection to occur at every opportunity.
4502 @end table
4503 @end table
4505 @node Preprocessor Options
4506 @section Options Controlling the Preprocessor
4507 @cindex preprocessor options
4508 @cindex options, preprocessor
4510 These options control the C preprocessor, which is run on each C source
4511 file before actual compilation.
4513 If you use the @option{-E} option, nothing is done except preprocessing.
4514 Some of these options make sense only together with @option{-E} because
4515 they cause the preprocessor output to be unsuitable for actual
4516 compilation.
4518 @table @gcctabopt
4519 @opindex Wp
4520 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4521 and pass @var{option} directly through to the preprocessor.  If
4522 @var{option} contains commas, it is split into multiple options at the
4523 commas.  However, many options are modified, translated or interpreted
4524 by the compiler driver before being passed to the preprocessor, and
4525 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4526 interface is undocumented and subject to change, so whenever possible
4527 you should avoid using @option{-Wp} and let the driver handle the
4528 options instead.
4530 @item -Xpreprocessor @var{option}
4531 @opindex preprocessor
4532 Pass @var{option} as an option to the preprocessor.  You can use this to
4533 supply system-specific preprocessor options which GCC does not know how to
4534 recognize.
4536 If you want to pass an option that takes an argument, you must use
4537 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4538 @end table
4540 @include cppopts.texi
4542 @node Assembler Options
4543 @section Passing Options to the Assembler
4545 @c prevent bad page break with this line
4546 You can pass options to the assembler.
4548 @table @gcctabopt
4549 @item -Wa,@var{option}
4550 @opindex Wa
4551 Pass @var{option} as an option to the assembler.  If @var{option}
4552 contains commas, it is split into multiple options at the commas.
4554 @item -Xassembler @var{option}
4555 @opindex Xassembler
4556 Pass @var{option} as an option to the assembler.  You can use this to
4557 supply system-specific assembler options which GCC does not know how to
4558 recognize.
4560 If you want to pass an option that takes an argument, you must use
4561 @option{-Xassembler} twice, once for the option and once for the argument.
4563 @end table
4565 @node Link Options
4566 @section Options for Linking
4567 @cindex link options
4568 @cindex options, linking
4570 These options come into play when the compiler links object files into
4571 an executable output file.  They are meaningless if the compiler is
4572 not doing a link step.
4574 @table @gcctabopt
4575 @cindex file names
4576 @item @var{object-file-name}
4577 A file name that does not end in a special recognized suffix is
4578 considered to name an object file or library.  (Object files are
4579 distinguished from libraries by the linker according to the file
4580 contents.)  If linking is done, these object files are used as input
4581 to the linker.
4583 @item -c
4584 @itemx -S
4585 @itemx -E
4586 @opindex c
4587 @opindex S
4588 @opindex E
4589 If any of these options is used, then the linker is not run, and
4590 object file names should not be used as arguments.  @xref{Overall
4591 Options}.
4593 @cindex Libraries
4594 @item -l@var{library}
4595 @itemx -l @var{library}
4596 @opindex l
4597 Search the library named @var{library} when linking.  (The second
4598 alternative with the library as a separate argument is only for
4599 POSIX compliance and is not recommended.)
4601 It makes a difference where in the command you write this option; the
4602 linker searches and processes libraries and object files in the order they
4603 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4604 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4605 to functions in @samp{z}, those functions may not be loaded.
4607 The linker searches a standard list of directories for the library,
4608 which is actually a file named @file{lib@var{library}.a}.  The linker
4609 then uses this file as if it had been specified precisely by name.
4611 The directories searched include several standard system directories
4612 plus any that you specify with @option{-L}.
4614 Normally the files found this way are library files---archive files
4615 whose members are object files.  The linker handles an archive file by
4616 scanning through it for members which define symbols that have so far
4617 been referenced but not defined.  But if the file that is found is an
4618 ordinary object file, it is linked in the usual fashion.  The only
4619 difference between using an @option{-l} option and specifying a file name
4620 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4621 and searches several directories.
4623 @item -lobjc
4624 @opindex lobjc
4625 You need this special case of the @option{-l} option in order to
4626 link an Objective-C program.
4628 @item -nostartfiles
4629 @opindex nostartfiles
4630 Do not use the standard system startup files when linking.
4631 The standard system libraries are used normally, unless @option{-nostdlib}
4632 or @option{-nodefaultlibs} is used.
4634 @item -nodefaultlibs
4635 @opindex nodefaultlibs
4636 Do not use the standard system libraries when linking.
4637 Only the libraries you specify will be passed to the linker.
4638 The standard startup files are used normally, unless @option{-nostartfiles}
4639 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4640 for System V (and ISO C) environments or to bcopy and bzero for
4641 BSD environments.  These entries are usually resolved by entries in
4642 libc.  These entry points should be supplied through some other
4643 mechanism when this option is specified.
4645 @item -nostdlib
4646 @opindex nostdlib
4647 Do not use the standard system startup files or libraries when linking.
4648 No startup files and only the libraries you specify will be passed to
4649 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4650 for System V (and ISO C) environments or to bcopy and bzero for
4651 BSD environments.  These entries are usually resolved by entries in
4652 libc.  These entry points should be supplied through some other
4653 mechanism when this option is specified.
4655 @cindex @option{-lgcc}, use with @option{-nostdlib}
4656 @cindex @option{-nostdlib} and unresolved references
4657 @cindex unresolved references and @option{-nostdlib}
4658 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4659 @cindex @option{-nodefaultlibs} and unresolved references
4660 @cindex unresolved references and @option{-nodefaultlibs}
4661 One of the standard libraries bypassed by @option{-nostdlib} and
4662 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4663 that GCC uses to overcome shortcomings of particular machines, or special
4664 needs for some languages.
4665 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4666 Collection (GCC) Internals},
4667 for more discussion of @file{libgcc.a}.)
4668 In most cases, you need @file{libgcc.a} even when you want to avoid
4669 other standard libraries.  In other words, when you specify @option{-nostdlib}
4670 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4671 This ensures that you have no unresolved references to internal GCC
4672 library subroutines.  (For example, @samp{__main}, used to ensure C++
4673 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4674 GNU Compiler Collection (GCC) Internals}.)
4676 @item -s
4677 @opindex s
4678 Remove all symbol table and relocation information from the executable.
4680 @item -static
4681 @opindex static
4682 On systems that support dynamic linking, this prevents linking with the shared
4683 libraries.  On other systems, this option has no effect.
4685 @item -shared
4686 @opindex shared
4687 Produce a shared object which can then be linked with other objects to
4688 form an executable.  Not all systems support this option.  For predictable
4689 results, you must also specify the same set of options that were used to
4690 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4691 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4692 needs to build supplementary stub code for constructors to work.  On
4693 multi-libbed systems, @samp{gcc -shared} must select the correct support
4694 libraries to link against.  Failing to supply the correct flags may lead
4695 to subtle defects.  Supplying them in cases where they are not necessary
4696 is innocuous.}
4698 @item -shared-libgcc
4699 @itemx -static-libgcc
4700 @opindex shared-libgcc
4701 @opindex static-libgcc
4702 On systems that provide @file{libgcc} as a shared library, these options
4703 force the use of either the shared or static version respectively.
4704 If no shared version of @file{libgcc} was built when the compiler was
4705 configured, these options have no effect.
4707 There are several situations in which an application should use the
4708 shared @file{libgcc} instead of the static version.  The most common
4709 of these is when the application wishes to throw and catch exceptions
4710 across different shared libraries.  In that case, each of the libraries
4711 as well as the application itself should use the shared @file{libgcc}.
4713 Therefore, the G++ and GCJ drivers automatically add
4714 @option{-shared-libgcc} whenever you build a shared library or a main
4715 executable, because C++ and Java programs typically use exceptions, so
4716 this is the right thing to do.
4718 If, instead, you use the GCC driver to create shared libraries, you may
4719 find that they will not always be linked with the shared @file{libgcc}.
4720 If GCC finds, at its configuration time, that you have a GNU linker that
4721 does not support option @option{--eh-frame-hdr}, it will link the shared
4722 version of @file{libgcc} into shared libraries by default.  Otherwise,
4723 it will take advantage of the linker and optimize away the linking with
4724 the shared version of @file{libgcc}, linking with the static version of
4725 libgcc by default.  This allows exceptions to propagate through such
4726 shared libraries, without incurring relocation costs at library load
4727 time.
4729 However, if a library or main executable is supposed to throw or catch
4730 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4731 for the languages used in the program, or using the option
4732 @option{-shared-libgcc}, such that it is linked with the shared
4733 @file{libgcc}.
4735 @item -symbolic
4736 @opindex symbolic
4737 Bind references to global symbols when building a shared object.  Warn
4738 about any unresolved references (unless overridden by the link editor
4739 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4740 this option.
4742 @item -Xlinker @var{option}
4743 @opindex Xlinker
4744 Pass @var{option} as an option to the linker.  You can use this to
4745 supply system-specific linker options which GCC does not know how to
4746 recognize.
4748 If you want to pass an option that takes an argument, you must use
4749 @option{-Xlinker} twice, once for the option and once for the argument.
4750 For example, to pass @option{-assert definitions}, you must write
4751 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4752 @option{-Xlinker "-assert definitions"}, because this passes the entire
4753 string as a single argument, which is not what the linker expects.
4755 @item -Wl,@var{option}
4756 @opindex Wl
4757 Pass @var{option} as an option to the linker.  If @var{option} contains
4758 commas, it is split into multiple options at the commas.
4760 @item -u @var{symbol}
4761 @opindex u
4762 Pretend the symbol @var{symbol} is undefined, to force linking of
4763 library modules to define it.  You can use @option{-u} multiple times with
4764 different symbols to force loading of additional library modules.
4765 @end table
4767 @node Directory Options
4768 @section Options for Directory Search
4769 @cindex directory options
4770 @cindex options, directory search
4771 @cindex search path
4773 These options specify directories to search for header files, for
4774 libraries and for parts of the compiler:
4776 @table @gcctabopt
4777 @item -I@var{dir}
4778 @opindex I
4779 Add the directory @var{dir} to the head of the list of directories to be
4780 searched for header files.  This can be used to override a system header
4781 file, substituting your own version, since these directories are
4782 searched before the system header file directories.  However, you should
4783 not use this option to add directories that contain vendor-supplied
4784 system header files (use @option{-isystem} for that).  If you use more than
4785 one @option{-I} option, the directories are scanned in left-to-right
4786 order; the standard system directories come after.
4788 If a standard system include directory, or a directory specified with
4789 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4790 option will be ignored.  The directory will still be searched but as a
4791 system directory at its normal position in the system include chain.
4792 This is to ensure that GCC's procedure to fix buggy system headers and
4793 the ordering for the include_next directive are not inadvertently changed.
4794 If you really need to change the search order for system directories,
4795 use the @option{-nostdinc} and/or @option{-isystem} options.
4797 @item -I-
4798 @opindex I-
4799 Any directories you specify with @option{-I} options before the @option{-I-}
4800 option are searched only for the case of @samp{#include "@var{file}"};
4801 they are not searched for @samp{#include <@var{file}>}.
4803 If additional directories are specified with @option{-I} options after
4804 the @option{-I-}, these directories are searched for all @samp{#include}
4805 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4806 this way.)
4808 In addition, the @option{-I-} option inhibits the use of the current
4809 directory (where the current input file came from) as the first search
4810 directory for @samp{#include "@var{file}"}.  There is no way to
4811 override this effect of @option{-I-}.  With @option{-I.} you can specify
4812 searching the directory which was current when the compiler was
4813 invoked.  That is not exactly the same as what the preprocessor does
4814 by default, but it is often satisfactory.
4816 @option{-I-} does not inhibit the use of the standard system directories
4817 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4818 independent.
4820 @item -L@var{dir}
4821 @opindex L
4822 Add directory @var{dir} to the list of directories to be searched
4823 for @option{-l}.
4825 @item -B@var{prefix}
4826 @opindex B
4827 This option specifies where to find the executables, libraries,
4828 include files, and data files of the compiler itself.
4830 The compiler driver program runs one or more of the subprograms
4831 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4832 @var{prefix} as a prefix for each program it tries to run, both with and
4833 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4835 For each subprogram to be run, the compiler driver first tries the
4836 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4837 was not specified, the driver tries two standard prefixes, which are
4838 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4839 those results in a file name that is found, the unmodified program
4840 name is searched for using the directories specified in your
4841 @env{PATH} environment variable.
4843 The compiler will check to see if the path provided by the @option{-B}
4844 refers to a directory, and if necessary it will add a directory
4845 separator character at the end of the path.
4847 @option{-B} prefixes that effectively specify directory names also apply
4848 to libraries in the linker, because the compiler translates these
4849 options into @option{-L} options for the linker.  They also apply to
4850 includes files in the preprocessor, because the compiler translates these
4851 options into @option{-isystem} options for the preprocessor.  In this case,
4852 the compiler appends @samp{include} to the prefix.
4854 The run-time support file @file{libgcc.a} can also be searched for using
4855 the @option{-B} prefix, if needed.  If it is not found there, the two
4856 standard prefixes above are tried, and that is all.  The file is left
4857 out of the link if it is not found by those means.
4859 Another way to specify a prefix much like the @option{-B} prefix is to use
4860 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4861 Variables}.
4863 As a special kludge, if the path provided by @option{-B} is
4864 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4865 9, then it will be replaced by @file{[dir/]include}.  This is to help
4866 with boot-strapping the compiler.
4868 @item -specs=@var{file}
4869 @opindex specs
4870 Process @var{file} after the compiler reads in the standard @file{specs}
4871 file, in order to override the defaults that the @file{gcc} driver
4872 program uses when determining what switches to pass to @file{cc1},
4873 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4874 @option{-specs=@var{file}} can be specified on the command line, and they
4875 are processed in order, from left to right.
4876 @end table
4878 @c man end
4880 @node Spec Files
4881 @section Specifying subprocesses and the switches to pass to them
4882 @cindex Spec Files
4883 @command{gcc} is a driver program.  It performs its job by invoking a
4884 sequence of other programs to do the work of compiling, assembling and
4885 linking.  GCC interprets its command-line parameters and uses these to
4886 deduce which programs it should invoke, and which command-line options
4887 it ought to place on their command lines.  This behavior is controlled
4888 by @dfn{spec strings}.  In most cases there is one spec string for each
4889 program that GCC can invoke, but a few programs have multiple spec
4890 strings to control their behavior.  The spec strings built into GCC can
4891 be overridden by using the @option{-specs=} command-line switch to specify
4892 a spec file.
4894 @dfn{Spec files} are plaintext files that are used to construct spec
4895 strings.  They consist of a sequence of directives separated by blank
4896 lines.  The type of directive is determined by the first non-whitespace
4897 character on the line and it can be one of the following:
4899 @table @code
4900 @item %@var{command}
4901 Issues a @var{command} to the spec file processor.  The commands that can
4902 appear here are:
4904 @table @code
4905 @item %include <@var{file}>
4906 @cindex %include
4907 Search for @var{file} and insert its text at the current point in the
4908 specs file.
4910 @item %include_noerr <@var{file}>
4911 @cindex %include_noerr
4912 Just like @samp{%include}, but do not generate an error message if the include
4913 file cannot be found.
4915 @item %rename @var{old_name} @var{new_name}
4916 @cindex %rename
4917 Rename the spec string @var{old_name} to @var{new_name}.
4919 @end table
4921 @item *[@var{spec_name}]:
4922 This tells the compiler to create, override or delete the named spec
4923 string.  All lines after this directive up to the next directive or
4924 blank line are considered to be the text for the spec string.  If this
4925 results in an empty string then the spec will be deleted.  (Or, if the
4926 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4927 does not currently exist a new spec will be created.  If the spec does
4928 exist then its contents will be overridden by the text of this
4929 directive, unless the first character of that text is the @samp{+}
4930 character, in which case the text will be appended to the spec.
4932 @item [@var{suffix}]:
4933 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4934 and up to the next directive or blank line are considered to make up the
4935 spec string for the indicated suffix.  When the compiler encounters an
4936 input file with the named suffix, it will processes the spec string in
4937 order to work out how to compile that file.  For example:
4939 @smallexample
4940 .ZZ:
4941 z-compile -input %i
4942 @end smallexample
4944 This says that any input file whose name ends in @samp{.ZZ} should be
4945 passed to the program @samp{z-compile}, which should be invoked with the
4946 command-line switch @option{-input} and with the result of performing the
4947 @samp{%i} substitution.  (See below.)
4949 As an alternative to providing a spec string, the text that follows a
4950 suffix directive can be one of the following:
4952 @table @code
4953 @item @@@var{language}
4954 This says that the suffix is an alias for a known @var{language}.  This is
4955 similar to using the @option{-x} command-line switch to GCC to specify a
4956 language explicitly.  For example:
4958 @smallexample
4959 .ZZ:
4960 @@c++
4961 @end smallexample
4963 Says that .ZZ files are, in fact, C++ source files.
4965 @item #@var{name}
4966 This causes an error messages saying:
4968 @smallexample
4969 @var{name} compiler not installed on this system.
4970 @end smallexample
4971 @end table
4973 GCC already has an extensive list of suffixes built into it.
4974 This directive will add an entry to the end of the list of suffixes, but
4975 since the list is searched from the end backwards, it is effectively
4976 possible to override earlier entries using this technique.
4978 @end table
4980 GCC has the following spec strings built into it.  Spec files can
4981 override these strings or create their own.  Note that individual
4982 targets can also add their own spec strings to this list.
4984 @smallexample
4985 asm          Options to pass to the assembler
4986 asm_final    Options to pass to the assembler post-processor
4987 cpp          Options to pass to the C preprocessor
4988 cc1          Options to pass to the C compiler
4989 cc1plus      Options to pass to the C++ compiler
4990 endfile      Object files to include at the end of the link
4991 link         Options to pass to the linker
4992 lib          Libraries to include on the command line to the linker
4993 libgcc       Decides which GCC support library to pass to the linker
4994 linker       Sets the name of the linker
4995 predefines   Defines to be passed to the C preprocessor
4996 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4997              by default
4998 startfile    Object files to include at the start of the link
4999 @end smallexample
5001 Here is a small example of a spec file:
5003 @smallexample
5004 %rename lib                 old_lib
5006 *lib:
5007 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5008 @end smallexample
5010 This example renames the spec called @samp{lib} to @samp{old_lib} and
5011 then overrides the previous definition of @samp{lib} with a new one.
5012 The new definition adds in some extra command-line options before
5013 including the text of the old definition.
5015 @dfn{Spec strings} are a list of command-line options to be passed to their
5016 corresponding program.  In addition, the spec strings can contain
5017 @samp{%}-prefixed sequences to substitute variable text or to
5018 conditionally insert text into the command line.  Using these constructs
5019 it is possible to generate quite complex command lines.
5021 Here is a table of all defined @samp{%}-sequences for spec
5022 strings.  Note that spaces are not generated automatically around the
5023 results of expanding these sequences.  Therefore you can concatenate them
5024 together or combine them with constant text in a single argument.
5026 @table @code
5027 @item %%
5028 Substitute one @samp{%} into the program name or argument.
5030 @item %i
5031 Substitute the name of the input file being processed.
5033 @item %b
5034 Substitute the basename of the input file being processed.
5035 This is the substring up to (and not including) the last period
5036 and not including the directory.
5038 @item %B
5039 This is the same as @samp{%b}, but include the file suffix (text after
5040 the last period).
5042 @item %d
5043 Marks the argument containing or following the @samp{%d} as a
5044 temporary file name, so that that file will be deleted if GCC exits
5045 successfully.  Unlike @samp{%g}, this contributes no text to the
5046 argument.
5048 @item %g@var{suffix}
5049 Substitute a file name that has suffix @var{suffix} and is chosen
5050 once per compilation, and mark the argument in the same way as
5051 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5052 name is now chosen in a way that is hard to predict even when previously
5053 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5054 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5055 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5056 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5057 was simply substituted with a file name chosen once per compilation,
5058 without regard to any appended suffix (which was therefore treated
5059 just like ordinary text), making such attacks more likely to succeed.
5061 @item %u@var{suffix}
5062 Like @samp{%g}, but generates a new temporary file name even if
5063 @samp{%u@var{suffix}} was already seen.
5065 @item %U@var{suffix}
5066 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5067 new one if there is no such last file name.  In the absence of any
5068 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5069 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5070 would involve the generation of two distinct file names, one
5071 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5072 simply substituted with a file name chosen for the previous @samp{%u},
5073 without regard to any appended suffix.
5075 @item %j@var{suffix}
5076 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5077 writable, and if save-temps is off; otherwise, substitute the name
5078 of a temporary file, just like @samp{%u}.  This temporary file is not
5079 meant for communication between processes, but rather as a junk
5080 disposal mechanism.
5082 @item %|@var{suffix}
5083 @itemx %m@var{suffix}
5084 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5085 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5086 all.  These are the two most common ways to instruct a program that it
5087 should read from standard input or write to standard output.  If you
5088 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5089 construct: see for example @file{f/lang-specs.h}.
5091 @item %.@var{SUFFIX}
5092 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5093 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5094 terminated by the next space or %.
5096 @item %w
5097 Marks the argument containing or following the @samp{%w} as the
5098 designated output file of this compilation.  This puts the argument
5099 into the sequence of arguments that @samp{%o} will substitute later.
5101 @item %o
5102 Substitutes the names of all the output files, with spaces
5103 automatically placed around them.  You should write spaces
5104 around the @samp{%o} as well or the results are undefined.
5105 @samp{%o} is for use in the specs for running the linker.
5106 Input files whose names have no recognized suffix are not compiled
5107 at all, but they are included among the output files, so they will
5108 be linked.
5110 @item %O
5111 Substitutes the suffix for object files.  Note that this is
5112 handled specially when it immediately follows @samp{%g, %u, or %U},
5113 because of the need for those to form complete file names.  The
5114 handling is such that @samp{%O} is treated exactly as if it had already
5115 been substituted, except that @samp{%g, %u, and %U} do not currently
5116 support additional @var{suffix} characters following @samp{%O} as they would
5117 following, for example, @samp{.o}.
5119 @item %p
5120 Substitutes the standard macro predefinitions for the
5121 current target machine.  Use this when running @code{cpp}.
5123 @item %P
5124 Like @samp{%p}, but puts @samp{__} before and after the name of each
5125 predefined macro, except for macros that start with @samp{__} or with
5126 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5129 @item %I
5130 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5131 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5132 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5133 as necessary.
5135 @item %s
5136 Current argument is the name of a library or startup file of some sort.
5137 Search for that file in a standard list of directories and substitute
5138 the full name found.
5140 @item %e@var{str}
5141 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5142 Use this when inconsistent options are detected.
5144 @item %(@var{name})
5145 Substitute the contents of spec string @var{name} at this point.
5147 @item %[@var{name}]
5148 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5150 @item %x@{@var{option}@}
5151 Accumulate an option for @samp{%X}.
5153 @item %X
5154 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5155 spec string.
5157 @item %Y
5158 Output the accumulated assembler options specified by @option{-Wa}.
5160 @item %Z
5161 Output the accumulated preprocessor options specified by @option{-Wp}.
5163 @item %v1
5164 Substitute the major version number of GCC@.
5165 (For version 2.9.5, this is 2.)
5167 @item %v2
5168 Substitute the minor version number of GCC@.
5169 (For version 2.9.5, this is 9.)
5171 @item %v3
5172 Substitute the patch level number of GCC@.
5173 (For version 2.9.5, this is 5.)
5175 @item %a
5176 Process the @code{asm} spec.  This is used to compute the
5177 switches to be passed to the assembler.
5179 @item %A
5180 Process the @code{asm_final} spec.  This is a spec string for
5181 passing switches to an assembler post-processor, if such a program is
5182 needed.
5184 @item %l
5185 Process the @code{link} spec.  This is the spec for computing the
5186 command line passed to the linker.  Typically it will make use of the
5187 @samp{%L %G %S %D and %E} sequences.
5189 @item %D
5190 Dump out a @option{-L} option for each directory that GCC believes might
5191 contain startup files.  If the target supports multilibs then the
5192 current multilib directory will be prepended to each of these paths.
5194 @item %M
5195 Output the multilib directory with directory separators replaced with
5196 @samp{_}.  If multilib directories are not set, or the multilib directory is
5197 @file{.} then this option emits nothing.
5199 @item %L
5200 Process the @code{lib} spec.  This is a spec string for deciding which
5201 libraries should be included on the command line to the linker.
5203 @item %G
5204 Process the @code{libgcc} spec.  This is a spec string for deciding
5205 which GCC support library should be included on the command line to the linker.
5207 @item %S
5208 Process the @code{startfile} spec.  This is a spec for deciding which
5209 object files should be the first ones passed to the linker.  Typically
5210 this might be a file named @file{crt0.o}.
5212 @item %E
5213 Process the @code{endfile} spec.  This is a spec string that specifies
5214 the last object files that will be passed to the linker.
5216 @item %C
5217 Process the @code{cpp} spec.  This is used to construct the arguments
5218 to be passed to the C preprocessor.
5220 @item %c
5221 Process the @code{signed_char} spec.  This is intended to be used
5222 to tell cpp whether a char is signed.  It typically has the definition:
5223 @smallexample
5224 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5225 @end smallexample
5227 @item %1
5228 Process the @code{cc1} spec.  This is used to construct the options to be
5229 passed to the actual C compiler (@samp{cc1}).
5231 @item %2
5232 Process the @code{cc1plus} spec.  This is used to construct the options to be
5233 passed to the actual C++ compiler (@samp{cc1plus}).
5235 @item %*
5236 Substitute the variable part of a matched option.  See below.
5237 Note that each comma in the substituted string is replaced by
5238 a single space.
5240 @item %<@code{S}
5241 Remove all occurrences of @code{-S} from the command line.  Note---this
5242 command is position dependent.  @samp{%} commands in the spec string
5243 before this one will see @code{-S}, @samp{%} commands in the spec string
5244 after this one will not.
5246 @item %:@var{function}(@var{args})
5247 Call the named function @var{function}, passing it @var{args}.
5248 @var{args} is first processed as a nested spec string, then split
5249 into an argument vector in the usual fashion.  The function returns
5250 a string which is processed as if it had appeared literally as part
5251 of the current spec.
5253 The following built-in spec functions are provided:
5255 @table @code
5256 @item @code{if-exists}
5257 The @code{if-exists} spec function takes one argument, an absolute
5258 pathname to a file.  If the file exists, @code{if-exists} returns the
5259 pathname.  Here is a small example of its usage:
5261 @smallexample
5262 *startfile:
5263 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5264 @end smallexample
5266 @item @code{if-exists-else}
5267 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5268 spec function, except that it takes two arguments.  The first argument is
5269 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5270 returns the pathname.  If it does not exist, it returns the second argument.
5271 This way, @code{if-exists-else} can be used to select one file or another,
5272 based on the existence of the first.  Here is a small example of its usage:
5274 @smallexample 
5275 *startfile:
5276 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5277 @end smallexample
5278 @end table 
5280 @item %@{@code{S}@}
5281 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5282 If that switch was not specified, this substitutes nothing.  Note that
5283 the leading dash is omitted when specifying this option, and it is
5284 automatically inserted if the substitution is performed.  Thus the spec
5285 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5286 and would output the command line option @option{-foo}.
5288 @item %W@{@code{S}@}
5289 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5290 deleted on failure.
5292 @item %@{@code{S}*@}
5293 Substitutes all the switches specified to GCC whose names start
5294 with @code{-S}, but which also take an argument.  This is used for
5295 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5296 GCC considers @option{-o foo} as being
5297 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5298 text, including the space.  Thus two arguments would be generated.
5300 @item %@{@code{S}*&@code{T}*@}
5301 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5302 (the order of @code{S} and @code{T} in the spec is not significant).
5303 There can be any number of ampersand-separated variables; for each the
5304 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5306 @item %@{@code{S}:@code{X}@}
5307 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5309 @item %@{!@code{S}:@code{X}@}
5310 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5312 @item %@{@code{S}*:@code{X}@}
5313 Substitutes @code{X} if one or more switches whose names start with
5314 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5315 once, no matter how many such switches appeared.  However, if @code{%*}
5316 appears somewhere in @code{X}, then @code{X} will be substituted once
5317 for each matching switch, with the @code{%*} replaced by the part of
5318 that switch that matched the @code{*}.
5320 @item %@{.@code{S}:@code{X}@}
5321 Substitutes @code{X}, if processing a file with suffix @code{S}.
5323 @item %@{!.@code{S}:@code{X}@}
5324 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5326 @item %@{@code{S}|@code{P}:@code{X}@}
5327 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5328 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5329 although they have a stronger binding than the @samp{|}.  If @code{%*}
5330 appears in @code{X}, all of the alternatives must be starred, and only
5331 the first matching alternative is substituted.
5333 For example, a spec string like this:
5335 @smallexample
5336 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5337 @end smallexample
5339 will output the following command-line options from the following input
5340 command-line options:
5342 @smallexample
5343 fred.c        -foo -baz
5344 jim.d         -bar -boggle
5345 -d fred.c     -foo -baz -boggle
5346 -d jim.d      -bar -baz -boggle
5347 @end smallexample
5349 @item %@{S:X; T:Y; :D@}
5351 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5352 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5353 be as many clauses as you need.  This may be combined with @code{.}, 
5354 @code{!}, @code{|}, and @code{*} as needed.
5357 @end table
5359 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5360 construct may contain other nested @samp{%} constructs or spaces, or
5361 even newlines.  They are processed as usual, as described above.
5362 Trailing white space in @code{X} is ignored.  White space may also
5363 appear anywhere on the left side of the colon in these constructs,
5364 except between @code{.} or @code{*} and the corresponding word.
5366 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5367 handled specifically in these constructs.  If another value of
5368 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5369 @option{-W} switch is found later in the command line, the earlier
5370 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5371 just one letter, which passes all matching options.
5373 The character @samp{|} at the beginning of the predicate text is used to
5374 indicate that a command should be piped to the following command, but
5375 only if @option{-pipe} is specified.
5377 It is built into GCC which switches take arguments and which do not.
5378 (You might think it would be useful to generalize this to allow each
5379 compiler's spec to say which switches take arguments.  But this cannot
5380 be done in a consistent fashion.  GCC cannot even decide which input
5381 files have been specified without knowing which switches take arguments,
5382 and it must know which input files to compile in order to tell which
5383 compilers to run).
5385 GCC also knows implicitly that arguments starting in @option{-l} are to be
5386 treated as compiler output files, and passed to the linker in their
5387 proper position among the other output files.
5389 @c man begin OPTIONS
5391 @node Target Options
5392 @section Specifying Target Machine and Compiler Version
5393 @cindex target options
5394 @cindex cross compiling
5395 @cindex specifying machine version
5396 @cindex specifying compiler version and target machine
5397 @cindex compiler version, specifying
5398 @cindex target machine, specifying
5400 The usual way to run GCC is to run the executable called @file{gcc}, or
5401 @file{<machine>-gcc} when cross-compiling, or
5402 @file{<machine>-gcc-<version>} to run a version other than the one that
5403 was installed last.  Sometimes this is inconvenient, so GCC provides
5404 options that will switch to another cross-compiler or version.
5406 @table @gcctabopt
5407 @item -b @var{machine}
5408 @opindex b
5409 The argument @var{machine} specifies the target machine for compilation.
5411 The value to use for @var{machine} is the same as was specified as the
5412 machine type when configuring GCC as a cross-compiler.  For
5413 example, if a cross-compiler was configured with @samp{configure
5414 i386v}, meaning to compile for an 80386 running System V, then you
5415 would specify @option{-b i386v} to run that cross compiler.
5417 @item -V @var{version}
5418 @opindex V
5419 The argument @var{version} specifies which version of GCC to run.
5420 This is useful when multiple versions are installed.  For example,
5421 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5422 @end table
5424 The @option{-V} and @option{-b} options work by running the
5425 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5426 use them if you can just run that directly.
5428 @node Submodel Options
5429 @section Hardware Models and Configurations
5430 @cindex submodel options
5431 @cindex specifying hardware config
5432 @cindex hardware models and configurations, specifying
5433 @cindex machine dependent options
5435 Earlier we discussed the standard option @option{-b} which chooses among
5436 different installed compilers for completely different target
5437 machines, such as VAX vs.@: 68000 vs.@: 80386.
5439 In addition, each of these target machine types can have its own
5440 special options, starting with @samp{-m}, to choose among various
5441 hardware models or configurations---for example, 68010 vs 68020,
5442 floating coprocessor or none.  A single installed version of the
5443 compiler can compile for any model or configuration, according to the
5444 options specified.
5446 Some configurations of the compiler also support additional special
5447 options, usually for compatibility with other compilers on the same
5448 platform.
5450 These options are defined by the macro @code{TARGET_SWITCHES} in the
5451 machine description.  The default for the options is also defined by
5452 that macro, which enables you to change the defaults.
5454 @menu
5455 * M680x0 Options::
5456 * M68hc1x Options::
5457 * VAX Options::
5458 * SPARC Options::
5459 * ARM Options::
5460 * MN10200 Options::
5461 * MN10300 Options::
5462 * M32R/D Options::
5463 * M88K Options::
5464 * RS/6000 and PowerPC Options::
5465 * Darwin Options::
5466 * RT Options::
5467 * MIPS Options::
5468 * i386 and x86-64 Options::
5469 * HPPA Options::
5470 * Intel 960 Options::
5471 * DEC Alpha Options::
5472 * DEC Alpha/VMS Options::
5473 * H8/300 Options::
5474 * SH Options::
5475 * System V Options::
5476 * TMS320C3x/C4x Options::
5477 * V850 Options::
5478 * ARC Options::
5479 * NS32K Options::
5480 * AVR Options::
5481 * MCore Options::
5482 * IA-64 Options::
5483 * D30V Options::
5484 * S/390 and zSeries Options::
5485 * CRIS Options::
5486 * MMIX Options::
5487 * PDP-11 Options::
5488 * Xstormy16 Options::
5489 * Xtensa Options::
5490 * FRV Options::
5491 @end menu
5493 @node M680x0 Options
5494 @subsection M680x0 Options
5495 @cindex M680x0 options
5497 These are the @samp{-m} options defined for the 68000 series.  The default
5498 values for these options depends on which style of 68000 was selected when
5499 the compiler was configured; the defaults for the most common choices are
5500 given below.
5502 @table @gcctabopt
5503 @item -m68000
5504 @itemx -mc68000
5505 @opindex m68000
5506 @opindex mc68000
5507 Generate output for a 68000.  This is the default
5508 when the compiler is configured for 68000-based systems.
5510 Use this option for microcontrollers with a 68000 or EC000 core,
5511 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5513 @item -m68020
5514 @itemx -mc68020
5515 @opindex m68020
5516 @opindex mc68020
5517 Generate output for a 68020.  This is the default
5518 when the compiler is configured for 68020-based systems.
5520 @item -m68881
5521 @opindex m68881
5522 Generate output containing 68881 instructions for floating point.
5523 This is the default for most 68020 systems unless @option{--nfp} was
5524 specified when the compiler was configured.
5526 @item -m68030
5527 @opindex m68030
5528 Generate output for a 68030.  This is the default when the compiler is
5529 configured for 68030-based systems.
5531 @item -m68040
5532 @opindex m68040
5533 Generate output for a 68040.  This is the default when the compiler is
5534 configured for 68040-based systems.
5536 This option inhibits the use of 68881/68882 instructions that have to be
5537 emulated by software on the 68040.  Use this option if your 68040 does not
5538 have code to emulate those instructions.
5540 @item -m68060
5541 @opindex m68060
5542 Generate output for a 68060.  This is the default when the compiler is
5543 configured for 68060-based systems.
5545 This option inhibits the use of 68020 and 68881/68882 instructions that
5546 have to be emulated by software on the 68060.  Use this option if your 68060
5547 does not have code to emulate those instructions.
5549 @item -mcpu32
5550 @opindex mcpu32
5551 Generate output for a CPU32.  This is the default
5552 when the compiler is configured for CPU32-based systems.
5554 Use this option for microcontrollers with a
5555 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5556 68336, 68340, 68341, 68349 and 68360.
5558 @item -m5200
5559 @opindex m5200
5560 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5561 when the compiler is configured for 520X-based systems.
5563 Use this option for microcontroller with a 5200 core, including
5564 the MCF5202, MCF5203, MCF5204 and MCF5202.
5567 @item -m68020-40
5568 @opindex m68020-40
5569 Generate output for a 68040, without using any of the new instructions.
5570 This results in code which can run relatively efficiently on either a
5571 68020/68881 or a 68030 or a 68040.  The generated code does use the
5572 68881 instructions that are emulated on the 68040.
5574 @item -m68020-60
5575 @opindex m68020-60
5576 Generate output for a 68060, without using any of the new instructions.
5577 This results in code which can run relatively efficiently on either a
5578 68020/68881 or a 68030 or a 68040.  The generated code does use the
5579 68881 instructions that are emulated on the 68060.
5581 @item -mfpa
5582 @opindex mfpa
5583 Generate output containing Sun FPA instructions for floating point.
5585 @item -msoft-float
5586 @opindex msoft-float
5587 Generate output containing library calls for floating point.
5588 @strong{Warning:} the requisite libraries are not available for all m68k
5589 targets.  Normally the facilities of the machine's usual C compiler are
5590 used, but this can't be done directly in cross-compilation.  You must
5591 make your own arrangements to provide suitable library functions for
5592 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5593 @samp{m68k-*-coff} do provide software floating point support.
5595 @item -mshort
5596 @opindex mshort
5597 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5599 @item -mnobitfield
5600 @opindex mnobitfield
5601 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5602 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5604 @item -mbitfield
5605 @opindex mbitfield
5606 Do use the bit-field instructions.  The @option{-m68020} option implies
5607 @option{-mbitfield}.  This is the default if you use a configuration
5608 designed for a 68020.
5610 @item -mrtd
5611 @opindex mrtd
5612 Use a different function-calling convention, in which functions
5613 that take a fixed number of arguments return with the @code{rtd}
5614 instruction, which pops their arguments while returning.  This
5615 saves one instruction in the caller since there is no need to pop
5616 the arguments there.
5618 This calling convention is incompatible with the one normally
5619 used on Unix, so you cannot use it if you need to call libraries
5620 compiled with the Unix compiler.
5622 Also, you must provide function prototypes for all functions that
5623 take variable numbers of arguments (including @code{printf});
5624 otherwise incorrect code will be generated for calls to those
5625 functions.
5627 In addition, seriously incorrect code will result if you call a
5628 function with too many arguments.  (Normally, extra arguments are
5629 harmlessly ignored.)
5631 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5632 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5634 @item -malign-int
5635 @itemx -mno-align-int
5636 @opindex malign-int
5637 @opindex mno-align-int
5638 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5639 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5640 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5641 Aligning variables on 32-bit boundaries produces code that runs somewhat
5642 faster on processors with 32-bit busses at the expense of more memory.
5644 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5645 align structures containing the above types  differently than
5646 most published application binary interface specifications for the m68k.
5648 @item -mpcrel
5649 @opindex mpcrel
5650 Use the pc-relative addressing mode of the 68000 directly, instead of
5651 using a global offset table.  At present, this option implies @option{-fpic},
5652 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5653 not presently supported with @option{-mpcrel}, though this could be supported for
5654 68020 and higher processors.
5656 @item -mno-strict-align
5657 @itemx -mstrict-align
5658 @opindex mno-strict-align
5659 @opindex mstrict-align
5660 Do not (do) assume that unaligned memory references will be handled by
5661 the system.
5663 @end table
5665 @node M68hc1x Options
5666 @subsection M68hc1x Options
5667 @cindex M68hc1x options
5669 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5670 microcontrollers.  The default values for these options depends on
5671 which style of microcontroller was selected when the compiler was configured;
5672 the defaults for the most common choices are given below.
5674 @table @gcctabopt
5675 @item -m6811
5676 @itemx -m68hc11
5677 @opindex m6811
5678 @opindex m68hc11
5679 Generate output for a 68HC11.  This is the default
5680 when the compiler is configured for 68HC11-based systems.
5682 @item -m6812
5683 @itemx -m68hc12
5684 @opindex m6812
5685 @opindex m68hc12
5686 Generate output for a 68HC12.  This is the default
5687 when the compiler is configured for 68HC12-based systems.
5689 @item -m68S12
5690 @itemx -m68hcs12
5691 @opindex m68S12
5692 @opindex m68hcs12
5693 Generate output for a 68HCS12.  
5695 @item -mauto-incdec
5696 @opindex mauto-incdec
5697 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5698 addressing modes.
5700 @item -minmax
5701 @itemx -nominmax
5702 @opindex minmax
5703 @opindex mnominmax
5704 Enable the use of 68HC12 min and max instructions.
5706 @item -mlong-calls
5707 @itemx -mno-long-calls
5708 @opindex mlong-calls
5709 @opindex mno-long-calls
5710 Treat all calls as being far away (near).  If calls are assumed to be
5711 far away, the compiler will use the @code{call} instruction to
5712 call a function and the @code{rtc} instruction for returning.
5714 @item -mshort
5715 @opindex mshort
5716 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5718 @item -msoft-reg-count=@var{count}
5719 @opindex msoft-reg-count
5720 Specify the number of pseudo-soft registers which are used for the
5721 code generation.  The maximum number is 32.  Using more pseudo-soft
5722 register may or may not result in better code depending on the program.
5723 The default is 4 for 68HC11 and 2 for 68HC12.
5725 @end table
5727 @node VAX Options
5728 @subsection VAX Options
5729 @cindex VAX options
5731 These @samp{-m} options are defined for the VAX:
5733 @table @gcctabopt
5734 @item -munix
5735 @opindex munix
5736 Do not output certain jump instructions (@code{aobleq} and so on)
5737 that the Unix assembler for the VAX cannot handle across long
5738 ranges.
5740 @item -mgnu
5741 @opindex mgnu
5742 Do output those jump instructions, on the assumption that you
5743 will assemble with the GNU assembler.
5745 @item -mg
5746 @opindex mg
5747 Output code for g-format floating point numbers instead of d-format.
5748 @end table
5750 @node SPARC Options
5751 @subsection SPARC Options
5752 @cindex SPARC options
5754 These @samp{-m} switches are supported on the SPARC:
5756 @table @gcctabopt
5757 @item -mno-app-regs
5758 @itemx -mapp-regs
5759 @opindex mno-app-regs
5760 @opindex mapp-regs
5761 Specify @option{-mapp-regs} to generate output using the global registers
5762 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5763 is the default.
5765 To be fully SVR4 ABI compliant at the cost of some performance loss,
5766 specify @option{-mno-app-regs}.  You should compile libraries and system
5767 software with this option.
5769 @item -mfpu
5770 @itemx -mhard-float
5771 @opindex mfpu
5772 @opindex mhard-float
5773 Generate output containing floating point instructions.  This is the
5774 default.
5776 @item -mno-fpu
5777 @itemx -msoft-float
5778 @opindex mno-fpu
5779 @opindex msoft-float
5780 Generate output containing library calls for floating point.
5781 @strong{Warning:} the requisite libraries are not available for all SPARC
5782 targets.  Normally the facilities of the machine's usual C compiler are
5783 used, but this cannot be done directly in cross-compilation.  You must make
5784 your own arrangements to provide suitable library functions for
5785 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5786 @samp{sparclite-*-*} do provide software floating point support.
5788 @option{-msoft-float} changes the calling convention in the output file;
5789 therefore, it is only useful if you compile @emph{all} of a program with
5790 this option.  In particular, you need to compile @file{libgcc.a}, the
5791 library that comes with GCC, with @option{-msoft-float} in order for
5792 this to work.
5794 @item -mhard-quad-float
5795 @opindex mhard-quad-float
5796 Generate output containing quad-word (long double) floating point
5797 instructions.
5799 @item -msoft-quad-float
5800 @opindex msoft-quad-float
5801 Generate output containing library calls for quad-word (long double)
5802 floating point instructions.  The functions called are those specified
5803 in the SPARC ABI@.  This is the default.
5805 As of this writing, there are no sparc implementations that have hardware
5806 support for the quad-word floating point instructions.  They all invoke
5807 a trap handler for one of these instructions, and then the trap handler
5808 emulates the effect of the instruction.  Because of the trap handler overhead,
5809 this is much slower than calling the ABI library routines.  Thus the
5810 @option{-msoft-quad-float} option is the default.
5812 @item -mno-flat
5813 @itemx -mflat
5814 @opindex mno-flat
5815 @opindex mflat
5816 With @option{-mflat}, the compiler does not generate save/restore instructions
5817 and will use a ``flat'' or single register window calling convention.
5818 This model uses %i7 as the frame pointer and is compatible with the normal
5819 register window model.  Code from either may be intermixed.
5820 The local registers and the input registers (0--5) are still treated as
5821 ``call saved'' registers and will be saved on the stack as necessary.
5823 With @option{-mno-flat} (the default), the compiler emits save/restore
5824 instructions (except for leaf functions) and is the normal mode of operation.
5826 @item -mno-unaligned-doubles
5827 @itemx -munaligned-doubles
5828 @opindex mno-unaligned-doubles
5829 @opindex munaligned-doubles
5830 Assume that doubles have 8 byte alignment.  This is the default.
5832 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5833 alignment only if they are contained in another type, or if they have an
5834 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5835 Specifying this option avoids some rare compatibility problems with code
5836 generated by other compilers.  It is not the default because it results
5837 in a performance loss, especially for floating point code.
5839 @item -mno-faster-structs
5840 @itemx -mfaster-structs
5841 @opindex mno-faster-structs
5842 @opindex mfaster-structs
5843 With @option{-mfaster-structs}, the compiler assumes that structures
5844 should have 8 byte alignment.  This enables the use of pairs of
5845 @code{ldd} and @code{std} instructions for copies in structure
5846 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5847 However, the use of this changed alignment directly violates the SPARC
5848 ABI@.  Thus, it's intended only for use on targets where the developer
5849 acknowledges that their resulting code will not be directly in line with
5850 the rules of the ABI@.
5852 @item -mv8
5853 @itemx -msparclite
5854 @opindex mv8
5855 @opindex msparclite
5856 These two options select variations on the SPARC architecture.
5858 By default (unless specifically configured for the Fujitsu SPARClite),
5859 GCC generates code for the v7 variant of the SPARC architecture.
5861 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5862 code is that the compiler emits the integer multiply and integer
5863 divide instructions which exist in SPARC v8 but not in SPARC v7.
5865 @option{-msparclite} will give you SPARClite code.  This adds the integer
5866 multiply, integer divide step and scan (@code{ffs}) instructions which
5867 exist in SPARClite but not in SPARC v7.
5869 These options are deprecated and will be deleted in a future GCC release.
5870 They have been replaced with @option{-mcpu=xxx}.
5872 @item -mcypress
5873 @itemx -msupersparc
5874 @opindex mcypress
5875 @opindex msupersparc
5876 These two options select the processor for which the code is optimized.
5878 With @option{-mcypress} (the default), the compiler optimizes code for the
5879 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5880 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5882 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5883 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5884 of the full SPARC v8 instruction set.
5886 These options are deprecated and will be deleted in a future GCC release.
5887 They have been replaced with @option{-mcpu=xxx}.
5889 @item -mcpu=@var{cpu_type}
5890 @opindex mcpu
5891 Set the instruction set, register set, and instruction scheduling parameters
5892 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5893 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5894 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5895 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5896 @samp{ultrasparc3}.
5898 Default instruction scheduling parameters are used for values that select
5899 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5900 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5902 Here is a list of each supported architecture and their supported
5903 implementations.
5905 @smallexample
5906     v7:             cypress
5907     v8:             supersparc, hypersparc
5908     sparclite:      f930, f934, sparclite86x
5909     sparclet:       tsc701
5910     v9:             ultrasparc, ultrasparc3
5911 @end smallexample
5913 @item -mtune=@var{cpu_type}
5914 @opindex mtune
5915 Set the instruction scheduling parameters for machine type
5916 @var{cpu_type}, but do not set the instruction set or register set that the
5917 option @option{-mcpu=@var{cpu_type}} would.
5919 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5920 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5921 that select a particular cpu implementation.  Those are @samp{cypress},
5922 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5923 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
5924 @samp{ultrasparc3}.
5926 @end table
5928 These @samp{-m} switches are supported in addition to the above
5929 on the SPARCLET processor.
5931 @table @gcctabopt
5932 @item -mlittle-endian
5933 @opindex mlittle-endian
5934 Generate code for a processor running in little-endian mode.
5936 @item -mlive-g0
5937 @opindex mlive-g0
5938 Treat register @code{%g0} as a normal register.
5939 GCC will continue to clobber it as necessary but will not assume
5940 it always reads as 0.
5942 @item -mbroken-saverestore
5943 @opindex mbroken-saverestore
5944 Generate code that does not use non-trivial forms of the @code{save} and
5945 @code{restore} instructions.  Early versions of the SPARCLET processor do
5946 not correctly handle @code{save} and @code{restore} instructions used with
5947 arguments.  They correctly handle them used without arguments.  A @code{save}
5948 instruction used without arguments increments the current window pointer
5949 but does not allocate a new stack frame.  It is assumed that the window
5950 overflow trap handler will properly handle this case as will interrupt
5951 handlers.
5952 @end table
5954 These @samp{-m} switches are supported in addition to the above
5955 on SPARC V9 processors in 64-bit environments.
5957 @table @gcctabopt
5958 @item -mlittle-endian
5959 @opindex mlittle-endian
5960 Generate code for a processor running in little-endian mode.
5962 @item -m32
5963 @itemx -m64
5964 @opindex m32
5965 @opindex m64
5966 Generate code for a 32-bit or 64-bit environment.
5967 The 32-bit environment sets int, long and pointer to 32 bits.
5968 The 64-bit environment sets int to 32 bits and long and pointer
5969 to 64 bits.
5971 @item -mcmodel=medlow
5972 @opindex mcmodel=medlow
5973 Generate code for the Medium/Low code model: the program must be linked
5974 in the low 32 bits of the address space.  Pointers are 64 bits.
5975 Programs can be statically or dynamically linked.
5977 @item -mcmodel=medmid
5978 @opindex mcmodel=medmid
5979 Generate code for the Medium/Middle code model: the program must be linked
5980 in the low 44 bits of the address space, the text segment must be less than
5981 2G bytes, and data segment must be within 2G of the text segment.
5982 Pointers are 64 bits.
5984 @item -mcmodel=medany
5985 @opindex mcmodel=medany
5986 Generate code for the Medium/Anywhere code model: the program may be linked
5987 anywhere in the address space, the text segment must be less than
5988 2G bytes, and data segment must be within 2G of the text segment.
5989 Pointers are 64 bits.
5991 @item -mcmodel=embmedany
5992 @opindex mcmodel=embmedany
5993 Generate code for the Medium/Anywhere code model for embedded systems:
5994 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5995 (determined at link time).  Register %g4 points to the base of the
5996 data segment.  Pointers are still 64 bits.
5997 Programs are statically linked, PIC is not supported.
5999 @item -mstack-bias
6000 @itemx -mno-stack-bias
6001 @opindex mstack-bias
6002 @opindex mno-stack-bias
6003 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6004 frame pointer if present, are offset by @minus{}2047 which must be added back
6005 when making stack frame references.
6006 Otherwise, assume no such offset is present.
6007 @end table
6009 @node ARM Options
6010 @subsection ARM Options
6011 @cindex ARM options
6013 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6014 architectures:
6016 @table @gcctabopt
6017 @item -mapcs-frame
6018 @opindex mapcs-frame
6019 Generate a stack frame that is compliant with the ARM Procedure Call
6020 Standard for all functions, even if this is not strictly necessary for
6021 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6022 with this option will cause the stack frames not to be generated for
6023 leaf functions.  The default is @option{-mno-apcs-frame}.
6025 @item -mapcs
6026 @opindex mapcs
6027 This is a synonym for @option{-mapcs-frame}.
6029 @item -mapcs-26
6030 @opindex mapcs-26
6031 Generate code for a processor running with a 26-bit program counter,
6032 and conforming to the function calling standards for the APCS 26-bit
6033 option.  This option replaces the @option{-m2} and @option{-m3} options
6034 of previous releases of the compiler.
6036 @item -mapcs-32
6037 @opindex mapcs-32
6038 Generate code for a processor running with a 32-bit program counter,
6039 and conforming to the function calling standards for the APCS 32-bit
6040 option.  This option replaces the @option{-m6} option of previous releases
6041 of the compiler.
6043 @ignore
6044 @c not currently implemented
6045 @item -mapcs-stack-check
6046 @opindex mapcs-stack-check
6047 Generate code to check the amount of stack space available upon entry to
6048 every function (that actually uses some stack space).  If there is
6049 insufficient space available then either the function
6050 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6051 called, depending upon the amount of stack space required.  The run time
6052 system is required to provide these functions.  The default is
6053 @option{-mno-apcs-stack-check}, since this produces smaller code.
6055 @c not currently implemented
6056 @item -mapcs-float
6057 @opindex mapcs-float
6058 Pass floating point arguments using the float point registers.  This is
6059 one of the variants of the APCS@.  This option is recommended if the
6060 target hardware has a floating point unit or if a lot of floating point
6061 arithmetic is going to be performed by the code.  The default is
6062 @option{-mno-apcs-float}, since integer only code is slightly increased in
6063 size if @option{-mapcs-float} is used.
6065 @c not currently implemented
6066 @item -mapcs-reentrant
6067 @opindex mapcs-reentrant
6068 Generate reentrant, position independent code.  The default is
6069 @option{-mno-apcs-reentrant}.
6070 @end ignore
6072 @item -mthumb-interwork
6073 @opindex mthumb-interwork
6074 Generate code which supports calling between the ARM and Thumb
6075 instruction sets.  Without this option the two instruction sets cannot
6076 be reliably used inside one program.  The default is
6077 @option{-mno-thumb-interwork}, since slightly larger code is generated
6078 when @option{-mthumb-interwork} is specified.
6080 @item -mno-sched-prolog
6081 @opindex mno-sched-prolog
6082 Prevent the reordering of instructions in the function prolog, or the
6083 merging of those instruction with the instructions in the function's
6084 body.  This means that all functions will start with a recognizable set
6085 of instructions (or in fact one of a choice from a small set of
6086 different function prologues), and this information can be used to
6087 locate the start if functions inside an executable piece of code.  The
6088 default is @option{-msched-prolog}.
6090 @item -mhard-float
6091 @opindex mhard-float
6092 Generate output containing floating point instructions.  This is the
6093 default.
6095 @item -msoft-float
6096 @opindex msoft-float
6097 Generate output containing library calls for floating point.
6098 @strong{Warning:} the requisite libraries are not available for all ARM
6099 targets.  Normally the facilities of the machine's usual C compiler are
6100 used, but this cannot be done directly in cross-compilation.  You must make
6101 your own arrangements to provide suitable library functions for
6102 cross-compilation.
6104 @option{-msoft-float} changes the calling convention in the output file;
6105 therefore, it is only useful if you compile @emph{all} of a program with
6106 this option.  In particular, you need to compile @file{libgcc.a}, the
6107 library that comes with GCC, with @option{-msoft-float} in order for
6108 this to work.
6110 @item -mlittle-endian
6111 @opindex mlittle-endian
6112 Generate code for a processor running in little-endian mode.  This is
6113 the default for all standard configurations.
6115 @item -mbig-endian
6116 @opindex mbig-endian
6117 Generate code for a processor running in big-endian mode; the default is
6118 to compile code for a little-endian processor.
6120 @item -mwords-little-endian
6121 @opindex mwords-little-endian
6122 This option only applies when generating code for big-endian processors.
6123 Generate code for a little-endian word order but a big-endian byte
6124 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6125 option should only be used if you require compatibility with code for
6126 big-endian ARM processors generated by versions of the compiler prior to
6127 2.8.
6129 @item -malignment-traps
6130 @opindex malignment-traps
6131 Generate code that will not trap if the MMU has alignment traps enabled.
6132 On ARM architectures prior to ARMv4, there were no instructions to
6133 access half-word objects stored in memory.  However, when reading from
6134 memory a feature of the ARM architecture allows a word load to be used,
6135 even if the address is unaligned, and the processor core will rotate the
6136 data as it is being loaded.  This option tells the compiler that such
6137 misaligned accesses will cause a MMU trap and that it should instead
6138 synthesize the access as a series of byte accesses.  The compiler can
6139 still use word accesses to load half-word data if it knows that the
6140 address is aligned to a word boundary.
6142 This option is ignored when compiling for ARM architecture 4 or later,
6143 since these processors have instructions to directly access half-word
6144 objects in memory.
6146 @item -mno-alignment-traps
6147 @opindex mno-alignment-traps
6148 Generate code that assumes that the MMU will not trap unaligned
6149 accesses.  This produces better code when the target instruction set
6150 does not have half-word memory operations (i.e.@: implementations prior to
6151 ARMv4).
6153 Note that you cannot use this option to access unaligned word objects,
6154 since the processor will only fetch one 32-bit aligned object from
6155 memory.
6157 The default setting for most targets is @option{-mno-alignment-traps}, since
6158 this produces better code when there are no half-word memory
6159 instructions available.
6161 @item -mshort-load-bytes
6162 @itemx -mno-short-load-words
6163 @opindex mshort-load-bytes
6164 @opindex mno-short-load-words
6165 These are deprecated aliases for @option{-malignment-traps}.
6167 @item -mno-short-load-bytes
6168 @itemx -mshort-load-words
6169 @opindex mno-short-load-bytes
6170 @opindex mshort-load-words
6171 This are deprecated aliases for @option{-mno-alignment-traps}.
6173 @item -mcpu=@var{name}
6174 @opindex mcpu
6175 This specifies the name of the target ARM processor.  GCC uses this name
6176 to determine what kind of instructions it can emit when generating
6177 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6178 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6179 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6180 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6181 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6182 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6183 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6184 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6185 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6186 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6188 @itemx -mtune=@var{name}
6189 @opindex mtune
6190 This option is very similar to the @option{-mcpu=} option, except that
6191 instead of specifying the actual target processor type, and hence
6192 restricting which instructions can be used, it specifies that GCC should
6193 tune the performance of the code as if the target were of the type
6194 specified in this option, but still choosing the instructions that it
6195 will generate based on the cpu specified by a @option{-mcpu=} option.
6196 For some ARM implementations better performance can be obtained by using
6197 this option.
6199 @item -march=@var{name}
6200 @opindex march
6201 This specifies the name of the target ARM architecture.  GCC uses this
6202 name to determine what kind of instructions it can emit when generating
6203 assembly code.  This option can be used in conjunction with or instead
6204 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6205 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6206 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6208 @item -mfpe=@var{number}
6209 @itemx -mfp=@var{number}
6210 @opindex mfpe
6211 @opindex mfp
6212 This specifies the version of the floating point emulation available on
6213 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6214 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6216 @item -mstructure-size-boundary=@var{n}
6217 @opindex mstructure-size-boundary
6218 The size of all structures and unions will be rounded up to a multiple
6219 of the number of bits set by this option.  Permissible values are 8 and
6220 32.  The default value varies for different toolchains.  For the COFF
6221 targeted toolchain the default value is 8.  Specifying the larger number
6222 can produce faster, more efficient code, but can also increase the size
6223 of the program.  The two values are potentially incompatible.  Code
6224 compiled with one value cannot necessarily expect to work with code or
6225 libraries compiled with the other value, if they exchange information
6226 using structures or unions.
6228 @item -mabort-on-noreturn
6229 @opindex mabort-on-noreturn
6230 Generate a call to the function @code{abort} at the end of a
6231 @code{noreturn} function.  It will be executed if the function tries to
6232 return.
6234 @item -mlong-calls
6235 @itemx -mno-long-calls
6236 @opindex mlong-calls
6237 @opindex mno-long-calls
6238 Tells the compiler to perform function calls by first loading the
6239 address of the function into a register and then performing a subroutine
6240 call on this register.  This switch is needed if the target function
6241 will lie outside of the 64 megabyte addressing range of the offset based
6242 version of subroutine call instruction.
6244 Even if this switch is enabled, not all function calls will be turned
6245 into long calls.  The heuristic is that static functions, functions
6246 which have the @samp{short-call} attribute, functions that are inside
6247 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6248 definitions have already been compiled within the current compilation
6249 unit, will not be turned into long calls.  The exception to this rule is
6250 that weak function definitions, functions with the @samp{long-call}
6251 attribute or the @samp{section} attribute, and functions that are within
6252 the scope of a @samp{#pragma long_calls} directive, will always be
6253 turned into long calls.
6255 This feature is not enabled by default.  Specifying
6256 @option{-mno-long-calls} will restore the default behavior, as will
6257 placing the function calls within the scope of a @samp{#pragma
6258 long_calls_off} directive.  Note these switches have no effect on how
6259 the compiler generates code to handle function calls via function
6260 pointers.
6262 @item -mnop-fun-dllimport
6263 @opindex mnop-fun-dllimport
6264 Disable support for the @code{dllimport} attribute.
6266 @item -msingle-pic-base
6267 @opindex msingle-pic-base
6268 Treat the register used for PIC addressing as read-only, rather than
6269 loading it in the prologue for each function.  The run-time system is
6270 responsible for initializing this register with an appropriate value
6271 before execution begins.
6273 @item -mpic-register=@var{reg}
6274 @opindex mpic-register
6275 Specify the register to be used for PIC addressing.  The default is R10
6276 unless stack-checking is enabled, when R9 is used.
6278 @item -mcirrus-fix-invalid-insns
6279 @opindex -mcirrus-fix-invalid-insns
6280 @opindex -mno-cirrus-fix-invalid-insns
6281 Insert NOPs into the instruction stream to in order to work around
6282 problems with invalid Maverick instruction combinations.  This option
6283 is only valid if the @option{-mcpu=ep9312} option has been used to
6284 enable generation of instructions for the Cirrus Maverick floating
6285 point co-processor.  This option is not enabled by default, since the
6286 problem is only present in older Maverick implemenations.  The default
6287 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6288 switch.
6290 @item -mpoke-function-name
6291 @opindex mpoke-function-name
6292 Write the name of each function into the text section, directly
6293 preceding the function prologue.  The generated code is similar to this:
6295 @smallexample
6296      t0
6297          .ascii "arm_poke_function_name", 0
6298          .align
6299      t1
6300          .word 0xff000000 + (t1 - t0)
6301      arm_poke_function_name
6302          mov     ip, sp
6303          stmfd   sp!, @{fp, ip, lr, pc@}
6304          sub     fp, ip, #4
6305 @end smallexample
6307 When performing a stack backtrace, code can inspect the value of
6308 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6309 location @code{pc - 12} and the top 8 bits are set, then we know that
6310 there is a function name embedded immediately preceding this location
6311 and has length @code{((pc[-3]) & 0xff000000)}.
6313 @item -mthumb
6314 @opindex mthumb
6315 Generate code for the 16-bit Thumb instruction set.  The default is to
6316 use the 32-bit ARM instruction set.
6318 @item -mtpcs-frame
6319 @opindex mtpcs-frame
6320 Generate a stack frame that is compliant with the Thumb Procedure Call
6321 Standard for all non-leaf functions.  (A leaf function is one that does
6322 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6324 @item -mtpcs-leaf-frame
6325 @opindex mtpcs-leaf-frame
6326 Generate a stack frame that is compliant with the Thumb Procedure Call
6327 Standard for all leaf functions.  (A leaf function is one that does
6328 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6330 @item -mcallee-super-interworking
6331 @opindex mcallee-super-interworking
6332 Gives all externally visible functions in the file being compiled an ARM
6333 instruction set header which switches to Thumb mode before executing the
6334 rest of the function.  This allows these functions to be called from
6335 non-interworking code.
6337 @item -mcaller-super-interworking
6338 @opindex mcaller-super-interworking
6339 Allows calls via function pointers (including virtual functions) to
6340 execute correctly regardless of whether the target code has been
6341 compiled for interworking or not.  There is a small overhead in the cost
6342 of executing a function pointer if this option is enabled.
6344 @end table
6346 @node MN10200 Options
6347 @subsection MN10200 Options
6348 @cindex MN10200 options
6349 These @option{-m} options are defined for Matsushita MN10200 architectures:
6350 @table @gcctabopt
6352 @item -mrelax
6353 @opindex mrelax
6354 Indicate to the linker that it should perform a relaxation optimization pass
6355 to shorten branches, calls and absolute memory addresses.  This option only
6356 has an effect when used on the command line for the final link step.
6358 This option makes symbolic debugging impossible.
6359 @end table
6361 @node MN10300 Options
6362 @subsection MN10300 Options
6363 @cindex MN10300 options
6364 These @option{-m} options are defined for Matsushita MN10300 architectures:
6366 @table @gcctabopt
6367 @item -mmult-bug
6368 @opindex mmult-bug
6369 Generate code to avoid bugs in the multiply instructions for the MN10300
6370 processors.  This is the default.
6372 @item -mno-mult-bug
6373 @opindex mno-mult-bug
6374 Do not generate code to avoid bugs in the multiply instructions for the
6375 MN10300 processors.
6377 @item -mam33
6378 @opindex mam33
6379 Generate code which uses features specific to the AM33 processor.
6381 @item -mno-am33
6382 @opindex mno-am33
6383 Do not generate code which uses features specific to the AM33 processor.  This
6384 is the default.
6386 @item -mno-crt0
6387 @opindex mno-crt0
6388 Do not link in the C run-time initialization object file.
6390 @item -mrelax
6391 @opindex mrelax
6392 Indicate to the linker that it should perform a relaxation optimization pass
6393 to shorten branches, calls and absolute memory addresses.  This option only
6394 has an effect when used on the command line for the final link step.
6396 This option makes symbolic debugging impossible.
6397 @end table
6400 @node M32R/D Options
6401 @subsection M32R/D Options
6402 @cindex M32R/D options
6404 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6406 @table @gcctabopt
6407 @item -m32rx
6408 @opindex m32rx
6409 Generate code for the M32R/X@.
6411 @item -m32r
6412 @opindex m32r
6413 Generate code for the M32R@.  This is the default.
6415 @item -mcode-model=small
6416 @opindex mcode-model=small
6417 Assume all objects live in the lower 16MB of memory (so that their addresses
6418 can be loaded with the @code{ld24} instruction), and assume all subroutines
6419 are reachable with the @code{bl} instruction.
6420 This is the default.
6422 The addressability of a particular object can be set with the
6423 @code{model} attribute.
6425 @item -mcode-model=medium
6426 @opindex mcode-model=medium
6427 Assume objects may be anywhere in the 32-bit address space (the compiler
6428 will generate @code{seth/add3} instructions to load their addresses), and
6429 assume all subroutines are reachable with the @code{bl} instruction.
6431 @item -mcode-model=large
6432 @opindex mcode-model=large
6433 Assume objects may be anywhere in the 32-bit address space (the compiler
6434 will generate @code{seth/add3} instructions to load their addresses), and
6435 assume subroutines may not be reachable with the @code{bl} instruction
6436 (the compiler will generate the much slower @code{seth/add3/jl}
6437 instruction sequence).
6439 @item -msdata=none
6440 @opindex msdata=none
6441 Disable use of the small data area.  Variables will be put into
6442 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6443 @code{section} attribute has been specified).
6444 This is the default.
6446 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6447 Objects may be explicitly put in the small data area with the
6448 @code{section} attribute using one of these sections.
6450 @item -msdata=sdata
6451 @opindex msdata=sdata
6452 Put small global and static data in the small data area, but do not
6453 generate special code to reference them.
6455 @item -msdata=use
6456 @opindex msdata=use
6457 Put small global and static data in the small data area, and generate
6458 special instructions to reference them.
6460 @item -G @var{num}
6461 @opindex G
6462 @cindex smaller data references
6463 Put global and static objects less than or equal to @var{num} bytes
6464 into the small data or bss sections instead of the normal data or bss
6465 sections.  The default value of @var{num} is 8.
6466 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6467 for this option to have any effect.
6469 All modules should be compiled with the same @option{-G @var{num}} value.
6470 Compiling with different values of @var{num} may or may not work; if it
6471 doesn't the linker will give an error message---incorrect code will not be
6472 generated.
6474 @end table
6476 @node M88K Options
6477 @subsection M88K Options
6478 @cindex M88k options
6480 These @samp{-m} options are defined for Motorola 88k architectures:
6482 @table @gcctabopt
6483 @item -m88000
6484 @opindex m88000
6485 Generate code that works well on both the m88100 and the
6486 m88110.
6488 @item -m88100
6489 @opindex m88100
6490 Generate code that works best for the m88100, but that also
6491 runs on the m88110.
6493 @item -m88110
6494 @opindex m88110
6495 Generate code that works best for the m88110, and may not run
6496 on the m88100.
6498 @item -mbig-pic
6499 @opindex mbig-pic
6500 Obsolete option to be removed from the next revision.
6501 Use @option{-fPIC}.
6503 @item -midentify-revision
6504 @opindex midentify-revision
6505 @cindex identifying source, compiler (88k)
6506 Include an @code{ident} directive in the assembler output recording the
6507 source file name, compiler name and version, timestamp, and compilation
6508 flags used.
6510 @item -mno-underscores
6511 @opindex mno-underscores
6512 @cindex underscores, avoiding (88k)
6513 In assembler output, emit symbol names without adding an underscore
6514 character at the beginning of each name.  The default is to use an
6515 underscore as prefix on each name.
6517 @item -mocs-debug-info
6518 @itemx -mno-ocs-debug-info
6519 @opindex mocs-debug-info
6520 @opindex mno-ocs-debug-info
6521 @cindex OCS (88k)
6522 @cindex debugging, 88k OCS
6523 Include (or omit) additional debugging information (about registers used
6524 in each stack frame) as specified in the 88open Object Compatibility
6525 Standard, ``OCS''@.  This extra information allows debugging of code that
6526 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6527 SVr3.2 is to include this information; other 88k configurations omit this
6528 information by default.
6530 @item -mocs-frame-position
6531 @opindex mocs-frame-position
6532 @cindex register positions in frame (88k)
6533 When emitting COFF debugging information for automatic variables and
6534 parameters stored on the stack, use the offset from the canonical frame
6535 address, which is the stack pointer (register 31) on entry to the
6536 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6537 @option{-mocs-frame-position}; other 88k configurations have the default
6538 @option{-mno-ocs-frame-position}.
6540 @item -mno-ocs-frame-position
6541 @opindex mno-ocs-frame-position
6542 @cindex register positions in frame (88k)
6543 When emitting COFF debugging information for automatic variables and
6544 parameters stored on the stack, use the offset from the frame pointer
6545 register (register 30).  When this option is in effect, the frame
6546 pointer is not eliminated when debugging information is selected by the
6547 -g switch.
6549 @item -moptimize-arg-area
6550 @opindex moptimize-arg-area
6551 @cindex arguments in frame (88k)
6552 Save space by reorganizing the stack frame.  This option generates code
6553 that does not agree with the 88open specifications, but uses less
6554 memory.
6556 @itemx -mno-optimize-arg-area
6557 @opindex mno-optimize-arg-area
6558 Do not reorganize the stack frame to save space.  This is the default.
6559 The generated conforms to the specification, but uses more memory.
6561 @item -mshort-data-@var{num}
6562 @opindex mshort-data
6563 @cindex smaller data references (88k)
6564 @cindex r0-relative references (88k)
6565 Generate smaller data references by making them relative to @code{r0},
6566 which allows loading a value using a single instruction (rather than the
6567 usual two).  You control which data references are affected by
6568 specifying @var{num} with this option.  For example, if you specify
6569 @option{-mshort-data-512}, then the data references affected are those
6570 involving displacements of less than 512 bytes.
6571 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6572 than 64k.
6574 @item -mserialize-volatile
6575 @opindex mserialize-volatile
6576 @itemx -mno-serialize-volatile
6577 @opindex mno-serialize-volatile
6578 @cindex sequential consistency on 88k
6579 Do, or don't, generate code to guarantee sequential consistency
6580 of volatile memory references.  By default, consistency is
6581 guaranteed.
6583 The order of memory references made by the MC88110 processor does
6584 not always match the order of the instructions requesting those
6585 references.  In particular, a load instruction may execute before
6586 a preceding store instruction.  Such reordering violates
6587 sequential consistency of volatile memory references, when there
6588 are multiple processors.   When consistency must be guaranteed,
6589 GCC generates special instructions, as needed, to force
6590 execution in the proper order.
6592 The MC88100 processor does not reorder memory references and so
6593 always provides sequential consistency.  However, by default, GCC
6594 generates the special instructions to guarantee consistency
6595 even when you use @option{-m88100}, so that the code may be run on an
6596 MC88110 processor.  If you intend to run your code only on the
6597 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6599 The extra code generated to guarantee consistency may affect the
6600 performance of your application.  If you know that you can safely
6601 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6603 @item -msvr4
6604 @itemx -msvr3
6605 @opindex msvr4
6606 @opindex msvr3
6607 @cindex assembler syntax, 88k
6608 @cindex SVr4
6609 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6610 related to System V release 4 (SVr4).  This controls the following:
6612 @enumerate
6613 @item
6614 Which variant of the assembler syntax to emit.
6615 @item
6616 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6617 that is used on System V release 4.
6618 @item
6619 @option{-msvr4} makes GCC issue additional declaration directives used in
6620 SVr4.
6621 @end enumerate
6623 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6624 @option{-msvr3} is the default for all other m88k configurations.
6626 @item -mversion-03.00
6627 @opindex mversion-03.00
6628 This option is obsolete, and is ignored.
6629 @c ??? which asm syntax better for GAS?  option there too?
6631 @item -mno-check-zero-division
6632 @itemx -mcheck-zero-division
6633 @opindex mno-check-zero-division
6634 @opindex mcheck-zero-division
6635 @cindex zero division on 88k
6636 Do, or don't, generate code to guarantee that integer division by
6637 zero will be detected.  By default, detection is guaranteed.
6639 Some models of the MC88100 processor fail to trap upon integer
6640 division by zero under certain conditions.  By default, when
6641 compiling code that might be run on such a processor, GCC
6642 generates code that explicitly checks for zero-valued divisors
6643 and traps with exception number 503 when one is detected.  Use of
6644 @option{-mno-check-zero-division} suppresses such checking for code
6645 generated to run on an MC88100 processor.
6647 GCC assumes that the MC88110 processor correctly detects all instances
6648 of integer division by zero.  When @option{-m88110} is specified, no
6649 explicit checks for zero-valued divisors are generated, and both
6650 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6651 ignored.
6653 @item -muse-div-instruction
6654 @opindex muse-div-instruction
6655 @cindex divide instruction, 88k
6656 Use the div instruction for signed integer division on the
6657 MC88100 processor.  By default, the div instruction is not used.
6659 On the MC88100 processor the signed integer division instruction
6660 div) traps to the operating system on a negative operand.  The
6661 operating system transparently completes the operation, but at a
6662 large cost in execution time.  By default, when compiling code
6663 that might be run on an MC88100 processor, GCC emulates signed
6664 integer division using the unsigned integer division instruction
6665 divu), thereby avoiding the large penalty of a trap to the
6666 operating system.  Such emulation has its own, smaller, execution
6667 cost in both time and space.  To the extent that your code's
6668 important signed integer division operations are performed on two
6669 nonnegative operands, it may be desirable to use the div
6670 instruction directly.
6672 On the MC88110 processor the div instruction (also known as the
6673 divs instruction) processes negative operands without trapping to
6674 the operating system.  When @option{-m88110} is specified,
6675 @option{-muse-div-instruction} is ignored, and the div instruction is used
6676 for signed integer division.
6678 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6679 particular, the behavior of such a division with and without
6680 @option{-muse-div-instruction} may differ.
6682 @item -mtrap-large-shift
6683 @itemx -mhandle-large-shift
6684 @opindex mtrap-large-shift
6685 @opindex mhandle-large-shift
6686 @cindex bit shift overflow (88k)
6687 @cindex large bit shifts (88k)
6688 Include code to detect bit-shifts of more than 31 bits; respectively,
6689 trap such shifts or emit code to handle them properly.  By default GCC
6690 makes no special provision for large bit shifts.
6692 @item -mwarn-passed-structs
6693 @opindex mwarn-passed-structs
6694 @cindex structure passing (88k)
6695 Warn when a function passes a struct as an argument or result.
6696 Structure-passing conventions have changed during the evolution of the C
6697 language, and are often the source of portability problems.  By default,
6698 GCC issues no such warning.
6699 @end table
6701 @c break page here to avoid unsightly interparagraph stretch.
6702 @c -zw, 2001-8-17
6703 @page
6705 @node RS/6000 and PowerPC Options
6706 @subsection IBM RS/6000 and PowerPC Options
6707 @cindex RS/6000 and PowerPC Options
6708 @cindex IBM RS/6000 and PowerPC Options
6710 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6711 @table @gcctabopt
6712 @item -mpower
6713 @itemx -mno-power
6714 @itemx -mpower2
6715 @itemx -mno-power2
6716 @itemx -mpowerpc
6717 @itemx -mno-powerpc
6718 @itemx -mpowerpc-gpopt
6719 @itemx -mno-powerpc-gpopt
6720 @itemx -mpowerpc-gfxopt
6721 @itemx -mno-powerpc-gfxopt
6722 @itemx -mpowerpc64
6723 @itemx -mno-powerpc64
6724 @opindex mpower
6725 @opindex mno-power
6726 @opindex mpower2
6727 @opindex mno-power2
6728 @opindex mpowerpc
6729 @opindex mno-powerpc
6730 @opindex mpowerpc-gpopt
6731 @opindex mno-powerpc-gpopt
6732 @opindex mpowerpc-gfxopt
6733 @opindex mno-powerpc-gfxopt
6734 @opindex mpowerpc64
6735 @opindex mno-powerpc64
6736 GCC supports two related instruction set architectures for the
6737 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6738 instructions supported by the @samp{rios} chip set used in the original
6739 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6740 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6741 the IBM 4xx microprocessors.
6743 Neither architecture is a subset of the other.  However there is a
6744 large common subset of instructions supported by both.  An MQ
6745 register is included in processors supporting the POWER architecture.
6747 You use these options to specify which instructions are available on the
6748 processor you are using.  The default value of these options is
6749 determined when configuring GCC@.  Specifying the
6750 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6751 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6752 rather than the options listed above.
6754 The @option{-mpower} option allows GCC to generate instructions that
6755 are found only in the POWER architecture and to use the MQ register.
6756 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6757 to generate instructions that are present in the POWER2 architecture but
6758 not the original POWER architecture.
6760 The @option{-mpowerpc} option allows GCC to generate instructions that
6761 are found only in the 32-bit subset of the PowerPC architecture.
6762 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6763 GCC to use the optional PowerPC architecture instructions in the
6764 General Purpose group, including floating-point square root.  Specifying
6765 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6766 use the optional PowerPC architecture instructions in the Graphics
6767 group, including floating-point select.
6769 The @option{-mpowerpc64} option allows GCC to generate the additional
6770 64-bit instructions that are found in the full PowerPC64 architecture
6771 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6772 @option{-mno-powerpc64}.
6774 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6775 will use only the instructions in the common subset of both
6776 architectures plus some special AIX common-mode calls, and will not use
6777 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6778 permits GCC to use any instruction from either architecture and to
6779 allow use of the MQ register; specify this for the Motorola MPC601.
6781 @item -mnew-mnemonics
6782 @itemx -mold-mnemonics
6783 @opindex mnew-mnemonics
6784 @opindex mold-mnemonics
6785 Select which mnemonics to use in the generated assembler code.  With
6786 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6787 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6788 assembler mnemonics defined for the POWER architecture.  Instructions
6789 defined in only one architecture have only one mnemonic; GCC uses that
6790 mnemonic irrespective of which of these options is specified.
6792 GCC defaults to the mnemonics appropriate for the architecture in
6793 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6794 value of these option.  Unless you are building a cross-compiler, you
6795 should normally not specify either @option{-mnew-mnemonics} or
6796 @option{-mold-mnemonics}, but should instead accept the default.
6798 @item -mcpu=@var{cpu_type}
6799 @opindex mcpu
6800 Set architecture type, register usage, choice of mnemonics, and
6801 instruction scheduling parameters for machine type @var{cpu_type}.
6802 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6803 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6804 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6805 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6806 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6807 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6809 @option{-mcpu=common} selects a completely generic processor.  Code
6810 generated under this option will run on any POWER or PowerPC processor.
6811 GCC will use only the instructions in the common subset of both
6812 architectures, and will not use the MQ register.  GCC assumes a generic
6813 processor model for scheduling purposes.
6815 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6816 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6817 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6818 types, with an appropriate, generic processor model assumed for
6819 scheduling purposes.
6821 The other options specify a specific processor.  Code generated under
6822 those options will run best on that processor, and may not run at all on
6823 others.
6825 The @option{-mcpu} options automatically enable or disable other
6826 @option{-m} options as follows:
6828 @table @samp
6829 @item common
6830 @option{-mno-power}, @option{-mno-powerpc}
6832 @item power
6833 @itemx power2
6834 @itemx rios1
6835 @itemx rios2
6836 @itemx rsc
6837 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6839 @item powerpc
6840 @itemx rs64a
6841 @itemx 602
6842 @itemx 603
6843 @itemx 603e
6844 @itemx 604
6845 @itemx 620
6846 @itemx 630
6847 @itemx 740
6848 @itemx 7400
6849 @itemx 7450
6850 @itemx 750
6851 @itemx 505
6852 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6854 @item 601
6855 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6857 @item 403
6858 @itemx 821
6859 @itemx 860
6860 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6861 @end table
6863 @item -mtune=@var{cpu_type}
6864 @opindex mtune
6865 Set the instruction scheduling parameters for machine type
6866 @var{cpu_type}, but do not set the architecture type, register usage, or
6867 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6868 values for @var{cpu_type} are used for @option{-mtune} as for
6869 @option{-mcpu}.  If both are specified, the code generated will use the
6870 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6871 scheduling parameters set by @option{-mtune}.
6873 @item -maltivec
6874 @itemx -mno-altivec
6875 @opindex maltivec
6876 @opindex mno-altivec
6877 These switches enable or disable the use of built-in functions that
6878 allow access to the AltiVec instruction set.  You may also need to set
6879 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6880 enhancements.
6882 @item -mabi=spe
6883 @opindex mabi=spe
6884 Extend the current ABI with SPE ABI extensions.  This does not change
6885 the default ABI, instead it adds the SPE ABI extensions to the current
6886 ABI@.
6888 @item -mabi=no-spe
6889 @opindex mabi=no-spe
6890 Disable Booke SPE ABI extensions for the current ABI.
6892 @item -misel=@var{yes/no}
6893 @itemx -misel
6894 @opindex misel
6895 This switch enables or disables the generation of ISEL instructions.
6897 @item -mfull-toc
6898 @itemx -mno-fp-in-toc
6899 @itemx -mno-sum-in-toc
6900 @itemx -mminimal-toc
6901 @opindex mfull-toc
6902 @opindex mno-fp-in-toc
6903 @opindex mno-sum-in-toc
6904 @opindex mminimal-toc
6905 Modify generation of the TOC (Table Of Contents), which is created for
6906 every executable file.  The @option{-mfull-toc} option is selected by
6907 default.  In that case, GCC will allocate at least one TOC entry for
6908 each unique non-automatic variable reference in your program.  GCC
6909 will also place floating-point constants in the TOC@.  However, only
6910 16,384 entries are available in the TOC@.
6912 If you receive a linker error message that saying you have overflowed
6913 the available TOC space, you can reduce the amount of TOC space used
6914 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6915 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6916 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6917 generate code to calculate the sum of an address and a constant at
6918 run-time instead of putting that sum into the TOC@.  You may specify one
6919 or both of these options.  Each causes GCC to produce very slightly
6920 slower and larger code at the expense of conserving TOC space.
6922 If you still run out of space in the TOC even when you specify both of
6923 these options, specify @option{-mminimal-toc} instead.  This option causes
6924 GCC to make only one TOC entry for every file.  When you specify this
6925 option, GCC will produce code that is slower and larger but which
6926 uses extremely little TOC space.  You may wish to use this option
6927 only on files that contain less frequently executed code.
6929 @item -maix64
6930 @itemx -maix32
6931 @opindex maix64
6932 @opindex maix32
6933 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6934 @code{long} type, and the infrastructure needed to support them.
6935 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6936 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6937 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6939 @item -mxl-call
6940 @itemx -mno-xl-call
6941 @opindex mxl-call
6942 @opindex mno-xl-call
6943 On AIX, pass floating-point arguments to prototyped functions beyond the
6944 register save area (RSA) on the stack in addition to argument FPRs.  The
6945 AIX calling convention was extended but not initially documented to
6946 handle an obscure K&R C case of calling a function that takes the
6947 address of its arguments with fewer arguments than declared.  AIX XL
6948 compilers access floating point arguments which do not fit in the
6949 RSA from the stack when a subroutine is compiled without
6950 optimization.  Because always storing floating-point arguments on the
6951 stack is inefficient and rarely needed, this option is not enabled by
6952 default and only is necessary when calling subroutines compiled by AIX
6953 XL compilers without optimization.
6955 @item -mpe
6956 @opindex mpe
6957 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6958 application written to use message passing with special startup code to
6959 enable the application to run.  The system must have PE installed in the
6960 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6961 must be overridden with the @option{-specs=} option to specify the
6962 appropriate directory location.  The Parallel Environment does not
6963 support threads, so the @option{-mpe} option and the @option{-pthread}
6964 option are incompatible.
6966 @item -msoft-float
6967 @itemx -mhard-float
6968 @opindex msoft-float
6969 @opindex mhard-float
6970 Generate code that does not use (uses) the floating-point register set.
6971 Software floating point emulation is provided if you use the
6972 @option{-msoft-float} option, and pass the option to GCC when linking.
6974 @item -mmultiple
6975 @itemx -mno-multiple
6976 @opindex mmultiple
6977 @opindex mno-multiple
6978 Generate code that uses (does not use) the load multiple word
6979 instructions and the store multiple word instructions.  These
6980 instructions are generated by default on POWER systems, and not
6981 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6982 endian PowerPC systems, since those instructions do not work when the
6983 processor is in little endian mode.  The exceptions are PPC740 and
6984 PPC750 which permit the instructions usage in little endian mode.
6986 @item -mstring
6987 @itemx -mno-string
6988 @opindex mstring
6989 @opindex mno-string
6990 Generate code that uses (does not use) the load string instructions
6991 and the store string word instructions to save multiple registers and
6992 do small block moves.  These instructions are generated by default on
6993 POWER systems, and not generated on PowerPC systems.  Do not use
6994 @option{-mstring} on little endian PowerPC systems, since those
6995 instructions do not work when the processor is in little endian mode.
6996 The exceptions are PPC740 and PPC750 which permit the instructions
6997 usage in little endian mode.
6999 @item -mupdate
7000 @itemx -mno-update
7001 @opindex mupdate
7002 @opindex mno-update
7003 Generate code that uses (does not use) the load or store instructions
7004 that update the base register to the address of the calculated memory
7005 location.  These instructions are generated by default.  If you use
7006 @option{-mno-update}, there is a small window between the time that the
7007 stack pointer is updated and the address of the previous frame is
7008 stored, which means code that walks the stack frame across interrupts or
7009 signals may get corrupted data.
7011 @item -mfused-madd
7012 @itemx -mno-fused-madd
7013 @opindex mfused-madd
7014 @opindex mno-fused-madd
7015 Generate code that uses (does not use) the floating point multiply and
7016 accumulate instructions.  These instructions are generated by default if
7017 hardware floating is used.
7019 @item -mno-bit-align
7020 @itemx -mbit-align
7021 @opindex mno-bit-align
7022 @opindex mbit-align
7023 On System V.4 and embedded PowerPC systems do not (do) force structures
7024 and unions that contain bit-fields to be aligned to the base type of the
7025 bit-field.
7027 For example, by default a structure containing nothing but 8
7028 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7029 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7030 the structure would be aligned to a 1 byte boundary and be one byte in
7031 size.
7033 @item -mno-strict-align
7034 @itemx -mstrict-align
7035 @opindex mno-strict-align
7036 @opindex mstrict-align
7037 On System V.4 and embedded PowerPC systems do not (do) assume that
7038 unaligned memory references will be handled by the system.
7040 @item -mrelocatable
7041 @itemx -mno-relocatable
7042 @opindex mrelocatable
7043 @opindex mno-relocatable
7044 On embedded PowerPC systems generate code that allows (does not allow)
7045 the program to be relocated to a different address at runtime.  If you
7046 use @option{-mrelocatable} on any module, all objects linked together must
7047 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7049 @item -mrelocatable-lib
7050 @itemx -mno-relocatable-lib
7051 @opindex mrelocatable-lib
7052 @opindex mno-relocatable-lib
7053 On embedded PowerPC systems generate code that allows (does not allow)
7054 the program to be relocated to a different address at runtime.  Modules
7055 compiled with @option{-mrelocatable-lib} can be linked with either modules
7056 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7057 with modules compiled with the @option{-mrelocatable} options.
7059 @item -mno-toc
7060 @itemx -mtoc
7061 @opindex mno-toc
7062 @opindex mtoc
7063 On System V.4 and embedded PowerPC systems do not (do) assume that
7064 register 2 contains a pointer to a global area pointing to the addresses
7065 used in the program.
7067 @item -mlittle
7068 @itemx -mlittle-endian
7069 @opindex mlittle
7070 @opindex mlittle-endian
7071 On System V.4 and embedded PowerPC systems compile code for the
7072 processor in little endian mode.  The @option{-mlittle-endian} option is
7073 the same as @option{-mlittle}.
7075 @item -mbig
7076 @itemx -mbig-endian
7077 @opindex mbig
7078 @opindex mbig-endian
7079 On System V.4 and embedded PowerPC systems compile code for the
7080 processor in big endian mode.  The @option{-mbig-endian} option is
7081 the same as @option{-mbig}.
7083 @item -mcall-sysv
7084 @opindex mcall-sysv
7085 On System V.4 and embedded PowerPC systems compile code using calling
7086 conventions that adheres to the March 1995 draft of the System V
7087 Application Binary Interface, PowerPC processor supplement.  This is the
7088 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7090 @item -mcall-sysv-eabi
7091 @opindex mcall-sysv-eabi
7092 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7094 @item -mcall-sysv-noeabi
7095 @opindex mcall-sysv-noeabi
7096 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7098 @item -mcall-aix
7099 @opindex mcall-aix
7100 On System V.4 and embedded PowerPC systems compile code using calling
7101 conventions that are similar to those used on AIX@.  This is the
7102 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7104 @item -mcall-solaris
7105 @opindex mcall-solaris
7106 On System V.4 and embedded PowerPC systems compile code for the Solaris
7107 operating system.
7109 @item -mcall-linux
7110 @opindex mcall-linux
7111 On System V.4 and embedded PowerPC systems compile code for the
7112 Linux-based GNU system.
7114 @item -mcall-gnu
7115 @opindex mcall-gnu
7116 On System V.4 and embedded PowerPC systems compile code for the
7117 Hurd-based GNU system.
7119 @item -mcall-netbsd
7120 @opindex mcall-netbsd
7121 On System V.4 and embedded PowerPC systems compile code for the
7122 NetBSD operating system.
7124 @item -maix-struct-return
7125 @opindex maix-struct-return
7126 Return all structures in memory (as specified by the AIX ABI)@.
7128 @item -msvr4-struct-return
7129 @opindex msvr4-struct-return
7130 Return structures smaller than 8 bytes in registers (as specified by the
7131 SVR4 ABI)@.
7133 @item -mabi=altivec
7134 @opindex mabi=altivec
7135 Extend the current ABI with AltiVec ABI extensions.  This does not
7136 change the default ABI, instead it adds the AltiVec ABI extensions to
7137 the current ABI@.
7139 @item -mabi=no-altivec
7140 @opindex mabi=no-altivec
7141 Disable AltiVec ABI extensions for the current ABI.
7143 @item -mprototype
7144 @itemx -mno-prototype
7145 @opindex mprototype
7146 @opindex mno-prototype
7147 On System V.4 and embedded PowerPC systems assume that all calls to
7148 variable argument functions are properly prototyped.  Otherwise, the
7149 compiler must insert an instruction before every non prototyped call to
7150 set or clear bit 6 of the condition code register (@var{CR}) to
7151 indicate whether floating point values were passed in the floating point
7152 registers in case the function takes a variable arguments.  With
7153 @option{-mprototype}, only calls to prototyped variable argument functions
7154 will set or clear the bit.
7156 @item -msim
7157 @opindex msim
7158 On embedded PowerPC systems, assume that the startup module is called
7159 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7160 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7161 configurations.
7163 @item -mmvme
7164 @opindex mmvme
7165 On embedded PowerPC systems, assume that the startup module is called
7166 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7167 @file{libc.a}.
7169 @item -mads
7170 @opindex mads
7171 On embedded PowerPC systems, assume that the startup module is called
7172 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7173 @file{libc.a}.
7175 @item -myellowknife
7176 @opindex myellowknife
7177 On embedded PowerPC systems, assume that the startup module is called
7178 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7179 @file{libc.a}.
7181 @item -mvxworks
7182 @opindex mvxworks
7183 On System V.4 and embedded PowerPC systems, specify that you are
7184 compiling for a VxWorks system.
7186 @item -mwindiss
7187 @opindex mwindiss
7188 Specify that you are compiling for the WindISS simulation environment.
7190 @item -memb
7191 @opindex memb
7192 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7193 header to indicate that @samp{eabi} extended relocations are used.
7195 @item -meabi
7196 @itemx -mno-eabi
7197 @opindex meabi
7198 @opindex mno-eabi
7199 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7200 Embedded Applications Binary Interface (eabi) which is a set of
7201 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7202 means that the stack is aligned to an 8 byte boundary, a function
7203 @code{__eabi} is called to from @code{main} to set up the eabi
7204 environment, and the @option{-msdata} option can use both @code{r2} and
7205 @code{r13} to point to two separate small data areas.  Selecting
7206 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7207 do not call an initialization function from @code{main}, and the
7208 @option{-msdata} option will only use @code{r13} to point to a single
7209 small data area.  The @option{-meabi} option is on by default if you
7210 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7212 @item -msdata=eabi
7213 @opindex msdata=eabi
7214 On System V.4 and embedded PowerPC systems, put small initialized
7215 @code{const} global and static data in the @samp{.sdata2} section, which
7216 is pointed to by register @code{r2}.  Put small initialized
7217 non-@code{const} global and static data in the @samp{.sdata} section,
7218 which is pointed to by register @code{r13}.  Put small uninitialized
7219 global and static data in the @samp{.sbss} section, which is adjacent to
7220 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7221 incompatible with the @option{-mrelocatable} option.  The
7222 @option{-msdata=eabi} option also sets the @option{-memb} option.
7224 @item -msdata=sysv
7225 @opindex msdata=sysv
7226 On System V.4 and embedded PowerPC systems, put small global and static
7227 data in the @samp{.sdata} section, which is pointed to by register
7228 @code{r13}.  Put small uninitialized global and static data in the
7229 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7230 The @option{-msdata=sysv} option is incompatible with the
7231 @option{-mrelocatable} option.
7233 @item -msdata=default
7234 @itemx -msdata
7235 @opindex msdata=default
7236 @opindex msdata
7237 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7238 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7239 same as @option{-msdata=sysv}.
7241 @item -msdata-data
7242 @opindex msdata-data
7243 On System V.4 and embedded PowerPC systems, put small global and static
7244 data in the @samp{.sdata} section.  Put small uninitialized global and
7245 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7246 to address small data however.  This is the default behavior unless
7247 other @option{-msdata} options are used.
7249 @item -msdata=none
7250 @itemx -mno-sdata
7251 @opindex msdata=none
7252 @opindex mno-sdata
7253 On embedded PowerPC systems, put all initialized global and static data
7254 in the @samp{.data} section, and all uninitialized data in the
7255 @samp{.bss} section.
7257 @item -G @var{num}
7258 @opindex G
7259 @cindex smaller data references (PowerPC)
7260 @cindex .sdata/.sdata2 references (PowerPC)
7261 On embedded PowerPC systems, put global and static items less than or
7262 equal to @var{num} bytes into the small data or bss sections instead of
7263 the normal data or bss section.  By default, @var{num} is 8.  The
7264 @option{-G @var{num}} switch is also passed to the linker.
7265 All modules should be compiled with the same @option{-G @var{num}} value.
7267 @item -mregnames
7268 @itemx -mno-regnames
7269 @opindex mregnames
7270 @opindex mno-regnames
7271 On System V.4 and embedded PowerPC systems do (do not) emit register
7272 names in the assembly language output using symbolic forms.
7274 @item -mlongcall
7275 @itemx -mno-longcall
7276 @opindex mlongcall
7277 @opindex mno-longcall
7278 Default to making all function calls via pointers, so that functions
7279 which reside further than 64 megabytes (67,108,864 bytes) from the
7280 current location can be called.  This setting can be overridden by the
7281 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7283 Some linkers are capable of detecting out-of-range calls and generating
7284 glue code on the fly.  On these systems, long calls are unnecessary and
7285 generate slower code.  As of this writing, the AIX linker can do this,
7286 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7287 to the GNU linker for 32-bit PowerPC systems as well.
7289 In the future, we may cause GCC to ignore all longcall specifications
7290 when the linker is known to generate glue.
7292 @item -pthread
7293 @opindex pthread
7294 Adds support for multithreading with the @dfn{pthreads} library.
7295 This option sets flags for both the preprocessor and linker.
7297 @end table
7299 @node Darwin Options
7300 @subsection Darwin Options
7301 @cindex Darwin options
7302 @table @gcctabopt
7303 @item -all_load    
7304 @opindex all_load   
7305 Loads all members of static archive libraries.
7306 See man ld(1) for more information.
7308 @item -arch_errors_fatal
7309 @opindex arch_errors_fatal
7310 Cause the errors having to do with files that have the wrong architecture
7311 to be fatal.
7313 @item -bind_at_load
7314 @opindex bind_at_load
7315 Causes the output file to be marked such that the dynamic linker will
7316 bind all undefined references when the file is loaded or launched.
7318 @item -bundle     
7319 @opindex bundle
7320 Produce a Mach-o bundle format file.
7321 See man ld(1) for more information.
7323 @item -bundle_loader @var{executable}
7324 @opindex bundle_loader
7325 This specifies the @var{executable} that will be loading the build
7326 output file being linked. See man ld(1) for more information.
7328 @item -allowable_client  @var{client_name}
7329 @item -arch_only
7331 @item -client_name       
7332 @item -compatibility_version
7333 @item -current_version    
7334 @item -dependency-file
7335 @item -dylib_file    
7336 @item -dylinker_install_name
7337 @item -dynamic
7338 @item -dynamiclib   
7339 @item -exported_symbols_list  
7340 @item -filelist
7341 @item -flat_namespace   
7342 @item -force_cpusubtype_ALL
7343 @item -force_flat_namespace   
7344 @item -headerpad_max_install_names
7345 @item -image_base  
7346 @item -init
7347 @item -install_name
7348 @item -keep_private_externs
7349 @item -multi_module
7350 @item -multiply_defined      
7351 @item -multiply_defined_unused      
7352 @item -noall_load  
7353 @item -nomultidefs
7354 @item -noprebind     
7355 @item -noseglinkedit
7356 @item -pagezero_size    
7357 @item -prebind
7358 @item -prebind_all_twolevel_modules
7359 @item -private_bundle
7360 @item -read_only_relocs
7361 @item -sectalign  
7362 @item -sectobjectsymbols    
7363 @item -whyload
7364 @item -seg1addr 
7365 @item -sectcreate
7366 @item -sectobjectsymbols
7367 @item -sectorder
7368 @item -seg_addr_table
7369 @item -seg_addr_table_filename
7370 @item -seglinkedit
7371 @item -segprot   
7372 @item -segs_read_only_addr
7373 @item -segs_read_write_addr
7374 @item -single_module   
7375 @item -static
7376 @item -sub_library
7377 @item -sub_umbrella 
7378 @item -twolevel_namespace
7379 @item -umbrella
7380 @item -undefined
7381 @item -unexported_symbols_list
7382 @item -weak_reference_mismatches
7383 @item -whatsloaded  
7385 @opindex allowable_client
7386 @opindex arch_only    
7387 @opindex client_name
7388 @opindex compatibility_version
7389 @opindex current_version
7390 @opindex dependency-file
7391 @opindex dylib_file
7392 @opindex dylinker_install_name
7393 @opindex dynamic
7394 @opindex dynamiclib
7395 @opindex exported_symbols_list
7396 @opindex filelist  
7397 @opindex flat_namespace    
7398 @opindex force_cpusubtype_ALL
7399 @opindex force_flat_namespace
7400 @opindex headerpad_max_install_names
7401 @opindex image_base
7402 @opindex init     
7403 @opindex install_name
7404 @opindex keep_private_externs
7405 @opindex multi_module   
7406 @opindex multiply_defined
7407 @opindex multiply_defined_unused   
7408 @opindex noall_load  
7409 @opindex nomultidefs   
7410 @opindex noprebind
7411 @opindex noseglinkedit      
7412 @opindex pagezero_size
7413 @opindex prebind
7414 @opindex prebind_all_twolevel_modules
7415 @opindex private_bundle 
7416 @opindex read_only_relocs
7417 @opindex sectalign   
7418 @opindex sectobjectsymbols    
7419 @opindex whyload  
7420 @opindex seg1addr
7421 @opindex sectcreate       
7422 @opindex sectobjectsymbols 
7423 @opindex sectorder     
7424 @opindex seg_addr_table
7425 @opindex seg_addr_table_filename
7426 @opindex seglinkedit
7427 @opindex segprot
7428 @opindex segs_read_only_addr
7429 @opindex segs_read_write_addr
7430 @opindex single_module
7431 @opindex static
7432 @opindex sub_library
7433 @opindex sub_umbrella
7434 @opindex twolevel_namespace
7435 @opindex umbrella
7436 @opindex undefined
7437 @opindex unexported_symbols_list
7438 @opindex weak_reference_mismatches
7439 @opindex whatsloaded
7441 This options are available for Darwin linker. Darwin linker man page
7442 describes them in detail.
7443 @end table
7446 @node RT Options
7447 @subsection IBM RT Options
7448 @cindex RT options
7449 @cindex IBM RT options
7451 These @samp{-m} options are defined for the IBM RT PC:
7453 @table @gcctabopt
7454 @item -min-line-mul
7455 @opindex min-line-mul
7456 Use an in-line code sequence for integer multiplies.  This is the
7457 default.
7459 @item -mcall-lib-mul
7460 @opindex mcall-lib-mul
7461 Call @code{lmul$$} for integer multiples.
7463 @item -mfull-fp-blocks
7464 @opindex mfull-fp-blocks
7465 Generate full-size floating point data blocks, including the minimum
7466 amount of scratch space recommended by IBM@.  This is the default.
7468 @item -mminimum-fp-blocks
7469 @opindex mminimum-fp-blocks
7470 Do not include extra scratch space in floating point data blocks.  This
7471 results in smaller code, but slower execution, since scratch space must
7472 be allocated dynamically.
7474 @cindex @file{stdarg.h} and RT PC
7475 @item -mfp-arg-in-fpregs
7476 @opindex mfp-arg-in-fpregs
7477 Use a calling sequence incompatible with the IBM calling convention in
7478 which floating point arguments are passed in floating point registers.
7479 Note that @code{stdarg.h} will not work with floating point operands
7480 if this option is specified.
7482 @item -mfp-arg-in-gregs
7483 @opindex mfp-arg-in-gregs
7484 Use the normal calling convention for floating point arguments.  This is
7485 the default.
7487 @item -mhc-struct-return
7488 @opindex mhc-struct-return
7489 Return structures of more than one word in memory, rather than in a
7490 register.  This provides compatibility with the MetaWare HighC (hc)
7491 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7492 with the Portable C Compiler (pcc).
7494 @item -mnohc-struct-return
7495 @opindex mnohc-struct-return
7496 Return some structures of more than one word in registers, when
7497 convenient.  This is the default.  For compatibility with the
7498 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7499 option @option{-mhc-struct-return}.
7500 @end table
7502 @node MIPS Options
7503 @subsection MIPS Options
7504 @cindex MIPS options
7506 These @samp{-m} options are defined for the MIPS family of computers:
7508 @table @gcctabopt
7510 @item -march=@var{arch}
7511 @opindex march
7512 Generate code that will run on @var{arch}, which can be the name of a
7513 generic MIPS ISA, or the name of a particular processor.
7514 The ISA names are:
7515 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7516 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7517 The processor names are:
7518 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7519 @samp{m4k},
7520 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7521 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7522 @samp{orion},
7523 @samp{sb1},
7524 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7525 The special value @samp{from-abi} selects the
7526 most compatible architecture for the selected ABI (that is,
7527 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7529 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7530 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7531 @samp{vr} may be written @samp{r}.
7533 GCC defines two macros based on the value of this option.  The first
7534 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7535 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7536 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7537 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7538 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7540 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7541 above.  In other words, it will have the full prefix and will not
7542 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7543 the macro names the resolved architecture (either @samp{"mips1"} or
7544 @samp{"mips3"}).  It names the default architecture when no
7545 @option{-march} option is given.
7547 @item -mtune=@var{arch}
7548 @opindex mtune
7549 Optimize for @var{arch}.  Among other things, this option controls
7550 the way instructions are scheduled, and the perceived cost of arithmetic
7551 operations.  The list of @var{arch} values is the same as for
7552 @option{-march}.
7554 When this option is not used, GCC will optimize for the processor
7555 specified by @option{-march}.  By using @option{-march} and
7556 @option{-mtune} together, it is possible to generate code that will
7557 run on a family of processors, but optimize the code for one
7558 particular member of that family.
7560 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7561 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7562 @samp{-march} ones described above.
7564 @item -mips1
7565 @opindex mips1
7566 Equivalent to @samp{-march=mips1}.
7568 @item -mips2
7569 @opindex mips2
7570 Equivalent to @samp{-march=mips2}.
7572 @item -mips3
7573 @opindex mips3
7574 Equivalent to @samp{-march=mips3}.
7576 @item -mips4
7577 @opindex mips4
7578 Equivalent to @samp{-march=mips4}.
7580 @item -mips32
7581 @opindex mips32
7582 Equivalent to @samp{-march=mips32}.
7584 @item -mips32r2
7585 @opindex mips32r2
7586 Equivalent to @samp{-march=mips32r2}.
7588 @item -mips64
7589 @opindex mips64
7590 Equivalent to @samp{-march=mips64}.
7592 @item -mfused-madd
7593 @itemx -mno-fused-madd
7594 @opindex mfused-madd
7595 @opindex mno-fused-madd
7596 Generate code that uses (does not use) the floating point multiply and
7597 accumulate instructions, when they are available.  These instructions
7598 are generated by default if they are available, but this may be
7599 undesirable if the extra precision causes problems or on certain chips
7600 in the mode where denormals are rounded to zero where denormals
7601 generated by multiply and accumulate instructions cause exceptions
7602 anyway.
7604 @item -mfp32
7605 @opindex mfp32
7606 Assume that floating point registers are 32 bits wide.
7608 @item -mfp64
7609 @opindex mfp64
7610 Assume that floating point registers are 64 bits wide.
7612 @item -mgp32
7613 @opindex mgp32
7614 Assume that general purpose registers are 32 bits wide.
7616 @item -mgp64
7617 @opindex mgp64
7618 Assume that general purpose registers are 64 bits wide.
7620 @item -mint64
7621 @opindex mint64
7622 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7623 explanation of the default, and the width of pointers.
7625 @item -mlong64
7626 @opindex mlong64
7627 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7628 explanation of the default, and the width of pointers.
7630 @item -mlong32
7631 @opindex mlong32
7632 Force long, int, and pointer types to be 32 bits wide.
7634 The default size of ints, longs and pointers depends on the ABI@.  All
7635 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7636 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7637 are the same size as longs, or the same size as integer registers,
7638 whichever is smaller.
7640 @item -mabi=32
7641 @itemx -mabi=o64
7642 @itemx -mabi=n32
7643 @itemx -mabi=64
7644 @itemx -mabi=eabi
7645 @itemx -mabi=meabi
7646 @opindex mabi=32
7647 @opindex mabi=o64
7648 @opindex mabi=n32
7649 @opindex mabi=64
7650 @opindex mabi=eabi
7651 @opindex mabi=meabi
7652 Generate code for the given ABI@.
7654 Note that there are two embedded ABIs: @option{-mabi=eabi}
7655 selects the one defined by Cygnus while @option{-meabi=meabi}
7656 selects the one defined by MIPS@.  Both these ABIs have
7657 32-bit and 64-bit variants.  Normally, GCC will generate
7658 64-bit code when you select a 64-bit architecture, but you
7659 can use @option{-mgp32} to get 32-bit code instead.
7661 @item -mabi-fake-default
7662 @opindex mabi-fake-default
7663 You don't want to know what this option does.  No, really.  I mean
7664 it.  Move on to the next option.
7666 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7667 wants the default set of options to get the root of the multilib tree,
7668 and the shared library SONAMEs without any multilib-indicating
7669 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7670 we want to default to the N32 ABI, while still being binary-compatible
7671 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7672 binary-compatible means shared libraries should have the same SONAMEs,
7673 and libraries should live in the same location.  Having O32 libraries
7674 in a sub-directory named say @file{o32} is not acceptable.
7676 So we trick GCC into believing that O32 is the default ABI, except
7677 that we override the default with some internal command-line
7678 processing magic.  Problem is, if we stopped at that, and you then
7679 created a multilib-aware package that used the output of @command{gcc
7680 -print-multi-lib} to decide which multilibs to build, and how, and
7681 you'd find yourself in an awkward situation when you found out that
7682 some of the options listed ended up mapping to the same multilib, and
7683 none of your libraries was actually built for the multilib that
7684 @option{-print-multi-lib} claims to be the default.  So we added this
7685 option that disables the default switcher, falling back to GCC's
7686 original notion of the default library.  Confused yet?
7688 For short: don't ever use this option, unless you find it in the list
7689 of additional options to be used when building for multilibs, in the
7690 output of @option{gcc -print-multi-lib}.
7692 @item -mmips-as
7693 @opindex mmips-as
7694 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7695 add normal debug information.  This is the default for all
7696 platforms except for the OSF/1 reference platform, using the OSF/rose
7697 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7698 switches are used, the @file{mips-tfile} program will encapsulate the
7699 stabs within MIPS ECOFF@.
7701 @item -mgas
7702 @opindex mgas
7703 Generate code for the GNU assembler.  This is the default on the OSF/1
7704 reference platform, using the OSF/rose object format.  Also, this is
7705 the default if the configure option @option{--with-gnu-as} is used.
7707 @item -msplit-addresses
7708 @itemx -mno-split-addresses
7709 @opindex msplit-addresses
7710 @opindex mno-split-addresses
7711 Generate code to load the high and low parts of address constants separately.
7712 This allows GCC to optimize away redundant loads of the high order
7713 bits of addresses.  This optimization requires GNU as and GNU ld.
7714 This optimization is enabled by default for some embedded targets where
7715 GNU as and GNU ld are standard.
7717 @item -mrnames
7718 @itemx -mno-rnames
7719 @opindex mrnames
7720 @opindex mno-rnames
7721 The @option{-mrnames} switch says to output code using the MIPS software
7722 names for the registers, instead of the hardware names (ie, @var{a0}
7723 instead of @var{$4}).  The only known assembler that supports this option
7724 is the Algorithmics assembler.
7726 @item -mgpopt
7727 @itemx -mno-gpopt
7728 @opindex mgpopt
7729 @opindex mno-gpopt
7730 The @option{-mgpopt} switch says to write all of the data declarations
7731 before the instructions in the text section, this allows the MIPS
7732 assembler to generate one word memory references instead of using two
7733 words for short global or static data items.  This is on by default if
7734 optimization is selected.
7736 @item -mstats
7737 @itemx -mno-stats
7738 @opindex mstats
7739 @opindex mno-stats
7740 For each non-inline function processed, the @option{-mstats} switch
7741 causes the compiler to emit one line to the standard error file to
7742 print statistics about the program (number of registers saved, stack
7743 size, etc.).
7745 @item -mmemcpy
7746 @itemx -mno-memcpy
7747 @opindex mmemcpy
7748 @opindex mno-memcpy
7749 The @option{-mmemcpy} switch makes all block moves call the appropriate
7750 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7751 generating inline code.
7753 @item -mmips-tfile
7754 @itemx -mno-mips-tfile
7755 @opindex mmips-tfile
7756 @opindex mno-mips-tfile
7757 The @option{-mno-mips-tfile} switch causes the compiler not
7758 postprocess the object file with the @file{mips-tfile} program,
7759 after the MIPS assembler has generated it to add debug support.  If
7760 @file{mips-tfile} is not run, then no local variables will be
7761 available to the debugger.  In addition, @file{stage2} and
7762 @file{stage3} objects will have the temporary file names passed to the
7763 assembler embedded in the object file, which means the objects will
7764 not compare the same.  The @option{-mno-mips-tfile} switch should only
7765 be used when there are bugs in the @file{mips-tfile} program that
7766 prevents compilation.
7768 @item -msoft-float
7769 @opindex msoft-float
7770 Generate output containing library calls for floating point.
7771 @strong{Warning:} the requisite libraries are not part of GCC@.
7772 Normally the facilities of the machine's usual C compiler are used, but
7773 this can't be done directly in cross-compilation.  You must make your
7774 own arrangements to provide suitable library functions for
7775 cross-compilation.
7777 @item -mhard-float
7778 @opindex mhard-float
7779 Generate output containing floating point instructions.  This is the
7780 default if you use the unmodified sources.
7782 @item -mabicalls
7783 @itemx -mno-abicalls
7784 @opindex mabicalls
7785 @opindex mno-abicalls
7786 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7787 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7788 position independent code.
7790 @item -mlong-calls
7791 @itemx -mno-long-calls
7792 @opindex mlong-calls
7793 @opindex mno-long-calls
7794 Do all calls with the @samp{JALR} instruction, which requires
7795 loading up a function's address into a register before the call.
7796 You need to use this switch, if you call outside of the current
7797 512 megabyte segment to functions that are not through pointers.
7799 @item -mhalf-pic
7800 @itemx -mno-half-pic
7801 @opindex mhalf-pic
7802 @opindex mno-half-pic
7803 Put pointers to extern references into the data section and load them
7804 up, rather than put the references in the text section.
7806 @item -membedded-pic
7807 @itemx -mno-embedded-pic
7808 @opindex membedded-pic
7809 @opindex mno-embedded-pic
7810 Generate PIC code suitable for some embedded systems.  All calls are
7811 made using PC relative address, and all data is addressed using the $gp
7812 register.  No more than 65536 bytes of global data may be used.  This
7813 requires GNU as and GNU ld which do most of the work.  This currently
7814 only works on targets which use ECOFF; it does not work with ELF@.
7816 @item -membedded-data
7817 @itemx -mno-embedded-data
7818 @opindex membedded-data
7819 @opindex mno-embedded-data
7820 Allocate variables to the read-only data section first if possible, then
7821 next in the small data section if possible, otherwise in data.  This gives
7822 slightly slower code than the default, but reduces the amount of RAM required
7823 when executing, and thus may be preferred for some embedded systems.
7825 @item -muninit-const-in-rodata
7826 @itemx -mno-uninit-const-in-rodata
7827 @opindex muninit-const-in-rodata
7828 @opindex mno-uninit-const-in-rodata
7829 When used together with @option{-membedded-data}, it will always store uninitialized
7830 const variables in the read-only data section.
7832 @item -msingle-float
7833 @itemx -mdouble-float
7834 @opindex msingle-float
7835 @opindex mdouble-float
7836 The @option{-msingle-float} switch tells gcc to assume that the floating
7837 point coprocessor only supports single precision operations, as on the
7838 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7839 double precision operations.  This is the default.
7841 @item -mmad
7842 @itemx -mno-mad
7843 @opindex mmad
7844 @opindex mno-mad
7845 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7846 as on the @samp{r4650} chip.
7848 @item -m4650
7849 @opindex m4650
7850 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7851 @option{-mcpu=r4650}.
7853 @item -mips16
7854 @itemx -mno-mips16
7855 @opindex mips16
7856 @opindex mno-mips16
7857 Enable 16-bit instructions.
7859 @item -mentry
7860 @opindex mentry
7861 Use the entry and exit pseudo ops.  This option can only be used with
7862 @option{-mips16}.
7864 @item -EL
7865 @opindex EL
7866 Compile code for the processor in little endian mode.
7867 The requisite libraries are assumed to exist.
7869 @item -EB
7870 @opindex EB
7871 Compile code for the processor in big endian mode.
7872 The requisite libraries are assumed to exist.
7874 @item -G @var{num}
7875 @opindex G
7876 @cindex smaller data references (MIPS)
7877 @cindex gp-relative references (MIPS)
7878 Put global and static items less than or equal to @var{num} bytes into
7879 the small data or bss sections instead of the normal data or bss
7880 section.  This allows the assembler to emit one word memory reference
7881 instructions based on the global pointer (@var{gp} or @var{$28}),
7882 instead of the normal two words used.  By default, @var{num} is 8 when
7883 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7884 @option{-G @var{num}} switch is also passed to the assembler and linker.
7885 All modules should be compiled with the same @option{-G @var{num}}
7886 value.
7888 @item -nocpp
7889 @opindex nocpp
7890 Tell the MIPS assembler to not run its preprocessor over user
7891 assembler files (with a @samp{.s} suffix) when assembling them.
7893 @item -mfix7000
7894 @opindex mfix7000
7895 Pass an option to gas which will cause nops to be inserted if
7896 the read of the destination register of an mfhi or mflo instruction
7897 occurs in the following two instructions.
7899 @item -no-crt0
7900 @opindex no-crt0
7901 Do not include the default crt0.
7903 @item -mflush-func=@var{func}
7904 @itemx -mno-flush-func
7905 @opindex mflush-func
7906 Specifies the function to call to flush the I and D caches, or to not
7907 call any such function.  If called, the function must take the same
7908 arguments as the common @code{_flush_func()}, that is, the address of the
7909 memory range for which the cache is being flushed, the size of the
7910 memory range, and the number 3 (to flush both caches).  The default
7911 depends on the target gcc was configured for, but commonly is either
7912 @samp{_flush_func} or @samp{__cpu_flush}.
7914 @item -mbranch-likely
7915 @itemx -mno-branch-likely
7916 @opindex mbranch-likely
7917 @opindex mno-branch-likely
7918 Enable or disable use of Branch Likely instructions, regardless of the
7919 default for the selected architecture.  By default, Branch Likely
7920 instructions may be generated if they are supported by the selected
7921 architecture.  An exception is for the MIPS32 and MIPS64 architectures
7922 and processors which implement those architectures; for those, Branch
7923 Likely instructions will not be generated by default because the MIPS32
7924 and MIPS64 architectures specifically deprecate their use.
7925 @end table
7927 @node i386 and x86-64 Options
7928 @subsection Intel 386 and AMD x86-64 Options
7929 @cindex i386 Options
7930 @cindex x86-64 Options
7931 @cindex Intel 386 Options
7932 @cindex AMD x86-64 Options
7934 These @samp{-m} options are defined for the i386 and x86-64 family of
7935 computers:
7937 @table @gcctabopt
7938 @item -mtune=@var{cpu-type}
7939 @opindex mtune
7940 Tune to @var{cpu-type} everything applicable about the generated code, except
7941 for the ABI and the set of available instructions.  The choices for
7942 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7943 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7944 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7945 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
7946 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
7947 and @samp{c3-2}.
7949 While picking a specific @var{cpu-type} will schedule things appropriately
7950 for that particular chip, the compiler will not generate any code that
7951 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7952 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7953 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7954 AMD chips as opposed to the Intel ones.
7956 @item -march=@var{cpu-type}
7957 @opindex march
7958 Generate instructions for the machine type @var{cpu-type}.  The choices
7959 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
7960 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
7962 @item -mcpu=@var{cpu-type}
7963 @opindex mcpu
7964 A deprecated synonym for @option{-mtune}.
7966 @item -m386
7967 @itemx -m486
7968 @itemx -mpentium
7969 @itemx -mpentiumpro
7970 @opindex m386
7971 @opindex m486
7972 @opindex mpentium
7973 @opindex mpentiumpro
7974 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
7975 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
7976 These synonyms are deprecated.
7978 @item -mfpmath=@var{unit}
7979 @opindex march
7980 generate floating point arithmetics for selected unit @var{unit}.  the choices
7981 for @var{unit} are:
7983 @table @samp
7984 @item 387
7985 Use the standard 387 floating point coprocessor present majority of chips and
7986 emulated otherwise.  Code compiled with this option will run almost everywhere.
7987 The temporary results are computed in 80bit precision instead of precision
7988 specified by the type resulting in slightly different results compared to most
7989 of other chips. See @option{-ffloat-store} for more detailed description.
7991 This is the default choice for i386 compiler.
7993 @item sse
7994 Use scalar floating point instructions present in the SSE instruction set.
7995 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7996 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7997 instruction set supports only single precision arithmetics, thus the double and
7998 extended precision arithmetics is still done using 387.  Later version, present
7999 only in Pentium4 and the future AMD x86-64 chips supports double precision
8000 arithmetics too.
8002 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8003 @option{-msse2} switches to enable SSE extensions and make this option
8004 effective.  For x86-64 compiler, these extensions are enabled by default.
8006 The resulting code should be considerably faster in majority of cases and avoid
8007 the numerical instability problems of 387 code, but may break some existing
8008 code that expects temporaries to be 80bit.
8010 This is the default choice for x86-64 compiler.
8012 @item sse,387
8013 Attempt to utilize both instruction sets at once.  This effectively double the
8014 amount of available registers and on chips with separate execution units for
8015 387 and SSE the execution resources too.  Use this option with care, as it is
8016 still experimental, because gcc register allocator does not model separate
8017 functional units well resulting in instable performance.
8018 @end table
8020 @item -masm=@var{dialect}
8021 @opindex masm=@var{dialect}
8022 Output asm instructions using selected @var{dialect}. Supported choices are
8023 @samp{intel} or @samp{att} (the default one).
8025 @item -mieee-fp
8026 @itemx -mno-ieee-fp
8027 @opindex mieee-fp
8028 @opindex mno-ieee-fp
8029 Control whether or not the compiler uses IEEE floating point
8030 comparisons.  These handle correctly the case where the result of a
8031 comparison is unordered.
8033 @item -msoft-float
8034 @opindex msoft-float
8035 Generate output containing library calls for floating point.
8036 @strong{Warning:} the requisite libraries are not part of GCC@.
8037 Normally the facilities of the machine's usual C compiler are used, but
8038 this can't be done directly in cross-compilation.  You must make your
8039 own arrangements to provide suitable library functions for
8040 cross-compilation.
8042 On machines where a function returns floating point results in the 80387
8043 register stack, some floating point opcodes may be emitted even if
8044 @option{-msoft-float} is used.
8046 @item -mno-fp-ret-in-387
8047 @opindex mno-fp-ret-in-387
8048 Do not use the FPU registers for return values of functions.
8050 The usual calling convention has functions return values of types
8051 @code{float} and @code{double} in an FPU register, even if there
8052 is no FPU@.  The idea is that the operating system should emulate
8053 an FPU@.
8055 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8056 in ordinary CPU registers instead.
8058 @item -mno-fancy-math-387
8059 @opindex mno-fancy-math-387
8060 Some 387 emulators do not support the @code{sin}, @code{cos} and
8061 @code{sqrt} instructions for the 387.  Specify this option to avoid
8062 generating those instructions.  This option is the default on FreeBSD,
8063 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8064 indicates that the target cpu will always have an FPU and so the
8065 instruction will not need emulation.  As of revision 2.6.1, these
8066 instructions are not generated unless you also use the
8067 @option{-funsafe-math-optimizations} switch.
8069 @item -malign-double
8070 @itemx -mno-align-double
8071 @opindex malign-double
8072 @opindex mno-align-double
8073 Control whether GCC aligns @code{double}, @code{long double}, and
8074 @code{long long} variables on a two word boundary or a one word
8075 boundary.  Aligning @code{double} variables on a two word boundary will
8076 produce code that runs somewhat faster on a @samp{Pentium} at the
8077 expense of more memory.
8079 @strong{Warning:} if you use the @option{-malign-double} switch,
8080 structures containing the above types will be aligned differently than
8081 the published application binary interface specifications for the 386
8082 and will not be binary compatible with structures in code compiled
8083 without that switch.
8085 @item -m128bit-long-double
8086 @opindex m128bit-long-double
8087 Control the size of @code{long double} type. i386 application binary interface
8088 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8089 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8090 impossible to reach with 12 byte long doubles in the array accesses.
8092 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8093 structures and arrays containing @code{long double} will change their size as
8094 well as function calling convention for function taking @code{long double}
8095 will be modified.
8097 @item -m96bit-long-double
8098 @opindex m96bit-long-double
8099 Set the size of @code{long double} to 96 bits as required by the i386
8100 application binary interface.  This is the default.
8102 @item -msvr3-shlib
8103 @itemx -mno-svr3-shlib
8104 @opindex msvr3-shlib
8105 @opindex mno-svr3-shlib
8106 Control whether GCC places uninitialized local variables into the
8107 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8108 into @code{bss}.  These options are meaningful only on System V Release 3.
8110 @item -mrtd
8111 @opindex mrtd
8112 Use a different function-calling convention, in which functions that
8113 take a fixed number of arguments return with the @code{ret} @var{num}
8114 instruction, which pops their arguments while returning.  This saves one
8115 instruction in the caller since there is no need to pop the arguments
8116 there.
8118 You can specify that an individual function is called with this calling
8119 sequence with the function attribute @samp{stdcall}.  You can also
8120 override the @option{-mrtd} option by using the function attribute
8121 @samp{cdecl}.  @xref{Function Attributes}.
8123 @strong{Warning:} this calling convention is incompatible with the one
8124 normally used on Unix, so you cannot use it if you need to call
8125 libraries compiled with the Unix compiler.
8127 Also, you must provide function prototypes for all functions that
8128 take variable numbers of arguments (including @code{printf});
8129 otherwise incorrect code will be generated for calls to those
8130 functions.
8132 In addition, seriously incorrect code will result if you call a
8133 function with too many arguments.  (Normally, extra arguments are
8134 harmlessly ignored.)
8136 @item -mregparm=@var{num}
8137 @opindex mregparm
8138 Control how many registers are used to pass integer arguments.  By
8139 default, no registers are used to pass arguments, and at most 3
8140 registers can be used.  You can control this behavior for a specific
8141 function by using the function attribute @samp{regparm}.
8142 @xref{Function Attributes}.
8144 @strong{Warning:} if you use this switch, and
8145 @var{num} is nonzero, then you must build all modules with the same
8146 value, including any libraries.  This includes the system libraries and
8147 startup modules.
8149 @item -mpreferred-stack-boundary=@var{num}
8150 @opindex mpreferred-stack-boundary
8151 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8152 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8153 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8154 size (@option{-Os}), in which case the default is the minimum correct
8155 alignment (4 bytes for x86, and 8 bytes for x86-64).
8157 On Pentium and PentiumPro, @code{double} and @code{long double} values
8158 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8159 suffer significant run time performance penalties.  On Pentium III, the
8160 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8161 penalties if it is not 16 byte aligned.
8163 To ensure proper alignment of this values on the stack, the stack boundary
8164 must be as aligned as that required by any value stored on the stack.
8165 Further, every function must be generated such that it keeps the stack
8166 aligned.  Thus calling a function compiled with a higher preferred
8167 stack boundary from a function compiled with a lower preferred stack
8168 boundary will most likely misalign the stack.  It is recommended that
8169 libraries that use callbacks always use the default setting.
8171 This extra alignment does consume extra stack space, and generally
8172 increases code size.  Code that is sensitive to stack space usage, such
8173 as embedded systems and operating system kernels, may want to reduce the
8174 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8176 @item -mmmx
8177 @itemx -mno-mmx
8178 @item -msse
8179 @itemx -mno-sse
8180 @item -msse2
8181 @itemx -mno-sse2
8182 @item -m3dnow
8183 @itemx -mno-3dnow
8184 @opindex mmmx
8185 @opindex mno-mmx
8186 @opindex msse
8187 @opindex mno-sse
8188 @opindex m3dnow
8189 @opindex mno-3dnow
8190 These switches enable or disable the use of built-in functions that allow
8191 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8193 @xref{X86 Built-in Functions}, for details of the functions enabled
8194 and disabled by these switches.
8196 To have SSE/SSE2 instructions generated automatically from floating-point
8197 code, see @option{-mfpmath=sse}.
8199 @item -mpush-args
8200 @itemx -mno-push-args
8201 @opindex mpush-args
8202 @opindex mno-push-args
8203 Use PUSH operations to store outgoing parameters.  This method is shorter
8204 and usually equally fast as method using SUB/MOV operations and is enabled
8205 by default.  In some cases disabling it may improve performance because of
8206 improved scheduling and reduced dependencies.
8208 @item -maccumulate-outgoing-args
8209 @opindex maccumulate-outgoing-args
8210 If enabled, the maximum amount of space required for outgoing arguments will be
8211 computed in the function prologue.  This is faster on most modern CPUs
8212 because of reduced dependencies, improved scheduling and reduced stack usage
8213 when preferred stack boundary is not equal to 2.  The drawback is a notable
8214 increase in code size.  This switch implies @option{-mno-push-args}.
8216 @item -mthreads
8217 @opindex mthreads
8218 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8219 on thread-safe exception handling must compile and link all code with the
8220 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8221 @option{-D_MT}; when linking, it links in a special thread helper library
8222 @option{-lmingwthrd} which cleans up per thread exception handling data.
8224 @item -mno-align-stringops
8225 @opindex mno-align-stringops
8226 Do not align destination of inlined string operations.  This switch reduces
8227 code size and improves performance in case the destination is already aligned,
8228 but gcc don't know about it.
8230 @item -minline-all-stringops
8231 @opindex minline-all-stringops
8232 By default GCC inlines string operations only when destination is known to be
8233 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8234 size, but may improve performance of code that depends on fast memcpy, strlen
8235 and memset for short lengths.
8237 @item -momit-leaf-frame-pointer
8238 @opindex momit-leaf-frame-pointer
8239 Don't keep the frame pointer in a register for leaf functions.  This
8240 avoids the instructions to save, set up and restore frame pointers and
8241 makes an extra register available in leaf functions.  The option
8242 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8243 which might make debugging harder.
8244 @end table
8246 These @samp{-m} switches are supported in addition to the above
8247 on AMD x86-64 processors in 64-bit environments.
8249 @table @gcctabopt
8250 @item -m32
8251 @itemx -m64
8252 @opindex m32
8253 @opindex m64
8254 Generate code for a 32-bit or 64-bit environment.
8255 The 32-bit environment sets int, long and pointer to 32 bits and
8256 generates code that runs on any i386 system.
8257 The 64-bit environment sets int to 32 bits and long and pointer
8258 to 64 bits and generates code for AMD's x86-64 architecture.
8260 @item -mno-red-zone
8261 @opindex no-red-zone
8262 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8263 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8264 stack pointer that will not be modified by signal or interrupt handlers
8265 and therefore can be used for temporary data without adjusting the stack
8266 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8268 @item -mcmodel=small
8269 @opindex mcmodel=small
8270 Generate code for the small code model: the program and its symbols must
8271 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8272 Programs can be statically or dynamically linked.  This is the default
8273 code model.
8275 @item -mcmodel=kernel
8276 @opindex mcmodel=kernel
8277 Generate code for the kernel code model.  The kernel runs in the
8278 negative 2 GB of the address space.
8279 This model has to be used for Linux kernel code.
8281 @item -mcmodel=medium
8282 @opindex mcmodel=medium
8283 Generate code for the medium model: The program is linked in the lower 2
8284 GB of the address space but symbols can be located anywhere in the
8285 address space.  Programs can be statically or dynamically linked, but
8286 building of shared libraries are not supported with the medium model.
8288 @item -mcmodel=large
8289 @opindex mcmodel=large
8290 Generate code for the large model: This model makes no assumptions
8291 about addresses and sizes of sections.  Currently GCC does not implement
8292 this model.
8293 @end table
8295 @node HPPA Options
8296 @subsection HPPA Options
8297 @cindex HPPA Options
8299 These @samp{-m} options are defined for the HPPA family of computers:
8301 @table @gcctabopt
8302 @item -march=@var{architecture-type}
8303 @opindex march
8304 Generate code for the specified architecture.  The choices for
8305 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8306 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8307 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8308 architecture option for your machine.  Code compiled for lower numbered
8309 architectures will run on higher numbered architectures, but not the
8310 other way around.
8312 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8313 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8314 support.
8316 @item -mpa-risc-1-0
8317 @itemx -mpa-risc-1-1
8318 @itemx -mpa-risc-2-0
8319 @opindex mpa-risc-1-0
8320 @opindex mpa-risc-1-1
8321 @opindex mpa-risc-2-0
8322 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8324 @item -mbig-switch
8325 @opindex mbig-switch
8326 Generate code suitable for big switch tables.  Use this option only if
8327 the assembler/linker complain about out of range branches within a switch
8328 table.
8330 @item -mjump-in-delay
8331 @opindex mjump-in-delay
8332 Fill delay slots of function calls with unconditional jump instructions
8333 by modifying the return pointer for the function call to be the target
8334 of the conditional jump.
8336 @item -mdisable-fpregs
8337 @opindex mdisable-fpregs
8338 Prevent floating point registers from being used in any manner.  This is
8339 necessary for compiling kernels which perform lazy context switching of
8340 floating point registers.  If you use this option and attempt to perform
8341 floating point operations, the compiler will abort.
8343 @item -mdisable-indexing
8344 @opindex mdisable-indexing
8345 Prevent the compiler from using indexing address modes.  This avoids some
8346 rather obscure problems when compiling MIG generated code under MACH@.
8348 @item -mno-space-regs
8349 @opindex mno-space-regs
8350 Generate code that assumes the target has no space registers.  This allows
8351 GCC to generate faster indirect calls and use unscaled index address modes.
8353 Such code is suitable for level 0 PA systems and kernels.
8355 @item -mfast-indirect-calls
8356 @opindex mfast-indirect-calls
8357 Generate code that assumes calls never cross space boundaries.  This
8358 allows GCC to emit code which performs faster indirect calls.
8360 This option will not work in the presence of shared libraries or nested
8361 functions.
8363 @item -mlong-load-store
8364 @opindex mlong-load-store
8365 Generate 3-instruction load and store sequences as sometimes required by
8366 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8367 the HP compilers.
8369 @item -mportable-runtime
8370 @opindex mportable-runtime
8371 Use the portable calling conventions proposed by HP for ELF systems.
8373 @item -mgas
8374 @opindex mgas
8375 Enable the use of assembler directives only GAS understands.
8377 @item -mschedule=@var{cpu-type}
8378 @opindex mschedule
8379 Schedule code according to the constraints for the machine type
8380 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8381 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8382 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8383 proper scheduling option for your machine.  The default scheduling is
8384 @samp{8000}.
8386 @item -mlinker-opt
8387 @opindex mlinker-opt
8388 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8389 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8390 linkers in which they give bogus error messages when linking some programs.
8392 @item -msoft-float
8393 @opindex msoft-float
8394 Generate output containing library calls for floating point.
8395 @strong{Warning:} the requisite libraries are not available for all HPPA
8396 targets.  Normally the facilities of the machine's usual C compiler are
8397 used, but this cannot be done directly in cross-compilation.  You must make
8398 your own arrangements to provide suitable library functions for
8399 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8400 does provide software floating point support.
8402 @option{-msoft-float} changes the calling convention in the output file;
8403 therefore, it is only useful if you compile @emph{all} of a program with
8404 this option.  In particular, you need to compile @file{libgcc.a}, the
8405 library that comes with GCC, with @option{-msoft-float} in order for
8406 this to work.
8408 @item -msio
8409 @opindex msio
8410 Generate the predefine, @code{_SIO}, for server IO.  The default is
8411 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8412 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8413 options are available under HP-UX and HI-UX.
8415 @item -mgnu-ld
8416 @opindex gnu-ld
8417 Use GNU ld specific options.  This passes @option{-shared} to ld when
8418 building a shared library.  It is the default when GCC is configured,
8419 explicitly or implicitly, with the GNU linker.  This option does not
8420 have any affect on which ld is called, it only changes what parameters
8421 are passed to that ld.  The ld that is called is determined by the
8422 @option{--with-ld} configure option, gcc's program search path, and
8423 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8424 using @samp{which `gcc -print-prog-name=ld`}.
8426 @item -mhp-ld
8427 @opindex hp-ld
8428 Use HP ld specific options.  This passes @option{-b} to ld when building
8429 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8430 links.  It is the default when GCC is configured, explicitly or
8431 implicitly, with the HP linker.  This option does not have any affect on
8432 which ld is called, it only changes what parameters are passed to that
8433 ld.  The ld that is called is determined by the @option{--with-ld}
8434 configure option, gcc's program search path, and finally by the user's
8435 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8436 `gcc -print-prog-name=ld`}.
8438 @item -mlong-calls
8439 @opindex mno-long-calls
8440 Generate code that uses long call sequences.  This ensures that a call
8441 is always able to reach linker generated stubs.  The default is to generate
8442 long calls only when the distance from the call site to the beginning
8443 of the function or translation unit, as the case may be, exceeds a
8444 predefined limit set by the branch type being used.  The limits for
8445 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8446 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8447 240,000 bytes.
8449 Distances are measured from the beginning of functions when using the
8450 @option{-ffunction-sections} option, or when using the @option{-mgas}
8451 and @option{-mno-portable-runtime} options together under HP-UX with
8452 the SOM linker.
8454 It is normally not desirable to use this option as it will degrade
8455 performance.  However, it may be useful in large applications,
8456 particularly when partial linking is used to build the application.
8458 The types of long calls used depends on the capabilities of the
8459 assembler and linker, and the type of code being generated.  The
8460 impact on systems that support long absolute calls, and long pic
8461 symbol-difference or pc-relative calls should be relatively small.
8462 However, an indirect call is used on 32-bit ELF systems in pic code
8463 and it is quite long.
8465 @end table
8467 @node Intel 960 Options
8468 @subsection Intel 960 Options
8470 These @samp{-m} options are defined for the Intel 960 implementations:
8472 @table @gcctabopt
8473 @item -m@var{cpu-type}
8474 @opindex mka
8475 @opindex mkb
8476 @opindex mmc
8477 @opindex mca
8478 @opindex mcf
8479 @opindex msa
8480 @opindex msb
8481 Assume the defaults for the machine type @var{cpu-type} for some of
8482 the other options, including instruction scheduling, floating point
8483 support, and addressing modes.  The choices for @var{cpu-type} are
8484 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8485 @samp{sa}, and @samp{sb}.
8486 The default is
8487 @samp{kb}.
8489 @item -mnumerics
8490 @itemx -msoft-float
8491 @opindex mnumerics
8492 @opindex msoft-float
8493 The @option{-mnumerics} option indicates that the processor does support
8494 floating-point instructions.  The @option{-msoft-float} option indicates
8495 that floating-point support should not be assumed.
8497 @item -mleaf-procedures
8498 @itemx -mno-leaf-procedures
8499 @opindex mleaf-procedures
8500 @opindex mno-leaf-procedures
8501 Do (or do not) attempt to alter leaf procedures to be callable with the
8502 @code{bal} instruction as well as @code{call}.  This will result in more
8503 efficient code for explicit calls when the @code{bal} instruction can be
8504 substituted by the assembler or linker, but less efficient code in other
8505 cases, such as calls via function pointers, or using a linker that doesn't
8506 support this optimization.
8508 @item -mtail-call
8509 @itemx -mno-tail-call
8510 @opindex mtail-call
8511 @opindex mno-tail-call
8512 Do (or do not) make additional attempts (beyond those of the
8513 machine-independent portions of the compiler) to optimize tail-recursive
8514 calls into branches.  You may not want to do this because the detection of
8515 cases where this is not valid is not totally complete.  The default is
8516 @option{-mno-tail-call}.
8518 @item -mcomplex-addr
8519 @itemx -mno-complex-addr
8520 @opindex mcomplex-addr
8521 @opindex mno-complex-addr
8522 Assume (or do not assume) that the use of a complex addressing mode is a
8523 win on this implementation of the i960.  Complex addressing modes may not
8524 be worthwhile on the K-series, but they definitely are on the C-series.
8525 The default is currently @option{-mcomplex-addr} for all processors except
8526 the CB and CC@.
8528 @item -mcode-align
8529 @itemx -mno-code-align
8530 @opindex mcode-align
8531 @opindex mno-code-align
8532 Align code to 8-byte boundaries for faster fetching (or don't bother).
8533 Currently turned on by default for C-series implementations only.
8535 @ignore
8536 @item -mclean-linkage
8537 @itemx -mno-clean-linkage
8538 @opindex mclean-linkage
8539 @opindex mno-clean-linkage
8540 These options are not fully implemented.
8541 @end ignore
8543 @item -mic-compat
8544 @itemx -mic2.0-compat
8545 @itemx -mic3.0-compat
8546 @opindex mic-compat
8547 @opindex mic2.0-compat
8548 @opindex mic3.0-compat
8549 Enable compatibility with iC960 v2.0 or v3.0.
8551 @item -masm-compat
8552 @itemx -mintel-asm
8553 @opindex masm-compat
8554 @opindex mintel-asm
8555 Enable compatibility with the iC960 assembler.
8557 @item -mstrict-align
8558 @itemx -mno-strict-align
8559 @opindex mstrict-align
8560 @opindex mno-strict-align
8561 Do not permit (do permit) unaligned accesses.
8563 @item -mold-align
8564 @opindex mold-align
8565 Enable structure-alignment compatibility with Intel's gcc release version
8566 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8568 @item -mlong-double-64
8569 @opindex mlong-double-64
8570 Implement type @samp{long double} as 64-bit floating point numbers.
8571 Without the option @samp{long double} is implemented by 80-bit
8572 floating point numbers.  The only reason we have it because there is
8573 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8574 is only useful for people using soft-float targets.  Otherwise, we
8575 should recommend against use of it.
8577 @end table
8579 @node DEC Alpha Options
8580 @subsection DEC Alpha Options
8582 These @samp{-m} options are defined for the DEC Alpha implementations:
8584 @table @gcctabopt
8585 @item -mno-soft-float
8586 @itemx -msoft-float
8587 @opindex mno-soft-float
8588 @opindex msoft-float
8589 Use (do not use) the hardware floating-point instructions for
8590 floating-point operations.  When @option{-msoft-float} is specified,
8591 functions in @file{libgcc.a} will be used to perform floating-point
8592 operations.  Unless they are replaced by routines that emulate the
8593 floating-point operations, or compiled in such a way as to call such
8594 emulations routines, these routines will issue floating-point
8595 operations.   If you are compiling for an Alpha without floating-point
8596 operations, you must ensure that the library is built so as not to call
8597 them.
8599 Note that Alpha implementations without floating-point operations are
8600 required to have floating-point registers.
8602 @item -mfp-reg
8603 @itemx -mno-fp-regs
8604 @opindex mfp-reg
8605 @opindex mno-fp-regs
8606 Generate code that uses (does not use) the floating-point register set.
8607 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8608 register set is not used, floating point operands are passed in integer
8609 registers as if they were integers and floating-point results are passed
8610 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8611 so any function with a floating-point argument or return value called by code
8612 compiled with @option{-mno-fp-regs} must also be compiled with that
8613 option.
8615 A typical use of this option is building a kernel that does not use,
8616 and hence need not save and restore, any floating-point registers.
8618 @item -mieee
8619 @opindex mieee
8620 The Alpha architecture implements floating-point hardware optimized for
8621 maximum performance.  It is mostly compliant with the IEEE floating
8622 point standard.  However, for full compliance, software assistance is
8623 required.  This option generates code fully IEEE compliant code
8624 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8625 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8626 defined during compilation.  The resulting code is less efficient but is
8627 able to correctly support denormalized numbers and exceptional IEEE
8628 values such as not-a-number and plus/minus infinity.  Other Alpha
8629 compilers call this option @option{-ieee_with_no_inexact}.
8631 @item -mieee-with-inexact
8632 @opindex mieee-with-inexact
8633 This is like @option{-mieee} except the generated code also maintains
8634 the IEEE @var{inexact-flag}.  Turning on this option causes the
8635 generated code to implement fully-compliant IEEE math.  In addition to
8636 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8637 macro.  On some Alpha implementations the resulting code may execute
8638 significantly slower than the code generated by default.  Since there is
8639 very little code that depends on the @var{inexact-flag}, you should
8640 normally not specify this option.  Other Alpha compilers call this
8641 option @option{-ieee_with_inexact}.
8643 @item -mfp-trap-mode=@var{trap-mode}
8644 @opindex mfp-trap-mode
8645 This option controls what floating-point related traps are enabled.
8646 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8647 The trap mode can be set to one of four values:
8649 @table @samp
8650 @item n
8651 This is the default (normal) setting.  The only traps that are enabled
8652 are the ones that cannot be disabled in software (e.g., division by zero
8653 trap).
8655 @item u
8656 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8657 as well.
8659 @item su
8660 Like @samp{su}, but the instructions are marked to be safe for software
8661 completion (see Alpha architecture manual for details).
8663 @item sui
8664 Like @samp{su}, but inexact traps are enabled as well.
8665 @end table
8667 @item -mfp-rounding-mode=@var{rounding-mode}
8668 @opindex mfp-rounding-mode
8669 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8670 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8673 @table @samp
8674 @item n
8675 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8676 the nearest machine number or towards the even machine number in case
8677 of a tie.
8679 @item m
8680 Round towards minus infinity.
8682 @item c
8683 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8685 @item d
8686 Dynamic rounding mode.  A field in the floating point control register
8687 (@var{fpcr}, see Alpha architecture reference manual) controls the
8688 rounding mode in effect.  The C library initializes this register for
8689 rounding towards plus infinity.  Thus, unless your program modifies the
8690 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8691 @end table
8693 @item -mtrap-precision=@var{trap-precision}
8694 @opindex mtrap-precision
8695 In the Alpha architecture, floating point traps are imprecise.  This
8696 means without software assistance it is impossible to recover from a
8697 floating trap and program execution normally needs to be terminated.
8698 GCC can generate code that can assist operating system trap handlers
8699 in determining the exact location that caused a floating point trap.
8700 Depending on the requirements of an application, different levels of
8701 precisions can be selected:
8703 @table @samp
8704 @item p
8705 Program precision.  This option is the default and means a trap handler
8706 can only identify which program caused a floating point exception.
8708 @item f
8709 Function precision.  The trap handler can determine the function that
8710 caused a floating point exception.
8712 @item i
8713 Instruction precision.  The trap handler can determine the exact
8714 instruction that caused a floating point exception.
8715 @end table
8717 Other Alpha compilers provide the equivalent options called
8718 @option{-scope_safe} and @option{-resumption_safe}.
8720 @item -mieee-conformant
8721 @opindex mieee-conformant
8722 This option marks the generated code as IEEE conformant.  You must not
8723 use this option unless you also specify @option{-mtrap-precision=i} and either
8724 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8725 is to emit the line @samp{.eflag 48} in the function prologue of the
8726 generated assembly file.  Under DEC Unix, this has the effect that
8727 IEEE-conformant math library routines will be linked in.
8729 @item -mbuild-constants
8730 @opindex mbuild-constants
8731 Normally GCC examines a 32- or 64-bit integer constant to
8732 see if it can construct it from smaller constants in two or three
8733 instructions.  If it cannot, it will output the constant as a literal and
8734 generate code to load it from the data segment at runtime.
8736 Use this option to require GCC to construct @emph{all} integer constants
8737 using code, even if it takes more instructions (the maximum is six).
8739 You would typically use this option to build a shared library dynamic
8740 loader.  Itself a shared library, it must relocate itself in memory
8741 before it can find the variables and constants in its own data segment.
8743 @item -malpha-as
8744 @itemx -mgas
8745 @opindex malpha-as
8746 @opindex mgas
8747 Select whether to generate code to be assembled by the vendor-supplied
8748 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8750 @item -mbwx
8751 @itemx -mno-bwx
8752 @itemx -mcix
8753 @itemx -mno-cix
8754 @itemx -mfix
8755 @itemx -mno-fix
8756 @itemx -mmax
8757 @itemx -mno-max
8758 @opindex mbwx
8759 @opindex mno-bwx
8760 @opindex mcix
8761 @opindex mno-cix
8762 @opindex mfix
8763 @opindex mno-fix
8764 @opindex mmax
8765 @opindex mno-max
8766 Indicate whether GCC should generate code to use the optional BWX,
8767 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8768 sets supported by the CPU type specified via @option{-mcpu=} option or that
8769 of the CPU on which GCC was built if none was specified.
8771 @item -mfloat-vax
8772 @itemx -mfloat-ieee
8773 @opindex mfloat-vax
8774 @opindex mfloat-ieee
8775 Generate code that uses (does not use) VAX F and G floating point
8776 arithmetic instead of IEEE single and double precision.
8778 @item -mexplicit-relocs
8779 @itemx -mno-explicit-relocs
8780 @opindex mexplicit-relocs
8781 @opindex mno-explicit-relocs
8782 Older Alpha assemblers provided no way to generate symbol relocations
8783 except via assembler macros.  Use of these macros does not allow
8784 optimal instruction scheduling.  GNU binutils as of version 2.12
8785 supports a new syntax that allows the compiler to explicitly mark
8786 which relocations should apply to which instructions.  This option
8787 is mostly useful for debugging, as GCC detects the capabilities of
8788 the assembler when it is built and sets the default accordingly.
8790 @item -msmall-data
8791 @itemx -mlarge-data
8792 @opindex msmall-data
8793 @opindex mlarge-data
8794 When @option{-mexplicit-relocs} is in effect, static data is
8795 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8796 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8797 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8798 16-bit relocations off of the @code{$gp} register.  This limits the
8799 size of the small data area to 64KB, but allows the variables to be
8800 directly accessed via a single instruction.
8802 The default is @option{-mlarge-data}.  With this option the data area
8803 is limited to just below 2GB.  Programs that require more than 2GB of
8804 data must use @code{malloc} or @code{mmap} to allocate the data in the
8805 heap instead of in the program's data segment.
8807 When generating code for shared libraries, @option{-fpic} implies
8808 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8810 @item -msmall-text
8811 @itemx -mlarge-text
8812 @opindex msmall-text
8813 @opindex mlarge-text
8814 When @option{-msmall-text} is used, the compiler assumes that the
8815 code of the entire program (or shared library) fits in 4MB, and is
8816 thus reachable with a branch instruction.  When @option{-msmall-data}
8817 is used, the compiler can assume that all local symbols share the
8818 same @code{$gp} value, and thus reduce the number of instructions
8819 required for a function call from 4 to 1.
8821 The default is @option{-mlarge-text}.
8823 @item -mcpu=@var{cpu_type}
8824 @opindex mcpu
8825 Set the instruction set and instruction scheduling parameters for
8826 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8827 style name or the corresponding chip number.  GCC supports scheduling
8828 parameters for the EV4, EV5 and EV6 family of processors and will
8829 choose the default values for the instruction set from the processor
8830 you specify.  If you do not specify a processor type, GCC will default
8831 to the processor on which the compiler was built.
8833 Supported values for @var{cpu_type} are
8835 @table @samp
8836 @item ev4
8837 @item ev45
8838 @itemx 21064
8839 Schedules as an EV4 and has no instruction set extensions.
8841 @item ev5
8842 @itemx 21164
8843 Schedules as an EV5 and has no instruction set extensions.
8845 @item ev56
8846 @itemx 21164a
8847 Schedules as an EV5 and supports the BWX extension.
8849 @item pca56
8850 @itemx 21164pc
8851 @itemx 21164PC
8852 Schedules as an EV5 and supports the BWX and MAX extensions.
8854 @item ev6
8855 @itemx 21264
8856 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8858 @item ev67
8859 @item 21264a
8860 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8861 @end table
8863 @item -mtune=@var{cpu_type}
8864 @opindex mtune
8865 Set only the instruction scheduling parameters for machine type
8866 @var{cpu_type}.  The instruction set is not changed.
8868 @item -mmemory-latency=@var{time}
8869 @opindex mmemory-latency
8870 Sets the latency the scheduler should assume for typical memory
8871 references as seen by the application.  This number is highly
8872 dependent on the memory access patterns used by the application
8873 and the size of the external cache on the machine.
8875 Valid options for @var{time} are
8877 @table @samp
8878 @item @var{number}
8879 A decimal number representing clock cycles.
8881 @item L1
8882 @itemx L2
8883 @itemx L3
8884 @itemx main
8885 The compiler contains estimates of the number of clock cycles for
8886 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8887 (also called Dcache, Scache, and Bcache), as well as to main memory.
8888 Note that L3 is only valid for EV5.
8890 @end table
8891 @end table
8893 @node DEC Alpha/VMS Options
8894 @subsection DEC Alpha/VMS Options
8896 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8898 @table @gcctabopt
8899 @item -mvms-return-codes
8900 @opindex mvms-return-codes
8901 Return VMS condition codes from main.  The default is to return POSIX
8902 style condition (e.g.@ error) codes.
8903 @end table
8905 @node H8/300 Options
8906 @subsection H8/300 Options
8908 These @samp{-m} options are defined for the H8/300 implementations:
8910 @table @gcctabopt
8911 @item -mrelax
8912 @opindex mrelax
8913 Shorten some address references at link time, when possible; uses the
8914 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8915 ld.info, Using ld}, for a fuller description.
8917 @item -mh
8918 @opindex mh
8919 Generate code for the H8/300H@.
8921 @item -ms
8922 @opindex ms
8923 Generate code for the H8S@.
8925 @item -mn
8926 @opindex mn
8927 Generate code for the H8S and H8/300H in the normal mode.  This switch
8928 must be used either with -mh or -ms.
8930 @item -ms2600
8931 @opindex ms2600
8932 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8934 @item -mint32
8935 @opindex mint32
8936 Make @code{int} data 32 bits by default.
8938 @item -malign-300
8939 @opindex malign-300
8940 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8941 The default for the H8/300H and H8S is to align longs and floats on 4
8942 byte boundaries.
8943 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8944 This option has no effect on the H8/300.
8945 @end table
8947 @node SH Options
8948 @subsection SH Options
8950 These @samp{-m} options are defined for the SH implementations:
8952 @table @gcctabopt
8953 @item -m1
8954 @opindex m1
8955 Generate code for the SH1.
8957 @item -m2
8958 @opindex m2
8959 Generate code for the SH2.
8961 @item -m2e
8962 Generate code for the SH2e.
8964 @item -m3
8965 @opindex m3
8966 Generate code for the SH3.
8968 @item -m3e
8969 @opindex m3e
8970 Generate code for the SH3e.
8972 @item -m4-nofpu
8973 @opindex m4-nofpu
8974 Generate code for the SH4 without a floating-point unit.
8976 @item -m4-single-only
8977 @opindex m4-single-only
8978 Generate code for the SH4 with a floating-point unit that only
8979 supports single-precision arithmetic.
8981 @item -m4-single
8982 @opindex m4-single
8983 Generate code for the SH4 assuming the floating-point unit is in
8984 single-precision mode by default.
8986 @item -m4
8987 @opindex m4
8988 Generate code for the SH4.
8990 @item -mb
8991 @opindex mb
8992 Compile code for the processor in big endian mode.
8994 @item -ml
8995 @opindex ml
8996 Compile code for the processor in little endian mode.
8998 @item -mdalign
8999 @opindex mdalign
9000 Align doubles at 64-bit boundaries.  Note that this changes the calling
9001 conventions, and thus some functions from the standard C library will
9002 not work unless you recompile it first with @option{-mdalign}.
9004 @item -mrelax
9005 @opindex mrelax
9006 Shorten some address references at link time, when possible; uses the
9007 linker option @option{-relax}.
9009 @item -mbigtable
9010 @opindex mbigtable
9011 Use 32-bit offsets in @code{switch} tables.  The default is to use
9012 16-bit offsets.
9014 @item -mfmovd
9015 @opindex mfmovd
9016 Enable the use of the instruction @code{fmovd}.
9018 @item -mhitachi
9019 @opindex mhitachi
9020 Comply with the calling conventions defined by Hitachi.
9022 @item -mnomacsave
9023 @opindex mnomacsave
9024 Mark the @code{MAC} register as call-clobbered, even if
9025 @option{-mhitachi} is given.
9027 @item -mieee
9028 @opindex mieee
9029 Increase IEEE-compliance of floating-point code.
9031 @item -misize
9032 @opindex misize
9033 Dump instruction size and location in the assembly code.
9035 @item -mpadstruct
9036 @opindex mpadstruct
9037 This option is deprecated.  It pads structures to multiple of 4 bytes,
9038 which is incompatible with the SH ABI@.
9040 @item -mspace
9041 @opindex mspace
9042 Optimize for space instead of speed.  Implied by @option{-Os}.
9044 @item -mprefergot
9045 @opindex mprefergot
9046 When generating position-independent code, emit function calls using
9047 the Global Offset Table instead of the Procedure Linkage Table.
9049 @item -musermode
9050 @opindex musermode
9051 Generate a library function call to invalidate instruction cache
9052 entries, after fixing up a trampoline.  This library function call
9053 doesn't assume it can write to the whole memory address space.  This
9054 is the default when the target is @code{sh-*-linux*}.
9055 @end table
9057 @node System V Options
9058 @subsection Options for System V
9060 These additional options are available on System V Release 4 for
9061 compatibility with other compilers on those systems:
9063 @table @gcctabopt
9064 @item -G
9065 @opindex G
9066 Create a shared object.
9067 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9069 @item -Qy
9070 @opindex Qy
9071 Identify the versions of each tool used by the compiler, in a
9072 @code{.ident} assembler directive in the output.
9074 @item -Qn
9075 @opindex Qn
9076 Refrain from adding @code{.ident} directives to the output file (this is
9077 the default).
9079 @item -YP,@var{dirs}
9080 @opindex YP
9081 Search the directories @var{dirs}, and no others, for libraries
9082 specified with @option{-l}.
9084 @item -Ym,@var{dir}
9085 @opindex Ym
9086 Look in the directory @var{dir} to find the M4 preprocessor.
9087 The assembler uses this option.
9088 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9089 @c the generic assembler that comes with Solaris takes just -Ym.
9090 @end table
9092 @node TMS320C3x/C4x Options
9093 @subsection TMS320C3x/C4x Options
9094 @cindex TMS320C3x/C4x Options
9096 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9098 @table @gcctabopt
9100 @item -mcpu=@var{cpu_type}
9101 @opindex mcpu
9102 Set the instruction set, register set, and instruction scheduling
9103 parameters for machine type @var{cpu_type}.  Supported values for
9104 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9105 @samp{c44}.  The default is @samp{c40} to generate code for the
9106 TMS320C40.
9108 @item -mbig-memory
9109 @item -mbig
9110 @itemx -msmall-memory
9111 @itemx -msmall
9112 @opindex mbig-memory
9113 @opindex mbig
9114 @opindex msmall-memory
9115 @opindex msmall
9116 Generates code for the big or small memory model.  The small memory
9117 model assumed that all data fits into one 64K word page.  At run-time
9118 the data page (DP) register must be set to point to the 64K page
9119 containing the .bss and .data program sections.  The big memory model is
9120 the default and requires reloading of the DP register for every direct
9121 memory access.
9123 @item -mbk
9124 @itemx -mno-bk
9125 @opindex mbk
9126 @opindex mno-bk
9127 Allow (disallow) allocation of general integer operands into the block
9128 count register BK@.
9130 @item -mdb
9131 @itemx -mno-db
9132 @opindex mdb
9133 @opindex mno-db
9134 Enable (disable) generation of code using decrement and branch,
9135 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9136 on the safe side, this is disabled for the C3x, since the maximum
9137 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9138 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9139 that it can utilize the decrement and branch instruction, but will give
9140 up if there is more than one memory reference in the loop.  Thus a loop
9141 where the loop counter is decremented can generate slightly more
9142 efficient code, in cases where the RPTB instruction cannot be utilized.
9144 @item -mdp-isr-reload
9145 @itemx -mparanoid
9146 @opindex mdp-isr-reload
9147 @opindex mparanoid
9148 Force the DP register to be saved on entry to an interrupt service
9149 routine (ISR), reloaded to point to the data section, and restored on
9150 exit from the ISR@.  This should not be required unless someone has
9151 violated the small memory model by modifying the DP register, say within
9152 an object library.
9154 @item -mmpyi
9155 @itemx -mno-mpyi
9156 @opindex mmpyi
9157 @opindex mno-mpyi
9158 For the C3x use the 24-bit MPYI instruction for integer multiplies
9159 instead of a library call to guarantee 32-bit results.  Note that if one
9160 of the operands is a constant, then the multiplication will be performed
9161 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9162 then squaring operations are performed inline instead of a library call.
9164 @item -mfast-fix
9165 @itemx -mno-fast-fix
9166 @opindex mfast-fix
9167 @opindex mno-fast-fix
9168 The C3x/C4x FIX instruction to convert a floating point value to an
9169 integer value chooses the nearest integer less than or equal to the
9170 floating point value rather than to the nearest integer.  Thus if the
9171 floating point number is negative, the result will be incorrectly
9172 truncated an additional code is necessary to detect and correct this
9173 case.  This option can be used to disable generation of the additional
9174 code required to correct the result.
9176 @item -mrptb
9177 @itemx -mno-rptb
9178 @opindex mrptb
9179 @opindex mno-rptb
9180 Enable (disable) generation of repeat block sequences using the RPTB
9181 instruction for zero overhead looping.  The RPTB construct is only used
9182 for innermost loops that do not call functions or jump across the loop
9183 boundaries.  There is no advantage having nested RPTB loops due to the
9184 overhead required to save and restore the RC, RS, and RE registers.
9185 This is enabled by default with @option{-O2}.
9187 @item -mrpts=@var{count}
9188 @itemx -mno-rpts
9189 @opindex mrpts
9190 @opindex mno-rpts
9191 Enable (disable) the use of the single instruction repeat instruction
9192 RPTS@.  If a repeat block contains a single instruction, and the loop
9193 count can be guaranteed to be less than the value @var{count}, GCC will
9194 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9195 then a RPTS will be emitted even if the loop count cannot be determined
9196 at compile time.  Note that the repeated instruction following RPTS does
9197 not have to be reloaded from memory each iteration, thus freeing up the
9198 CPU buses for operands.  However, since interrupts are blocked by this
9199 instruction, it is disabled by default.
9201 @item -mloop-unsigned
9202 @itemx -mno-loop-unsigned
9203 @opindex mloop-unsigned
9204 @opindex mno-loop-unsigned
9205 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9206 is @math{2^{31} + 1} since these instructions test if the iteration count is
9207 negative to terminate the loop.  If the iteration count is unsigned
9208 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9209 exceeded.  This switch allows an unsigned iteration count.
9211 @item -mti
9212 @opindex mti
9213 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9214 with.  This also enforces compatibility with the API employed by the TI
9215 C3x C compiler.  For example, long doubles are passed as structures
9216 rather than in floating point registers.
9218 @item -mregparm
9219 @itemx -mmemparm
9220 @opindex mregparm
9221 @opindex mmemparm
9222 Generate code that uses registers (stack) for passing arguments to functions.
9223 By default, arguments are passed in registers where possible rather
9224 than by pushing arguments on to the stack.
9226 @item -mparallel-insns
9227 @itemx -mno-parallel-insns
9228 @opindex mparallel-insns
9229 @opindex mno-parallel-insns
9230 Allow the generation of parallel instructions.  This is enabled by
9231 default with @option{-O2}.
9233 @item -mparallel-mpy
9234 @itemx -mno-parallel-mpy
9235 @opindex mparallel-mpy
9236 @opindex mno-parallel-mpy
9237 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9238 provided @option{-mparallel-insns} is also specified.  These instructions have
9239 tight register constraints which can pessimize the code generation
9240 of large functions.
9242 @end table
9244 @node V850 Options
9245 @subsection V850 Options
9246 @cindex V850 Options
9248 These @samp{-m} options are defined for V850 implementations:
9250 @table @gcctabopt
9251 @item -mlong-calls
9252 @itemx -mno-long-calls
9253 @opindex mlong-calls
9254 @opindex mno-long-calls
9255 Treat all calls as being far away (near).  If calls are assumed to be
9256 far away, the compiler will always load the functions address up into a
9257 register, and call indirect through the pointer.
9259 @item -mno-ep
9260 @itemx -mep
9261 @opindex mno-ep
9262 @opindex mep
9263 Do not optimize (do optimize) basic blocks that use the same index
9264 pointer 4 or more times to copy pointer into the @code{ep} register, and
9265 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9266 option is on by default if you optimize.
9268 @item -mno-prolog-function
9269 @itemx -mprolog-function
9270 @opindex mno-prolog-function
9271 @opindex mprolog-function
9272 Do not use (do use) external functions to save and restore registers at
9273 the prolog and epilog of a function.  The external functions are slower,
9274 but use less code space if more than one function saves the same number
9275 of registers.  The @option{-mprolog-function} option is on by default if
9276 you optimize.
9278 @item -mspace
9279 @opindex mspace
9280 Try to make the code as small as possible.  At present, this just turns
9281 on the @option{-mep} and @option{-mprolog-function} options.
9283 @item -mtda=@var{n}
9284 @opindex mtda
9285 Put static or global variables whose size is @var{n} bytes or less into
9286 the tiny data area that register @code{ep} points to.  The tiny data
9287 area can hold up to 256 bytes in total (128 bytes for byte references).
9289 @item -msda=@var{n}
9290 @opindex msda
9291 Put static or global variables whose size is @var{n} bytes or less into
9292 the small data area that register @code{gp} points to.  The small data
9293 area can hold up to 64 kilobytes.
9295 @item -mzda=@var{n}
9296 @opindex mzda
9297 Put static or global variables whose size is @var{n} bytes or less into
9298 the first 32 kilobytes of memory.
9300 @item -mv850
9301 @opindex mv850
9302 Specify that the target processor is the V850.
9304 @item -mbig-switch
9305 @opindex mbig-switch
9306 Generate code suitable for big switch tables.  Use this option only if
9307 the assembler/linker complain about out of range branches within a switch
9308 table.
9310 @item -mapp-regs
9311 @opindex -mapp-regs
9312 This option will cause r2 and r5 to be used in the code generated by
9313 the compiler.  This setting is the default.
9315 @item -mno-app-regs
9316 @opindex -mno-app-regs
9317 This option will cause r2 and r5 to be treated as fixed registers.
9318   
9319 @item -mv850e
9320 @opindex -mv850e
9321 Specify that the target processor is the V850E.  The preprocessor
9322 constant @samp{__v850e__} will be defined if this option is used.
9324 If neither @option{-mv850} nor @option{-mv850e} are defined
9325 then a default target processor will be chosen and the relevant
9326 @samp{__v850*__} preprocessor constant will be defined.
9328 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9329 defined, regardless of which processor variant is the target.
9331 @item -mdisable-callt
9332 @opindex -mdisable-callt
9333 This option will suppress generation of the CALLT instruction for the
9334 v850e flavors of the v850 architecture.  The default is
9335 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9337 @end table
9339 @node ARC Options
9340 @subsection ARC Options
9341 @cindex ARC Options
9343 These options are defined for ARC implementations:
9345 @table @gcctabopt
9346 @item -EL
9347 @opindex EL
9348 Compile code for little endian mode.  This is the default.
9350 @item -EB
9351 @opindex EB
9352 Compile code for big endian mode.
9354 @item -mmangle-cpu
9355 @opindex mmangle-cpu
9356 Prepend the name of the cpu to all public symbol names.
9357 In multiple-processor systems, there are many ARC variants with different
9358 instruction and register set characteristics.  This flag prevents code
9359 compiled for one cpu to be linked with code compiled for another.
9360 No facility exists for handling variants that are ``almost identical''.
9361 This is an all or nothing option.
9363 @item -mcpu=@var{cpu}
9364 @opindex mcpu
9365 Compile code for ARC variant @var{cpu}.
9366 Which variants are supported depend on the configuration.
9367 All variants support @option{-mcpu=base}, this is the default.
9369 @item -mtext=@var{text-section}
9370 @itemx -mdata=@var{data-section}
9371 @itemx -mrodata=@var{readonly-data-section}
9372 @opindex mtext
9373 @opindex mdata
9374 @opindex mrodata
9375 Put functions, data, and readonly data in @var{text-section},
9376 @var{data-section}, and @var{readonly-data-section} respectively
9377 by default.  This can be overridden with the @code{section} attribute.
9378 @xref{Variable Attributes}.
9380 @end table
9382 @node NS32K Options
9383 @subsection NS32K Options
9384 @cindex NS32K options
9386 These are the @samp{-m} options defined for the 32000 series.  The default
9387 values for these options depends on which style of 32000 was selected when
9388 the compiler was configured; the defaults for the most common choices are
9389 given below.
9391 @table @gcctabopt
9392 @item -m32032
9393 @itemx -m32032
9394 @opindex m32032
9395 @opindex m32032
9396 Generate output for a 32032.  This is the default
9397 when the compiler is configured for 32032 and 32016 based systems.
9399 @item -m32332
9400 @itemx -m32332
9401 @opindex m32332
9402 @opindex m32332
9403 Generate output for a 32332.  This is the default
9404 when the compiler is configured for 32332-based systems.
9406 @item -m32532
9407 @itemx -m32532
9408 @opindex m32532
9409 @opindex m32532
9410 Generate output for a 32532.  This is the default
9411 when the compiler is configured for 32532-based systems.
9413 @item -m32081
9414 @opindex m32081
9415 Generate output containing 32081 instructions for floating point.
9416 This is the default for all systems.
9418 @item -m32381
9419 @opindex m32381
9420 Generate output containing 32381 instructions for floating point.  This
9421 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9422 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9424 @item -mmulti-add
9425 @opindex mmulti-add
9426 Try and generate multiply-add floating point instructions @code{polyF}
9427 and @code{dotF}.  This option is only available if the @option{-m32381}
9428 option is in effect.  Using these instructions requires changes to
9429 register allocation which generally has a negative impact on
9430 performance.  This option should only be enabled when compiling code
9431 particularly likely to make heavy use of multiply-add instructions.
9433 @item -mnomulti-add
9434 @opindex mnomulti-add
9435 Do not try and generate multiply-add floating point instructions
9436 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9438 @item -msoft-float
9439 @opindex msoft-float
9440 Generate output containing library calls for floating point.
9441 @strong{Warning:} the requisite libraries may not be available.
9443 @item -mieee-compare
9444 @itemx -mno-ieee-compare
9445 @opindex mieee-compare
9446 @opindex mno-ieee-compare
9447 Control whether or not the compiler uses IEEE floating point
9448 comparisons.  These handle correctly the case where the result of a
9449 comparison is unordered.
9450 @strong{Warning:} the requisite kernel support may not be available.
9452 @item -mnobitfield
9453 @opindex mnobitfield
9454 Do not use the bit-field instructions.  On some machines it is faster to
9455 use shifting and masking operations.  This is the default for the pc532.
9457 @item -mbitfield
9458 @opindex mbitfield
9459 Do use the bit-field instructions.  This is the default for all platforms
9460 except the pc532.
9462 @item -mrtd
9463 @opindex mrtd
9464 Use a different function-calling convention, in which functions
9465 that take a fixed number of arguments return pop their
9466 arguments on return with the @code{ret} instruction.
9468 This calling convention is incompatible with the one normally
9469 used on Unix, so you cannot use it if you need to call libraries
9470 compiled with the Unix compiler.
9472 Also, you must provide function prototypes for all functions that
9473 take variable numbers of arguments (including @code{printf});
9474 otherwise incorrect code will be generated for calls to those
9475 functions.
9477 In addition, seriously incorrect code will result if you call a
9478 function with too many arguments.  (Normally, extra arguments are
9479 harmlessly ignored.)
9481 This option takes its name from the 680x0 @code{rtd} instruction.
9484 @item -mregparam
9485 @opindex mregparam
9486 Use a different function-calling convention where the first two arguments
9487 are passed in registers.
9489 This calling convention is incompatible with the one normally
9490 used on Unix, so you cannot use it if you need to call libraries
9491 compiled with the Unix compiler.
9493 @item -mnoregparam
9494 @opindex mnoregparam
9495 Do not pass any arguments in registers.  This is the default for all
9496 targets.
9498 @item -msb
9499 @opindex msb
9500 It is OK to use the sb as an index register which is always loaded with
9501 zero.  This is the default for the pc532-netbsd target.
9503 @item -mnosb
9504 @opindex mnosb
9505 The sb register is not available for use or has not been initialized to
9506 zero by the run time system.  This is the default for all targets except
9507 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9508 @option{-fpic} is set.
9510 @item -mhimem
9511 @opindex mhimem
9512 Many ns32000 series addressing modes use displacements of up to 512MB@.
9513 If an address is above 512MB then displacements from zero can not be used.
9514 This option causes code to be generated which can be loaded above 512MB@.
9515 This may be useful for operating systems or ROM code.
9517 @item -mnohimem
9518 @opindex mnohimem
9519 Assume code will be loaded in the first 512MB of virtual address space.
9520 This is the default for all platforms.
9523 @end table
9525 @node AVR Options
9526 @subsection AVR Options
9527 @cindex AVR Options
9529 These options are defined for AVR implementations:
9531 @table @gcctabopt
9532 @item -mmcu=@var{mcu}
9533 @opindex mmcu
9534 Specify ATMEL AVR instruction set or MCU type.
9536 Instruction set avr1 is for the minimal AVR core, not supported by the C
9537 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9538 attiny11, attiny12, attiny15, attiny28).
9540 Instruction set avr2 (default) is for the classic AVR core with up to
9541 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9542 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9543 at90c8534, at90s8535).
9545 Instruction set avr3 is for the classic AVR core with up to 128K program
9546 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9548 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9549 memory space (MCU types: atmega8, atmega83, atmega85).
9551 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9552 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9553 atmega64, atmega128, at43usb355, at94k).
9555 @item -msize
9556 @opindex msize
9557 Output instruction sizes to the asm file.
9559 @item -minit-stack=@var{N}
9560 @opindex minit-stack
9561 Specify the initial stack address, which may be a symbol or numeric value,
9562 @samp{__stack} is the default.
9564 @item -mno-interrupts
9565 @opindex mno-interrupts
9566 Generated code is not compatible with hardware interrupts.
9567 Code size will be smaller.
9569 @item -mcall-prologues
9570 @opindex mcall-prologues
9571 Functions prologues/epilogues expanded as call to appropriate
9572 subroutines.  Code size will be smaller.
9574 @item -mno-tablejump
9575 @opindex mno-tablejump
9576 Do not generate tablejump insns which sometimes increase code size.
9578 @item -mtiny-stack
9579 @opindex mtiny-stack
9580 Change only the low 8 bits of the stack pointer.
9581 @end table
9583 @node MCore Options
9584 @subsection MCore Options
9585 @cindex MCore options
9587 These are the @samp{-m} options defined for the Motorola M*Core
9588 processors.
9590 @table @gcctabopt
9592 @item -mhardlit
9593 @itemx -mhardlit
9594 @itemx -mno-hardlit
9595 @opindex mhardlit
9596 @opindex mhardlit
9597 @opindex mno-hardlit
9598 Inline constants into the code stream if it can be done in two
9599 instructions or less.
9601 @item -mdiv
9602 @itemx -mdiv
9603 @itemx -mno-div
9604 @opindex mdiv
9605 @opindex mdiv
9606 @opindex mno-div
9607 Use the divide instruction.  (Enabled by default).
9609 @item -mrelax-immediate
9610 @itemx -mrelax-immediate
9611 @itemx -mno-relax-immediate
9612 @opindex mrelax-immediate
9613 @opindex mrelax-immediate
9614 @opindex mno-relax-immediate
9615 Allow arbitrary sized immediates in bit operations.
9617 @item -mwide-bitfields
9618 @itemx -mwide-bitfields
9619 @itemx -mno-wide-bitfields
9620 @opindex mwide-bitfields
9621 @opindex mwide-bitfields
9622 @opindex mno-wide-bitfields
9623 Always treat bit-fields as int-sized.
9625 @item -m4byte-functions
9626 @itemx -m4byte-functions
9627 @itemx -mno-4byte-functions
9628 @opindex m4byte-functions
9629 @opindex m4byte-functions
9630 @opindex mno-4byte-functions
9631 Force all functions to be aligned to a four byte boundary.
9633 @item -mcallgraph-data
9634 @itemx -mcallgraph-data
9635 @itemx -mno-callgraph-data
9636 @opindex mcallgraph-data
9637 @opindex mcallgraph-data
9638 @opindex mno-callgraph-data
9639 Emit callgraph information.
9641 @item -mslow-bytes
9642 @itemx -mslow-bytes
9643 @itemx -mno-slow-bytes
9644 @opindex mslow-bytes
9645 @opindex mslow-bytes
9646 @opindex mno-slow-bytes
9647 Prefer word access when reading byte quantities.
9649 @item -mlittle-endian
9650 @itemx -mlittle-endian
9651 @itemx -mbig-endian
9652 @opindex mlittle-endian
9653 @opindex mlittle-endian
9654 @opindex mbig-endian
9655 Generate code for a little endian target.
9657 @item -m210
9658 @itemx -m210
9659 @itemx -m340
9660 @opindex m210
9661 @opindex m210
9662 @opindex m340
9663 Generate code for the 210 processor.
9664 @end table
9666 @node IA-64 Options
9667 @subsection IA-64 Options
9668 @cindex IA-64 Options
9670 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9672 @table @gcctabopt
9673 @item -mbig-endian
9674 @opindex mbig-endian
9675 Generate code for a big endian target.  This is the default for HP-UX@.
9677 @item -mlittle-endian
9678 @opindex mlittle-endian
9679 Generate code for a little endian target.  This is the default for AIX5
9680 and Linux.
9682 @item -mgnu-as
9683 @itemx -mno-gnu-as
9684 @opindex mgnu-as
9685 @opindex mno-gnu-as
9686 Generate (or don't) code for the GNU assembler.  This is the default.
9687 @c Also, this is the default if the configure option @option{--with-gnu-as}
9688 @c is used.
9690 @item -mgnu-ld
9691 @itemx -mno-gnu-ld
9692 @opindex mgnu-ld
9693 @opindex mno-gnu-ld
9694 Generate (or don't) code for the GNU linker.  This is the default.
9695 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9696 @c is used.
9698 @item -mno-pic
9699 @opindex mno-pic
9700 Generate code that does not use a global pointer register.  The result
9701 is not position independent code, and violates the IA-64 ABI@.
9703 @item -mvolatile-asm-stop
9704 @itemx -mno-volatile-asm-stop
9705 @opindex mvolatile-asm-stop
9706 @opindex mno-volatile-asm-stop
9707 Generate (or don't) a stop bit immediately before and after volatile asm
9708 statements.
9710 @item -mb-step
9711 @opindex mb-step
9712 Generate code that works around Itanium B step errata.
9714 @item -mregister-names
9715 @itemx -mno-register-names
9716 @opindex mregister-names
9717 @opindex mno-register-names
9718 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9719 the stacked registers.  This may make assembler output more readable.
9721 @item -mno-sdata
9722 @itemx -msdata
9723 @opindex mno-sdata
9724 @opindex msdata
9725 Disable (or enable) optimizations that use the small data section.  This may
9726 be useful for working around optimizer bugs.
9728 @item -mconstant-gp
9729 @opindex mconstant-gp
9730 Generate code that uses a single constant global pointer value.  This is
9731 useful when compiling kernel code.
9733 @item -mauto-pic
9734 @opindex mauto-pic
9735 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9736 This is useful when compiling firmware code.
9738 @item -minline-float-divide-min-latency
9739 @opindex minline-float-divide-min-latency
9740 Generate code for inline divides of floating point values
9741 using the minimum latency algorithm.
9743 @item -minline-float-divide-max-throughput
9744 @opindex minline-float-divide-max-throughput
9745 Generate code for inline divides of floating point values
9746 using the maximum throughput algorithm.
9748 @item -minline-int-divide-min-latency
9749 @opindex minline-int-divide-min-latency
9750 Generate code for inline divides of integer values
9751 using the minimum latency algorithm.
9753 @item -minline-int-divide-max-throughput
9754 @opindex minline-int-divide-max-throughput
9755 Generate code for inline divides of integer values
9756 using the maximum throughput algorithm.
9758 @item -mno-dwarf2-asm
9759 @itemx -mdwarf2-asm
9760 @opindex mno-dwarf2-asm
9761 @opindex mdwarf2-asm
9762 Don't (or do) generate assembler code for the DWARF2 line number debugging
9763 info.  This may be useful when not using the GNU assembler.
9765 @item -mfixed-range=@var{register-range}
9766 @opindex mfixed-range
9767 Generate code treating the given register range as fixed registers.
9768 A fixed register is one that the register allocator can not use.  This is
9769 useful when compiling kernel code.  A register range is specified as
9770 two registers separated by a dash.  Multiple register ranges can be
9771 specified separated by a comma.
9773 @item -mearly-stop-bits
9774 @itemx -mno-early-stop-bits
9775 @opindex mearly-stop-bits
9776 @opindex mno-early-stop-bits
9777 Allow stop bits to be placed earlier than immediately preceding the
9778 instruction that triggered the stop bit.  This can improve instruction
9779 scheduling, but does not always do so.
9780 @end table
9782 @node D30V Options
9783 @subsection D30V Options
9784 @cindex D30V Options
9786 These @samp{-m} options are defined for D30V implementations:
9788 @table @gcctabopt
9789 @item -mextmem
9790 @opindex mextmem
9791 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9792 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9793 memory, which starts at location @code{0x80000000}.
9795 @item -mextmemory
9796 @opindex mextmemory
9797 Same as the @option{-mextmem} switch.
9799 @item -monchip
9800 @opindex monchip
9801 Link the @samp{.text} section into onchip text memory, which starts at
9802 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9803 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9804 into onchip data memory, which starts at location @code{0x20000000}.
9806 @item -mno-asm-optimize
9807 @itemx -masm-optimize
9808 @opindex mno-asm-optimize
9809 @opindex masm-optimize
9810 Disable (enable) passing @option{-O} to the assembler when optimizing.
9811 The assembler uses the @option{-O} option to automatically parallelize
9812 adjacent short instructions where possible.
9814 @item -mbranch-cost=@var{n}
9815 @opindex mbranch-cost
9816 Increase the internal costs of branches to @var{n}.  Higher costs means
9817 that the compiler will issue more instructions to avoid doing a branch.
9818 The default is 2.
9820 @item -mcond-exec=@var{n}
9821 @opindex mcond-exec
9822 Specify the maximum number of conditionally executed instructions that
9823 replace a branch.  The default is 4.
9824 @end table
9826 @node S/390 and zSeries Options
9827 @subsection S/390 and zSeries Options
9828 @cindex S/390 and zSeries Options
9830 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9832 @table @gcctabopt
9833 @item -mhard-float
9834 @itemx -msoft-float
9835 @opindex mhard-float
9836 @opindex msoft-float
9837 Use (do not use) the hardware floating-point instructions and registers
9838 for floating-point operations.  When @option{-msoft-float} is specified,
9839 functions in @file{libgcc.a} will be used to perform floating-point
9840 operations.  When @option{-mhard-float} is specified, the compiler
9841 generates IEEE floating-point instructions.  This is the default.
9843 @item -mbackchain
9844 @itemx -mno-backchain
9845 @opindex mbackchain
9846 @opindex mno-backchain
9847 Generate (or do not generate) code which maintains an explicit
9848 backchain within the stack frame that points to the caller's frame.
9849 This is currently needed to allow debugging.  The default is to
9850 generate the backchain.
9852 @item -msmall-exec
9853 @itemx -mno-small-exec
9854 @opindex msmall-exec
9855 @opindex mno-small-exec
9856 Generate (or do not generate) code using the @code{bras} instruction
9857 to do subroutine calls.
9858 This only works reliably if the total executable size does not
9859 exceed 64k.  The default is to use the @code{basr} instruction instead,
9860 which does not have this limitation.
9862 @item -m64
9863 @itemx -m31
9864 @opindex m64
9865 @opindex m31
9866 When @option{-m31} is specified, generate code compliant to the
9867 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9868 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9869 particular to generate 64-bit instructions.  For the @samp{s390}
9870 targets, the default is @option{-m31}, while the @samp{s390x}
9871 targets default to @option{-m64}.
9873 @item -mzarch
9874 @itemx -mesa
9875 @opindex mzarch
9876 @opindex mesa
9877 When @option{-mzarch} is specified, generate code using the 
9878 instructions available on z/Architecture. 
9879 When @option{-mesa} is specified, generate code using the 
9880 instructions available on ESA/390. Note that @option{-mesa} is
9881 not possible with @option{-m64}.
9882 For the @samp{s390} targets, the default is @option{-mesa}, 
9883 while the @samp{s390x} targets default to @option{-mzarch}.
9885 @item -mmvcle
9886 @itemx -mno-mvcle
9887 @opindex mmvcle
9888 @opindex mno-mvcle
9889 Generate (or do not generate) code using the @code{mvcle} instruction
9890 to perform block moves.  When @option{-mno-mvcle} is specified,
9891 use a @code{mvc} loop instead.  This is the default.
9893 @item -mdebug
9894 @itemx -mno-debug
9895 @opindex mdebug
9896 @opindex mno-debug
9897 Print (or do not print) additional debug information when compiling.
9898 The default is to not print debug information.
9900 @item -march=@var{arch}
9901 @opindex march
9902 Generate code that will run on @var{arch}, which is the name of system
9903 representing a certain processor type. Possible values for
9904 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
9906 @item -mtune=@var{arch}
9907 @opindex mtune
9908 Tune to @var{cpu-type} everything applicable about the generated code,
9909  except for the ABI and the set of available instructions. 
9910 The list of @var{arch} values is the same as for @option{-march}.
9912 @end table
9914 @node CRIS Options
9915 @subsection CRIS Options
9916 @cindex CRIS Options
9918 These options are defined specifically for the CRIS ports.
9920 @table @gcctabopt
9921 @item -march=@var{architecture-type}
9922 @itemx -mcpu=@var{architecture-type}
9923 @opindex march
9924 @opindex mcpu
9925 Generate code for the specified architecture.  The choices for
9926 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9927 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9928 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9929 @samp{v10}.
9931 @item -mtune=@var{architecture-type}
9932 @opindex mtune
9933 Tune to @var{architecture-type} everything applicable about the generated
9934 code, except for the ABI and the set of available instructions.  The
9935 choices for @var{architecture-type} are the same as for
9936 @option{-march=@var{architecture-type}}.
9938 @item -mmax-stack-frame=@var{n}
9939 @opindex mmax-stack-frame
9940 Warn when the stack frame of a function exceeds @var{n} bytes.
9942 @item -melinux-stacksize=@var{n}
9943 @opindex melinux-stacksize
9944 Only available with the @samp{cris-axis-aout} target.  Arranges for
9945 indications in the program to the kernel loader that the stack of the
9946 program should be set to @var{n} bytes.
9948 @item -metrax4
9949 @itemx -metrax100
9950 @opindex metrax4
9951 @opindex metrax100
9952 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9953 @option{-march=v3} and @option{-march=v8} respectively.
9955 @item -mpdebug
9956 @opindex mpdebug
9957 Enable CRIS-specific verbose debug-related information in the assembly
9958 code.  This option also has the effect to turn off the @samp{#NO_APP}
9959 formatted-code indicator to the assembler at the beginning of the
9960 assembly file.
9962 @item -mcc-init
9963 @opindex mcc-init
9964 Do not use condition-code results from previous instruction; always emit
9965 compare and test instructions before use of condition codes.
9967 @item -mno-side-effects
9968 @opindex mno-side-effects
9969 Do not emit instructions with side-effects in addressing modes other than
9970 post-increment.
9972 @item -mstack-align
9973 @itemx -mno-stack-align
9974 @itemx -mdata-align
9975 @itemx -mno-data-align
9976 @itemx -mconst-align
9977 @itemx -mno-const-align
9978 @opindex mstack-align
9979 @opindex mno-stack-align
9980 @opindex mdata-align
9981 @opindex mno-data-align
9982 @opindex mconst-align
9983 @opindex mno-const-align
9984 These options (no-options) arranges (eliminate arrangements) for the
9985 stack-frame, individual data and constants to be aligned for the maximum
9986 single data access size for the chosen CPU model.  The default is to
9987 arrange for 32-bit alignment.  ABI details such as structure layout are
9988 not affected by these options.
9990 @item -m32-bit
9991 @itemx -m16-bit
9992 @itemx -m8-bit
9993 @opindex m32-bit
9994 @opindex m16-bit
9995 @opindex m8-bit
9996 Similar to the stack- data- and const-align options above, these options
9997 arrange for stack-frame, writable data and constants to all be 32-bit,
9998 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10000 @item -mno-prologue-epilogue
10001 @itemx -mprologue-epilogue
10002 @opindex mno-prologue-epilogue
10003 @opindex mprologue-epilogue
10004 With @option{-mno-prologue-epilogue}, the normal function prologue and
10005 epilogue that sets up the stack-frame are omitted and no return
10006 instructions or return sequences are generated in the code.  Use this
10007 option only together with visual inspection of the compiled code: no
10008 warnings or errors are generated when call-saved registers must be saved,
10009 or storage for local variable needs to be allocated.
10011 @item -mno-gotplt
10012 @itemx -mgotplt
10013 @opindex mno-gotplt
10014 @opindex mgotplt
10015 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10016 instruction sequences that load addresses for functions from the PLT part
10017 of the GOT rather than (traditional on other architectures) calls to the
10018 PLT.  The default is @option{-mgotplt}.
10020 @item -maout
10021 @opindex maout
10022 Legacy no-op option only recognized with the cris-axis-aout target.
10024 @item -melf
10025 @opindex melf
10026 Legacy no-op option only recognized with the cris-axis-elf and
10027 cris-axis-linux-gnu targets.
10029 @item -melinux
10030 @opindex melinux
10031 Only recognized with the cris-axis-aout target, where it selects a
10032 GNU/linux-like multilib, include files and instruction set for
10033 @option{-march=v8}.
10035 @item -mlinux
10036 @opindex mlinux
10037 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10039 @item -sim
10040 @opindex sim
10041 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10042 to link with input-output functions from a simulator library.  Code,
10043 initialized data and zero-initialized data are allocated consecutively.
10045 @item -sim2
10046 @opindex sim2
10047 Like @option{-sim}, but pass linker options to locate initialized data at
10048 0x40000000 and zero-initialized data at 0x80000000.
10049 @end table
10051 @node MMIX Options
10052 @subsection MMIX Options
10053 @cindex MMIX Options
10055 These options are defined for the MMIX:
10057 @table @gcctabopt
10058 @item -mlibfuncs
10059 @itemx -mno-libfuncs
10060 @opindex mlibfuncs
10061 @opindex mno-libfuncs
10062 Specify that intrinsic library functions are being compiled, passing all
10063 values in registers, no matter the size.
10065 @item -mepsilon
10066 @itemx -mno-epsilon
10067 @opindex mepsilon
10068 @opindex mno-epsilon
10069 Generate floating-point comparison instructions that compare with respect
10070 to the @code{rE} epsilon register.
10072 @item -mabi=mmixware
10073 @itemx -mabi=gnu
10074 @opindex mabi-mmixware
10075 @opindex mabi=gnu
10076 Generate code that passes function parameters and return values that (in
10077 the called function) are seen as registers @code{$0} and up, as opposed to
10078 the GNU ABI which uses global registers @code{$231} and up.
10080 @item -mzero-extend
10081 @itemx -mno-zero-extend
10082 @opindex mzero-extend
10083 @opindex mno-zero-extend
10084 When reading data from memory in sizes shorter than 64 bits, use (do not
10085 use) zero-extending load instructions by default, rather than
10086 sign-extending ones.
10088 @item -mknuthdiv
10089 @itemx -mno-knuthdiv
10090 @opindex mknuthdiv
10091 @opindex mno-knuthdiv
10092 Make the result of a division yielding a remainder have the same sign as
10093 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10094 remainder follows the sign of the dividend.  Both methods are
10095 arithmetically valid, the latter being almost exclusively used.
10097 @item -mtoplevel-symbols
10098 @itemx -mno-toplevel-symbols
10099 @opindex mtoplevel-symbols
10100 @opindex mno-toplevel-symbols
10101 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10102 code can be used with the @code{PREFIX} assembly directive.
10104 @item -melf
10105 @opindex melf
10106 Generate an executable in the ELF format, rather than the default
10107 @samp{mmo} format used by the @command{mmix} simulator.
10109 @item -mbranch-predict
10110 @itemx -mno-branch-predict
10111 @opindex mbranch-predict
10112 @opindex mno-branch-predict
10113 Use (do not use) the probable-branch instructions, when static branch
10114 prediction indicates a probable branch.
10116 @item -mbase-addresses
10117 @itemx -mno-base-addresses
10118 @opindex mbase-addresses
10119 @opindex mno-base-addresses
10120 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10121 base address automatically generates a request (handled by the assembler
10122 and the linker) for a constant to be set up in a global register.  The
10123 register is used for one or more base address requests within the range 0
10124 to 255 from the value held in the register.  The generally leads to short
10125 and fast code, but the number of different data items that can be
10126 addressed is limited.  This means that a program that uses lots of static
10127 data may require @option{-mno-base-addresses}.
10129 @item -msingle-exit
10130 @itemx -mno-single-exit
10131 @opindex msingle-exit
10132 @opindex mno-single-exit
10133 Force (do not force) generated code to have a single exit point in each
10134 function.
10135 @end table
10137 @node PDP-11 Options
10138 @subsection PDP-11 Options
10139 @cindex PDP-11 Options
10141 These options are defined for the PDP-11:
10143 @table @gcctabopt
10144 @item -mfpu
10145 @opindex mfpu
10146 Use hardware FPP floating point.  This is the default.  (FIS floating
10147 point on the PDP-11/40 is not supported.)
10149 @item -msoft-float
10150 @opindex msoft-float
10151 Do not use hardware floating point.
10153 @item -mac0
10154 @opindex mac0
10155 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10157 @item -mno-ac0
10158 @opindex mno-ac0
10159 Return floating-point results in memory.  This is the default.
10161 @item -m40
10162 @opindex m40
10163 Generate code for a PDP-11/40.
10165 @item -m45
10166 @opindex m45
10167 Generate code for a PDP-11/45.  This is the default.
10169 @item -m10
10170 @opindex m10
10171 Generate code for a PDP-11/10.
10173 @item -mbcopy-builtin
10174 @opindex bcopy-builtin
10175 Use inline @code{movstrhi} patterns for copying memory.  This is the
10176 default.
10178 @item -mbcopy
10179 @opindex mbcopy
10180 Do not use inline @code{movstrhi} patterns for copying memory.
10182 @item -mint16
10183 @itemx -mno-int32
10184 @opindex mint16
10185 @opindex mno-int32
10186 Use 16-bit @code{int}.  This is the default.
10188 @item -mint32
10189 @itemx -mno-int16
10190 @opindex mint32
10191 @opindex mno-int16
10192 Use 32-bit @code{int}.
10194 @item -mfloat64
10195 @itemx -mno-float32
10196 @opindex mfloat64
10197 @opindex mno-float32
10198 Use 64-bit @code{float}.  This is the default.
10200 @item -mfloat32
10201 @item -mno-float64
10202 @opindex mfloat32
10203 @opindex mno-float64
10204 Use 32-bit @code{float}.
10206 @item -mabshi
10207 @opindex mabshi
10208 Use @code{abshi2} pattern.  This is the default.
10210 @item -mno-abshi
10211 @opindex mno-abshi
10212 Do not use @code{abshi2} pattern.
10214 @item -mbranch-expensive
10215 @opindex mbranch-expensive
10216 Pretend that branches are expensive.  This is for experimenting with
10217 code generation only.
10219 @item -mbranch-cheap
10220 @opindex mbranch-cheap
10221 Do not pretend that branches are expensive.  This is the default.
10223 @item -msplit
10224 @opindex msplit
10225 Generate code for a system with split I&D.
10227 @item -mno-split
10228 @opindex mno-split
10229 Generate code for a system without split I&D.  This is the default.
10231 @item -munix-asm
10232 @opindex munix-asm
10233 Use Unix assembler syntax.  This is the default when configured for
10234 @samp{pdp11-*-bsd}.
10236 @item -mdec-asm
10237 @opindex mdec-asm
10238 Use DEC assembler syntax.  This is the default when configured for any
10239 PDP-11 target other than @samp{pdp11-*-bsd}.
10240 @end table
10242 @node Xstormy16 Options
10243 @subsection Xstormy16 Options
10244 @cindex Xstormy16 Options
10246 These options are defined for Xstormy16:
10248 @table @gcctabopt
10249 @item -msim
10250 @opindex msim
10251 Choose startup files and linker script suitable for the simulator.
10252 @end table
10254 @node FRV Options
10255 @subsection FRV Options
10256 @cindex FRV Options
10258 @table @gcctabopt
10259 @item -mgpr-32
10260 @opindex mgpr-32
10262 Only use the first 32 general purpose registers.
10264 @item -mgpr-64
10265 @opindex mgpr-64
10267 Use all 64 general purpose registers.
10269 @item -mfpr-32
10270 @opindex mfpr-32
10272 Use only the first 32 floating point registers.
10274 @item -mfpr-64
10275 @opindex mfpr-64
10277 Use all 64 floating point registers
10279 @item -mhard-float
10280 @opindex mhard-float
10282 Use hardware instructions for floating point operations.
10284 @item -msoft-float
10285 @opindex msoft-float
10287 Use library routines for floating point operations.
10289 @item -malloc-cc
10290 @opindex malloc-cc
10292 Dynamically allocate condition code registers.
10294 @item -mfixed-cc
10295 @opindex mfixed-cc
10297 Do not try to dynamically allocate condition code registers, only
10298 use @code{icc0} and @code{fcc0}.
10300 @item -mdword
10301 @opindex mdword
10303 Change ABI to use double word insns.
10305 @item -mno-dword
10306 @opindex mno-dword
10308 Do not use double word instructions.
10310 @item -mdouble
10311 @opindex mdouble
10313 Use floating point double instructions.
10315 @item -mno-double
10316 @opindex mno-double
10318 Do not use floating point double instructions.
10320 @item -mmedia
10321 @opindex mmedia
10323 Use media instructions.
10325 @item -mno-media
10326 @opindex mno-media
10328 Do not use media instructions.
10330 @item -mmuladd
10331 @opindex mmuladd
10333 Use multiply and add/subtract instructions.
10335 @item -mno-muladd
10336 @opindex mno-muladd
10338 Do not use multiply and add/subtract instructions.
10340 @item -mlibrary-pic
10341 @opindex mlibrary-pic
10343 Enable PIC support for building libraries
10345 @item -macc-4
10346 @opindex macc-4
10348 Use only the first four media accumulator registers.
10350 @item -macc-8
10351 @opindex macc-8
10353 Use all eight media accumulator registers.
10355 @item -mpack
10356 @opindex mpack
10358 Pack VLIW instructions.
10360 @item -mno-pack
10361 @opindex mno-pack
10363 Do not pack VLIW instructions.
10365 @item -mno-eflags
10366 @opindex mno-eflags
10368 Do not mark ABI switches in e_flags.
10370 @item -mcond-move
10371 @opindex mcond-move
10373 Enable the use of conditional-move instructions (default).
10375 This switch is mainly for debugging the compiler and will likely be removed
10376 in a future version.
10378 @item -mno-cond-move
10379 @opindex mno-cond-move
10381 Disable the use of conditional-move instructions.
10383 This switch is mainly for debugging the compiler and will likely be removed
10384 in a future version.
10386 @item -mscc
10387 @opindex mscc
10389 Enable the use of conditional set instructions (default).
10391 This switch is mainly for debugging the compiler and will likely be removed
10392 in a future version.
10394 @item -mno-scc
10395 @opindex mno-scc
10397 Disable the use of conditional set instructions.
10399 This switch is mainly for debugging the compiler and will likely be removed
10400 in a future version.
10402 @item -mcond-exec
10403 @opindex mcond-exec
10405 Enable the use of conditional execution (default).
10407 This switch is mainly for debugging the compiler and will likely be removed
10408 in a future version.
10410 @item -mno-cond-exec
10411 @opindex mno-cond-exec
10413 Disable the use of conditional execution.
10415 This switch is mainly for debugging the compiler and will likely be removed
10416 in a future version.
10418 @item -mvliw-branch
10419 @opindex mvliw-branch
10421 Run a pass to pack branches into VLIW instructions (default).
10423 This switch is mainly for debugging the compiler and will likely be removed
10424 in a future version.
10426 @item -mno-vliw-branch
10427 @opindex mno-vliw-branch
10429 Do not run a pass to pack branches into VLIW instructions.
10431 This switch is mainly for debugging the compiler and will likely be removed
10432 in a future version.
10434 @item -mmulti-cond-exec
10435 @opindex mmulti-cond-exec
10437 Enable optimization of @code{&&} and @code{||} in conditional execution
10438 (default).
10440 This switch is mainly for debugging the compiler and will likely be removed
10441 in a future version.
10443 @item -mno-multi-cond-exec
10444 @opindex mno-multi-cond-exec
10446 Disable optimization of @code{&&} and @code{||} in conditional execution.
10448 This switch is mainly for debugging the compiler and will likely be removed
10449 in a future version.
10451 @item -mnested-cond-exec
10452 @opindex mnested-cond-exec
10454 Enable nested conditional execution optimizations (default).
10456 This switch is mainly for debugging the compiler and will likely be removed
10457 in a future version.
10459 @item -mno-nested-cond-exec
10460 @opindex mno-nested-cond-exec
10462 Disable nested conditional execution optimizations.
10464 This switch is mainly for debugging the compiler and will likely be removed
10465 in a future version.
10467 @item -mtomcat-stats
10468 @opindex mtomcat-stats
10470 Cause gas to print out tomcat statistics.
10472 @item -mcpu=@var{cpu}
10473 @opindex mcpu
10475 Select the processor type for which to generate code.  Possible values are
10476 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10477 @samp{frv}.
10479 @end table
10481 @node Xtensa Options
10482 @subsection Xtensa Options
10483 @cindex Xtensa Options
10485 The Xtensa architecture is designed to support many different
10486 configurations.  The compiler's default options can be set to match a
10487 particular Xtensa configuration by copying a configuration file into the
10488 GCC sources when building GCC@.  The options below may be used to
10489 override the default options.
10491 @table @gcctabopt
10492 @item -mbig-endian
10493 @itemx -mlittle-endian
10494 @opindex mbig-endian
10495 @opindex mlittle-endian
10496 Specify big-endian or little-endian byte ordering for the target Xtensa
10497 processor.
10499 @item -mdensity
10500 @itemx -mno-density
10501 @opindex mdensity
10502 @opindex mno-density
10503 Enable or disable use of the optional Xtensa code density instructions.
10505 @item -mmac16
10506 @itemx -mno-mac16
10507 @opindex mmac16
10508 @opindex mno-mac16
10509 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10510 will generate MAC16 instructions from standard C code, with the
10511 limitation that it will use neither the MR register file nor any
10512 instruction that operates on the MR registers.  When this option is
10513 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10514 combination of core instructions and library calls, depending on whether
10515 any other multiplier options are enabled.
10517 @item -mmul16
10518 @itemx -mno-mul16
10519 @opindex mmul16
10520 @opindex mno-mul16
10521 Enable or disable use of the 16-bit integer multiplier option.  When
10522 enabled, the compiler will generate 16-bit multiply instructions for
10523 multiplications of 16 bits or smaller in standard C code.  When this
10524 option is disabled, the compiler will either use 32-bit multiply or
10525 MAC16 instructions if they are available or generate library calls to
10526 perform the multiply operations using shifts and adds.
10528 @item -mmul32
10529 @itemx -mno-mul32
10530 @opindex mmul32
10531 @opindex mno-mul32
10532 Enable or disable use of the 32-bit integer multiplier option.  When
10533 enabled, the compiler will generate 32-bit multiply instructions for
10534 multiplications of 32 bits or smaller in standard C code.  When this
10535 option is disabled, the compiler will generate library calls to perform
10536 the multiply operations using either shifts and adds or 16-bit multiply
10537 instructions if they are available.
10539 @item -mnsa
10540 @itemx -mno-nsa
10541 @opindex mnsa
10542 @opindex mno-nsa
10543 Enable or disable use of the optional normalization shift amount
10544 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10546 @item -mminmax
10547 @itemx -mno-minmax
10548 @opindex mminmax
10549 @opindex mno-minmax
10550 Enable or disable use of the optional minimum and maximum value
10551 instructions.
10553 @item -msext
10554 @itemx -mno-sext
10555 @opindex msext
10556 @opindex mno-sext
10557 Enable or disable use of the optional sign extend (@code{SEXT})
10558 instruction.
10560 @item -mbooleans
10561 @itemx -mno-booleans
10562 @opindex mbooleans
10563 @opindex mno-booleans
10564 Enable or disable support for the boolean register file used by Xtensa
10565 coprocessors.  This is not typically useful by itself but may be
10566 required for other options that make use of the boolean registers (e.g.,
10567 the floating-point option).
10569 @item -mhard-float
10570 @itemx -msoft-float
10571 @opindex mhard-float
10572 @opindex msoft-float
10573 Enable or disable use of the floating-point option.  When enabled, GCC
10574 generates floating-point instructions for 32-bit @code{float}
10575 operations.  When this option is disabled, GCC generates library calls
10576 to emulate 32-bit floating-point operations using integer instructions.
10577 Regardless of this option, 64-bit @code{double} operations are always
10578 emulated with calls to library functions.
10580 @item -mfused-madd
10581 @itemx -mno-fused-madd
10582 @opindex mfused-madd
10583 @opindex mno-fused-madd
10584 Enable or disable use of fused multiply/add and multiply/subtract
10585 instructions in the floating-point option.  This has no effect if the
10586 floating-point option is not also enabled.  Disabling fused multiply/add
10587 and multiply/subtract instructions forces the compiler to use separate
10588 instructions for the multiply and add/subtract operations.  This may be
10589 desirable in some cases where strict IEEE 754-compliant results are
10590 required: the fused multiply add/subtract instructions do not round the
10591 intermediate result, thereby producing results with @emph{more} bits of
10592 precision than specified by the IEEE standard.  Disabling fused multiply
10593 add/subtract instructions also ensures that the program output is not
10594 sensitive to the compiler's ability to combine multiply and add/subtract
10595 operations.
10597 @item -mserialize-volatile
10598 @itemx -mno-serialize-volatile
10599 @opindex mserialize-volatile
10600 @opindex mno-serialize-volatile
10601 When this option is enabled, GCC inserts @code{MEMW} instructions before
10602 @code{volatile} memory references to guarantee sequential consistency.
10603 The default is @option{-mserialize-volatile}.  Use
10604 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10606 @item -mtext-section-literals
10607 @itemx -mno-text-section-literals
10608 @opindex mtext-section-literals
10609 @opindex mno-text-section-literals
10610 Control the treatment of literal pools.  The default is
10611 @option{-mno-text-section-literals}, which places literals in a separate
10612 section in the output file.  This allows the literal pool to be placed
10613 in a data RAM/ROM, and it also allows the linker to combine literal
10614 pools from separate object files to remove redundant literals and
10615 improve code size.  With @option{-mtext-section-literals}, the literals
10616 are interspersed in the text section in order to keep them as close as
10617 possible to their references.  This may be necessary for large assembly
10618 files.
10620 @item -mtarget-align
10621 @itemx -mno-target-align
10622 @opindex mtarget-align
10623 @opindex mno-target-align
10624 When this option is enabled, GCC instructs the assembler to
10625 automatically align instructions to reduce branch penalties at the
10626 expense of some code density.  The assembler attempts to widen density
10627 instructions to align branch targets and the instructions following call
10628 instructions.  If there are not enough preceding safe density
10629 instructions to align a target, no widening will be performed.  The
10630 default is @option{-mtarget-align}.  These options do not affect the
10631 treatment of auto-aligned instructions like @code{LOOP}, which the
10632 assembler will always align, either by widening density instructions or
10633 by inserting no-op instructions.
10635 @item -mlongcalls
10636 @itemx -mno-longcalls
10637 @opindex mlongcalls
10638 @opindex mno-longcalls
10639 When this option is enabled, GCC instructs the assembler to translate
10640 direct calls to indirect calls unless it can determine that the target
10641 of a direct call is in the range allowed by the call instruction.  This
10642 translation typically occurs for calls to functions in other source
10643 files.  Specifically, the assembler translates a direct @code{CALL}
10644 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10645 The default is @option{-mno-longcalls}.  This option should be used in
10646 programs where the call target can potentially be out of range.  This
10647 option is implemented in the assembler, not the compiler, so the
10648 assembly code generated by GCC will still show direct call
10649 instructions---look at the disassembled object code to see the actual
10650 instructions.  Note that the assembler will use an indirect call for
10651 every cross-file call, not just those that really will be out of range.
10652 @end table
10654 @node Code Gen Options
10655 @section Options for Code Generation Conventions
10656 @cindex code generation conventions
10657 @cindex options, code generation
10658 @cindex run-time options
10660 These machine-independent options control the interface conventions
10661 used in code generation.
10663 Most of them have both positive and negative forms; the negative form
10664 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10665 one of the forms is listed---the one which is not the default.  You
10666 can figure out the other form by either removing @samp{no-} or adding
10669 @table @gcctabopt
10670 @item -fbounds-check
10671 @opindex fbounds-check
10672 For front-ends that support it, generate additional code to check that
10673 indices used to access arrays are within the declared range.  This is
10674 currently only supported by the Java and Fortran 77 front-ends, where
10675 this option defaults to true and false respectively.
10677 @item -ftrapv
10678 @opindex ftrapv
10679 This option generates traps for signed overflow on addition, subtraction,
10680 multiplication operations.
10682 @item -fexceptions
10683 @opindex fexceptions
10684 Enable exception handling.  Generates extra code needed to propagate
10685 exceptions.  For some targets, this implies GCC will generate frame
10686 unwind information for all functions, which can produce significant data
10687 size overhead, although it does not affect execution.  If you do not
10688 specify this option, GCC will enable it by default for languages like
10689 C++ which normally require exception handling, and disable it for
10690 languages like C that do not normally require it.  However, you may need
10691 to enable this option when compiling C code that needs to interoperate
10692 properly with exception handlers written in C++.  You may also wish to
10693 disable this option if you are compiling older C++ programs that don't
10694 use exception handling.
10696 @item -fnon-call-exceptions
10697 @opindex fnon-call-exceptions
10698 Generate code that allows trapping instructions to throw exceptions.
10699 Note that this requires platform-specific runtime support that does
10700 not exist everywhere.  Moreover, it only allows @emph{trapping}
10701 instructions to throw exceptions, i.e.@: memory references or floating
10702 point instructions.  It does not allow exceptions to be thrown from
10703 arbitrary signal handlers such as @code{SIGALRM}.
10705 @item -funwind-tables
10706 @opindex funwind-tables
10707 Similar to @option{-fexceptions}, except that it will just generate any needed
10708 static data, but will not affect the generated code in any other way.
10709 You will normally not enable this option; instead, a language processor
10710 that needs this handling would enable it on your behalf.
10712 @item -fasynchronous-unwind-tables
10713 @opindex funwind-tables
10714 Generate unwind table in dwarf2 format, if supported by target machine.  The
10715 table is exact at each instruction boundary, so it can be used for stack
10716 unwinding from asynchronous events (such as debugger or garbage collector).
10718 @item -fpcc-struct-return
10719 @opindex fpcc-struct-return
10720 Return ``short'' @code{struct} and @code{union} values in memory like
10721 longer ones, rather than in registers.  This convention is less
10722 efficient, but it has the advantage of allowing intercallability between
10723 GCC-compiled files and files compiled with other compilers, particularly
10724 the Portable C Compiler (pcc).
10726 The precise convention for returning structures in memory depends
10727 on the target configuration macros.
10729 Short structures and unions are those whose size and alignment match
10730 that of some integer type.
10732 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10733 switch is not binary compatible with code compiled with the
10734 @option{-freg-struct-return} switch.
10735 Use it to conform to a non-default application binary interface.
10737 @item -freg-struct-return
10738 @opindex freg-struct-return
10739 Return @code{struct} and @code{union} values in registers when possible.
10740 This is more efficient for small structures than
10741 @option{-fpcc-struct-return}.
10743 If you specify neither @option{-fpcc-struct-return} nor
10744 @option{-freg-struct-return}, GCC defaults to whichever convention is
10745 standard for the target.  If there is no standard convention, GCC
10746 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10747 the principal compiler.  In those cases, we can choose the standard, and
10748 we chose the more efficient register return alternative.
10750 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10751 switch is not binary compatible with code compiled with the
10752 @option{-fpcc-struct-return} switch.
10753 Use it to conform to a non-default application binary interface.
10755 @item -fshort-enums
10756 @opindex fshort-enums
10757 Allocate to an @code{enum} type only as many bytes as it needs for the
10758 declared range of possible values.  Specifically, the @code{enum} type
10759 will be equivalent to the smallest integer type which has enough room.
10761 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10762 code that is not binary compatible with code generated without that switch.
10763 Use it to conform to a non-default application binary interface.
10765 @item -fshort-double
10766 @opindex fshort-double
10767 Use the same size for @code{double} as for @code{float}.
10769 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10770 code that is not binary compatible with code generated without that switch.
10771 Use it to conform to a non-default application binary interface.
10773 @item -fshort-wchar
10774 @opindex fshort-wchar
10775 Override the underlying type for @samp{wchar_t} to be @samp{short
10776 unsigned int} instead of the default for the target.  This option is
10777 useful for building programs to run under WINE@.
10779 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10780 code that is not binary compatible with code generated without that switch.
10781 Use it to conform to a non-default application binary interface.
10783 @item -fshared-data
10784 @opindex fshared-data
10785 Requests that the data and non-@code{const} variables of this
10786 compilation be shared data rather than private data.  The distinction
10787 makes sense only on certain operating systems, where shared data is
10788 shared between processes running the same program, while private data
10789 exists in one copy per process.
10791 @item -fno-common
10792 @opindex fno-common
10793 In C, allocate even uninitialized global variables in the data section of the
10794 object file, rather than generating them as common blocks.  This has the
10795 effect that if the same variable is declared (without @code{extern}) in
10796 two different compilations, you will get an error when you link them.
10797 The only reason this might be useful is if you wish to verify that the
10798 program will work on other systems which always work this way.
10800 @item -fno-ident
10801 @opindex fno-ident
10802 Ignore the @samp{#ident} directive.
10804 @item -fno-gnu-linker
10805 @opindex fno-gnu-linker
10806 Do not output global initializations (such as C++ constructors and
10807 destructors) in the form used by the GNU linker (on systems where the GNU
10808 linker is the standard method of handling them).  Use this option when
10809 you want to use a non-GNU linker, which also requires using the
10810 @command{collect2} program to make sure the system linker includes
10811 constructors and destructors.  (@command{collect2} is included in the GCC
10812 distribution.)  For systems which @emph{must} use @command{collect2}, the
10813 compiler driver @command{gcc} is configured to do this automatically.
10815 @item -finhibit-size-directive
10816 @opindex finhibit-size-directive
10817 Don't output a @code{.size} assembler directive, or anything else that
10818 would cause trouble if the function is split in the middle, and the
10819 two halves are placed at locations far apart in memory.  This option is
10820 used when compiling @file{crtstuff.c}; you should not need to use it
10821 for anything else.
10823 @item -fverbose-asm
10824 @opindex fverbose-asm
10825 Put extra commentary information in the generated assembly code to
10826 make it more readable.  This option is generally only of use to those
10827 who actually need to read the generated assembly code (perhaps while
10828 debugging the compiler itself).
10830 @option{-fno-verbose-asm}, the default, causes the
10831 extra information to be omitted and is useful when comparing two assembler
10832 files.
10834 @item -fpic
10835 @opindex fpic
10836 @cindex global offset table
10837 @cindex PIC
10838 Generate position-independent code (PIC) suitable for use in a shared
10839 library, if supported for the target machine.  Such code accesses all
10840 constant addresses through a global offset table (GOT)@.  The dynamic
10841 loader resolves the GOT entries when the program starts (the dynamic
10842 loader is not part of GCC; it is part of the operating system).  If
10843 the GOT size for the linked executable exceeds a machine-specific
10844 maximum size, you get an error message from the linker indicating that
10845 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10846 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10847 on the m68k and RS/6000.  The 386 has no such limit.)
10849 Position-independent code requires special support, and therefore works
10850 only on certain machines.  For the 386, GCC supports PIC for System V
10851 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10852 position-independent.
10854 @item -fPIC
10855 @opindex fPIC
10856 If supported for the target machine, emit position-independent code,
10857 suitable for dynamic linking and avoiding any limit on the size of the
10858 global offset table.  This option makes a difference on the m68k, m88k,
10859 and the SPARC.
10861 Position-independent code requires special support, and therefore works
10862 only on certain machines.
10864 @item -ffixed-@var{reg}
10865 @opindex ffixed
10866 Treat the register named @var{reg} as a fixed register; generated code
10867 should never refer to it (except perhaps as a stack pointer, frame
10868 pointer or in some other fixed role).
10870 @var{reg} must be the name of a register.  The register names accepted
10871 are machine-specific and are defined in the @code{REGISTER_NAMES}
10872 macro in the machine description macro file.
10874 This flag does not have a negative form, because it specifies a
10875 three-way choice.
10877 @item -fcall-used-@var{reg}
10878 @opindex fcall-used
10879 Treat the register named @var{reg} as an allocable register that is
10880 clobbered by function calls.  It may be allocated for temporaries or
10881 variables that do not live across a call.  Functions compiled this way
10882 will not save and restore the register @var{reg}.
10884 It is an error to used this flag with the frame pointer or stack pointer.
10885 Use of this flag for other registers that have fixed pervasive roles in
10886 the machine's execution model will produce disastrous results.
10888 This flag does not have a negative form, because it specifies a
10889 three-way choice.
10891 @item -fcall-saved-@var{reg}
10892 @opindex fcall-saved
10893 Treat the register named @var{reg} as an allocable register saved by
10894 functions.  It may be allocated even for temporaries or variables that
10895 live across a call.  Functions compiled this way will save and restore
10896 the register @var{reg} if they use it.
10898 It is an error to used this flag with the frame pointer or stack pointer.
10899 Use of this flag for other registers that have fixed pervasive roles in
10900 the machine's execution model will produce disastrous results.
10902 A different sort of disaster will result from the use of this flag for
10903 a register in which function values may be returned.
10905 This flag does not have a negative form, because it specifies a
10906 three-way choice.
10908 @item -fpack-struct
10909 @opindex fpack-struct
10910 Pack all structure members together without holes.
10912 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
10913 code that is not binary compatible with code generated without that switch.
10914 Additionally, it makes the code suboptimal.
10915 Use it to conform to a non-default application binary interface.
10917 @item -finstrument-functions
10918 @opindex finstrument-functions
10919 Generate instrumentation calls for entry and exit to functions.  Just
10920 after function entry and just before function exit, the following
10921 profiling functions will be called with the address of the current
10922 function and its call site.  (On some platforms,
10923 @code{__builtin_return_address} does not work beyond the current
10924 function, so the call site information may not be available to the
10925 profiling functions otherwise.)
10927 @example
10928 void __cyg_profile_func_enter (void *this_fn,
10929                                void *call_site);
10930 void __cyg_profile_func_exit  (void *this_fn,
10931                                void *call_site);
10932 @end example
10934 The first argument is the address of the start of the current function,
10935 which may be looked up exactly in the symbol table.
10937 This instrumentation is also done for functions expanded inline in other
10938 functions.  The profiling calls will indicate where, conceptually, the
10939 inline function is entered and exited.  This means that addressable
10940 versions of such functions must be available.  If all your uses of a
10941 function are expanded inline, this may mean an additional expansion of
10942 code size.  If you use @samp{extern inline} in your C code, an
10943 addressable version of such functions must be provided.  (This is
10944 normally the case anyways, but if you get lucky and the optimizer always
10945 expands the functions inline, you might have gotten away without
10946 providing static copies.)
10948 A function may be given the attribute @code{no_instrument_function}, in
10949 which case this instrumentation will not be done.  This can be used, for
10950 example, for the profiling functions listed above, high-priority
10951 interrupt routines, and any functions from which the profiling functions
10952 cannot safely be called (perhaps signal handlers, if the profiling
10953 routines generate output or allocate memory).
10955 @item -fstack-check
10956 @opindex fstack-check
10957 Generate code to verify that you do not go beyond the boundary of the
10958 stack.  You should specify this flag if you are running in an
10959 environment with multiple threads, but only rarely need to specify it in
10960 a single-threaded environment since stack overflow is automatically
10961 detected on nearly all systems if there is only one stack.
10963 Note that this switch does not actually cause checking to be done; the
10964 operating system must do that.  The switch causes generation of code
10965 to ensure that the operating system sees the stack being extended.
10967 @item -fstack-limit-register=@var{reg}
10968 @itemx -fstack-limit-symbol=@var{sym}
10969 @itemx -fno-stack-limit
10970 @opindex fstack-limit-register
10971 @opindex fstack-limit-symbol
10972 @opindex fno-stack-limit
10973 Generate code to ensure that the stack does not grow beyond a certain value,
10974 either the value of a register or the address of a symbol.  If the stack
10975 would grow beyond the value, a signal is raised.  For most targets,
10976 the signal is raised before the stack overruns the boundary, so
10977 it is possible to catch the signal without taking special precautions.
10979 For instance, if the stack starts at absolute address @samp{0x80000000}
10980 and grows downwards, you can use the flags
10981 @option{-fstack-limit-symbol=__stack_limit} and
10982 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10983 of 128KB@.  Note that this may only work with the GNU linker.
10985 @cindex aliasing of parameters
10986 @cindex parameters, aliased
10987 @item -fargument-alias
10988 @itemx -fargument-noalias
10989 @itemx -fargument-noalias-global
10990 @opindex fargument-alias
10991 @opindex fargument-noalias
10992 @opindex fargument-noalias-global
10993 Specify the possible relationships among parameters and between
10994 parameters and global data.
10996 @option{-fargument-alias} specifies that arguments (parameters) may
10997 alias each other and may alias global storage.@*
10998 @option{-fargument-noalias} specifies that arguments do not alias
10999 each other, but may alias global storage.@*
11000 @option{-fargument-noalias-global} specifies that arguments do not
11001 alias each other and do not alias global storage.
11003 Each language will automatically use whatever option is required by
11004 the language standard.  You should not need to use these options yourself.
11006 @item -fleading-underscore
11007 @opindex fleading-underscore
11008 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11009 change the way C symbols are represented in the object file.  One use
11010 is to help link with legacy assembly code.
11012 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11013 generate code that is not binary compatible with code generated without that
11014 switch.  Use it to conform to a non-default application binary interface.
11015 Not all targets provide complete support for this switch.
11017 @item -ftls-model=@var{model}
11018 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11019 The @var{model} argument should be one of @code{global-dynamic},
11020 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11022 The default without @option{-fpic} is @code{initial-exec}; with
11023 @option{-fpic} the default is @code{global-dynamic}.
11024 @end table
11026 @c man end
11028 @node Environment Variables
11029 @section Environment Variables Affecting GCC
11030 @cindex environment variables
11032 @c man begin ENVIRONMENT
11034 This section describes several environment variables that affect how GCC
11035 operates.  Some of them work by specifying directories or prefixes to use
11036 when searching for various kinds of files.  Some are used to specify other
11037 aspects of the compilation environment.
11039 Note that you can also specify places to search using options such as
11040 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11041 take precedence over places specified using environment variables, which
11042 in turn take precedence over those specified by the configuration of GCC@.
11043 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11044 GNU Compiler Collection (GCC) Internals}.
11046 @table @env
11047 @item LANG
11048 @itemx LC_CTYPE
11049 @c @itemx LC_COLLATE
11050 @itemx LC_MESSAGES
11051 @c @itemx LC_MONETARY
11052 @c @itemx LC_NUMERIC
11053 @c @itemx LC_TIME
11054 @itemx LC_ALL
11055 @findex LANG
11056 @findex LC_CTYPE
11057 @c @findex LC_COLLATE
11058 @findex LC_MESSAGES
11059 @c @findex LC_MONETARY
11060 @c @findex LC_NUMERIC
11061 @c @findex LC_TIME
11062 @findex LC_ALL
11063 @cindex locale
11064 These environment variables control the way that GCC uses
11065 localization information that allow GCC to work with different
11066 national conventions.  GCC inspects the locale categories
11067 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11068 so.  These locale categories can be set to any value supported by your
11069 installation.  A typical value is @samp{en_UK} for English in the United
11070 Kingdom.
11072 The @env{LC_CTYPE} environment variable specifies character
11073 classification.  GCC uses it to determine the character boundaries in
11074 a string; this is needed for some multibyte encodings that contain quote
11075 and escape characters that would otherwise be interpreted as a string
11076 end or escape.
11078 The @env{LC_MESSAGES} environment variable specifies the language to
11079 use in diagnostic messages.
11081 If the @env{LC_ALL} environment variable is set, it overrides the value
11082 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11083 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11084 environment variable.  If none of these variables are set, GCC
11085 defaults to traditional C English behavior.
11087 @item TMPDIR
11088 @findex TMPDIR
11089 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11090 files.  GCC uses temporary files to hold the output of one stage of
11091 compilation which is to be used as input to the next stage: for example,
11092 the output of the preprocessor, which is the input to the compiler
11093 proper.
11095 @item GCC_EXEC_PREFIX
11096 @findex GCC_EXEC_PREFIX
11097 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11098 names of the subprograms executed by the compiler.  No slash is added
11099 when this prefix is combined with the name of a subprogram, but you can
11100 specify a prefix that ends with a slash if you wish.
11102 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11103 an appropriate prefix to use based on the pathname it was invoked with.
11105 If GCC cannot find the subprogram using the specified prefix, it
11106 tries looking in the usual places for the subprogram.
11108 The default value of @env{GCC_EXEC_PREFIX} is
11109 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11110 of @code{prefix} when you ran the @file{configure} script.
11112 Other prefixes specified with @option{-B} take precedence over this prefix.
11114 This prefix is also used for finding files such as @file{crt0.o} that are
11115 used for linking.
11117 In addition, the prefix is used in an unusual way in finding the
11118 directories to search for header files.  For each of the standard
11119 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11120 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11121 replacing that beginning with the specified prefix to produce an
11122 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11123 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11124 These alternate directories are searched first; the standard directories
11125 come next.
11127 @item COMPILER_PATH
11128 @findex COMPILER_PATH
11129 The value of @env{COMPILER_PATH} is a colon-separated list of
11130 directories, much like @env{PATH}.  GCC tries the directories thus
11131 specified when searching for subprograms, if it can't find the
11132 subprograms using @env{GCC_EXEC_PREFIX}.
11134 @item LIBRARY_PATH
11135 @findex LIBRARY_PATH
11136 The value of @env{LIBRARY_PATH} is a colon-separated list of
11137 directories, much like @env{PATH}.  When configured as a native compiler,
11138 GCC tries the directories thus specified when searching for special
11139 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11140 using GCC also uses these directories when searching for ordinary
11141 libraries for the @option{-l} option (but directories specified with
11142 @option{-L} come first).
11144 @item LANG
11145 @findex LANG
11146 @cindex locale definition
11147 This variable is used to pass locale information to the compiler.  One way in
11148 which this information is used is to determine the character set to be used
11149 when character literals, string literals and comments are parsed in C and C++.
11150 When the compiler is configured to allow multibyte characters,
11151 the following values for @env{LANG} are recognized:
11153 @table @samp
11154 @item C-JIS
11155 Recognize JIS characters.
11156 @item C-SJIS
11157 Recognize SJIS characters.
11158 @item C-EUCJP
11159 Recognize EUCJP characters.
11160 @end table
11162 If @env{LANG} is not defined, or if it has some other value, then the
11163 compiler will use mblen and mbtowc as defined by the default locale to
11164 recognize and translate multibyte characters.
11165 @end table
11167 @noindent
11168 Some additional environments variables affect the behavior of the
11169 preprocessor.
11171 @include cppenv.texi
11173 @c man end
11175 @node Precompiled Headers
11176 @section Using Precompiled Headers
11177 @cindex precompiled headers
11178 @cindex speed of compilation
11180 Often large projects have many header files that are included in every
11181 source file.  The time the compiler takes to process these header files
11182 over and over again can account for nearly all of the time required to
11183 build the project.  To make builds faster, GCC allows users to
11184 `precompile' a header file; then, if builds can use the precompiled
11185 header file they will be much faster.
11187 To create a precompiled header file, simply compile it as you would any
11188 other file, if necessary using the @option{-x} option to make the driver
11189 treat it as a C or C++ header file.  You will probably want to use a
11190 tool like @command{make} to keep the precompiled header up-to-date when
11191 the headers it contains change.
11193 A precompiled header file will be searched for when @code{#include} is
11194 seen in the compilation.  As it searches for the included file
11195 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11196 compiler looks for a precompiled header in each directory just before it
11197 looks for the include file in that directory.  The name searched for is
11198 the name specified in the @code{#include} with @samp{.pch} appended.  If
11199 the precompiled header file can't be used, it is ignored.
11201 For instance, if you have @code{#include "all.h"}, and you have
11202 @file{all.h.pch} in the same directory as @file{all.h}, then the
11203 precompiled header file will be used if possible, and the original
11204 header will be used otherwise.
11206 Alternatively, you might decide to put the precompiled header file in a
11207 directory and use @option{-I} to ensure that directory is searched
11208 before (or instead of) the directory containing the original header.
11209 Then, if you want to check that the precompiled header file is always
11210 used, you can put a file of the same name as the original header in this
11211 directory containing an @code{#error} command.
11213 This also works with @option{-include}.  So yet another way to use
11214 precompiled headers, good for projects not designed with precompiled
11215 header files in mind, is to simply take most of the header files used by
11216 a project, include them from another header file, precompile that header
11217 file, and @option{-include} the precompiled header.  If the header files
11218 have guards against multiple inclusion, they will be skipped because
11219 they've already been included (in the precompiled header).
11221 If you need to precompile the same header file for different
11222 languages, targets, or compiler options, you can instead make a
11223 @emph{directory} named like @file{all.h.pch}, and put each precompiled
11224 header in the directory.  (It doesn't matter what you call the files
11225 in the directory, every precompiled header in the directory will be
11226 considered.)  The first precompiled header encountered in the
11227 directory that is valid for this compilation will be used; they're
11228 searched in no particular order.
11230 There are many other possibilities, limited only by your imagination,
11231 good sense, and the constraints of your build system.
11233 A precompiled header file can be used only when these conditions apply:
11235 @itemize
11236 @item
11237 Only one precompiled header can be used in a particular compilation.
11238 @item
11239 A precompiled header can't be used once the first C token is seen.  You
11240 can have preprocessor directives before a precompiled header; you can
11241 even include a precompiled header from inside another header, so long as
11242 there are no C tokens before the @code{#include}.
11243 @item
11244 The precompiled header file must be produced for the same language as
11245 the current compilation.  You can't use a C precompiled header for a C++
11246 compilation.
11247 @item
11248 The precompiled header file must be produced by the same compiler
11249 version and configuration as the current compilation is using.
11250 The easiest way to guarantee this is to use the same compiler binary
11251 for creating and using precompiled headers.
11252 @item
11253 Any macros defined before the precompiled header (including with
11254 @option{-D}) must either be defined in the same way as when the
11255 precompiled header was generated, or must not affect the precompiled
11256 header, which usually means that the they don't appear in the
11257 precompiled header at all.
11258 @item
11259 Certain command-line options must be defined in the same way as when the
11260 precompiled header was generated.  At present, it's not clear which
11261 options are safe to change and which are not; the safest choice is to
11262 use exactly the same options when generating and using the precompiled
11263 header.
11264 @end itemize
11266 For all of these but the last, the compiler will automatically ignore
11267 the precompiled header if the conditions aren't met.  For the last item,
11268 some option changes will cause the precompiled header to be rejected,
11269 but not all incompatible option combinations have yet been found.  If
11270 you find a new incompatible combination, please consider filing a bug
11271 report, see @ref{Bugs}.
11273 @node Running Protoize
11274 @section Running Protoize
11276 The program @code{protoize} is an optional part of GCC@.  You can use
11277 it to add prototypes to a program, thus converting the program to ISO
11278 C in one respect.  The companion program @code{unprotoize} does the
11279 reverse: it removes argument types from any prototypes that are found.
11281 When you run these programs, you must specify a set of source files as
11282 command line arguments.  The conversion programs start out by compiling
11283 these files to see what functions they define.  The information gathered
11284 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11286 After scanning comes actual conversion.  The specified files are all
11287 eligible to be converted; any files they include (whether sources or
11288 just headers) are eligible as well.
11290 But not all the eligible files are converted.  By default,
11291 @code{protoize} and @code{unprotoize} convert only source and header
11292 files in the current directory.  You can specify additional directories
11293 whose files should be converted with the @option{-d @var{directory}}
11294 option.  You can also specify particular files to exclude with the
11295 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11296 directory name matches one of the specified directory names, and its
11297 name within the directory has not been excluded.
11299 Basic conversion with @code{protoize} consists of rewriting most
11300 function definitions and function declarations to specify the types of
11301 the arguments.  The only ones not rewritten are those for varargs
11302 functions.
11304 @code{protoize} optionally inserts prototype declarations at the
11305 beginning of the source file, to make them available for any calls that
11306 precede the function's definition.  Or it can insert prototype
11307 declarations with block scope in the blocks where undeclared functions
11308 are called.
11310 Basic conversion with @code{unprotoize} consists of rewriting most
11311 function declarations to remove any argument types, and rewriting
11312 function definitions to the old-style pre-ISO form.
11314 Both conversion programs print a warning for any function declaration or
11315 definition that they can't convert.  You can suppress these warnings
11316 with @option{-q}.
11318 The output from @code{protoize} or @code{unprotoize} replaces the
11319 original source file.  The original file is renamed to a name ending
11320 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11321 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11322 for DOS) file already exists, then the source file is simply discarded.
11324 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11325 scan the program and collect information about the functions it uses.
11326 So neither of these programs will work until GCC is installed.
11328 Here is a table of the options you can use with @code{protoize} and
11329 @code{unprotoize}.  Each option works with both programs unless
11330 otherwise stated.
11332 @table @code
11333 @item -B @var{directory}
11334 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11335 usual directory (normally @file{/usr/local/lib}).  This file contains
11336 prototype information about standard system functions.  This option
11337 applies only to @code{protoize}.
11339 @item -c @var{compilation-options}
11340 Use @var{compilation-options} as the options when running @command{gcc} to
11341 produce the @samp{.X} files.  The special option @option{-aux-info} is
11342 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11344 Note that the compilation options must be given as a single argument to
11345 @code{protoize} or @code{unprotoize}.  If you want to specify several
11346 @command{gcc} options, you must quote the entire set of compilation options
11347 to make them a single word in the shell.
11349 There are certain @command{gcc} arguments that you cannot use, because they
11350 would produce the wrong kind of output.  These include @option{-g},
11351 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11352 the @var{compilation-options}, they are ignored.
11354 @item -C
11355 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11356 systems) instead of @samp{.c}.  This is convenient if you are converting
11357 a C program to C++.  This option applies only to @code{protoize}.
11359 @item -g
11360 Add explicit global declarations.  This means inserting explicit
11361 declarations at the beginning of each source file for each function
11362 that is called in the file and was not declared.  These declarations
11363 precede the first function definition that contains a call to an
11364 undeclared function.  This option applies only to @code{protoize}.
11366 @item -i @var{string}
11367 Indent old-style parameter declarations with the string @var{string}.
11368 This option applies only to @code{protoize}.
11370 @code{unprotoize} converts prototyped function definitions to old-style
11371 function definitions, where the arguments are declared between the
11372 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11373 uses five spaces as the indentation.  If you want to indent with just
11374 one space instead, use @option{-i " "}.
11376 @item -k
11377 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11378 is finished.
11380 @item -l
11381 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11382 a prototype declaration for each function in each block which calls the
11383 function without any declaration.  This option applies only to
11384 @code{protoize}.
11386 @item -n
11387 Make no real changes.  This mode just prints information about the conversions
11388 that would have been done without @option{-n}.
11390 @item -N
11391 Make no @samp{.save} files.  The original files are simply deleted.
11392 Use this option with caution.
11394 @item -p @var{program}
11395 Use the program @var{program} as the compiler.  Normally, the name
11396 @file{gcc} is used.
11398 @item -q
11399 Work quietly.  Most warnings are suppressed.
11401 @item -v
11402 Print the version number, just like @option{-v} for @command{gcc}.
11403 @end table
11405 If you need special compiler options to compile one of your program's
11406 source files, then you should generate that file's @samp{.X} file
11407 specially, by running @command{gcc} on that source file with the
11408 appropriate options and the option @option{-aux-info}.  Then run
11409 @code{protoize} on the entire set of files.  @code{protoize} will use
11410 the existing @samp{.X} file because it is newer than the source file.
11411 For example:
11413 @example
11414 gcc -Dfoo=bar file1.c -aux-info file1.X
11415 protoize *.c
11416 @end example
11418 @noindent
11419 You need to include the special files along with the rest in the
11420 @code{protoize} command, even though their @samp{.X} files already
11421 exist, because otherwise they won't get converted.
11423 @xref{Protoize Caveats}, for more information on how to use
11424 @code{protoize} successfully.