gcc.texi, [...]: Update copyright and last update dates.
[official-gcc.git] / gcc / doc / invoke.texi
blob5018a841233d0322e878c91fd4adbe9490215c6b
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002 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 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.1 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @file{gcc}, or
57 @w{@uref{http://gcc.gnu.org/thanks.html}}, for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Running Protoize::    Automatically adding or removing function prototypes.
144 @end menu
146 @c man begin OPTIONS
148 @node Option Summary
149 @section Option Summary
151 Here is a summary of all the options, grouped by type.  Explanations are
152 in the following sections.
154 @table @emph
155 @item Overall Options
156 @xref{Overall Options,,Options Controlling the Kind of Output}.
157 @gccoptlist{
158 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
159 -v  --target-help  --help}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{
164 -ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding @gol
167 -trigraphs  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char @gol
171 -fwritable-strings  -fshort-wchar}
173 @item C++ Language Options
174 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
175 @gccoptlist{
176 -fno-access-control  -fcheck-new  -fconserve-space @gol
177 -fno-const-strings  -fdollars-in-identifiers @gol
178 -fno-elide-constructors @gol
179 -fno-enforce-eh-specs  -fexternal-templates @gol
180 -falt-external-templates @gol
181 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines  -fms-extensions @gol
185 -fno-nonansi-builtins  -fno-operator-names @gol
186 -fno-optional-diags  -fpermissive @gol
187 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
188 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
189 -fno-default-inline  -Wctor-dtor-privacy @gol
190 -Wnon-virtual-dtor  -Wreorder @gol
191 -Weffc++  -Wno-deprecated @gol
192 -Wno-non-template-friend  -Wold-style-cast @gol
193 -Woverloaded-virtual  -Wno-pmf-conversions @gol
194 -Wsign-promo  -Wsynth}
196 @item Objective-C Language Options
197 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
198 @gccoptlist{
199 -fconstant-string-class=@var{class-name} @gol
200 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
201 -Wno-protocol  -Wselector}
203 @item Language Independent Options
204 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
205 @gccoptlist{
206 -fmessage-length=@var{n}  @gol
207 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209 @item Warning Options
210 @xref{Warning Options,,Options to Request or Suppress Warnings}.
211 @gccoptlist{
212 -fsyntax-only  -pedantic  -pedantic-errors @gol
213 -w  -W  -Wall  -Waggregate-return @gol
214 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
215 -Wconversion  -Wdisabled-optimization  -Wdiv-by-zero  -Werror @gol
216 -Wfloat-equal  -Wformat  -Wformat=2 @gol
217 -Wformat-nonliteral  -Wformat-security @gol
218 -Wimplicit  -Wimplicit-int  @gol
219 -Wimplicit-function-declaration @gol
220 -Werror-implicit-function-declaration @gol
221 -Wimport  -Winline @gol
222 -Wlarger-than-@var{len}  -Wlong-long @gol
223 -Wmain  -Wmissing-braces  -Wmissing-declarations @gol
224 -Wmissing-format-attribute  -Wmissing-noreturn @gol
225 -Wmultichar  -Wno-format-extra-args  -Wno-format-y2k @gol
226 -Wno-import  -Wpacked  -Wpadded @gol
227 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
228 -Wreturn-type  -Wsequence-point  -Wshadow @gol
229 -Wsign-compare  -Wswitch  -Wsystem-headers @gol
230 -Wtrigraphs  -Wundef  -Wuninitialized @gol
231 -Wunknown-pragmas  -Wunreachable-code @gol
232 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
233 -Wunused-value  -Wunused-variable  -Wwrite-strings}
235 @item C-only Warning Options
236 @gccoptlist{
237 -Wbad-function-cast  -Wmissing-prototypes  -Wnested-externs @gol
238 -Wstrict-prototypes  -Wtraditional}
240 @item Debugging Options
241 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
242 @gccoptlist{
243 -d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
244 -fdump-unnumbered 
245 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
246 -fdump-tree-original@r{[}-@var{n}@r{]} -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
247 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
248 -fmem-report  -fpretend-float @gol
249 -fprofile-arcs  -ftest-coverage  -ftime-report @gol
250 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
251 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
252 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
253 -print-multi-directory  -print-multi-lib @gol
254 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
255 -save-temps  -time}
257 @item Optimization Options
258 @xref{Optimize Options,,Options that Control Optimization}.
259 @gccoptlist{
260 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
261 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
262 -fbranch-probabilities  -fcaller-saves -fcprop-registers @gol
263 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
264 -fdelayed-branch  -fdelete-null-pointer-checks @gol
265 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
266 -fforce-addr  -fforce-mem  -ffunction-sections @gol
267 -fgcse  -fgcse-lm  -fgcse-sm @gol
268 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
269 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
270 -fmove-all-movables  -fno-default-inline  -fno-defer-pop @gol
271 -fno-function-cse  -fno-guess-branch-probability @gol
272 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
273 -funsafe-math-optimizations -fno-trapping-math @gol
274 -fomit-frame-pointer  -foptimize-register-move @gol
275 -foptimize-sibling-calls  -fprefetch-loop-arrays  -freduce-all-givs @gol
276 -fregmove  -frename-registers @gol
277 -frerun-cse-after-loop  -frerun-loop-opt @gol
278 -fschedule-insns  -fschedule-insns2 @gol
279 -fsingle-precision-constant  -fssa -fssa-ccp -fssa-dce @gol
280 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
281 -funroll-all-loops  -funroll-loops  @gol
282 --param @var{name}=@var{value}
283 -O  -O0  -O1  -O2  -O3  -Os}
285 @item Preprocessor Options
286 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
287 @gccoptlist{
288 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
289 -C  -dD  -dI  -dM  -dN @gol
290 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
291 -idirafter @var{dir} @gol
292 -include @var{file}  -imacros @var{file} @gol
293 -iprefix @var{file}  -iwithprefix @var{dir} @gol
294 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
295 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
296 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option}}
298 @item Assembler Option
299 @xref{Assembler Options,,Passing Options to the Assembler}.
300 @gccoptlist{
301 -Wa,@var{option}}
303 @item Linker Options
304 @xref{Link Options,,Options for Linking}.
305 @gccoptlist{
306 @var{object-file-name}  -l@var{library} @gol
307 -nostartfiles  -nodefaultlibs  -nostdlib @gol
308 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
309 -Wl,@var{option}  -Xlinker @var{option} @gol
310 -u @var{symbol}}
312 @item Directory Options
313 @xref{Directory Options,,Options for Directory Search}.
314 @gccoptlist{
315 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
317 @item Target Options
318 @c I wrote this xref this way to avoid overfull hbox. -- rms
319 @xref{Target Options}.
320 @gccoptlist{
321 -b @var{machine}  -V @var{version}}
323 @item Machine Dependent Options
324 @xref{Submodel Options,,Hardware Models and Configurations}.
325 @emph{M680x0 Options}
326 @gccoptlist{
327 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
328 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
329 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
330 -malign-int  -mstrict-align}
332 @emph{M68hc1x Options}
333 @gccoptlist{
334 -m6811  -m6812  -m68hc11  -m68hc12 @gol
335 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
337 @emph{VAX Options}
338 @gccoptlist{
339 -mg  -mgnu  -munix}
341 @emph{SPARC Options}
342 @gccoptlist{
343 -mcpu=@var{cpu-type} @gol
344 -mtune=@var{cpu-type} @gol
345 -mcmodel=@var{code-model} @gol
346 -m32  -m64 @gol
347 -mapp-regs  -mbroken-saverestore  -mcypress @gol
348 -mepilogue  -mfaster-structs  -mflat @gol
349 -mfpu  -mhard-float  -mhard-quad-float @gol
350 -mimpure-text  -mlive-g0  -mno-app-regs @gol
351 -mno-epilogue  -mno-faster-structs  -mno-flat  -mno-fpu @gol
352 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
353 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
354 -msupersparc  -munaligned-doubles  -mv8}
356 @emph{Convex Options}
357 @gccoptlist{
358 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
359 -margcount  -mnoargcount @gol
360 -mlong32  -mlong64 @gol
361 -mvolatile-cache  -mvolatile-nocache}
363 @emph{AMD29K Options}
364 @gccoptlist{
365 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
366 -mlarge  -mnormal  -msmall @gol
367 -mkernel-registers  -mno-reuse-arg-regs @gol
368 -mno-stack-check  -mno-storem-bug @gol
369 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
370 -mstorem-bug  -muser-registers}
372 @emph{ARM Options}
373 @gccoptlist{
374 -mapcs-frame  -mno-apcs-frame @gol
375 -mapcs-26  -mapcs-32 @gol
376 -mapcs-stack-check  -mno-apcs-stack-check @gol
377 -mapcs-float  -mno-apcs-float @gol
378 -mapcs-reentrant  -mno-apcs-reentrant @gol
379 -msched-prolog  -mno-sched-prolog @gol
380 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
381 -malignment-traps  -mno-alignment-traps @gol
382 -msoft-float  -mhard-float  -mfpe @gol
383 -mthumb-interwork  -mno-thumb-interwork @gol
384 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
385 -mstructure-size-boundary=@var{n} @gol
386 -mbsd -mxopen  -mno-symrename @gol
387 -mabort-on-noreturn @gol
388 -mlong-calls  -mno-long-calls @gol
389 -msingle-pic-base  -mno-single-pic-base @gol
390 -mpic-register=@var{reg} @gol
391 -mnop-fun-dllimport @gol
392 -mpoke-function-name @gol
393 -mthumb  -marm @gol
394 -mtpcs-frame  -mtpcs-leaf-frame @gol
395 -mcaller-super-interworking  -mcallee-super-interworking }
397 @emph{MN10200 Options}
398 @gccoptlist{
399 -mrelax}
401 @emph{MN10300 Options}
402 @gccoptlist{
403 -mmult-bug  -mno-mult-bug @gol
404 -mam33  -mno-am33 @gol
405 -mno-crt0  -mrelax}
407 @emph{M32R/D Options}
408 @gccoptlist{
409 -m32rx -m32r -mcode-model=@var{model-type}  -msdata=@var{sdata-type} @gol
410 -G @var{num}}
412 @emph{M88K Options}
413 @gccoptlist{
414 -m88000  -m88100  -m88110  -mbig-pic @gol
415 -mcheck-zero-division  -mhandle-large-shift @gol
416 -midentify-revision  -mno-check-zero-division @gol
417 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
418 -mno-optimize-arg-area  -mno-serialize-volatile @gol
419 -mno-underscores  -mocs-debug-info @gol
420 -mocs-frame-position  -moptimize-arg-area @gol
421 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
422 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
423 -mversion-03.00  -mwarn-passed-structs}
425 @emph{RS/6000 and PowerPC Options}
426 @gccoptlist{
427 -mcpu=@var{cpu-type} @gol
428 -mtune=@var{cpu-type} @gol
429 -mpower  -mno-power  -mpower2  -mno-power2 @gol
430 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
431 -maltivec -mno-altivec @gol
432 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
433 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
434 -mnew-mnemonics  -mold-mnemonics @gol
435 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
436 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
437 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
438 -mstring  -mno-string  -mupdate  -mno-update @gol
439 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
440 -mstrict-align  -mno-strict-align  -mrelocatable @gol
441 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
442 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
443 -mcall-aix -mcall-sysv -mcall-netbsd @gol
444 -maix-struct-return -msvr4-struct-return
445 -mabi=altivec @gol
446 -mprototype  -mno-prototype @gol
447 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
448 -msdata=@var{opt}  -mvxworks -G @var{num} -pthread}
450 @emph{RT Options}
451 @gccoptlist{
452 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
453 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
454 -mminimum-fp-blocks  -mnohc-struct-return}
456 @emph{MIPS Options}
457 @gccoptlist{
458 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
459 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
460 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
461 -mgas  -mgp32  -mgp64 @gol
462 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
463 -mips2  -mips3  -mips4  -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
464 -mmips-as  -mmips-tfile  -mno-abicalls @gol
465 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
466 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
467 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
468 -mrnames  -msoft-float @gol
469 -m4650  -msingle-float  -mmad @gol
470 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
471 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi @gol
472 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func}
474 @emph{i386 and x86-64 Options}
475 @gccoptlist{
476 -mcpu=@var{cpu-type}  -march=@var{cpu-type} -mfpmath=@var{unit} @gol
477 -masm=@var{dialect}  -mno-fancy-math-387 @gol
478 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
479 -mno-wide-multiply  -mrtd  -malign-double @gol
480 -mpreferred-stack-boundary=@var{num} @gol
481 -mmmx  -msse -msse2 -msse-math -m3dnow @gol
482 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
483 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
484 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
485 -mno-red-zone@gol
486 -m32 -m64}
488 @emph{HPPA Options}
489 @gccoptlist{
490 -march=@var{architecture-type} @gol
491 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
492 -mfast-indirect-calls  -mgas  -mjump-in-delay @gol
493 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
494 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
495 -mno-jump-in-delay  -mno-long-load-store @gol
496 -mno-portable-runtime  -mno-soft-float @gol
497 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
498 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
499 -mschedule=@var{cpu-type}  -mspace-regs}
501 @emph{Intel 960 Options}
502 @gccoptlist{
503 -m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
504 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
505 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
506 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
507 -mno-complex-addr  -mno-leaf-procedures @gol
508 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
509 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
510 -mtail-call}
512 @emph{DEC Alpha Options}
513 @gccoptlist{
514 -mfp-regs  -mno-fp-regs  -mno-soft-float  -msoft-float @gol
515 -malpha-as  -mgas @gol
516 -mieee  -mieee-with-inexact  -mieee-conformant @gol
517 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
518 -mtrap-precision=@var{mode}  -mbuild-constants @gol
519 -mcpu=@var{cpu-type} @gol
520 -mbwx  -mno-bwx  -mcix  -mno-cix  -mmax  -mno-max @gol
521 -mmemory-latency=@var{time}}
523 @emph{DEC Alpha/VMS Options}
524 @gccoptlist{
525 -mvms-return-codes}
527 @emph{Clipper Options}
528 @gccoptlist{
529 -mc300  -mc400}
531 @emph{H8/300 Options}
532 @gccoptlist{
533 -mrelax  -mh  -ms  -mint32  -malign-300}
535 @emph{SH Options}
536 @gccoptlist{
537 -m1  -m2  -m3  -m3e @gol
538 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
539 -mb  -ml  -mdalign  -mrelax @gol
540 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
541 -mieee  -misize  -mpadstruct  -mspace @gol
542 -mprefergot  -musermode}
544 @emph{System V Options}
545 @gccoptlist{
546 -Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
548 @emph{ARC Options}
549 @gccoptlist{
550 -EB  -EL @gol
551 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
552 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
554 @emph{TMS320C3x/C4x Options}
555 @gccoptlist{
556 -mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
557 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
558 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
559 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
561 @emph{V850 Options}
562 @gccoptlist{
563 -mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
564 -mprolog-function  -mno-prolog-function  -mspace @gol
565 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
566 -mv850  -mbig-switch}
568 @emph{NS32K Options}
569 @gccoptlist{
570 -m32032  -m32332  -m32532  -m32081  -m32381 @gol
571 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
572 -mregparam  -mnoregparam  -msb  -mnosb @gol
573 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
575 @emph{AVR Options}
576 @gccoptlist{
577 -mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
578 -mcall-prologues  -mno-tablejump  -mtiny-stack}
580 @emph{MCore Options}
581 @gccoptlist{
582 -mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
583 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
584 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
585 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
586 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
588 @emph{MMIX Options}
589 @gccoptlist{
590 -mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
591 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
592 -melf -mbranch-predict -mreg-stack-fill-bug-workaround @gol
593 -mno-branch-predict -mno-reg-stack-fill-bug-workaround}
595 @emph{IA-64 Options}
596 @gccoptlist{
597 -mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
598 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
599 -mconstant-gp  -mauto-pic  -minline-divide-min-latency @gol
600 -minline-divide-max-throughput  -mno-dwarf2-asm @gol
601 -mfixed-range=@var{register-range}}
603 @emph{S/390 and zSeries Options}
604 @gccoptlist{
605 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
606 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
607 -m64 -m31 -mdebug -mno-debug}
609 @emph{CRIS Options}
610 @gccoptlist{
611 -mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
612 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
613 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
614 -mstack-align -mdata-align -mconst-align @gol
615 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
616 -melf -maout -melinux -mlinux -sim -sim2}
618 @item Code Generation Options
619 @xref{Code Gen Options,,Options for Code Generation Conventions}.
620 @gccoptlist{
621 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
622 -ffixed-@var{reg} -fexceptions @gol
623 -fnon-call-exceptions  -funwind-tables -fasynchronous-unwind-tables @gol
624 -finhibit-size-directive  -finstrument-functions @gol
625 -fno-common  -fno-ident  -fno-gnu-linker @gol
626 -fpcc-struct-return  -fpic  -fPIC @gol
627 -freg-struct-return  -fshared-data  -fshort-enums @gol
628 -fshort-double  -fvolatile @gol
629 -fvolatile-global  -fvolatile-static @gol
630 -fverbose-asm  -fpack-struct  -fstack-check @gol
631 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
632 -fargument-alias  -fargument-noalias @gol
633 -fargument-noalias-global  -fleading-underscore}
634 @end table
636 @menu
637 * Overall Options::     Controlling the kind of output:
638                         an executable, object files, assembler files,
639                         or preprocessed source.
640 * C Dialect Options::   Controlling the variant of C language compiled.
641 * C++ Dialect Options:: Variations on C++.
642 * Objective-C Dialect Options:: Variations on Objective-C.
643 * Language Independent Options:: Controlling how diagnostics should be
644                         formatted.
645 * Warning Options::     How picky should the compiler be?
646 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
647 * Optimize Options::    How much optimization?
648 * Preprocessor Options:: Controlling header files and macro definitions.
649                          Also, getting dependency information for Make.
650 * Assembler Options::   Passing options to the assembler.
651 * Link Options::        Specifying libraries and so on.
652 * Directory Options::   Where to find header files and libraries.
653                         Where to find the compiler executable files.
654 * Spec Files::          How to pass switches to sub-processes.
655 * Target Options::      Running a cross-compiler, or an old version of GCC.
656 @end menu
658 @node Overall Options
659 @section Options Controlling the Kind of Output
661 Compilation can involve up to four stages: preprocessing, compilation
662 proper, assembly and linking, always in that order.  The first three
663 stages apply to an individual source file, and end by producing an
664 object file; linking combines all the object files (those newly
665 compiled, and those specified as input) into an executable file.
667 @cindex file name suffix
668 For any given input file, the file name suffix determines what kind of
669 compilation is done:
671 @table @gcctabopt
672 @item @var{file}.c
673 C source code which must be preprocessed.
675 @item @var{file}.i
676 C source code which should not be preprocessed.
678 @item @var{file}.ii
679 C++ source code which should not be preprocessed.
681 @item @var{file}.m
682 Objective-C source code.  Note that you must link with the library
683 @file{libobjc.a} to make an Objective-C program work.
685 @item @var{file}.mi
686 Objective-C source code which should not be preprocessed.
688 @item @var{file}.h
689 C header file (not to be compiled or linked).
691 @item @var{file}.cc
692 @itemx @var{file}.cp
693 @itemx @var{file}.cxx
694 @itemx @var{file}.cpp
695 @itemx @var{file}.c++
696 @itemx @var{file}.C
697 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
698 the last two letters must both be literally @samp{x}.  Likewise,
699 @samp{.C} refers to a literal capital C@.
701 @item @var{file}.f
702 @itemx @var{file}.for
703 @itemx @var{file}.FOR
704 Fortran source code which should not be preprocessed.
706 @item @var{file}.F
707 @itemx @var{file}.fpp
708 @itemx @var{file}.FPP
709 Fortran source code which must be preprocessed (with the traditional
710 preprocessor).
712 @item @var{file}.r
713 Fortran source code which must be preprocessed with a RATFOR
714 preprocessor (not included with GCC)@.
716 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
717 Using and Porting GNU Fortran}, for more details of the handling of
718 Fortran input files.
720 @c FIXME: Descriptions of Java file types.
721 @c @var{file}.java
722 @c @var{file}.class
723 @c @var{file}.zip
724 @c @var{file}.jar
726 @item @var{file}.ads
727 Ada source code file which contains a library unit declaration (a
728 declaration of a package, subprogram, or generic, or a generic
729 instantiation), or a library unit renaming declaration (a package,
730 generic, or subprogram renaming declaration).  Such files are also
731 called @dfn{specs}.
733 @itemx @var{file}.adb
734 Ada source code file containing a library unit body (a subprogram or
735 package body).  Such files are also called @dfn{bodies}.
737 @c GCC also knows about some suffixes for languages not yet included:
738 @c Pascal:
739 @c @var{file}.p
740 @c @var{file}.pas
742 @item @var{file}.ch
743 @itemx @var{file}.chi
744 CHILL source code (preprocessed with the traditional preprocessor).
746 @item @var{file}.s
747 Assembler code.
749 @item @var{file}.S
750 Assembler code which must be preprocessed.
752 @item @var{other}
753 An object file to be fed straight into linking.
754 Any file name with no recognized suffix is treated this way.
755 @end table
757 @opindex x
758 You can specify the input language explicitly with the @option{-x} option:
760 @table @gcctabopt
761 @item -x @var{language}
762 Specify explicitly the @var{language} for the following input files
763 (rather than letting the compiler choose a default based on the file
764 name suffix).  This option applies to all following input files until
765 the next @option{-x} option.  Possible values for @var{language} are:
766 @example
767 c  c-header  cpp-output
768 c++  c++-cpp-output
769 objective-c  objc-cpp-output
770 assembler  assembler-with-cpp
772 chill
773 f77  f77-cpp-input  ratfor
774 java
775 @end example
777 @item -x none
778 Turn off any specification of a language, so that subsequent files are
779 handled according to their file name suffixes (as they are if @option{-x}
780 has not been used at all).
782 @item -pass-exit-codes
783 @opindex pass-exit-codes
784 Normally the @command{gcc} program will exit with the code of 1 if any
785 phase of the compiler returns a non-success return code.  If you specify
786 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
787 numerically highest error produced by any phase that returned an error
788 indication.
789 @end table
791 If you only want some of the stages of compilation, you can use
792 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
793 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
794 @command{gcc} is to stop.  Note that some combinations (for example,
795 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
797 @table @gcctabopt
798 @item -c
799 @opindex c
800 Compile or assemble the source files, but do not link.  The linking
801 stage simply is not done.  The ultimate output is in the form of an
802 object file for each source file.
804 By default, the object file name for a source file is made by replacing
805 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
807 Unrecognized input files, not requiring compilation or assembly, are
808 ignored.
810 @item -S
811 @opindex S
812 Stop after the stage of compilation proper; do not assemble.  The output
813 is in the form of an assembler code file for each non-assembler input
814 file specified.
816 By default, the assembler file name for a source file is made by
817 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
819 Input files that don't require compilation are ignored.
821 @item -E
822 @opindex E
823 Stop after the preprocessing stage; do not run the compiler proper.  The
824 output is in the form of preprocessed source code, which is sent to the
825 standard output.
827 Input files which don't require preprocessing are ignored.
829 @cindex output file option
830 @item -o @var{file}
831 @opindex o
832 Place output in file @var{file}.  This applies regardless to whatever
833 sort of output is being produced, whether it be an executable file,
834 an object file, an assembler file or preprocessed C code.
836 Since only one output file can be specified, it does not make sense to
837 use @option{-o} when compiling more than one input file, unless you are
838 producing an executable file as output.
840 If @option{-o} is not specified, the default is to put an executable file
841 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
842 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
843 all preprocessed C source on standard output.
845 @item -v
846 @opindex v
847 Print (on standard error output) the commands executed to run the stages
848 of compilation.  Also print the version number of the compiler driver
849 program and of the preprocessor and the compiler proper.
851 @item -pipe
852 @opindex pipe
853 Use pipes rather than temporary files for communication between the
854 various stages of compilation.  This fails to work on some systems where
855 the assembler is unable to read from a pipe; but the GNU assembler has
856 no trouble.
858 @item --help
859 @opindex help
860 Print (on the standard output) a description of the command line options
861 understood by @command{gcc}.  If the @option{-v} option is also specified
862 then @option{--help} will also be passed on to the various processes
863 invoked by @command{gcc}, so that they can display the command line options
864 they accept.  If the @option{-W} option is also specified then command
865 line options which have no documentation associated with them will also
866 be displayed.
868 @item --target-help
869 @opindex target-help
870 Print (on the standard output) a description of target specific command
871 line options for each tool.
872 @end table
874 @node Invoking G++
875 @section Compiling C++ Programs
877 @cindex suffixes for C++ source
878 @cindex C++ source file suffixes
879 C++ source files conventionally use one of the suffixes @samp{.C},
880 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
881 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
882 files with these names and compiles them as C++ programs even if you
883 call the compiler the same way as for compiling C programs (usually with
884 the name @command{gcc}).
886 @findex g++
887 @findex c++
888 However, C++ programs often require class libraries as well as a
889 compiler that understands the C++ language---and under some
890 circumstances, you might want to compile programs from standard input,
891 or otherwise without a suffix that flags them as C++ programs.
892 @command{g++} is a program that calls GCC with the default language
893 set to C++, and automatically specifies linking against the C++
894 library.  On many systems, @command{g++} is also
895 installed with the name @command{c++}.
897 @cindex invoking @command{g++}
898 When you compile C++ programs, you may specify many of the same
899 command-line options that you use for compiling programs in any
900 language; or command-line options meaningful for C and related
901 languages; or options that are meaningful only for C++ programs.
902 @xref{C Dialect Options,,Options Controlling C Dialect}, for
903 explanations of options for languages related to C@.
904 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
905 explanations of options that are meaningful only for C++ programs.
907 @node C Dialect Options
908 @section Options Controlling C Dialect
909 @cindex dialect options
910 @cindex language dialect options
911 @cindex options, dialect
913 The following options control the dialect of C (or languages derived
914 from C, such as C++ and Objective-C) that the compiler accepts:
916 @table @gcctabopt
917 @cindex ANSI support
918 @cindex ISO support
919 @item -ansi
920 @opindex ansi
921 In C mode, support all ISO C89 programs.  In C++ mode,
922 remove GNU extensions that conflict with ISO C++.
924 This turns off certain features of GCC that are incompatible with ISO
925 C89 (when compiling C code), or of standard C++ (when compiling C++ code),
926 such as the @code{asm} and @code{typeof} keywords, and
927 predefined macros such as @code{unix} and @code{vax} that identify the
928 type of system you are using.  It also enables the undesirable and
929 rarely used ISO trigraph feature.  For the C compiler,
930 it disables recognition of C++ style @samp{//} comments as well as
931 the @code{inline} keyword.
933 The alternate keywords @code{__asm__}, @code{__extension__},
934 @code{__inline__} and @code{__typeof__} continue to work despite
935 @option{-ansi}.  You would not want to use them in an ISO C program, of
936 course, but it is useful to put them in header files that might be included
937 in compilations done with @option{-ansi}.  Alternate predefined macros
938 such as @code{__unix__} and @code{__vax__} are also available, with or
939 without @option{-ansi}.
941 The @option{-ansi} option does not cause non-ISO programs to be
942 rejected gratuitously.  For that, @option{-pedantic} is required in
943 addition to @option{-ansi}.  @xref{Warning Options}.
945 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
946 option is used.  Some header files may notice this macro and refrain
947 from declaring certain functions or defining certain macros that the
948 ISO standard doesn't call for; this is to avoid interfering with any
949 programs that might use these names for other things.
951 Functions which would normally be built in but do not have semantics
952 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
953 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
954 built-in functions provided by GCC}, for details of the functions
955 affected.
957 @item -std=
958 @opindex std
959 Determine the language standard.  This option is currently only
960 supported when compiling C@.  A value for this option must be provided;
961 possible values are
963 @table @samp
964 @item c89
965 @itemx iso9899:1990
966 ISO C89 (same as @option{-ansi}).
968 @item iso9899:199409
969 ISO C89 as modified in amendment 1.
971 @item c99
972 @itemx c9x
973 @itemx iso9899:1999
974 @itemx iso9899:199x
975 ISO C99.  Note that this standard is not yet fully supported; see
976 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
977 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
979 @item gnu89
980 Default, ISO C89 plus GNU extensions (including some C99 features).
982 @item gnu99
983 @item gnu9x
984 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
985 this will become the default.  The name @samp{gnu9x} is deprecated.
987 @end table
989 Even when this option is not specified, you can still use some of the
990 features of newer standards in so far as they do not conflict with
991 previous C standards.  For example, you may use @code{__restrict__} even
992 when @option{-std=c99} is not specified.
994 The @option{-std} options specifying some version of ISO C have the same
995 effects as @option{-ansi}, except that features that were not in ISO C89
996 but are in the specified version (for example, @samp{//} comments and
997 the @code{inline} keyword in ISO C99) are not disabled.
999 @xref{Standards,,Language Standards Supported by GCC}, for details of
1000 these standard versions.
1002 @item -aux-info @var{filename}
1003 @opindex aux-info
1004 Output to the given filename prototyped declarations for all functions
1005 declared and/or defined in a translation unit, including those in header
1006 files.  This option is silently ignored in any language other than C@.
1008 Besides declarations, the file indicates, in comments, the origin of
1009 each declaration (source file and line), whether the declaration was
1010 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1011 @samp{O} for old, respectively, in the first character after the line
1012 number and the colon), and whether it came from a declaration or a
1013 definition (@samp{C} or @samp{F}, respectively, in the following
1014 character).  In the case of function definitions, a K&R-style list of
1015 arguments followed by their declarations is also provided, inside
1016 comments, after the declaration.
1018 @item -fno-asm
1019 @opindex fno-asm
1020 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1021 keyword, so that code can use these words as identifiers.  You can use
1022 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1023 instead.  @option{-ansi} implies @option{-fno-asm}.
1025 In C++, this switch only affects the @code{typeof} keyword, since
1026 @code{asm} and @code{inline} are standard keywords.  You may want to
1027 use the @option{-fno-gnu-keywords} flag instead, which has the same
1028 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1029 switch only affects the @code{asm} and @code{typeof} keywords, since
1030 @code{inline} is a standard keyword in ISO C99.
1032 @item -fno-builtin
1033 @itemx -fno-builtin-@var{function} @r{(C and Objective-C only)}
1034 @opindex fno-builtin
1035 @cindex built-in functions
1036 Don't recognize built-in functions that do not begin with
1037 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1038 functions provided by GCC}, for details of the functions affected,
1039 including those which are not built-in functions when @option{-ansi} or
1040 @option{-std} options for strict ISO C conformance are used because they
1041 do not have an ISO standard meaning.
1043 GCC normally generates special code to handle certain built-in functions
1044 more efficiently; for instance, calls to @code{alloca} may become single
1045 instructions that adjust the stack directly, and calls to @code{memcpy}
1046 may become inline copy loops.  The resulting code is often both smaller
1047 and faster, but since the function calls no longer appear as such, you
1048 cannot set a breakpoint on those calls, nor can you change the behavior
1049 of the functions by linking with a different library.
1051 In C++, @option{-fno-builtin} is always in effect.  The @option{-fbuiltin}
1052 option has no effect.  Therefore, in C++, the only way to get the
1053 optimization benefits of built-in functions is to call the function
1054 using the @samp{__builtin_} prefix.  The GNU C++ Standard Library uses
1055 built-in functions to implement many functions (like
1056 @code{std::strchr}), so that you automatically get efficient code.
1058 With the @option{-fno-builtin-@var{function}} option, not available
1059 when compiling C++, only the built-in function @var{function} is
1060 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1061 function is named this is not built-in in this version of GCC, this
1062 option is ignored.  There is no corresponding
1063 @option{-fbuiltin-@var{function}} option; if you wish to enable
1064 built-in functions selectively when using @option{-fno-builtin} or
1065 @option{-ffreestanding}, you may define macros such as:
1067 @smallexample
1068 #define abs(n)          __builtin_abs ((n))
1069 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1070 @end smallexample
1072 @item -fhosted
1073 @opindex fhosted
1074 @cindex hosted environment
1076 Assert that compilation takes place in a hosted environment.  This implies
1077 @option{-fbuiltin}.  A hosted environment is one in which the
1078 entire standard library is available, and in which @code{main} has a return
1079 type of @code{int}.  Examples are nearly everything except a kernel.
1080 This is equivalent to @option{-fno-freestanding}.
1082 @item -ffreestanding
1083 @opindex ffreestanding
1084 @cindex hosted environment
1086 Assert that compilation takes place in a freestanding environment.  This
1087 implies @option{-fno-builtin}.  A freestanding environment
1088 is one in which the standard library may not exist, and program startup may
1089 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1090 This is equivalent to @option{-fno-hosted}.
1092 @xref{Standards,,Language Standards Supported by GCC}, for details of
1093 freestanding and hosted environments.
1095 @item -trigraphs
1096 @opindex trigraphs
1097 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1098 options for strict ISO C conformance) implies @option{-trigraphs}.
1100 @cindex traditional C language
1101 @cindex C language, traditional
1102 @item -traditional
1103 @opindex traditional
1104 Attempt to support some aspects of traditional C compilers.
1105 Specifically:
1107 @itemize @bullet
1108 @item
1109 All @code{extern} declarations take effect globally even if they
1110 are written inside of a function definition.  This includes implicit
1111 declarations of functions.
1113 @item
1114 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1115 and @code{volatile} are not recognized.  (You can still use the
1116 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1117 so on.)
1119 @item
1120 Comparisons between pointers and integers are always allowed.
1122 @item
1123 Integer types @code{unsigned short} and @code{unsigned char} promote
1124 to @code{unsigned int}.
1126 @item
1127 Out-of-range floating point literals are not an error.
1129 @item
1130 Certain constructs which ISO regards as a single invalid preprocessing
1131 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1133 @item
1134 String ``constants'' are not necessarily constant; they are stored in
1135 writable space, and identical looking constants are allocated
1136 separately.  (This is the same as the effect of
1137 @option{-fwritable-strings}.)
1139 @cindex @code{longjmp} and automatic variables
1140 @item
1141 All automatic variables not declared @code{register} are preserved by
1142 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1143 not declared @code{volatile} may be clobbered.
1145 @item
1146 @cindex @samp{\x}
1147 @cindex @samp{\a}
1148 @cindex escape sequences, traditional
1149 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1150 literal characters @samp{x} and @samp{a} respectively.  Without
1151 @w{@option{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1152 representation of a character, and @samp{\a} produces a bell.
1153 @end itemize
1155 This option is deprecated and may be removed.
1157 You may wish to use @option{-fno-builtin} as well as @option{-traditional}
1158 if your program uses names that are normally GNU C built-in functions for
1159 other purposes of its own.
1161 You cannot use @option{-traditional} if you include any header files that
1162 rely on ISO C features.  Some vendors are starting to ship systems with
1163 ISO C header files and you cannot use @option{-traditional} on such
1164 systems to compile files that include any system headers.
1166 The @option{-traditional} option also enables @option{-traditional-cpp}.
1168 @item -traditional-cpp
1169 @opindex traditional-cpp
1170 Attempt to support some aspects of traditional C preprocessors.
1171 See the GNU CPP manual for details.
1173 @item -fcond-mismatch
1174 @opindex fcond-mismatch
1175 Allow conditional expressions with mismatched types in the second and
1176 third arguments.  The value of such an expression is void.  This option
1177 is not supported for C++.
1179 @item -funsigned-char
1180 @opindex funsigned-char
1181 Let the type @code{char} be unsigned, like @code{unsigned char}.
1183 Each kind of machine has a default for what @code{char} should
1184 be.  It is either like @code{unsigned char} by default or like
1185 @code{signed char} by default.
1187 Ideally, a portable program should always use @code{signed char} or
1188 @code{unsigned char} when it depends on the signedness of an object.
1189 But many programs have been written to use plain @code{char} and
1190 expect it to be signed, or expect it to be unsigned, depending on the
1191 machines they were written for.  This option, and its inverse, let you
1192 make such a program work with the opposite default.
1194 The type @code{char} is always a distinct type from each of
1195 @code{signed char} or @code{unsigned char}, even though its behavior
1196 is always just like one of those two.
1198 @item -fsigned-char
1199 @opindex fsigned-char
1200 Let the type @code{char} be signed, like @code{signed char}.
1202 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1203 the negative form of @option{-funsigned-char}.  Likewise, the option
1204 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1206 @item -fsigned-bitfields
1207 @itemx -funsigned-bitfields
1208 @itemx -fno-signed-bitfields
1209 @itemx -fno-unsigned-bitfields
1210 @opindex fsigned-bitfields
1211 @opindex funsigned-bitfields
1212 @opindex fno-signed-bitfields
1213 @opindex fno-unsigned-bitfields
1214 These options control whether a bit-field is signed or unsigned, when the
1215 declaration does not use either @code{signed} or @code{unsigned}.  By
1216 default, such a bit-field is signed, because this is consistent: the
1217 basic integer types such as @code{int} are signed types.
1219 However, when @option{-traditional} is used, bit-fields are all unsigned
1220 no matter what.
1222 @item -fwritable-strings
1223 @opindex fwritable-strings
1224 Store string constants in the writable data segment and don't uniquize
1225 them.  This is for compatibility with old programs which assume they can
1226 write into string constants.  The option @option{-traditional} also has
1227 this effect.
1229 Writing into string constants is a very bad idea; ``constants'' should
1230 be constant.
1232 @item -fallow-single-precision
1233 @opindex fallow-single-precision
1234 Do not promote single precision math operations to double precision,
1235 even when compiling with @option{-traditional}.
1237 Traditional K&R C promotes all floating point operations to double
1238 precision, regardless of the sizes of the operands.   On the
1239 architecture for which you are compiling, single precision may be faster
1240 than double precision.   If you must use @option{-traditional}, but want
1241 to use single precision operations when the operands are single
1242 precision, use this option.   This option has no effect when compiling
1243 with ISO or GNU C conventions (the default).
1245 @item -fshort-wchar
1246 @opindex fshort-wchar
1247 Override the underlying type for @samp{wchar_t} to be @samp{short
1248 unsigned int} instead of the default for the target.  This option is
1249 useful for building programs to run under WINE@.
1250 @end table
1252 @node C++ Dialect Options
1253 @section Options Controlling C++ Dialect
1255 @cindex compiler options, C++
1256 @cindex C++ options, command line
1257 @cindex options, C++
1258 This section describes the command-line options that are only meaningful
1259 for C++ programs; but you can also use most of the GNU compiler options
1260 regardless of what language your program is in.  For example, you
1261 might compile a file @code{firstClass.C} like this:
1263 @example
1264 g++ -g -frepo -O -c firstClass.C
1265 @end example
1267 @noindent
1268 In this example, only @option{-frepo} is an option meant
1269 only for C++ programs; you can use the other options with any
1270 language supported by GCC@.
1272 Here is a list of options that are @emph{only} for compiling C++ programs:
1274 @table @gcctabopt
1275 @item -fno-access-control
1276 @opindex fno-access-control
1277 Turn off all access checking.  This switch is mainly useful for working
1278 around bugs in the access control code.
1280 @item -fcheck-new
1281 @opindex fcheck-new
1282 Check that the pointer returned by @code{operator new} is non-null
1283 before attempting to modify the storage allocated.  The current Working
1284 Paper requires that @code{operator new} never return a null pointer, so
1285 this check is normally unnecessary.
1287 An alternative to using this option is to specify that your
1288 @code{operator new} does not throw any exceptions; if you declare it
1289 @samp{throw()}, G++ will check the return value.  See also @samp{new
1290 (nothrow)}.
1292 @item -fconserve-space
1293 @opindex fconserve-space
1294 Put uninitialized or runtime-initialized global variables into the
1295 common segment, as C does.  This saves space in the executable at the
1296 cost of not diagnosing duplicate definitions.  If you compile with this
1297 flag and your program mysteriously crashes after @code{main()} has
1298 completed, you may have an object that is being destroyed twice because
1299 two definitions were merged.
1301 This option is no longer useful on most targets, now that support has
1302 been added for putting variables into BSS without making them common.
1304 @item -fno-const-strings
1305 @opindex fno-const-strings
1306 Give string constants type @code{char *} instead of type @code{const
1307 char *}.  By default, G++ uses type @code{const char *} as required by
1308 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1309 actually modify the value of a string constant, unless you also use
1310 @option{-fwritable-strings}.
1312 This option might be removed in a future release of G++.  For maximum
1313 portability, you should structure your code so that it works with
1314 string constants that have type @code{const char *}.
1316 @item -fdollars-in-identifiers
1317 @opindex fdollars-in-identifiers
1318 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1319 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1320 @samp{$} by default on most target systems, but there are a few exceptions.)
1321 Traditional C allowed the character @samp{$} to form part of
1322 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1324 @item -fno-elide-constructors
1325 @opindex fno-elide-constructors
1326 The C++ standard allows an implementation to omit creating a temporary
1327 which is only used to initialize another object of the same type.
1328 Specifying this option disables that optimization, and forces G++ to
1329 call the copy constructor in all cases.
1331 @item -fno-enforce-eh-specs
1332 @opindex fno-enforce-eh-specs
1333 Don't check for violation of exception specifications at runtime.  This
1334 option violates the C++ standard, but may be useful for reducing code
1335 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1336 will still optimize based on the exception specifications.
1338 @item -fexternal-templates
1339 @opindex fexternal-templates
1341 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1342 template instantiation; template instances are emitted or not according
1343 to the location of the template definition.  @xref{Template
1344 Instantiation}, for more information.
1346 This option is deprecated.
1348 @item -falt-external-templates
1349 @opindex falt-external-templates
1350 Similar to @option{-fexternal-templates}, but template instances are
1351 emitted or not according to the place where they are first instantiated.
1352 @xref{Template Instantiation}, for more information.
1354 This option is deprecated.
1356 @item -ffor-scope
1357 @itemx -fno-for-scope
1358 @opindex ffor-scope
1359 @opindex fno-for-scope
1360 If @option{-ffor-scope} is specified, the scope of variables declared in
1361 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1362 as specified by the C++ standard.
1363 If @option{-fno-for-scope} is specified, the scope of variables declared in
1364 a @i{for-init-statement} extends to the end of the enclosing scope,
1365 as was the case in old versions of G++, and other (traditional)
1366 implementations of C++.
1368 The default if neither flag is given to follow the standard,
1369 but to allow and give a warning for old-style code that would
1370 otherwise be invalid, or have different behavior.
1372 @item -fno-gnu-keywords
1373 @opindex fno-gnu-keywords
1374 Do not recognize @code{typeof} as a keyword, so that code can use this
1375 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1376 @option{-ansi} implies @option{-fno-gnu-keywords}.
1378 @item -fno-implicit-templates
1379 @opindex fno-implicit-templates
1380 Never emit code for non-inline templates which are instantiated
1381 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1382 @xref{Template Instantiation}, for more information.
1384 @item -fno-implicit-inline-templates
1385 @opindex fno-implicit-inline-templates
1386 Don't emit code for implicit instantiations of inline templates, either.
1387 The default is to handle inlines differently so that compiles with and
1388 without optimization will need the same set of explicit instantiations.
1390 @item -fno-implement-inlines
1391 @opindex fno-implement-inlines
1392 To save space, do not emit out-of-line copies of inline functions
1393 controlled by @samp{#pragma implementation}.  This will cause linker
1394 errors if these functions are not inlined everywhere they are called.
1396 @item -fms-extensions
1397 @opindex fms-extensions
1398 Disable pedantic warnings about constructs used in MFC, such as implicit
1399 int and getting a pointer to member function via non-standard syntax.
1401 @item -fno-nonansi-builtins
1402 @opindex fno-nonansi-builtins
1403 Disable built-in declarations of functions that are not mandated by
1404 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1405 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1407 @item -fno-operator-names
1408 @opindex fno-operator-names
1409 Do not treat the operator name keywords @code{and}, @code{bitand},
1410 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1411 synonyms as keywords.
1413 @item -fno-optional-diags
1414 @opindex fno-optional-diags
1415 Disable diagnostics that the standard says a compiler does not need to
1416 issue.  Currently, the only such diagnostic issued by G++ is the one for
1417 a name having multiple meanings within a class.
1419 @item -fpermissive
1420 @opindex fpermissive
1421 Downgrade messages about nonconformant code from errors to warnings.  By
1422 default, G++ effectively sets @option{-pedantic-errors} without
1423 @option{-pedantic}; this option reverses that.  This behavior and this
1424 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1426 @item -frepo
1427 @opindex frepo
1428 Enable automatic template instantiation at link time.  This option also
1429 implies @option{-fno-implicit-templates}.  @xref{Template
1430 Instantiation}, for more information.
1432 @item -fno-rtti
1433 @opindex fno-rtti
1434 Disable generation of information about every class with virtual
1435 functions for use by the C++ runtime type identification features
1436 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1437 of the language, you can save some space by using this flag.  Note that
1438 exception handling uses the same information, but it will generate it as
1439 needed.
1441 @item -fstats
1442 @opindex fstats
1443 Emit statistics about front-end processing at the end of the compilation.
1444 This information is generally only useful to the G++ development team.
1446 @item -ftemplate-depth-@var{n}
1447 @opindex ftemplate-depth
1448 Set the maximum instantiation depth for template classes to @var{n}.
1449 A limit on the template instantiation depth is needed to detect
1450 endless recursions during template class instantiation.  ANSI/ISO C++
1451 conforming programs must not rely on a maximum depth greater than 17.
1453 @item -fuse-cxa-atexit
1454 @opindex fuse-cxa-atexit
1455 Register destructors for objects with static storage duration with the
1456 @code{__cxa_atexit} function rather than the @code{atexit} function.
1457 This option is required for fully standards-compliant handling of static
1458 destructors, but will only work if your C library supports
1459 @code{__cxa_atexit}.
1461 @item -fvtable-gc
1462 @opindex fvtable-gc
1463 Emit special relocations for vtables and virtual function references
1464 so that the linker can identify unused virtual functions and zero out
1465 vtable slots that refer to them.  This is most useful with
1466 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1467 also discard the functions themselves.
1469 This optimization requires GNU as and GNU ld.  Not all systems support
1470 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1472 @item -fno-weak
1473 @opindex fno-weak
1474 Do not use weak symbol support, even if it is provided by the linker.
1475 By default, G++ will use weak symbols if they are available.  This
1476 option exists only for testing, and should not be used by end-users;
1477 it will result in inferior code and has no benefits.  This option may
1478 be removed in a future release of G++.
1480 @item -nostdinc++
1481 @opindex nostdinc++
1482 Do not search for header files in the standard directories specific to
1483 C++, but do still search the other standard directories.  (This option
1484 is used when building the C++ library.)
1485 @end table
1487 In addition, these optimization, warning, and code generation options
1488 have meanings only for C++ programs:
1490 @table @gcctabopt
1491 @item -fno-default-inline
1492 @opindex fno-default-inline
1493 Do not assume @samp{inline} for functions defined inside a class scope.
1494 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1495 functions will have linkage like inline functions; they just won't be
1496 inlined by default.
1498 @item -Wctor-dtor-privacy @r{(C++ only)}
1499 @opindex Wctor-dtor-privacy
1500 Warn when a class seems unusable, because all the constructors or
1501 destructors in a class are private and the class has no friends or
1502 public static member functions.
1504 @item -Wnon-virtual-dtor @r{(C++ only)}
1505 @opindex Wnon-virtual-dtor
1506 Warn when a class declares a non-virtual destructor that should probably
1507 be virtual, because it looks like the class will be used polymorphically.
1509 @item -Wreorder @r{(C++ only)}
1510 @opindex Wreorder
1511 @cindex reordering, warning
1512 @cindex warning for reordering of member initializers
1513 Warn when the order of member initializers given in the code does not
1514 match the order in which they must be executed.  For instance:
1516 @smallexample
1517 struct A @{
1518   int i;
1519   int j;
1520   A(): j (0), i (1) @{ @}
1522 @end smallexample
1524 Here the compiler will warn that the member initializers for @samp{i}
1525 and @samp{j} will be rearranged to match the declaration order of the
1526 members.
1527 @end table
1529 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1531 @table @gcctabopt
1532 @item -Weffc++ @r{(C++ only)}
1533 @opindex Weffc++
1534 Warn about violations of various style guidelines from Scott Meyers'
1535 @cite{Effective C++} books.  If you use this option, you should be aware
1536 that the standard library headers do not obey all of these guidelines;
1537 you can use @samp{grep -v} to filter out those warnings.
1539 @item -Wno-deprecated @r{(C++ only)}
1540 @opindex Wno-deprecated
1541 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1543 @item -Wno-non-template-friend @r{(C++ only)}
1544 @opindex Wno-non-template-friend
1545 Disable warnings when non-templatized friend functions are declared
1546 within a template.  With the advent of explicit template specification
1547 support in G++, if the name of the friend is an unqualified-id (i.e.,
1548 @samp{friend foo(int)}), the C++ language specification demands that the
1549 friend declare or define an ordinary, nontemplate function.  (Section
1550 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1551 could be interpreted as a particular specialization of a templatized
1552 function.  Because this non-conforming behavior is no longer the default
1553 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1554 check existing code for potential trouble spots, and is on by default.
1555 This new compiler behavior can be turned off with
1556 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1557 but disables the helpful warning.
1559 @item -Wold-style-cast @r{(C++ only)}
1560 @opindex Wold-style-cast
1561 Warn if an old-style (C-style) cast to a non-void type is used within
1562 a C++ program.  The new-style casts (@samp{static_cast},
1563 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1564 unintended effects, and much easier to grep for.
1566 @item -Woverloaded-virtual @r{(C++ only)}
1567 @opindex Woverloaded-virtual
1568 @cindex overloaded virtual fn, warning
1569 @cindex warning for overloaded virtual fn
1570 Warn when a function declaration hides virtual functions from a
1571 base class.  For example, in:
1573 @smallexample
1574 struct A @{
1575   virtual void f();
1578 struct B: public A @{
1579   void f(int);
1581 @end smallexample
1583 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1584 like this:
1586 @smallexample
1587 B* b;
1588 b->f();
1589 @end smallexample
1591 will fail to compile.
1593 @item -Wno-pmf-conversions @r{(C++ only)}
1594 @opindex Wno-pmf-conversions
1595 Disable the diagnostic for converting a bound pointer to member function
1596 to a plain pointer.
1598 @item -Wsign-promo @r{(C++ only)}
1599 @opindex Wsign-promo
1600 Warn when overload resolution chooses a promotion from unsigned or
1601 enumeral type to a signed type over a conversion to an unsigned type of
1602 the same size.  Previous versions of G++ would try to preserve
1603 unsignedness, but the standard mandates the current behavior.
1605 @item -Wsynth @r{(C++ only)}
1606 @opindex Wsynth
1607 @cindex warning for synthesized methods
1608 @cindex synthesized methods, warning
1609 Warn when G++'s synthesis behavior does not match that of cfront.  For
1610 instance:
1612 @smallexample
1613 struct A @{
1614   operator int ();
1615   A& operator = (int);
1618 main ()
1620   A a,b;
1621   a = b;
1623 @end smallexample
1625 In this example, G++ will synthesize a default @samp{A& operator =
1626 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1627 @end table
1629 @node Objective-C Dialect Options
1630 @section Options Controlling Objective-C Dialect
1632 @cindex compiler options, Objective-C
1633 @cindex Objective-C options, command line
1634 @cindex options, Objective-C
1635 This section describes the command-line options that are only meaningful
1636 for Objective-C programs; but you can also use most of the GNU compiler
1637 options regardless of what language your program is in.  For example,
1638 you might compile a file @code{some_class.m} like this:
1640 @example
1641 gcc -g -fgnu-runtime -O -c some_class.m
1642 @end example
1644 @noindent
1645 In this example, only @option{-fgnu-runtime} is an option meant only for
1646 Objective-C programs; you can use the other options with any language
1647 supported by GCC@.
1649 Here is a list of options that are @emph{only} for compiling Objective-C
1650 programs:
1652 @table @gcctabopt
1653 @item -fconstant-string-class=@var{class-name}
1654 @opindex fconstant-string-class
1655 Use @var{class-name} as the name of the class to instantiate for each
1656 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1657 class name is @code{NXConstantString}.
1659 @item -fgnu-runtime
1660 @opindex fgnu-runtime
1661 Generate object code compatible with the standard GNU Objective-C
1662 runtime.  This is the default for most types of systems.
1664 @item -fnext-runtime
1665 @opindex fnext-runtime
1666 Generate output compatible with the NeXT runtime.  This is the default
1667 for NeXT-based systems, including Darwin and Mac OS X@.
1669 @item -gen-decls
1670 @opindex gen-decls
1671 Dump interface declarations for all classes seen in the source file to a
1672 file named @file{@var{sourcename}.decl}.
1674 @item -Wno-protocol
1675 @opindex Wno-protocol
1676 Do not warn if methods required by a protocol are not implemented
1677 in the class adopting it.
1679 @item -Wselector
1680 @opindex Wselector
1681 Warn if a selector has multiple methods of different types defined.
1683 @c not documented because only avail via -Wp
1684 @c @item -print-objc-runtime-info
1686 @end table
1688 @node Language Independent Options
1689 @section Options to Control Diagnostic Messages Formatting
1690 @cindex options to control diagnostics formatting
1691 @cindex diagnostic messages
1692 @cindex message formatting
1694 Traditionally, diagnostic messages have been formatted irrespective of
1695 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1696 below can be used to control the diagnostic messages formatting
1697 algorithm, e.g.@: how many characters per line, how often source location
1698 information should be reported.  Right now, only the C++ front end can
1699 honor these options.  However it is expected, in the near future, that
1700 the remaining front ends would be able to digest them correctly.
1702 @table @gcctabopt
1703 @item -fmessage-length=@var{n}
1704 @opindex fmessage-length
1705 Try to format error messages so that they fit on lines of about @var{n}
1706 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1707 the front ends supported by GCC@.  If @var{n} is zero, then no
1708 line-wrapping will be done; each error message will appear on a single
1709 line.
1711 @opindex fdiagnostics-show-location
1712 @item -fdiagnostics-show-location=once
1713 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1714 reporter to emit @emph{once} source location information; that is, in
1715 case the message is too long to fit on a single physical line and has to
1716 be wrapped, the source location won't be emitted (as prefix) again,
1717 over and over, in subsequent continuation lines.  This is the default
1718 behavior.
1720 @item -fdiagnostics-show-location=every-line
1721 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1722 messages reporter to emit the same source location information (as
1723 prefix) for physical lines that result from the process of breaking
1724 a message which is too long to fit on a single line.
1726 @end table
1728 @node Warning Options
1729 @section Options to Request or Suppress Warnings
1730 @cindex options to control warnings
1731 @cindex warning messages
1732 @cindex messages, warning
1733 @cindex suppressing warnings
1735 Warnings are diagnostic messages that report constructions which
1736 are not inherently erroneous but which are risky or suggest there
1737 may have been an error.
1739 You can request many specific warnings with options beginning @samp{-W},
1740 for example @option{-Wimplicit} to request warnings on implicit
1741 declarations.  Each of these specific warning options also has a
1742 negative form beginning @samp{-Wno-} to turn off warnings;
1743 for example, @option{-Wno-implicit}.  This manual lists only one of the
1744 two forms, whichever is not the default.
1746 These options control the amount and kinds of warnings produced by GCC:
1748 @table @gcctabopt
1749 @cindex syntax checking
1750 @item -fsyntax-only
1751 @opindex fsyntax-only
1752 Check the code for syntax errors, but don't do anything beyond that.
1754 @item -pedantic
1755 @opindex pedantic
1756 Issue all the warnings demanded by strict ISO C and ISO C++;
1757 reject all programs that use forbidden extensions, and some other
1758 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1759 version of the ISO C standard specified by any @option{-std} option used.
1761 Valid ISO C and ISO C++ programs should compile properly with or without
1762 this option (though a rare few will require @option{-ansi} or a
1763 @option{-std} option specifying the required version of ISO C)@.  However,
1764 without this option, certain GNU extensions and traditional C and C++
1765 features are supported as well.  With this option, they are rejected.
1767 @option{-pedantic} does not cause warning messages for use of the
1768 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1769 warnings are also disabled in the expression that follows
1770 @code{__extension__}.  However, only system header files should use
1771 these escape routes; application programs should avoid them.
1772 @xref{Alternate Keywords}.
1774 Some users try to use @option{-pedantic} to check programs for strict ISO
1775 C conformance.  They soon find that it does not do quite what they want:
1776 it finds some non-ISO practices, but not all---only those for which
1777 ISO C @emph{requires} a diagnostic, and some others for which
1778 diagnostics have been added.
1780 A feature to report any failure to conform to ISO C might be useful in
1781 some instances, but would require considerable additional work and would
1782 be quite different from @option{-pedantic}.  We don't have plans to
1783 support such a feature in the near future.
1785 Where the standard specified with @option{-std} represents a GNU
1786 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1787 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1788 extended dialect is based.  Warnings from @option{-pedantic} are given
1789 where they are required by the base standard.  (It would not make sense
1790 for such warnings to be given only for features not in the specified GNU
1791 C dialect, since by definition the GNU dialects of C include all
1792 features the compiler supports with the given option, and there would be
1793 nothing to warn about.)
1795 @item -pedantic-errors
1796 @opindex pedantic-errors
1797 Like @option{-pedantic}, except that errors are produced rather than
1798 warnings.
1800 @item -w
1801 @opindex w
1802 Inhibit all warning messages.
1804 @item -Wno-import
1805 @opindex Wno-import
1806 Inhibit warning messages about the use of @samp{#import}.
1808 @item -Wchar-subscripts
1809 @opindex Wchar-subscripts
1810 Warn if an array subscript has type @code{char}.  This is a common cause
1811 of error, as programmers often forget that this type is signed on some
1812 machines.
1814 @item -Wcomment
1815 @opindex Wcomment
1816 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1817 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1819 @item -Wformat
1820 @opindex Wformat
1821 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1822 the arguments supplied have types appropriate to the format string
1823 specified, and that the conversions specified in the format string make
1824 sense.  This includes standard functions, and others specified by format
1825 attributes (@pxref{Function Attributes}), in the @code{printf},
1826 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1827 not in the C standard) families.
1829 The formats are checked against the format features supported by GNU
1830 libc version 2.2.  These include all ISO C89 and C99 features, as well
1831 as features from the Single Unix Specification and some BSD and GNU
1832 extensions.  Other library implementations may not support all these
1833 features; GCC does not support warning about features that go beyond a
1834 particular library's limitations.  However, if @option{-pedantic} is used
1835 with @option{-Wformat}, warnings will be given about format features not
1836 in the selected standard version (but not for @code{strfmon} formats,
1837 since those are not in any version of the C standard).  @xref{C Dialect
1838 Options,,Options Controlling C Dialect}.
1840 @option{-Wformat} is included in @option{-Wall}.  For more control over some
1841 aspects of format checking, the options @option{-Wno-format-y2k},
1842 @option{-Wno-format-extra-args}, @option{-Wformat-nonliteral},
1843 @option{-Wformat-security} and @option{-Wformat=2} are available, but are
1844 not included in @option{-Wall}.
1846 @item -Wno-format-y2k
1847 @opindex Wno-format-y2k
1848 If @option{-Wformat} is specified, do not warn about @code{strftime}
1849 formats which may yield only a two-digit year.
1851 @item -Wno-format-extra-args
1852 @opindex Wno-format-extra-args
1853 If @option{-Wformat} is specified, do not warn about excess arguments to a
1854 @code{printf} or @code{scanf} format function.  The C standard specifies
1855 that such arguments are ignored.
1857 Where the unused arguments lie between used arguments that are
1858 specified with @samp{$} operand number specifications, normally
1859 warnings are still given, since the implementation could not know what
1860 type to pass to @code{va_arg} to skip the unused arguments.  However,
1861 in the case of @code{scanf} formats, this option will suppress the
1862 warning if the unused arguments are all pointers, since the Single
1863 Unix Specification says that such unused arguments are allowed.
1865 @item -Wformat-nonliteral
1866 @opindex Wformat-nonliteral
1867 If @option{-Wformat} is specified, also warn if the format string is not a
1868 string literal and so cannot be checked, unless the format function
1869 takes its format arguments as a @code{va_list}.
1871 @item -Wformat-security
1872 @opindex Wformat-security
1873 If @option{-Wformat} is specified, also warn about uses of format
1874 functions that represent possible security problems.  At present, this
1875 warns about calls to @code{printf} and @code{scanf} functions where the
1876 format string is not a string literal and there are no format arguments,
1877 as in @code{printf (foo);}.  This may be a security hole if the format
1878 string came from untrusted input and contains @samp{%n}.  (This is
1879 currently a subset of what @option{-Wformat-nonliteral} warns about, but
1880 in future warnings may be added to @option{-Wformat-security} that are not
1881 included in @option{-Wformat-nonliteral}.)
1883 @item -Wformat=2
1884 @opindex Wformat=2
1885 Enable @option{-Wformat} plus format checks not included in
1886 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
1887 -Wformat-nonliteral -Wformat-security}.
1889 @item -Wimplicit-int
1890 @opindex Wimplicit-int
1891 Warn when a declaration does not specify a type.
1893 @item -Wimplicit-function-declaration
1894 @itemx -Werror-implicit-function-declaration
1895 @opindex Wimplicit-function-declaration
1896 @opindex Werror-implicit-function-declaration
1897 Give a warning (or error) whenever a function is used before being
1898 declared.
1900 @item -Wimplicit
1901 @opindex Wimplicit
1902 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
1904 @item -Wmain
1905 @opindex Wmain
1906 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1907 function with external linkage, returning int, taking either zero
1908 arguments, two, or three arguments of appropriate types.
1910 @item -Wmissing-braces
1911 @opindex Wmissing-braces
1912 Warn if an aggregate or union initializer is not fully bracketed.  In
1913 the following example, the initializer for @samp{a} is not fully
1914 bracketed, but that for @samp{b} is fully bracketed.
1916 @smallexample
1917 int a[2][2] = @{ 0, 1, 2, 3 @};
1918 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
1919 @end smallexample
1921 @item -Wparentheses
1922 @opindex Wparentheses
1923 Warn if parentheses are omitted in certain contexts, such
1924 as when there is an assignment in a context where a truth value
1925 is expected, or when operators are nested whose precedence people
1926 often get confused about.
1928 Also warn about constructions where there may be confusion to which
1929 @code{if} statement an @code{else} branch belongs.  Here is an example of
1930 such a case:
1932 @smallexample
1933 @group
1935   if (a)
1936     if (b)
1937       foo ();
1938   else
1939     bar ();
1941 @end group
1942 @end smallexample
1944 In C, every @code{else} branch belongs to the innermost possible @code{if}
1945 statement, which in this example is @code{if (b)}.  This is often not
1946 what the programmer expected, as illustrated in the above example by
1947 indentation the programmer chose.  When there is the potential for this
1948 confusion, GCC will issue a warning when this flag is specified.
1949 To eliminate the warning, add explicit braces around the innermost
1950 @code{if} statement so there is no way the @code{else} could belong to
1951 the enclosing @code{if}.  The resulting code would look like this:
1953 @smallexample
1954 @group
1956   if (a)
1957     @{
1958       if (b)
1959         foo ();
1960       else
1961         bar ();
1962     @}
1964 @end group
1965 @end smallexample
1967 @item -Wsequence-point
1968 @opindex Wsequence-point
1969 Warn about code that may have undefined semantics because of violations
1970 of sequence point rules in the C standard.
1972 The C standard defines the order in which expressions in a C program are
1973 evaluated in terms of @dfn{sequence points}, which represent a partial
1974 ordering between the execution of parts of the program: those executed
1975 before the sequence point, and those executed after it.  These occur
1976 after the evaluation of a full expression (one which is not part of a
1977 larger expression), after the evaluation of the first operand of a
1978 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1979 function is called (but after the evaluation of its arguments and the
1980 expression denoting the called function), and in certain other places.
1981 Other than as expressed by the sequence point rules, the order of
1982 evaluation of subexpressions of an expression is not specified.  All
1983 these rules describe only a partial order rather than a total order,
1984 since, for example, if two functions are called within one expression
1985 with no sequence point between them, the order in which the functions
1986 are called is not specified.  However, the standards committee have
1987 ruled that function calls do not overlap.
1989 It is not specified when between sequence points modifications to the
1990 values of objects take effect.  Programs whose behavior depends on this
1991 have undefined behavior; the C standard specifies that ``Between the
1992 previous and next sequence point an object shall have its stored value
1993 modified at most once by the evaluation of an expression.  Furthermore,
1994 the prior value shall be read only to determine the value to be
1995 stored.''.  If a program breaks these rules, the results on any
1996 particular implementation are entirely unpredictable.
1998 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1999 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2000 diagnosed by this option, and it may give an occasional false positive
2001 result, but in general it has been found fairly effective at detecting
2002 this sort of problem in programs.
2004 The present implementation of this option only works for C programs.  A
2005 future implementation may also work for C++ programs.
2007 The C standard is worded confusingly, therefore there is some debate
2008 over the precise meaning of the sequence point rules in subtle cases.
2009 Links to discussions of the problem, including proposed formal
2010 definitions, may be found on our readings page, at
2011 @w{@uref{http://gcc.gnu.org/readings.html}}.
2013 @item -Wreturn-type
2014 @opindex Wreturn-type
2015 Warn whenever a function is defined with a return-type that defaults to
2016 @code{int}.  Also warn about any @code{return} statement with no
2017 return-value in a function whose return-type is not @code{void}.
2019 For C++, a function without return type always produces a diagnostic
2020 message, even when @option{-Wno-return-type} is specified.  The only
2021 exceptions are @samp{main} and functions defined in system headers.
2023 @item -Wswitch
2024 @opindex Wswitch
2025 Warn whenever a @code{switch} statement has an index of enumeral type
2026 and lacks a @code{case} for one or more of the named codes of that
2027 enumeration.  (The presence of a @code{default} label prevents this
2028 warning.)  @code{case} labels outside the enumeration range also
2029 provoke warnings when this option is used.
2031 @item -Wtrigraphs
2032 @opindex Wtrigraphs
2033 Warn if any trigraphs are encountered that might change the meaning of
2034 the program (trigraphs within comments are not warned about).
2036 @item -Wunused-function
2037 @opindex Wunused-function
2038 Warn whenever a static function is declared but not defined or a
2039 non\-inline static function is unused.
2041 @item -Wunused-label
2042 @opindex Wunused-label
2043 Warn whenever a label is declared but not used.
2045 To suppress this warning use the @samp{unused} attribute
2046 (@pxref{Variable Attributes}).
2048 @item -Wunused-parameter
2049 @opindex Wunused-parameter
2050 Warn whenever a function parameter is unused aside from its declaration.
2052 To suppress this warning use the @samp{unused} attribute
2053 (@pxref{Variable Attributes}).
2055 @item -Wunused-variable
2056 @opindex Wunused-variable
2057 Warn whenever a local variable or non-constant static variable is unused
2058 aside from its declaration
2060 To suppress this warning use the @samp{unused} attribute
2061 (@pxref{Variable Attributes}).
2063 @item -Wunused-value
2064 @opindex Wunused-value
2065 Warn whenever a statement computes a result that is explicitly not used.
2067 To suppress this warning cast the expression to @samp{void}.
2069 @item -Wunused
2070 @opindex Wunused
2071 All all the above @option{-Wunused} options combined.
2073 In order to get a warning about an unused function parameter, you must
2074 either specify @samp{-W -Wunused} or separately specify
2075 @option{-Wunused-parameter}.
2077 @item -Wuninitialized
2078 @opindex Wuninitialized
2079 Warn if an automatic variable is used without first being initialized or
2080 if a variable may be clobbered by a @code{setjmp} call.
2082 These warnings are possible only in optimizing compilation,
2083 because they require data flow information that is computed only
2084 when optimizing.  If you don't specify @option{-O}, you simply won't
2085 get these warnings.
2087 These warnings occur only for variables that are candidates for
2088 register allocation.  Therefore, they do not occur for a variable that
2089 is declared @code{volatile}, or whose address is taken, or whose size
2090 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2091 structures, unions or arrays, even when they are in registers.
2093 Note that there may be no warning about a variable that is used only
2094 to compute a value that itself is never used, because such
2095 computations may be deleted by data flow analysis before the warnings
2096 are printed.
2098 These warnings are made optional because GCC is not smart
2099 enough to see all the reasons why the code might be correct
2100 despite appearing to have an error.  Here is one example of how
2101 this can happen:
2103 @smallexample
2104 @group
2106   int x;
2107   switch (y)
2108     @{
2109     case 1: x = 1;
2110       break;
2111     case 2: x = 4;
2112       break;
2113     case 3: x = 5;
2114     @}
2115   foo (x);
2117 @end group
2118 @end smallexample
2120 @noindent
2121 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2122 always initialized, but GCC doesn't know this.  Here is
2123 another common case:
2125 @smallexample
2127   int save_y;
2128   if (change_y) save_y = y, y = new_y;
2129   @dots{}
2130   if (change_y) y = save_y;
2132 @end smallexample
2134 @noindent
2135 This has no bug because @code{save_y} is used only if it is set.
2137 @cindex @code{longjmp} warnings
2138 This option also warns when a non-volatile automatic variable might be
2139 changed by a call to @code{longjmp}.  These warnings as well are possible
2140 only in optimizing compilation.
2142 The compiler sees only the calls to @code{setjmp}.  It cannot know
2143 where @code{longjmp} will be called; in fact, a signal handler could
2144 call it at any point in the code.  As a result, you may get a warning
2145 even when there is in fact no problem because @code{longjmp} cannot
2146 in fact be called at the place which would cause a problem.
2148 Some spurious warnings can be avoided if you declare all the functions
2149 you use that never return as @code{noreturn}.  @xref{Function
2150 Attributes}.
2152 @item -Wreorder @r{(C++ only)}
2153 @opindex Wreorder
2154 @cindex reordering, warning
2155 @cindex warning for reordering of member initializers
2156 Warn when the order of member initializers given in the code does not
2157 match the order in which they must be executed.  For instance:
2159 @item -Wunknown-pragmas
2160 @opindex Wunknown-pragmas
2161 @cindex warning for unknown pragmas
2162 @cindex unknown pragmas, warning
2163 @cindex pragmas, warning of unknown
2164 Warn when a #pragma directive is encountered which is not understood by
2165 GCC@.  If this command line option is used, warnings will even be issued
2166 for unknown pragmas in system header files.  This is not the case if
2167 the warnings were only enabled by the @option{-Wall} command line option.
2169 @item -Wall
2170 @opindex Wall
2171 All of the above @samp{-W} options combined.  This enables all the
2172 warnings about constructions that some users consider questionable, and
2173 that are easy to avoid (or modify to prevent the warning), even in
2174 conjunction with macros.
2176 @item -Wdiv-by-zero
2177 @opindex Wno-div-by-zero
2178 @opindex Wdiv-by-zero
2179 Warn about compile-time integer division by zero.  This is default.  To
2180 inhibit the warning messages, use @option{-Wno-div-by-zero}.  Floating
2181 point division by zero is not warned about, as it can be a legitimate
2182 way of obtaining infinities and NaNs.
2184 @item -Wmultichar
2185 @opindex Wno-multichar
2186 @opindex Wmultichar
2187 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  This is
2188 default.  To inhibit the warning messages, use @option{-Wno-multichar}.
2189 Usually they indicate a typo in the user's code, as they have
2190 implementation-defined values, and should not be used in portable code.
2192 @item -Wsystem-headers
2193 @opindex Wsystem-headers
2194 @cindex warnings from system headers
2195 @cindex system headers, warnings from
2196 Print warning messages for constructs found in system header files.
2197 Warnings from system headers are normally suppressed, on the assumption
2198 that they usually do not indicate real problems and would only make the
2199 compiler output harder to read.  Using this command line option tells
2200 GCC to emit warnings from system headers as if they occurred in user
2201 code.  However, note that using @option{-Wall} in conjunction with this
2202 option will @emph{not} warn about unknown pragmas in system
2203 headers---for that, @option{-Wunknown-pragmas} must also be used.
2204 @end table
2206 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2207 Some of them warn about constructions that users generally do not
2208 consider questionable, but which occasionally you might wish to check
2209 for; others warn about constructions that are necessary or hard to avoid
2210 in some cases, and there is no simple way to modify the code to suppress
2211 the warning.
2213 @table @gcctabopt
2214 @item -W
2215 @opindex W
2216 Print extra warning messages for these events:
2218 @itemize @bullet
2219 @item
2220 A function can return either with or without a value.  (Falling
2221 off the end of the function body is considered returning without
2222 a value.)  For example, this function would evoke such a
2223 warning:
2225 @smallexample
2226 @group
2227 foo (a)
2229   if (a > 0)
2230     return a;
2232 @end group
2233 @end smallexample
2235 @item
2236 An expression-statement or the left-hand side of a comma expression
2237 contains no side effects.
2238 To suppress the warning, cast the unused expression to void.
2239 For example, an expression such as @samp{x[i,j]} will cause a warning,
2240 but @samp{x[(void)i,j]} will not.
2242 @item
2243 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
2245 @item
2246 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2247 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2248 that of ordinary mathematical notation.
2250 @item
2251 Storage-class specifiers like @code{static} are not the first things in
2252 a declaration.  According to the C Standard, this usage is obsolescent.
2254 @item
2255 The return type of a function has a type qualifier such as @code{const}.
2256 Such a type qualifier has no effect, since the value returned by a
2257 function is not an lvalue.  (But don't warn about the GNU extension of
2258 @code{volatile void} return types.  That extension will be warned about
2259 if @option{-pedantic} is specified.)
2261 @item
2262 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2263 arguments.
2265 @item
2266 A comparison between signed and unsigned values could produce an
2267 incorrect result when the signed value is converted to unsigned.
2268 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2270 @item
2271 An aggregate has a partly bracketed initializer.
2272 For example, the following code would evoke such a warning,
2273 because braces are missing around the initializer for @code{x.h}:
2275 @smallexample
2276 struct s @{ int f, g; @};
2277 struct t @{ struct s h; int i; @};
2278 struct t x = @{ 1, 2, 3 @};
2279 @end smallexample
2281 @item
2282 An aggregate has an initializer which does not initialize all members.
2283 For example, the following code would cause such a warning, because
2284 @code{x.h} would be implicitly initialized to zero:
2286 @smallexample
2287 struct s @{ int f, g, h; @};
2288 struct s x = @{ 3, 4 @};
2289 @end smallexample
2290 @end itemize
2292 @item -Wfloat-equal
2293 @opindex Wfloat-equal
2294 Warn if floating point values are used in equality comparisons.
2296 The idea behind this is that sometimes it is convenient (for the
2297 programmer) to consider floating-point values as approximations to
2298 infinitely precise real numbers.  If you are doing this, then you need
2299 to compute (by analysing the code, or in some other way) the maximum or
2300 likely maximum error that the computation introduces, and allow for it
2301 when performing comparisons (and when producing output, but that's a
2302 different problem).  In particular, instead of testing for equality, you
2303 would check to see whether the two values have ranges that overlap; and
2304 this is done with the relational operators, so equality comparisons are
2305 probably mistaken.
2307 @item -Wtraditional @r{(C only)}
2308 @opindex Wtraditional
2309 Warn about certain constructs that behave differently in traditional and
2310 ISO C@.  Also warn about ISO C constructs that have no traditional C
2311 equivalent, and/or problematic constructs which should be avoided.
2313 @itemize @bullet
2314 @item
2315 Macro parameters that appear within string literals in the macro body.
2316 In traditional C macro replacement takes place within string literals,
2317 but does not in ISO C@.
2319 @item
2320 In traditional C, some preprocessor directives did not exist.
2321 Traditional preprocessors would only consider a line to be a directive
2322 if the @samp{#} appeared in column 1 on the line.  Therefore
2323 @option{-Wtraditional} warns about directives that traditional C
2324 understands but would ignore because the @samp{#} does not appear as the
2325 first character on the line.  It also suggests you hide directives like
2326 @samp{#pragma} not understood by traditional C by indenting them.  Some
2327 traditional implementations would not recognize @samp{#elif}, so it
2328 suggests avoiding it altogether.
2330 @item
2331 A function-like macro that appears without arguments.
2333 @item
2334 The unary plus operator.
2336 @item
2337 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2338 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2339 constants.)  Note, these suffixes appear in macros defined in the system
2340 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2341 Use of these macros in user code might normally lead to spurious
2342 warnings, however gcc's integrated preprocessor has enough context to
2343 avoid warning in these cases.
2345 @item
2346 A function declared external in one block and then used after the end of
2347 the block.
2349 @item
2350 A @code{switch} statement has an operand of type @code{long}.
2352 @item
2353 A non-@code{static} function declaration follows a @code{static} one.
2354 This construct is not accepted by some traditional C compilers.
2356 @item
2357 The ISO type of an integer constant has a different width or
2358 signedness from its traditional type.  This warning is only issued if
2359 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2360 typically represent bit patterns, are not warned about.
2362 @item
2363 Usage of ISO string concatenation is detected.
2365 @item
2366 Initialization of automatic aggregates.
2368 @item
2369 Identifier conflicts with labels.  Traditional C lacks a separate
2370 namespace for labels.
2372 @item
2373 Initialization of unions.  If the initializer is zero, the warning is
2374 omitted.  This is done under the assumption that the zero initializer in
2375 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2376 initializer warnings and relies on default initialization to zero in the
2377 traditional C case.
2379 @item
2380 Conversions by prototypes between fixed/floating point values and vice
2381 versa.  The absence of these prototypes when compiling with traditional
2382 C would cause serious problems.  This is a subset of the possible
2383 conversion warnings, for the full set use @option{-Wconversion}.
2384 @end itemize
2386 @item -Wundef
2387 @opindex Wundef
2388 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2390 @item -Wshadow
2391 @opindex Wshadow
2392 Warn whenever a local variable shadows another local variable, parameter or
2393 global variable or whenever a built-in function is shadowed.
2395 @item -Wlarger-than-@var{len}
2396 @opindex Wlarger-than
2397 Warn whenever an object of larger than @var{len} bytes is defined.
2399 @item -Wpointer-arith
2400 @opindex Wpointer-arith
2401 Warn about anything that depends on the ``size of'' a function type or
2402 of @code{void}.  GNU C assigns these types a size of 1, for
2403 convenience in calculations with @code{void *} pointers and pointers
2404 to functions.
2406 @item -Wbad-function-cast @r{(C only)}
2407 @opindex Wbad-function-cast
2408 Warn whenever a function call is cast to a non-matching type.
2409 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2411 @item -Wcast-qual
2412 @opindex Wcast-qual
2413 Warn whenever a pointer is cast so as to remove a type qualifier from
2414 the target type.  For example, warn if a @code{const char *} is cast
2415 to an ordinary @code{char *}.
2417 @item -Wcast-align
2418 @opindex Wcast-align
2419 Warn whenever a pointer is cast such that the required alignment of the
2420 target is increased.  For example, warn if a @code{char *} is cast to
2421 an @code{int *} on machines where integers can only be accessed at
2422 two- or four-byte boundaries.
2424 @item -Wwrite-strings
2425 @opindex Wwrite-strings
2426 When compiling C, give string constants the type @code{const
2427 char[@var{length}]} so that
2428 copying the address of one into a non-@code{const} @code{char *}
2429 pointer will get a warning; when compiling C++, warn about the
2430 deprecated conversion from string constants to @code{char *}.
2431 These warnings will help you find at
2432 compile time code that can try to write into a string constant, but
2433 only if you have been very careful about using @code{const} in
2434 declarations and prototypes.  Otherwise, it will just be a nuisance;
2435 this is why we did not make @option{-Wall} request these warnings.
2437 @item -Wconversion
2438 @opindex Wconversion
2439 Warn if a prototype causes a type conversion that is different from what
2440 would happen to the same argument in the absence of a prototype.  This
2441 includes conversions of fixed point to floating and vice versa, and
2442 conversions changing the width or signedness of a fixed point argument
2443 except when the same as the default promotion.
2445 Also, warn if a negative integer constant expression is implicitly
2446 converted to an unsigned type.  For example, warn about the assignment
2447 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2448 casts like @code{(unsigned) -1}.
2450 @item -Wsign-compare
2451 @opindex Wsign-compare
2452 @cindex warning for comparison of signed and unsigned values
2453 @cindex comparison of signed and unsigned values, warning
2454 @cindex signed and unsigned values, comparison warning
2455 Warn when a comparison between signed and unsigned values could produce
2456 an incorrect result when the signed value is converted to unsigned.
2457 This warning is also enabled by @option{-W}; to get the other warnings
2458 of @option{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2460 @item -Waggregate-return
2461 @opindex Waggregate-return
2462 Warn if any functions that return structures or unions are defined or
2463 called.  (In languages where you can return an array, this also elicits
2464 a warning.)
2466 @item -Wstrict-prototypes @r{(C only)}
2467 @opindex Wstrict-prototypes
2468 Warn if a function is declared or defined without specifying the
2469 argument types.  (An old-style function definition is permitted without
2470 a warning if preceded by a declaration which specifies the argument
2471 types.)
2473 @item -Wmissing-prototypes @r{(C only)}
2474 @opindex Wmissing-prototypes
2475 Warn if a global function is defined without a previous prototype
2476 declaration.  This warning is issued even if the definition itself
2477 provides a prototype.  The aim is to detect global functions that fail
2478 to be declared in header files.
2480 @item -Wmissing-declarations
2481 @opindex Wmissing-declarations
2482 Warn if a global function is defined without a previous declaration.
2483 Do so even if the definition itself provides a prototype.
2484 Use this option to detect global functions that are not declared in
2485 header files.
2487 @item -Wmissing-noreturn
2488 @opindex Wmissing-noreturn
2489 Warn about functions which might be candidates for attribute @code{noreturn}.
2490 Note these are only possible candidates, not absolute ones.  Care should
2491 be taken to manually verify functions actually do not ever return before
2492 adding the @code{noreturn} attribute, otherwise subtle code generation
2493 bugs could be introduced.  You will not get a warning for @code{main} in
2494 hosted C environments.
2496 @item -Wmissing-format-attribute
2497 @opindex Wmissing-format-attribute
2498 @opindex Wformat
2499 If @option{-Wformat} is enabled, also warn about functions which might be
2500 candidates for @code{format} attributes.  Note these are only possible
2501 candidates, not absolute ones.  GCC will guess that @code{format}
2502 attributes might be appropriate for any function that calls a function
2503 like @code{vprintf} or @code{vscanf}, but this might not always be the
2504 case, and some functions for which @code{format} attributes are
2505 appropriate may not be detected.  This option has no effect unless
2506 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2508 @item -Wpacked
2509 @opindex Wpacked
2510 Warn if a structure is given the packed attribute, but the packed
2511 attribute has no effect on the layout or size of the structure.
2512 Such structures may be mis-aligned for little benefit.  For
2513 instance, in this code, the variable @code{f.x} in @code{struct bar}
2514 will be misaligned even though @code{struct bar} does not itself
2515 have the packed attribute:
2517 @smallexample
2518 @group
2519 struct foo @{
2520   int x;
2521   char a, b, c, d;
2522 @} __attribute__((packed));
2523 struct bar @{
2524   char z;
2525   struct foo f;
2527 @end group
2528 @end smallexample
2530 @item -Wpadded
2531 @opindex Wpadded
2532 Warn if padding is included in a structure, either to align an element
2533 of the structure or to align the whole structure.  Sometimes when this
2534 happens it is possible to rearrange the fields of the structure to
2535 reduce the padding and so make the structure smaller.
2537 @item -Wredundant-decls
2538 @opindex Wredundant-decls
2539 Warn if anything is declared more than once in the same scope, even in
2540 cases where multiple declaration is valid and changes nothing.
2542 @item -Wnested-externs @r{(C only)}
2543 @opindex Wnested-externs
2544 Warn if an @code{extern} declaration is encountered within a function.
2546 @item -Wunreachable-code
2547 @opindex Wunreachable-code
2548 Warn if the compiler detects that code will never be executed.
2550 This option is intended to warn when the compiler detects that at
2551 least a whole line of source code will never be executed, because
2552 some condition is never satisfied or because it is after a
2553 procedure that never returns.
2555 It is possible for this option to produce a warning even though there
2556 are circumstances under which part of the affected line can be executed,
2557 so care should be taken when removing apparently-unreachable code.
2559 For instance, when a function is inlined, a warning may mean that the
2560 line is unreachable in only one inlined copy of the function.
2562 This option is not made part of @option{-Wall} because in a debugging
2563 version of a program there is often substantial code which checks
2564 correct functioning of the program and is, hopefully, unreachable
2565 because the program does work.  Another common use of unreachable
2566 code is to provide behavior which is selectable at compile-time.
2568 @item -Winline
2569 @opindex Winline
2570 Warn if a function can not be inlined and it was declared as inline.
2572 @item -Wlong-long
2573 @opindex Wlong-long
2574 @opindex Wno-long-long
2575 Warn if @samp{long long} type is used.  This is default.  To inhibit
2576 the warning messages, use @option{-Wno-long-long}.  Flags
2577 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2578 only when @option{-pedantic} flag is used.
2580 @item -Wdisabled-optimization
2581 @opindex Wdisabled-optimization
2582 Warn if a requested optimization pass is disabled.  This warning does
2583 not generally indicate that there is anything wrong with your code; it
2584 merely indicates that GCC's optimizers were unable to handle the code
2585 effectively.  Often, the problem is that your code is too big or too
2586 complex; GCC will refuse to optimize programs when the optimization
2587 itself is likely to take inordinate amounts of time.
2589 @item -Werror
2590 @opindex Werror
2591 Make all warnings into errors.
2592 @end table
2594 @node Debugging Options
2595 @section Options for Debugging Your Program or GCC
2596 @cindex options, debugging
2597 @cindex debugging information options
2599 GCC has various special options that are used for debugging
2600 either your program or GCC:
2602 @table @gcctabopt
2603 @item -g
2604 @opindex g
2605 Produce debugging information in the operating system's native format
2606 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2607 information.
2609 On most systems that use stabs format, @option{-g} enables use of extra
2610 debugging information that only GDB can use; this extra information
2611 makes debugging work better in GDB but will probably make other debuggers
2612 crash or
2613 refuse to read the program.  If you want to control for certain whether
2614 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2615 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2616 or @option{-gvms} (see below).
2618 Unlike most other C compilers, GCC allows you to use @option{-g} with
2619 @option{-O}.  The shortcuts taken by optimized code may occasionally
2620 produce surprising results: some variables you declared may not exist
2621 at all; flow of control may briefly move where you did not expect it;
2622 some statements may not be executed because they compute constant
2623 results or their values were already at hand; some statements may
2624 execute in different places because they were moved out of loops.
2626 Nevertheless it proves possible to debug optimized output.  This makes
2627 it reasonable to use the optimizer for programs that might have bugs.
2629 The following options are useful when GCC is generated with the
2630 capability for more than one debugging format.
2632 @item -ggdb
2633 @opindex ggdb
2634 Produce debugging information for use by GDB@.  This means to use the
2635 most expressive format available (DWARF 2, stabs, or the native format
2636 if neither of those are supported), including GDB extensions if at all
2637 possible.
2639 @item -gstabs
2640 @opindex gstabs
2641 Produce debugging information in stabs format (if that is supported),
2642 without GDB extensions.  This is the format used by DBX on most BSD
2643 systems.  On MIPS, Alpha and System V Release 4 systems this option
2644 produces stabs debugging output which is not understood by DBX or SDB@.
2645 On System V Release 4 systems this option requires the GNU assembler.
2647 @item -gstabs+
2648 @opindex gstabs+
2649 Produce debugging information in stabs format (if that is supported),
2650 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2651 use of these extensions is likely to make other debuggers crash or
2652 refuse to read the program.
2654 @item -gcoff
2655 @opindex gcoff
2656 Produce debugging information in COFF format (if that is supported).
2657 This is the format used by SDB on most System V systems prior to
2658 System V Release 4.
2660 @item -gxcoff
2661 @opindex gxcoff
2662 Produce debugging information in XCOFF format (if that is supported).
2663 This is the format used by the DBX debugger on IBM RS/6000 systems.
2665 @item -gxcoff+
2666 @opindex gxcoff+
2667 Produce debugging information in XCOFF format (if that is supported),
2668 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2669 use of these extensions is likely to make other debuggers crash or
2670 refuse to read the program, and may cause assemblers other than the GNU
2671 assembler (GAS) to fail with an error.
2673 @item -gdwarf
2674 @opindex gdwarf
2675 Produce debugging information in DWARF version 1 format (if that is
2676 supported).  This is the format used by SDB on most System V Release 4
2677 systems.
2679 @item -gdwarf+
2680 @opindex gdwarf+
2681 Produce debugging information in DWARF version 1 format (if that is
2682 supported), using GNU extensions understood only by the GNU debugger
2683 (GDB)@.  The use of these extensions is likely to make other debuggers
2684 crash or refuse to read the program.
2686 @item -gdwarf-2
2687 @opindex gdwarf-2
2688 Produce debugging information in DWARF version 2 format (if that is
2689 supported).  This is the format used by DBX on IRIX 6.
2691 @item -gvms
2692 @opindex gvms
2693 Produce debugging information in VMS debug format (if that is
2694 supported).  This is the format used by DEBUG on VMS systems.
2696 @item -g@var{level}
2697 @itemx -ggdb@var{level}
2698 @itemx -gstabs@var{level}
2699 @itemx -gcoff@var{level}
2700 @itemx -gxcoff@var{level}
2701 @itemx -gdwarf@var{level}
2702 @itemx -gdwarf-2@var{level}
2703 @itemx -gvms@var{level}
2704 Request debugging information and also use @var{level} to specify how
2705 much information.  The default level is 2.
2707 Level 1 produces minimal information, enough for making backtraces in
2708 parts of the program that you don't plan to debug.  This includes
2709 descriptions of functions and external variables, but no information
2710 about local variables and no line numbers.
2712 Level 3 includes extra information, such as all the macro definitions
2713 present in the program.  Some debuggers support macro expansion when
2714 you use @option{-g3}.
2716 @cindex @code{prof}
2717 @item -p
2718 @opindex p
2719 Generate extra code to write profile information suitable for the
2720 analysis program @code{prof}.  You must use this option when compiling
2721 the source files you want data about, and you must also use it when
2722 linking.
2724 @cindex @code{gprof}
2725 @item -pg
2726 @opindex pg
2727 Generate extra code to write profile information suitable for the
2728 analysis program @code{gprof}.  You must use this option when compiling
2729 the source files you want data about, and you must also use it when
2730 linking.
2732 @cindex @code{tcov}
2733 @item -a
2734 @opindex a
2735 Generate extra code to write profile information for basic blocks, which will
2736 record the number of times each basic block is executed, the basic block start
2737 address, and the function name containing the basic block.  If @option{-g} is
2738 used, the line number and filename of the start of the basic block will also be
2739 recorded.  If not overridden by the machine description, the default action is
2740 to append to the text file @file{bb.out}.
2742 This data could be analyzed by a program like @code{tcov}.  Note,
2743 however, that the format of the data is not what @code{tcov} expects.
2744 Eventually GNU @code{gprof} should be extended to process this data.
2746 @item -Q
2747 @opindex Q
2748 Makes the compiler print out each function name as it is compiled, and
2749 print some statistics about each pass when it finishes.
2751 @item -ftime-report
2752 @opindex ftime-report
2753 Makes the compiler print some statistics about the time consumed by each
2754 pass when it finishes.
2756 @item -fmem-report
2757 @opindex fmem-report
2758 Makes the compiler print some statistics about permanent memory
2759 allocation when it finishes.
2761 @item -fprofile-arcs
2762 @opindex fprofile-arcs
2763 Instrument @dfn{arcs} during compilation to generate coverage data
2764 or for profile-directed block ordering.  During execution the program
2765 records how many times each branch is executed and how many times it is
2766 taken.  When the compiled program exits it saves this data to a file
2767 called @file{@var{sourcename}.da} for each source file.
2769 For profile-directed block ordering, compile the program with
2770 @option{-fprofile-arcs} plus optimization and code generation options,
2771 generate the arc profile information by running the program on a
2772 selected workload, and then compile the program again with the same
2773 optimization and code generation options plus
2774 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2775 Control Optimization}).
2777 The other use of @option{-fprofile-arcs} is for use with @code{gcov},
2778 when it is used with the @option{-ftest-coverage} option.  GCC
2779 supports two methods of determining code coverage: the options that
2780 support @code{gcov}, and options @option{-a} and @option{-ax}, which
2781 write information to text files.  The options that support @code{gcov}
2782 do not need to instrument every arc in the program, so a program compiled
2783 with them runs faster than a program compiled with @option{-a}, which
2784 adds instrumentation code to every basic block in the program.  The
2785 tradeoff: since @code{gcov} does not have execution counts for all
2786 branches, it must start with the execution counts for the instrumented
2787 branches, and then iterate over the program flow graph until the entire
2788 graph has been solved.  Hence, @code{gcov} runs a little more slowly than
2789 a program which uses information from @option{-a} and @option{-ax}.
2791 With @option{-fprofile-arcs}, for each function of your program GCC
2792 creates a program flow graph, then finds a spanning tree for the graph.
2793 Only arcs that are not on the spanning tree have to be instrumented: the
2794 compiler adds code to count the number of times that these arcs are
2795 executed.  When an arc is the only exit or only entrance to a block, the
2796 instrumentation code can be added to the block; otherwise, a new basic
2797 block must be created to hold the instrumentation code.
2799 This option makes it possible to estimate branch probabilities and to
2800 calculate basic block execution counts.  In general, basic block
2801 execution counts as provided by @option{-a} do not give enough
2802 information to estimate all branch probabilities.
2804 @need 2000
2805 @item -ftest-coverage
2806 @opindex ftest-coverage
2807 Create data files for the @code{gcov} code-coverage utility
2808 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2809 The data file names begin with the name of your source file:
2811 @table @gcctabopt
2812 @item @var{sourcename}.bb
2813 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2814 associate basic block execution counts with line numbers.
2816 @item @var{sourcename}.bbg
2817 A list of all arcs in the program flow graph.  This allows @code{gcov}
2818 to reconstruct the program flow graph, so that it can compute all basic
2819 block and arc execution counts from the information in the
2820 @code{@var{sourcename}.da} file.
2821 @end table
2823 Use @option{-ftest-coverage} with @option{-fprofile-arcs}; the latter
2824 option adds instrumentation to the program, which then writes
2825 execution counts to another data file:
2827 @table @gcctabopt
2828 @item @var{sourcename}.da
2829 Runtime arc execution counts, used in conjunction with the arc
2830 information in the file @code{@var{sourcename}.bbg}.
2831 @end table
2833 Coverage data will map better to the source files if
2834 @option{-ftest-coverage} is used without optimization.
2836 @item -d@var{letters}
2837 @opindex d
2838 Says to make debugging dumps during compilation at times specified by
2839 @var{letters}.  This is used for debugging the compiler.  The file names
2840 for most of the dumps are made by appending a pass number and a word to
2841 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}).
2842 Here are the possible letters for use in @var{letters}, and their meanings:
2844 @table @samp
2845 @item A
2846 @opindex dA
2847 Annotate the assembler output with miscellaneous debugging information.
2848 @item b
2849 @opindex db
2850 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
2851 @item B
2852 @opindex dB
2853 Dump after block reordering, to @file{@var{file}.28.bbro}.
2854 @item c
2855 @opindex dc
2856 Dump after instruction combination, to the file @file{@var{file}.16.combine}.
2857 @item C
2858 @opindex dC
2859 Dump after the first if conversion, to the file @file{@var{file}.17.ce}.
2860 @item d
2861 @opindex dd
2862 Dump after delayed branch scheduling, to @file{@var{file}.31.dbr}.
2863 @item D
2864 @opindex dD
2865 Dump all macro definitions, at the end of preprocessing, in addition to
2866 normal output.
2867 @item e
2868 @opindex de
2869 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
2870 @file{@var{file}.07.ussa}.
2871 @item E
2872 @opindex dE
2873 Dump after the second if conversion, to @file{@var{file}.26.ce2}.
2874 @item f
2875 @opindex df
2876 Dump after life analysis, to @file{@var{file}.15.life}.
2877 @item F
2878 @opindex dF
2879 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.09.addressof}.
2880 @item g
2881 @opindex dg
2882 Dump after global register allocation, to @file{@var{file}.21.greg}.
2883 @item h
2884 @opindex dh
2885 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
2886 @item o
2887 @opindex do
2888 Dump after post-reload optimizations, to @file{@var{file}.22.postreload}.
2889 @item G
2890 @opindex dG
2891 Dump after GCSE, to @file{@var{file}.10.gcse}.
2892 @item i
2893 @opindex di
2894 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2895 @item j
2896 @opindex dj
2897 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
2898 @item k
2899 @opindex dk
2900 Dump after conversion from registers to stack, to @file{@var{file}.32.stack}.
2901 @item l
2902 @opindex dl
2903 Dump after local register allocation, to @file{@var{file}.20.lreg}.
2904 @item L
2905 @opindex dL
2906 Dump after loop optimization, to @file{@var{file}.11.loop}.
2907 @item M
2908 @opindex dM
2909 Dump after performing the machine dependent reorganisation pass, to
2910 @file{@var{file}.30.mach}.
2911 @item n
2912 @opindex dn
2913 Dump after register renumbering, to @file{@var{file}.25.rnreg}.
2914 @item N
2915 @opindex dN
2916 Dump after the register move pass, to @file{@var{file}.18.regmove}.
2917 @item r
2918 @opindex dr
2919 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2920 @item R
2921 @opindex dR
2922 Dump after the second scheduling pass, to @file{@var{file}.27.sched2}.
2923 @item s
2924 @opindex ds
2925 Dump after CSE (including the jump optimization that sometimes follows
2926 CSE), to @file{@var{file}.08.cse}.
2927 @item S
2928 @opindex dS
2929 Dump after the first scheduling pass, to @file{@var{file}.19.sched}.
2930 @item t
2931 @opindex dt
2932 Dump after the second CSE pass (including the jump optimization that
2933 sometimes follows CSE), to @file{@var{file}.12.cse2}.
2934 @item w
2935 @opindex dw
2936 Dump after the second flow pass, to @file{@var{file}.23.flow2}.
2937 @item X
2938 @opindex dX
2939 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
2940 @item z
2941 @opindex dz
2942 Dump after the peephole pass, to @file{@var{file}.24.peephole2}.
2943 @item a
2944 @opindex da
2945 Produce all the dumps listed above.
2946 @item m
2947 @opindex dm
2948 Print statistics on memory usage, at the end of the run, to
2949 standard error.
2950 @item p
2951 @opindex dp
2952 Annotate the assembler output with a comment indicating which
2953 pattern and alternative was used.  The length of each instruction is
2954 also printed.
2955 @item P
2956 @opindex dP
2957 Dump the RTL in the assembler output as a comment before each instruction.
2958 Also turns on @option{-dp} annotation.
2959 @item v
2960 @opindex dv
2961 For each of the other indicated dump files (except for
2962 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2963 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2964 @item x
2965 @opindex dx
2966 Just generate RTL for a function instead of compiling it.  Usually used
2967 with @samp{r}.
2968 @item y
2969 @opindex dy
2970 Dump debugging information during parsing, to standard error.
2971 @end table
2973 @item -fdump-unnumbered
2974 @opindex fdump-unnumbered
2975 When doing debugging dumps (see @option{-d} option above), suppress instruction
2976 numbers and line number note output.  This makes it more feasible to
2977 use diff on debugging dumps for compiler invocations with different
2978 options, in particular with and without @option{-g}.
2980 @item -fdump-class-hierarchy @r{(C++ only)}
2981 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
2982 @opindex fdump-class-hierarchy
2983 Dump a representation of each class's hierarchy and virtual function
2984 table layout to a file.  The file name is made by appending @file{.class}
2985 to the source file name.  If the @samp{-@var{options}} form is used,
2986 @var{options} controls the details of the dump as described for the
2987 @option{-fdump-tree} options.
2989 @item -fdump-tree-@var{switch} @r{(C++ only)}
2990 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
2991 @opindex fdump-tree
2992 Control the dumping at various stages of processing the intermediate
2993 language tree to a file.  The file name is generated by appending a switch
2994 specific suffix to the source file name.  If the @samp{-@var{options}}
2995 form is used, @var{options} is a list of @samp{-} separated options that
2996 control the details of the dump. Not all options are applicable to all
2997 dumps, those which are not meaningful will be ignored. The following
2998 options are available
3000 @table @samp
3001 @item address
3002 Print the address of each node.  Usually this is not meaningful as it
3003 changes according to the environment and source file. Its primary use
3004 is for tying up a dump file with a debug environment.
3005 @item slim
3006 Inhibit dumping of members of a scope or body of a function merely
3007 because that scope has been reached. Only dump such items when they
3008 are directly reachable by some other path.
3009 @item all
3010 Turn on all options.
3011 @end table
3013 The following tree dumps are possible:
3014 @table @samp
3015 @item original
3016 Dump before any tree based optimization, to @file{@var{file}.original}.
3017 @item optimized
3018 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3019 @item inlined
3020 Dump after function inlining, to @file{@var{file}.inlined}.
3021 @end table
3023 @item -fpretend-float
3024 @opindex fpretend-float
3025 When running a cross-compiler, pretend that the target machine uses the
3026 same floating point format as the host machine.  This causes incorrect
3027 output of the actual floating constants, but the actual instruction
3028 sequence will probably be the same as GCC would make when running on
3029 the target machine.
3031 @item -save-temps
3032 @opindex save-temps
3033 Store the usual ``temporary'' intermediate files permanently; place them
3034 in the current directory and name them based on the source file.  Thus,
3035 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3036 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3037 preprocessed @file{foo.i} output file even though the compiler now
3038 normally uses an integrated preprocessor.
3040 @item -time
3041 @opindex time
3042 Report the CPU time taken by each subprocess in the compilation
3043 sequence.  For C source files, this is the compiler proper and assembler
3044 (plus the linker if linking is done).  The output looks like this:
3046 @smallexample
3047 # cc1 0.12 0.01
3048 # as 0.00 0.01
3049 @end smallexample
3051 The first number on each line is the ``user time,'' that is time spent
3052 executing the program itself.  The second number is ``system time,''
3053 time spent executing operating system routines on behalf of the program.
3054 Both numbers are in seconds.
3056 @item -print-file-name=@var{library}
3057 @opindex print-file-name
3058 Print the full absolute name of the library file @var{library} that
3059 would be used when linking---and don't do anything else.  With this
3060 option, GCC does not compile or link anything; it just prints the
3061 file name.
3063 @item -print-multi-directory
3064 @opindex print-multi-directory
3065 Print the directory name corresponding to the multilib selected by any
3066 other switches present in the command line.  This directory is supposed
3067 to exist in @env{GCC_EXEC_PREFIX}.
3069 @item -print-multi-lib
3070 @opindex print-multi-lib
3071 Print the mapping from multilib directory names to compiler switches
3072 that enable them.  The directory name is separated from the switches by
3073 @samp{;}, and each switch starts with an @samp{@@} instead of the
3074 @samp{-}, without spaces between multiple switches.  This is supposed to
3075 ease shell-processing.
3077 @item -print-prog-name=@var{program}
3078 @opindex print-prog-name
3079 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3081 @item -print-libgcc-file-name
3082 @opindex print-libgcc-file-name
3083 Same as @option{-print-file-name=libgcc.a}.
3085 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3086 but you do want to link with @file{libgcc.a}.  You can do
3088 @example
3089 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3090 @end example
3092 @item -print-search-dirs
3093 @opindex print-search-dirs
3094 Print the name of the configured installation directory and a list of
3095 program and library directories gcc will search---and don't do anything else.
3097 This is useful when gcc prints the error message
3098 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3099 To resolve this you either need to put @file{cpp0} and the other compiler
3100 components where gcc expects to find them, or you can set the environment
3101 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3102 Don't forget the trailing '/'.
3103 @xref{Environment Variables}.
3105 @item -dumpmachine
3106 @opindex dumpmachine
3107 Print the compiler's target machine (for example,
3108 @samp{i686-pc-linux-gnu})---and don't do anything else.
3110 @item -dumpversion
3111 @opindex dumpversion
3112 Print the compiler version (for example, @samp{3.0})---and don't do
3113 anything else.
3115 @item -dumpspecs
3116 @opindex dumpspecs
3117 Print the compiler's built-in specs---and don't do anything else.  (This
3118 is used when GCC itself is being built.)  @xref{Spec Files}.
3119 @end table
3121 @node Optimize Options
3122 @section Options That Control Optimization
3123 @cindex optimize options
3124 @cindex options, optimization
3126 These options control various sorts of optimizations:
3128 @table @gcctabopt
3129 @item -O
3130 @itemx -O1
3131 @opindex O
3132 @opindex O1
3133 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3134 more memory for a large function.
3136 Without @option{-O}, the compiler's goal is to reduce the cost of
3137 compilation and to make debugging produce the expected results.
3138 Statements are independent: if you stop the program with a breakpoint
3139 between statements, you can then assign a new value to any variable or
3140 change the program counter to any other statement in the function and
3141 get exactly the results you would expect from the source code.
3143 With @option{-O}, the compiler tries to reduce code size and execution
3144 time, without performing any optimizations that take a great deal of
3145 compilation time.
3147 @item -O2
3148 @opindex O2
3149 Optimize even more.  GCC performs nearly all supported optimizations
3150 that do not involve a space-speed tradeoff.  The compiler does not
3151 perform loop unrolling or function inlining when you specify @option{-O2}.
3152 As compared to @option{-O}, this option increases both compilation time
3153 and the performance of the generated code.
3155 @option{-O2} turns on all optional optimizations except for loop unrolling,
3156 function inlining, and register renaming.  It also turns on the
3157 @option{-fforce-mem} option on all machines and frame pointer elimination
3158 on machines where doing so does not interfere with debugging.
3160 Please note the warning under @option{-fgcse} about
3161 invoking @option{-O2} on programs that use computed gotos.
3163 @item -O3
3164 @opindex O3
3165 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3166 @option{-O2} and also turns on the @option{-finline-functions} and
3167 @option{-frename-registers} options.
3169 @item -O0
3170 @opindex O0
3171 Do not optimize.
3173 @item -Os
3174 @opindex Os
3175 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3176 do not typically increase code size.  It also performs further
3177 optimizations designed to reduce code size.
3179 If you use multiple @option{-O} options, with or without level numbers,
3180 the last such option is the one that is effective.
3181 @end table
3183 Options of the form @option{-f@var{flag}} specify machine-independent
3184 flags.  Most flags have both positive and negative forms; the negative
3185 form of @option{-ffoo} would be @option{-fno-foo}.  In the table below,
3186 only one of the forms is listed---the one which is not the default.
3187 You can figure out the other form by either removing @samp{no-} or
3188 adding it.
3190 @table @gcctabopt
3191 @item -ffloat-store
3192 @opindex ffloat-store
3193 Do not store floating point variables in registers, and inhibit other
3194 options that might change whether a floating point value is taken from a
3195 register or memory.
3197 @cindex floating point precision
3198 This option prevents undesirable excess precision on machines such as
3199 the 68000 where the floating registers (of the 68881) keep more
3200 precision than a @code{double} is supposed to have.  Similarly for the
3201 x86 architecture.  For most programs, the excess precision does only
3202 good, but a few programs rely on the precise definition of IEEE floating
3203 point.  Use @option{-ffloat-store} for such programs, after modifying
3204 them to store all pertinent intermediate computations into variables.
3206 @item -fno-default-inline
3207 @opindex fno-default-inline
3208 Do not make member functions inline by default merely because they are
3209 defined inside the class scope (C++ only).  Otherwise, when you specify
3210 @w{@option{-O}}, member functions defined inside class scope are compiled
3211 inline by default; i.e., you don't need to add @samp{inline} in front of
3212 the member function name.
3214 @item -fno-defer-pop
3215 @opindex fno-defer-pop
3216 Always pop the arguments to each function call as soon as that function
3217 returns.  For machines which must pop arguments after a function call,
3218 the compiler normally lets arguments accumulate on the stack for several
3219 function calls and pops them all at once.
3221 @item -fforce-mem
3222 @opindex fforce-mem
3223 Force memory operands to be copied into registers before doing
3224 arithmetic on them.  This produces better code by making all memory
3225 references potential common subexpressions.  When they are not common
3226 subexpressions, instruction combination should eliminate the separate
3227 register-load.  The @option{-O2} option turns on this option.
3229 @item -fforce-addr
3230 @opindex fforce-addr
3231 Force memory address constants to be copied into registers before
3232 doing arithmetic on them.  This may produce better code just as
3233 @option{-fforce-mem} may.
3235 @item -fomit-frame-pointer
3236 @opindex fomit-frame-pointer
3237 Don't keep the frame pointer in a register for functions that
3238 don't need one.  This avoids the instructions to save, set up and
3239 restore frame pointers; it also makes an extra register available
3240 in many functions.  @strong{It also makes debugging impossible on
3241 some machines.}
3243 On some machines, such as the VAX, this flag has no effect, because
3244 the standard calling sequence automatically handles the frame pointer
3245 and nothing is saved by pretending it doesn't exist.  The
3246 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3247 whether a target machine supports this flag.  @xref{Registers,,Register
3248 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3250 @item -foptimize-sibling-calls
3251 @opindex foptimize-sibling-calls
3252 Optimize sibling and tail recursive calls.
3254 @item -ftrapv
3255 @opindex ftrapv
3256 This option generates traps for signed overflow on addition, subtraction,
3257 multiplication operations.
3259 @item -fno-inline
3260 @opindex fno-inline
3261 Don't pay attention to the @code{inline} keyword.  Normally this option
3262 is used to keep the compiler from expanding any functions inline.
3263 Note that if you are not optimizing, no functions can be expanded inline.
3265 @item -finline-functions
3266 @opindex finline-functions
3267 Integrate all simple functions into their callers.  The compiler
3268 heuristically decides which functions are simple enough to be worth
3269 integrating in this way.
3271 If all calls to a given function are integrated, and the function is
3272 declared @code{static}, then the function is normally not output as
3273 assembler code in its own right.
3275 @item -finline-limit=@var{n}
3276 @opindex finline-limit
3277 By default, gcc limits the size of functions that can be inlined.  This flag
3278 allows the control of this limit for functions that are explicitly marked as
3279 inline (ie marked with the inline keyword or defined within the class
3280 definition in c++).  @var{n} is the size of functions that can be inlined in
3281 number of pseudo instructions (not counting parameter handling).  The default
3282 value of @var{n} is 600.
3283 Increasing this value can result in more inlined code at
3284 the cost of compilation time and memory consumption.  Decreasing usually makes
3285 the compilation faster and less code will be inlined (which presumably
3286 means slower programs).  This option is particularly useful for programs that
3287 use inlining heavily such as those based on recursive templates with C++.
3289 @emph{Note:} pseudo instruction represents, in this particular context, an
3290 abstract measurement of function's size.  In no way, it represents a count
3291 of assembly instructions and as such its exact meaning might change from one
3292 release to an another.
3294 @item -fkeep-inline-functions
3295 @opindex fkeep-inline-functions
3296 Even if all calls to a given function are integrated, and the function
3297 is declared @code{static}, nevertheless output a separate run-time
3298 callable version of the function.  This switch does not affect
3299 @code{extern inline} functions.
3301 @item -fkeep-static-consts
3302 @opindex fkeep-static-consts
3303 Emit variables declared @code{static const} when optimization isn't turned
3304 on, even if the variables aren't referenced.
3306 GCC enables this option by default.  If you want to force the compiler to
3307 check if the variable was referenced, regardless of whether or not
3308 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3310 @item -fmerge-constants
3311 Attempt to merge identical constants (string constants and floating point
3312 constants) accross compilation units.
3314 This option is default for optimized compilation if assembler and linker
3315 support it.  Use @option{-fno-merge-constants} to inhibit this behavior.
3317 @item -fmerge-all-constants
3318 Attempt to merge identical constants and identical variables.
3320 This option implies @option{-fmerge-constants}.  In addition to
3321 @option{-fmerge-constants} this considers e.g. even constant initialized
3322 arrays or initialized constant variables with integral or floating point
3323 types.  Languages like C or C++ require each non-automatic variable to
3324 have distinct location, so using this option will result in non-conforming
3325 behavior.
3327 @item -fno-function-cse
3328 @opindex fno-function-cse
3329 Do not put function addresses in registers; make each instruction that
3330 calls a constant function contain the function's address explicitly.
3332 This option results in less efficient code, but some strange hacks
3333 that alter the assembler output may be confused by the optimizations
3334 performed when this option is not used.
3336 @item -ffast-math
3337 @opindex ffast-math
3338 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, and @*
3339 @option{-fno-trapping-math}.
3341 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
3343 This option should never be turned on by any @option{-O} option since
3344 it can result in incorrect output for programs which depend on
3345 an exact implementation of IEEE or ISO rules/specifications for
3346 math functions.
3348 @item -fno-math-errno
3349 @opindex fno-math-errno
3350 Do not set ERRNO after calling math functions that are executed
3351 with a single instruction, e.g., sqrt.  A program that relies on
3352 IEEE exceptions for math error handling may want to use this flag
3353 for speed while maintaining IEEE arithmetic compatibility.
3355 This option should never be turned on by any @option{-O} option since
3356 it can result in incorrect output for programs which depend on
3357 an exact implementation of IEEE or ISO rules/specifications for
3358 math functions.
3360 The default is @option{-fmath-errno}.
3362 @item -funsafe-math-optimizations
3363 @opindex funsafe-math-optimizations
3364 Allow optimizations for floating-point arithmetic that (a) assume
3365 that arguments and results are valid and (b) may violate IEEE or
3366 ANSI standards.  When used at link-time, it may include libraries
3367 or startup files that change the default FPU control word or other
3368 similar optimizations.
3370 This option should never be turned on by any @option{-O} option since
3371 it can result in incorrect output for programs which depend on
3372 an exact implementation of IEEE or ISO rules/specifications for
3373 math functions.
3375 The default is @option{-fno-unsafe-math-optimizations}.
3377 @item -fno-trapping-math
3378 @opindex fno-trapping-math
3379 Compile code assuming that floating-point operations cannot generate
3380 user-visible traps.  Setting this option may allow faster code
3381 if one relies on ``non-stop'' IEEE arithmetic, for example.
3383 This option should never be turned on by any @option{-O} option since
3384 it can result in incorrect output for programs which depend on
3385 an exact implementation of IEEE or ISO rules/specifications for
3386 math functions.
3388 The default is @option{-ftrapping-math}.
3389 @end table
3391 The following options control specific optimizations.  The @option{-O2}
3392 option turns on all of these optimizations except @option{-funroll-loops}
3393 and @option{-funroll-all-loops}.  On most machines, the @option{-O} option
3394 turns on the @option{-fthread-jumps} and @option{-fdelayed-branch} options,
3395 but specific machines may handle it differently.
3397 You can use the following flags in the rare cases when ``fine-tuning''
3398 of optimizations to be performed is desired.
3400 Not all of the optimizations performed by GCC have @option{-f} options
3401 to control them.
3403 @table @gcctabopt
3404 @item -fstrength-reduce
3405 @opindex fstrength-reduce
3406 Perform the optimizations of loop strength reduction and
3407 elimination of iteration variables.
3409 @item -fthread-jumps
3410 @opindex fthread-jumps
3411 Perform optimizations where we check to see if a jump branches to a
3412 location where another comparison subsumed by the first is found.  If
3413 so, the first branch is redirected to either the destination of the
3414 second branch or a point immediately following it, depending on whether
3415 the condition is known to be true or false.
3417 @item -fcse-follow-jumps
3418 @opindex fcse-follow-jumps
3419 In common subexpression elimination, scan through jump instructions
3420 when the target of the jump is not reached by any other path.  For
3421 example, when CSE encounters an @code{if} statement with an
3422 @code{else} clause, CSE will follow the jump when the condition
3423 tested is false.
3425 @item -fcse-skip-blocks
3426 @opindex fcse-skip-blocks
3427 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3428 follow jumps which conditionally skip over blocks.  When CSE
3429 encounters a simple @code{if} statement with no else clause,
3430 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3431 body of the @code{if}.
3433 @item -frerun-cse-after-loop
3434 @opindex frerun-cse-after-loop
3435 Re-run common subexpression elimination after loop optimizations has been
3436 performed.
3438 @item -frerun-loop-opt
3439 @opindex frerun-loop-opt
3440 Run the loop optimizer twice.
3442 @item -fgcse
3443 @opindex fgcse
3444 Perform a global common subexpression elimination pass.
3445 This pass also performs global constant and copy propagation.
3447 @emph{Note:} When compiling a program using computed gotos, a GCC
3448 extension, you may get better runtime performance if you disable
3449 the global common subexpression elmination pass by adding
3450 @option{-fno-gcse} to the command line.
3452 @item -fgcse-lm
3453 @opindex fgcse-lm
3454 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3455 attempt to move loads which are only killed by stores into themselves.  This
3456 allows a loop containing a load/store sequence to be changed to a load outside
3457 the loop, and a copy/store within the loop.
3459 @item -fgcse-sm
3460 @opindex fgcse-sm
3461 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3462 subexpression elimination.  This pass will attempt to move stores out of loops.
3463 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3464 can be changed to a load before the loop and a store after the loop.
3466 @item -fdelete-null-pointer-checks
3467 @opindex fdelete-null-pointer-checks
3468 Use global dataflow analysis to identify and eliminate useless checks
3469 for null pointers.  The compiler assumes that dereferencing a null
3470 pointer would have halted the program.  If a pointer is checked after
3471 it has already been dereferenced, it cannot be null.
3473 In some environments, this assumption is not true, and programs can
3474 safely dereference null pointers.  Use
3475 @option{-fno-delete-null-pointer-checks} to disable this optimization
3476 for programs which depend on that behavior.
3478 @item -fexpensive-optimizations
3479 @opindex fexpensive-optimizations
3480 Perform a number of minor optimizations that are relatively expensive.
3482 @item -foptimize-register-move
3483 @itemx -fregmove
3484 @opindex foptimize-register-move
3485 @opindex fregmove
3486 Attempt to reassign register numbers in move instructions and as
3487 operands of other simple instructions in order to maximize the amount of
3488 register tying.  This is especially helpful on machines with two-operand
3489 instructions.  GCC enables this optimization by default with @option{-O2}
3490 or higher.
3492 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3493 optimization.
3495 @item -fdelayed-branch
3496 @opindex fdelayed-branch
3497 If supported for the target machine, attempt to reorder instructions
3498 to exploit instruction slots available after delayed branch
3499 instructions.
3501 @item -fschedule-insns
3502 @opindex fschedule-insns
3503 If supported for the target machine, attempt to reorder instructions to
3504 eliminate execution stalls due to required data being unavailable.  This
3505 helps machines that have slow floating point or memory load instructions
3506 by allowing other instructions to be issued until the result of the load
3507 or floating point instruction is required.
3509 @item -fschedule-insns2
3510 @opindex fschedule-insns2
3511 Similar to @option{-fschedule-insns}, but requests an additional pass of
3512 instruction scheduling after register allocation has been done.  This is
3513 especially useful on machines with a relatively small number of
3514 registers and where memory load instructions take more than one cycle.
3516 @item -ffunction-sections
3517 @itemx -fdata-sections
3518 @opindex ffunction-sections
3519 @opindex fdata-sections
3520 Place each function or data item into its own section in the output
3521 file if the target supports arbitrary sections.  The name of the
3522 function or the name of the data item determines the section's name
3523 in the output file.
3525 Use these options on systems where the linker can perform optimizations
3526 to improve locality of reference in the instruction space.  HPPA
3527 processors running HP-UX and Sparc processors running Solaris 2 have
3528 linkers with such optimizations.  Other systems using the ELF object format
3529 as well as AIX may have these optimizations in the future.
3531 Only use these options when there are significant benefits from doing
3532 so.  When you specify these options, the assembler and linker will
3533 create larger object and executable files and will also be slower.
3534 You will not be able to use @code{gprof} on all systems if you
3535 specify this option and you may have problems with debugging if
3536 you specify both this option and @option{-g}.
3538 @item -fcaller-saves
3539 @opindex fcaller-saves
3540 Enable values to be allocated in registers that will be clobbered by
3541 function calls, by emitting extra instructions to save and restore the
3542 registers around such calls.  Such allocation is done only when it
3543 seems to result in better code than would otherwise be produced.
3545 This option is always enabled by default on certain machines, usually
3546 those which have no call-preserved registers to use instead.
3548 For all machines, optimization level 2 and higher enables this flag by
3549 default.
3551 @item -funroll-loops
3552 @opindex funroll-loops
3553 Unroll loops whose number of iterations can be determined at compile
3554 time or upon entry to the loop.  @option{-funroll-loops} implies both
3555 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
3556 option makes code larger, and may or may not make it run faster.
3558 @item -funroll-all-loops
3559 @opindex funroll-all-loops
3560 Unroll all loops, even if their number of iterations is uncertain when
3561 the loop is entered.  This usually makes programs run more slowly.
3562 @option{-funroll-all-loops} implies the same options as
3563 @option{-funroll-loops},
3565 @item -fprefetch-loop-arrays
3566 @opindex fprefetch-loop-arrays
3567 If supported by the target machine, generate instructions to prefetch
3568 memory to improve the performance of loops that access large arrays.
3570 @item -fmove-all-movables
3571 @opindex fmove-all-movables
3572 Forces all invariant computations in loops to be moved
3573 outside the loop.
3575 @item -freduce-all-givs
3576 @opindex freduce-all-givs
3577 Forces all general-induction variables in loops to be
3578 strength-reduced.
3580 @emph{Note:} When compiling programs written in Fortran,
3581 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3582 by default when you use the optimizer.
3584 These options may generate better or worse code; results are highly
3585 dependent on the structure of loops within the source code.
3587 These two options are intended to be removed someday, once
3588 they have helped determine the efficacy of various
3589 approaches to improving loop optimizations.
3591 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3592 know how use of these options affects
3593 the performance of your production code.
3594 We're very interested in code that runs @emph{slower}
3595 when these options are @emph{enabled}.
3597 @item -fno-peephole
3598 @itemx -fno-peephole2
3599 @opindex fno-peephole
3600 @opindex fno-peephole2
3601 Disable any machine-specific peephole optimizations.  The difference
3602 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3603 are implemented in the compiler; some targets use one, some use the
3604 other, a few use both.
3606 @item -fbranch-probabilities
3607 @opindex fbranch-probabilities
3608 After running a program compiled with @option{-fprofile-arcs}
3609 (@pxref{Debugging Options,, Options for Debugging Your Program or
3610 @command{gcc}}), you can compile it a second time using
3611 @option{-fbranch-probabilities}, to improve optimizations based on
3612 the number of times each branch was taken.  When the program
3613 compiled with @option{-fprofile-arcs} exits it saves arc execution
3614 counts to a file called @file{@var{sourcename}.da} for each source
3615 file  The information in this data file is very dependent on the
3616 structure of the generated code, so you must use the same source code
3617 and the same optimization options for both compilations.
3619 With @option{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3620 note on the first instruction of each basic block, and a
3621 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3622 These can be used to improve optimization.  Currently, they are only
3623 used in one place: in @file{reorg.c}, instead of guessing which path a
3624 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3625 exactly determine which path is taken more often.
3627 @item -fno-guess-branch-probability
3628 @opindex fno-guess-branch-probability
3629 Do not guess branch probabilities using a randomized model.
3631 Sometimes gcc will opt to use a randomized model to guess branch
3632 probabilities, when none are available from either profiling feedback
3633 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3634 different runs of the compiler on the same program may produce different
3635 object code.
3637 In a hard real-time system, people don't want different runs of the
3638 compiler to produce code that has different behavior; minimizing
3639 non-determinism is of paramount import.  This switch allows users to
3640 reduce non-determinism, possibly at the expense of inferior
3641 optimization.
3643 @item -fstrict-aliasing
3644 @opindex fstrict-aliasing
3645 Allows the compiler to assume the strictest aliasing rules applicable to
3646 the language being compiled.  For C (and C++), this activates
3647 optimizations based on the type of expressions.  In particular, an
3648 object of one type is assumed never to reside at the same address as an
3649 object of a different type, unless the types are almost the same.  For
3650 example, an @code{unsigned int} can alias an @code{int}, but not a
3651 @code{void*} or a @code{double}.  A character type may alias any other
3652 type.
3654 Pay special attention to code like this:
3655 @example
3656 union a_union @{
3657   int i;
3658   double d;
3661 int f() @{
3662   a_union t;
3663   t.d = 3.0;
3664   return t.i;
3666 @end example
3667 The practice of reading from a different union member than the one most
3668 recently written to (called ``type-punning'') is common.  Even with
3669 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
3670 is accessed through the union type.  So, the code above will work as
3671 expected.  However, this code might not:
3672 @example
3673 int f() @{
3674   a_union t;
3675   int* ip;
3676   t.d = 3.0;
3677   ip = &t.i;
3678   return *ip;
3680 @end example
3682 Every language that wishes to perform language-specific alias analysis
3683 should define a function that computes, given an @code{tree}
3684 node, an alias set for the node.  Nodes in different alias sets are not
3685 allowed to alias.  For an example, see the C front-end function
3686 @code{c_get_alias_set}.
3688 @item -falign-functions
3689 @itemx -falign-functions=@var{n}
3690 @opindex falign-functions
3691 Align the start of functions to the next power-of-two greater than
3692 @var{n}, skipping up to @var{n} bytes.  For instance,
3693 @option{-falign-functions=32} aligns functions to the next 32-byte
3694 boundary, but @option{-falign-functions=24} would align to the next
3695 32-byte boundary only if this can be done by skipping 23 bytes or less.
3697 @option{-fno-align-functions} and @option{-falign-functions=1} are
3698 equivalent and mean that functions will not be aligned.
3700 Some assemblers only support this flag when @var{n} is a power of two;
3701 in that case, it is rounded up.
3703 If @var{n} is not specified, use a machine-dependent default.
3705 @item -falign-labels
3706 @itemx -falign-labels=@var{n}
3707 @opindex falign-labels
3708 Align all branch targets to a power-of-two boundary, skipping up to
3709 @var{n} bytes like @option{-falign-functions}.  This option can easily
3710 make code slower, because it must insert dummy operations for when the
3711 branch target is reached in the usual flow of the code.
3713 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
3714 are greater than this value, then their values are used instead.
3716 If @var{n} is not specified, use a machine-dependent default which is
3717 very likely to be @samp{1}, meaning no alignment.
3719 @item -falign-loops
3720 @itemx -falign-loops=@var{n}
3721 @opindex falign-loops
3722 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3723 like @option{-falign-functions}.  The hope is that the loop will be
3724 executed many times, which will make up for any execution of the dummy
3725 operations.
3727 If @var{n} is not specified, use a machine-dependent default.
3729 @item -falign-jumps
3730 @itemx -falign-jumps=@var{n}
3731 @opindex falign-jumps
3732 Align branch targets to a power-of-two boundary, for branch targets
3733 where the targets can only be reached by jumping, skipping up to @var{n}
3734 bytes like @option{-falign-functions}.  In this case, no dummy operations
3735 need be executed.
3737 If @var{n} is not specified, use a machine-dependent default.
3739 @item -fssa
3740 @opindex fssa
3741 Perform optimizations in static single assignment form.  Each function's
3742 flow graph is translated into SSA form, optimizations are performed, and
3743 the flow graph is translated back from SSA form.  Users should not
3744 specify this option, since it is not yet ready for production use.
3746 @item -fssa-ccp
3747 @opindex fssa-ccp
3748 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
3749 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
3751 @item -fssa-dce
3752 @opindex fssa-dce
3753 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
3754 Like @option{-fssa}, this is an experimental feature.
3756 @item -fsingle-precision-constant
3757 @opindex fsingle-precision-constant
3758 Treat floating point constant as single precision constant instead of
3759 implicitly converting it to double precision constant.
3761 @item -frename-registers
3762 @opindex frename-registers
3763 Attempt to avoid false dependencies in scheduled code by making use
3764 of registers left over after register allocation.  This optimization
3765 will most benefit processors with lots of registers.  It can, however,
3766 make debugging impossible, since variables will no longer stay in
3767 a ``home register''.
3769 @item -fno-cprop-registers
3770 @opindex fno-cprop-registers
3771 After register allocation and post-register allocation instruction splitting,
3772 we perform a copy-propagation pass to try to reduce scheduling dependencies
3773 and occasionally eliminate the copy.
3775 @item --param @var{name}=@var{value}
3776 @opindex param
3777 In some places, GCC uses various constants to control the amount of
3778 optimization that is done.  For example, GCC will not inline functions
3779 that contain more that a certain number of instructions.  You can
3780 control some of these constants on the command-line using the
3781 @option{--param} option.
3783 In each case, the @var{value} is an integer.  The allowable choices for
3784 @var{name} are given in the following table:
3786 @table @gcctabopt
3787 @item max-delay-slot-insn-search
3788 The maximum number of instructions to consider when looking for an
3789 instruction to fill a delay slot.  If more than this arbitrary number of
3790 instructions is searched, the time savings from filling the delay slot
3791 will be minimal so stop searching.  Increasing values mean more
3792 aggressive optimization, making the compile time increase with probably
3793 small improvement in executable run time.
3795 @item max-delay-slot-live-search
3796 When trying to fill delay slots, the maximum number of instructions to
3797 consider when searching for a block with valid live register
3798 information.  Increasing this arbitrarily chosen value means more
3799 aggressive optimization, increasing the compile time.  This parameter
3800 should be removed when the delay slot code is rewritten to maintain the
3801 control-flow graph.
3803 @item max-gcse-memory
3804 The approximate maximum amount of memory that will be allocated in
3805 order to perform the global common subexpression elimination
3806 optimization.  If more memory than specified is required, the
3807 optimization will not be done.
3809 @item max-gcse-passes
3810 The maximum number of passes of GCSE to run.
3812 @item max-pending-list-length
3813 The maximum number of pending dependencies scheduling will allow
3814 before flushing the current state and starting over.  Large functions
3815 with few branches or calls can create excessively large lists which
3816 needlessly consume memory and resources.
3818 @item max-inline-insns
3819 If an function contains more than this many instructions, it
3820 will not be inlined.  This option is precisely equivalent to
3821 @option{-finline-limit}.
3823 @end table
3824 @end table
3826 @node Preprocessor Options
3827 @section Options Controlling the Preprocessor
3828 @cindex preprocessor options
3829 @cindex options, preprocessor
3831 These options control the C preprocessor, which is run on each C source
3832 file before actual compilation.
3834 If you use the @option{-E} option, nothing is done except preprocessing.
3835 Some of these options make sense only together with @option{-E} because
3836 they cause the preprocessor output to be unsuitable for actual
3837 compilation.
3839 @table @gcctabopt
3840 @item -include @var{file}
3841 @opindex include
3842 Process @var{file} as input before processing the regular input file.
3843 In effect, the contents of @var{file} are compiled first.  Any @option{-D}
3844 and @option{-U} options on the command line are always processed before
3845 @option{-include @var{file}}, regardless of the order in which they are
3846 written.  All the @option{-include} and @option{-imacros} options are
3847 processed in the order in which they are written.
3849 @item -imacros @var{file}
3850 @opindex imacros
3851 Process @var{file} as input, discarding the resulting output, before
3852 processing the regular input file.  Because the output generated from
3853 @var{file} is discarded, the only effect of @option{-imacros @var{file}}
3854 is to make the macros defined in @var{file} available for use in the
3855 main input.  All the @option{-include} and @option{-imacros} options are
3856 processed in the order in which they are written.
3858 @item -idirafter @var{dir}
3859 @opindex idirafter
3860 @cindex second include path
3861 Add the directory @var{dir} to the second include path.  The directories
3862 on the second include path are searched when a header file is not found
3863 in any of the directories in the main include path (the one that
3864 @option{-I} adds to).
3866 @item -iprefix @var{prefix}
3867 @opindex iprefix
3868 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
3869 options.
3871 @item -iwithprefix @var{dir}
3872 @opindex iwithprefix
3873 Add a directory to the second include path.  The directory's name is
3874 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3875 specified previously with @option{-iprefix}.  If you have not specified a
3876 prefix yet, the directory containing the installed passes of the
3877 compiler is used as the default.
3879 @item -iwithprefixbefore @var{dir}
3880 @opindex iwithprefixbefore
3881 Add a directory to the main include path.  The directory's name is made
3882 by concatenating @var{prefix} and @var{dir}, as in the case of
3883 @option{-iwithprefix}.
3885 @item -isystem @var{dir}
3886 @opindex isystem
3887 Add a directory to the beginning of the second include path, marking it
3888 as a system directory, so that it gets the same special treatment as
3889 is applied to the standard system directories.
3891 @item -nostdinc
3892 @opindex nostdinc
3893 Do not search the standard system directories for header files.  Only
3894 the directories you have specified with @option{-I} options (and the
3895 current directory, if appropriate) are searched.  @xref{Directory
3896 Options}, for information on @option{-I}.
3898 By using both @option{-nostdinc} and @option{-I-}, you can limit the include-file
3899 search path to only those directories you specify explicitly.
3901 @item -remap
3902 @opindex remap
3903 When searching for a header file in a directory, remap file names if a
3904 file named @file{header.gcc} exists in that directory.  This can be used
3905 to work around limitations of file systems with file name restrictions.
3906 The @file{header.gcc} file should contain a series of lines with two
3907 tokens on each line: the first token is the name to map, and the second
3908 token is the actual name to use.
3910 @item -undef
3911 @opindex undef
3912 Do not predefine any nonstandard macros.  (Including architecture flags).
3914 @item -E
3915 @opindex E
3916 Run only the C preprocessor.  Preprocess all the C source files
3917 specified and output the results to standard output or to the
3918 specified output file.
3920 @item -C
3921 @opindex C
3922 Tell the preprocessor not to discard comments.  Used with the
3923 @option{-E} option.
3925 @item -P
3926 @opindex P
3927 Tell the preprocessor not to generate @samp{#line} directives.
3928 Used with the @option{-E} option.
3930 @cindex make
3931 @cindex dependencies, make
3932 @item -M
3933 @opindex M
3934 Instead of outputting the result of preprocessing, output a rule
3935 suitable for @code{make} describing the dependencies of the main source
3936 file.  The preprocessor outputs one @code{make} rule containing the
3937 object file name for that source file, a colon, and the names of all the
3938 included files.  Unless overridden explicitly, the object file name
3939 consists of the basename of the source file with any suffix replaced with
3940 object file suffix.  If there are many included files then the
3941 rule is split into several lines using @samp{\}-newline.
3943 @option{-M} implies @option{-E}.
3945 @item -MM
3946 @opindex MM
3947 Like @option{-M}, but mention only the files included with @samp{#include
3948 "@var{file}"}.  System header files included with @samp{#include
3949 <@var{file}>} are omitted.
3951 @item -MD
3952 @opindex MD
3953 Like @option{-M} but the dependency information is written to a file
3954 rather than stdout.  @code{gcc} will use the same file name and
3955 directory as the object file, but with the suffix @file{.d} instead.
3957 This is in addition to compiling the main file as specified---@option{-MD}
3958 does not inhibit ordinary compilation the way @option{-M} does,
3959 unless you also specify @option{-MG}.
3961 With Mach, you can use the utility @code{md} to merge multiple
3962 dependency files into a single dependency file suitable for using with
3963 the @samp{make} command.
3965 @item -MMD
3966 @opindex MMD
3967 Like @option{-MD} except mention only user header files, not system
3968 -header files.
3970 @item -MF @var{file}
3971 @opindex MF
3972 When used with @option{-M} or @option{-MM}, specifies a file to write the
3973 dependencies to.  This allows the preprocessor to write the preprocessed
3974 file to stdout normally.  If no @option{-MF} switch is given, CPP sends
3975 the rules to stdout and suppresses normal preprocessed output.
3977 Another way to specify output of a @code{make} rule is by setting
3978 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3979 Variables}).
3981 @item -MG
3982 @opindex MG
3983 When used with @option{-M} or @option{-MM}, @option{-MG} says to treat missing
3984 header files as generated files and assume they live in the same
3985 directory as the source file.  It suppresses preprocessed output, as a
3986 missing header file is ordinarily an error.
3988 This feature is used in automatic updating of makefiles.
3990 @item -MP
3991 @opindex MP
3992 This option instructs CPP to add a phony target for each dependency
3993 other than the main file, causing each to depend on nothing.  These
3994 dummy rules work around errors @code{make} gives if you remove header
3995 files without updating the @code{Makefile} to match.
3997 This is typical output:-
3999 @smallexample
4000 /tmp/test.o: /tmp/test.c /tmp/test.h
4002 /tmp/test.h:
4003 @end smallexample
4005 @item -MQ @var{target}
4006 @item -MT @var{target}
4007 @opindex MQ
4008 @opindex MT
4009 By default CPP uses the main file name, including any path, and appends
4010 the object suffix, normally ``.o'', to it to obtain the name of the
4011 target for dependency generation.  With @option{-MT} you can specify a
4012 target yourself, overriding the default one.
4014 If you want multiple targets, you can specify them as a single argument
4015 to @option{-MT}, or use multiple @option{-MT} options.
4017 The targets you specify are output in the order they appear on the
4018 command line.  @option{-MQ} is identical to @option{-MT}, except that the
4019 target name is quoted for Make, but with @option{-MT} it isn't.  For
4020 example, @option{-MT '$(objpfx)foo.o'} gives
4022 @smallexample
4023 $(objpfx)foo.o: /tmp/foo.c
4024 @end smallexample
4026 but @option{-MQ '$(objpfx)foo.o'} gives
4028 @smallexample
4029 $$(objpfx)foo.o: /tmp/foo.c
4030 @end smallexample
4032 The default target is automatically quoted, as if it were given with
4033 @option{-MQ}.
4035 @item -H
4036 @opindex H
4037 Print the name of each header file used, in addition to other normal
4038 activities.
4040 @item -A@var{question}(@var{answer})
4041 @opindex A
4042 Assert the answer @var{answer} for @var{question}, in case it is tested
4043 with a preprocessing conditional such as @samp{#if
4044 #@var{question}(@var{answer})}.  @option{-A-} disables the standard
4045 assertions that normally describe the target machine.
4047 @item -D@var{macro}
4048 @opindex D
4049 Define macro @var{macro} with the string @samp{1} as its definition.
4051 @item -D@var{macro}=@var{defn}
4052 Define macro @var{macro} as @var{defn}.  All instances of @option{-D} on
4053 the command line are processed before any @option{-U} options.
4055 Any @option{-D} and @option{-U} options on the command line are processed in
4056 order, and always before @option{-imacros @var{file}}, regardless of the
4057 order in which they are written.
4059 @item -U@var{macro}
4060 @opindex U
4061 Undefine macro @var{macro}.  @option{-U} options are evaluated after all
4062 @option{-D} options, but before any @option{-include} and @option{-imacros}
4063 options.
4065 Any @option{-D} and @option{-U} options on the command line are processed in
4066 order, and always before @option{-imacros @var{file}}, regardless of the
4067 order in which they are written.
4069 @item -dM
4070 @opindex dM
4071 Tell the preprocessor to output only a list of the macro definitions
4072 that are in effect at the end of preprocessing.  Used with the @option{-E}
4073 option.
4075 @item -dD
4076 @opindex dD
4077 Tell the preprocessing to pass all macro definitions into the output, in
4078 their proper sequence in the rest of the output.
4080 @item -dN
4081 @opindex dN
4082 Like @option{-dD} except that the macro arguments and contents are omitted.
4083 Only @samp{#define @var{name}} is included in the output.
4085 @item -dI
4086 @opindex dI
4087 Output @samp{#include} directives in addition to the result of
4088 preprocessing.
4090 @item -fpreprocessed
4091 @opindex fpreprocessed
4092 Indicate to the preprocessor that the input file has already been
4093 preprocessed.  This suppresses things like macro expansion, trigraph
4094 conversion, escaped newline splicing, and processing of most directives.
4095 The preprocessor still recognizes and removes comments, so that you can
4096 pass a file preprocessed with @option{-C} to the compiler without
4097 problems.  In this mode the integrated preprocessor is little more than
4098 a tokenizer for the front ends.
4100 @option{-fpreprocessed} is implicit if the input file has one of the
4101 extensions @samp{i}, @samp{ii} or @samp{mi}.  These are the extensions
4102 that GCC uses for preprocessed files created by @option{-save-temps}.
4104 @item -trigraphs
4105 @opindex trigraphs
4106 Process ISO standard trigraph sequences.  These are three-character
4107 sequences, all starting with @samp{??}, that are defined by ISO C to
4108 stand for single characters.  For example, @samp{??/} stands for
4109 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
4110 default, GCC ignores trigraphs, but in standard-conforming modes it
4111 converts them.  See the @option{-std} and @option{-ansi} options.
4113 The nine trigraph sequences are
4114 @table @samp
4115 @item ??(
4116 @expansion{} @samp{[}
4118 @item ??)
4119 @expansion{} @samp{]}
4121 @item ??<
4122 @expansion{} @samp{@{}
4124 @item ??>
4125 @expansion{} @samp{@}}
4127 @item ??=
4128 @expansion{} @samp{#}
4130 @item ??/
4131 @expansion{} @samp{\}
4133 @item ??'
4134 @expansion{} @samp{^}
4136 @item ??!
4137 @expansion{} @samp{|}
4139 @item ??-
4140 @expansion{} @samp{~}
4142 @end table
4144 Trigraph support is not popular, so many compilers do not implement it
4145 properly.  Portable code should not rely on trigraphs being either
4146 converted or ignored.
4148 @item -Wp,@var{option}
4149 @opindex Wp
4150 Pass @var{option} as an option to the preprocessor.  If @var{option}
4151 contains commas, it is split into multiple options at the commas.
4152 @end table
4154 @node Assembler Options
4155 @section Passing Options to the Assembler
4157 @c prevent bad page break with this line
4158 You can pass options to the assembler.
4160 @table @gcctabopt
4161 @item -Wa,@var{option}
4162 @opindex Wa
4163 Pass @var{option} as an option to the assembler.  If @var{option}
4164 contains commas, it is split into multiple options at the commas.
4165 @end table
4167 @node Link Options
4168 @section Options for Linking
4169 @cindex link options
4170 @cindex options, linking
4172 These options come into play when the compiler links object files into
4173 an executable output file.  They are meaningless if the compiler is
4174 not doing a link step.
4176 @table @gcctabopt
4177 @cindex file names
4178 @item @var{object-file-name}
4179 A file name that does not end in a special recognized suffix is
4180 considered to name an object file or library.  (Object files are
4181 distinguished from libraries by the linker according to the file
4182 contents.)  If linking is done, these object files are used as input
4183 to the linker.
4185 @item -c
4186 @itemx -S
4187 @itemx -E
4188 @opindex c
4189 @opindex S
4190 @opindex E
4191 If any of these options is used, then the linker is not run, and
4192 object file names should not be used as arguments.  @xref{Overall
4193 Options}.
4195 @cindex Libraries
4196 @item -l@var{library}
4197 @itemx -l @var{library}
4198 @opindex l
4199 Search the library named @var{library} when linking.  (The second
4200 alternative with the library as a separate argument is only for
4201 POSIX compliance and is not recommended.)
4203 It makes a difference where in the command you write this option; the
4204 linker searches and processes libraries and object files in the order they
4205 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4206 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4207 to functions in @samp{z}, those functions may not be loaded.
4209 The linker searches a standard list of directories for the library,
4210 which is actually a file named @file{lib@var{library}.a}.  The linker
4211 then uses this file as if it had been specified precisely by name.
4213 The directories searched include several standard system directories
4214 plus any that you specify with @option{-L}.
4216 Normally the files found this way are library files---archive files
4217 whose members are object files.  The linker handles an archive file by
4218 scanning through it for members which define symbols that have so far
4219 been referenced but not defined.  But if the file that is found is an
4220 ordinary object file, it is linked in the usual fashion.  The only
4221 difference between using an @option{-l} option and specifying a file name
4222 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4223 and searches several directories.
4225 @item -lobjc
4226 @opindex lobjc
4227 You need this special case of the @option{-l} option in order to
4228 link an Objective-C program.
4230 @item -nostartfiles
4231 @opindex nostartfiles
4232 Do not use the standard system startup files when linking.
4233 The standard system libraries are used normally, unless @option{-nostdlib}
4234 or @option{-nodefaultlibs} is used.
4236 @item -nodefaultlibs
4237 @opindex nodefaultlibs
4238 Do not use the standard system libraries when linking.
4239 Only the libraries you specify will be passed to the linker.
4240 The standard startup files are used normally, unless @option{-nostartfiles}
4241 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4242 for System V (and ISO C) environments or to bcopy and bzero for
4243 BSD environments.  These entries are usually resolved by entries in
4244 libc.  These entry points should be supplied through some other
4245 mechanism when this option is specified.
4247 @item -nostdlib
4248 @opindex nostdlib
4249 Do not use the standard system startup files or libraries when linking.
4250 No startup files and only the libraries you specify will be passed to
4251 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4252 for System V (and ISO C) environments or to bcopy and bzero for
4253 BSD environments.  These entries are usually resolved by entries in
4254 libc.  These entry points should be supplied through some other
4255 mechanism when this option is specified.
4257 @cindex @option{-lgcc}, use with @option{-nostdlib}
4258 @cindex @option{-nostdlib} and unresolved references
4259 @cindex unresolved references and @option{-nostdlib}
4260 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4261 @cindex @option{-nodefaultlibs} and unresolved references
4262 @cindex unresolved references and @option{-nodefaultlibs}
4263 One of the standard libraries bypassed by @option{-nostdlib} and
4264 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4265 that GCC uses to overcome shortcomings of particular machines, or special
4266 needs for some languages.
4267 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4268 Collection (GCC) Internals},
4269 for more discussion of @file{libgcc.a}.)
4270 In most cases, you need @file{libgcc.a} even when you want to avoid
4271 other standard libraries.  In other words, when you specify @option{-nostdlib}
4272 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4273 This ensures that you have no unresolved references to internal GCC
4274 library subroutines.  (For example, @samp{__main}, used to ensure C++
4275 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4276 GNU Compiler Collection (GCC) Internals}.)
4278 @item -s
4279 @opindex s
4280 Remove all symbol table and relocation information from the executable.
4282 @item -static
4283 @opindex static
4284 On systems that support dynamic linking, this prevents linking with the shared
4285 libraries.  On other systems, this option has no effect.
4287 @item -shared
4288 @opindex shared
4289 Produce a shared object which can then be linked with other objects to
4290 form an executable.  Not all systems support this option.  For predictable
4291 results, you must also specify the same set of options that were used to
4292 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4293 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4294 needs to build supplementary stub code for constructors to work.  On
4295 multi-libbed systems, @samp{gcc -shared} must select the correct support
4296 libraries to link against.  Failing to supply the correct flags may lead
4297 to subtle defects.  Supplying them in cases where they are not necessary
4298 is innocuous.}
4300 @item -shared-libgcc
4301 @itemx -static-libgcc
4302 @opindex shared-libgcc
4303 @opindex static-libgcc
4304 On systems that provide @file{libgcc} as a shared library, these options
4305 force the use of either the shared or static version respectively.
4306 If no shared version of @file{libgcc} was built when the compiler was
4307 configured, these options have no effect.
4309 There are several situations in which an application should use the
4310 shared @file{libgcc} instead of the static version.  The most common
4311 of these is when the application wishes to throw and catch exceptions
4312 across different shared libraries.  In that case, each of the libraries
4313 as well as the application itself should use the shared @file{libgcc}.
4315 Therefore, whenever you specify the @option{-shared} option, the GCC
4316 driver automatically adds @option{-shared-libgcc}, unless you explicitly
4317 specify @option{-static-libgcc}.  The G++ driver automatically adds
4318 @option{-shared-libgcc} when you build a main executable as well because
4319 for C++ programs that is typically the right thing to do.
4320 (Exception-handling will not work reliably otherwise.)
4322 However, when linking a main executable written in C, you must
4323 explicitly say @option{-shared-libgcc} if you want to use the shared
4324 @file{libgcc}.
4326 @item -symbolic
4327 @opindex symbolic
4328 Bind references to global symbols when building a shared object.  Warn
4329 about any unresolved references (unless overridden by the link editor
4330 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4331 this option.
4333 @item -Xlinker @var{option}
4334 @opindex Xlinker
4335 Pass @var{option} as an option to the linker.  You can use this to
4336 supply system-specific linker options which GCC does not know how to
4337 recognize.
4339 If you want to pass an option that takes an argument, you must use
4340 @option{-Xlinker} twice, once for the option and once for the argument.
4341 For example, to pass @option{-assert definitions}, you must write
4342 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4343 @option{-Xlinker "-assert definitions"}, because this passes the entire
4344 string as a single argument, which is not what the linker expects.
4346 @item -Wl,@var{option}
4347 @opindex Wl
4348 Pass @var{option} as an option to the linker.  If @var{option} contains
4349 commas, it is split into multiple options at the commas.
4351 @item -u @var{symbol}
4352 @opindex u
4353 Pretend the symbol @var{symbol} is undefined, to force linking of
4354 library modules to define it.  You can use @option{-u} multiple times with
4355 different symbols to force loading of additional library modules.
4356 @end table
4358 @node Directory Options
4359 @section Options for Directory Search
4360 @cindex directory options
4361 @cindex options, directory search
4362 @cindex search path
4364 These options specify directories to search for header files, for
4365 libraries and for parts of the compiler:
4367 @table @gcctabopt
4368 @item -I@var{dir}
4369 @opindex I
4370 Add the directory @var{dir} to the head of the list of directories to be
4371 searched for header files.  This can be used to override a system header
4372 file, substituting your own version, since these directories are
4373 searched before the system header file directories.  However, you should
4374 not use this option to add directories that contain vendor-supplied
4375 system header files (use @option{-isystem} for that).  If you use more than
4376 one @option{-I} option, the directories are scanned in left-to-right
4377 order; the standard system directories come after.
4379 If a standard system include directory, or a directory specified with
4380 @option{-isystem}, is also specified with @option{-I}, it will be
4381 searched only in the position requested by @option{-I}.  Also, it will
4382 not be considered a system include directory.  If that directory really
4383 does contain system headers, there is a good chance that they will
4384 break.  For instance, if GCC's installation procedure edited the headers
4385 in @file{/usr/include} to fix bugs, @samp{-I/usr/include} will cause the
4386 original, buggy headers to be found instead of the corrected ones.  GCC
4387 will issue a warning when a system include directory is hidden in this
4388 way.
4390 @item -I-
4391 @opindex I-
4392 Any directories you specify with @option{-I} options before the @option{-I-}
4393 option are searched only for the case of @samp{#include "@var{file}"};
4394 they are not searched for @samp{#include <@var{file}>}.
4396 If additional directories are specified with @option{-I} options after
4397 the @option{-I-}, these directories are searched for all @samp{#include}
4398 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4399 this way.)
4401 In addition, the @option{-I-} option inhibits the use of the current
4402 directory (where the current input file came from) as the first search
4403 directory for @samp{#include "@var{file}"}.  There is no way to
4404 override this effect of @option{-I-}.  With @option{-I.} you can specify
4405 searching the directory which was current when the compiler was
4406 invoked.  That is not exactly the same as what the preprocessor does
4407 by default, but it is often satisfactory.
4409 @option{-I-} does not inhibit the use of the standard system directories
4410 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4411 independent.
4413 @item -L@var{dir}
4414 @opindex L
4415 Add directory @var{dir} to the list of directories to be searched
4416 for @option{-l}.
4418 @item -B@var{prefix}
4419 @opindex B
4420 This option specifies where to find the executables, libraries,
4421 include files, and data files of the compiler itself.
4423 The compiler driver program runs one or more of the subprograms
4424 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4425 @var{prefix} as a prefix for each program it tries to run, both with and
4426 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4428 For each subprogram to be run, the compiler driver first tries the
4429 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4430 was not specified, the driver tries two standard prefixes, which are
4431 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4432 those results in a file name that is found, the unmodified program
4433 name is searched for using the directories specified in your
4434 @env{PATH} environment variable.
4436 The compiler will check to see if the path provided by the @option{-B}
4437 refers to a directory, and if necessary it will add a directory
4438 separator character at the end of the path.
4440 @option{-B} prefixes that effectively specify directory names also apply
4441 to libraries in the linker, because the compiler translates these
4442 options into @option{-L} options for the linker.  They also apply to
4443 includes files in the preprocessor, because the compiler translates these
4444 options into @option{-isystem} options for the preprocessor.  In this case,
4445 the compiler appends @samp{include} to the prefix.
4447 The run-time support file @file{libgcc.a} can also be searched for using
4448 the @option{-B} prefix, if needed.  If it is not found there, the two
4449 standard prefixes above are tried, and that is all.  The file is left
4450 out of the link if it is not found by those means.
4452 Another way to specify a prefix much like the @option{-B} prefix is to use
4453 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4454 Variables}.
4456 As a special kludge, if the path provided by @option{-B} is
4457 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4458 9, then it will be replaced by @file{[dir/]include}.  This is to help
4459 with boot-strapping the compiler.
4461 @item -specs=@var{file}
4462 @opindex specs
4463 Process @var{file} after the compiler reads in the standard @file{specs}
4464 file, in order to override the defaults that the @file{gcc} driver
4465 program uses when determining what switches to pass to @file{cc1},
4466 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4467 @option{-specs=@var{file}} can be specified on the command line, and they
4468 are processed in order, from left to right.
4469 @end table
4471 @c man end
4473 @node Spec Files
4474 @section Specifying subprocesses and the switches to pass to them
4475 @cindex Spec Files
4476 @command{gcc} is a driver program.  It performs its job by invoking a
4477 sequence of other programs to do the work of compiling, assembling and
4478 linking.  GCC interprets its command-line parameters and uses these to
4479 deduce which programs it should invoke, and which command-line options
4480 it ought to place on their command lines.  This behavior is controlled
4481 by @dfn{spec strings}.  In most cases there is one spec string for each
4482 program that GCC can invoke, but a few programs have multiple spec
4483 strings to control their behavior.  The spec strings built into GCC can
4484 be overridden by using the @option{-specs=} command-line switch to specify
4485 a spec file.
4487 @dfn{Spec files} are plaintext files that are used to construct spec
4488 strings.  They consist of a sequence of directives separated by blank
4489 lines.  The type of directive is determined by the first non-whitespace
4490 character on the line and it can be one of the following:
4492 @table @code
4493 @item %@var{command}
4494 Issues a @var{command} to the spec file processor.  The commands that can
4495 appear here are:
4497 @table @code
4498 @item %include <@var{file}>
4499 @cindex %include
4500 Search for @var{file} and insert its text at the current point in the
4501 specs file.
4503 @item %include_noerr <@var{file}>
4504 @cindex %include_noerr
4505 Just like @samp{%include}, but do not generate an error message if the include
4506 file cannot be found.
4508 @item %rename @var{old_name} @var{new_name}
4509 @cindex %rename
4510 Rename the spec string @var{old_name} to @var{new_name}.
4512 @end table
4514 @item *[@var{spec_name}]:
4515 This tells the compiler to create, override or delete the named spec
4516 string.  All lines after this directive up to the next directive or
4517 blank line are considered to be the text for the spec string.  If this
4518 results in an empty string then the spec will be deleted.  (Or, if the
4519 spec did not exist, then nothing will happened.)  Otherwise, if the spec
4520 does not currently exist a new spec will be created.  If the spec does
4521 exist then its contents will be overridden by the text of this
4522 directive, unless the first character of that text is the @samp{+}
4523 character, in which case the text will be appended to the spec.
4525 @item [@var{suffix}]:
4526 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
4527 and up to the next directive or blank line are considered to make up the
4528 spec string for the indicated suffix.  When the compiler encounters an
4529 input file with the named suffix, it will processes the spec string in
4530 order to work out how to compile that file.  For example:
4532 @smallexample
4533 .ZZ:
4534 z-compile -input %i
4535 @end smallexample
4537 This says that any input file whose name ends in @samp{.ZZ} should be
4538 passed to the program @samp{z-compile}, which should be invoked with the
4539 command-line switch @option{-input} and with the result of performing the
4540 @samp{%i} substitution.  (See below.)
4542 As an alternative to providing a spec string, the text that follows a
4543 suffix directive can be one of the following:
4545 @table @code
4546 @item @@@var{language}
4547 This says that the suffix is an alias for a known @var{language}.  This is
4548 similar to using the @option{-x} command-line switch to GCC to specify a
4549 language explicitly.  For example:
4551 @smallexample
4552 .ZZ:
4553 @@c++
4554 @end smallexample
4556 Says that .ZZ files are, in fact, C++ source files.
4558 @item #@var{name}
4559 This causes an error messages saying:
4561 @smallexample
4562 @var{name} compiler not installed on this system.
4563 @end smallexample
4564 @end table
4566 GCC already has an extensive list of suffixes built into it.
4567 This directive will add an entry to the end of the list of suffixes, but
4568 since the list is searched from the end backwards, it is effectively
4569 possible to override earlier entries using this technique.
4571 @end table
4573 GCC has the following spec strings built into it.  Spec files can
4574 override these strings or create their own.  Note that individual
4575 targets can also add their own spec strings to this list.
4577 @smallexample
4578 asm          Options to pass to the assembler
4579 asm_final    Options to pass to the assembler post-processor
4580 cpp          Options to pass to the C preprocessor
4581 cc1          Options to pass to the C compiler
4582 cc1plus      Options to pass to the C++ compiler
4583 endfile      Object files to include at the end of the link
4584 link         Options to pass to the linker
4585 lib          Libraries to include on the command line to the linker
4586 libgcc       Decides which GCC support library to pass to the linker
4587 linker       Sets the name of the linker
4588 predefines   Defines to be passed to the C preprocessor
4589 signed_char  Defines to pass to CPP to say whether @code{char} is signed
4590              by default
4591 startfile    Object files to include at the start of the link
4592 @end smallexample
4594 Here is a small example of a spec file:
4596 @smallexample
4597 %rename lib                 old_lib
4599 *lib:
4600 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4601 @end smallexample
4603 This example renames the spec called @samp{lib} to @samp{old_lib} and
4604 then overrides the previous definition of @samp{lib} with a new one.
4605 The new definition adds in some extra command-line options before
4606 including the text of the old definition.
4608 @dfn{Spec strings} are a list of command-line options to be passed to their
4609 corresponding program.  In addition, the spec strings can contain
4610 @samp{%}-prefixed sequences to substitute variable text or to
4611 conditionally insert text into the command line.  Using these constructs
4612 it is possible to generate quite complex command lines.
4614 Here is a table of all defined @samp{%}-sequences for spec
4615 strings.  Note that spaces are not generated automatically around the
4616 results of expanding these sequences.  Therefore you can concatenate them
4617 together or combine them with constant text in a single argument.
4619 @table @code
4620 @item %%
4621 Substitute one @samp{%} into the program name or argument.
4623 @item %i
4624 Substitute the name of the input file being processed.
4626 @item %b
4627 Substitute the basename of the input file being processed.
4628 This is the substring up to (and not including) the last period
4629 and not including the directory.
4631 @item %B
4632 This is the same as @samp{%b}, but include the file suffix (text after
4633 the last period).
4635 @item %d
4636 Marks the argument containing or following the @samp{%d} as a
4637 temporary file name, so that that file will be deleted if GCC exits
4638 successfully.  Unlike @samp{%g}, this contributes no text to the
4639 argument.
4641 @item %g@var{suffix}
4642 Substitute a file name that has suffix @var{suffix} and is chosen
4643 once per compilation, and mark the argument in the same way as
4644 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4645 name is now chosen in a way that is hard to predict even when previously
4646 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
4647 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4648 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4649 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4650 was simply substituted with a file name chosen once per compilation,
4651 without regard to any appended suffix (which was therefore treated
4652 just like ordinary text), making such attacks more likely to succeed.
4654 @item %u@var{suffix}
4655 Like @samp{%g}, but generates a new temporary file name even if
4656 @samp{%u@var{suffix}} was already seen.
4658 @item %U@var{suffix}
4659 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4660 new one if there is no such last file name.  In the absence of any
4661 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4662 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
4663 would involve the generation of two distinct file names, one
4664 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4665 simply substituted with a file name chosen for the previous @samp{%u},
4666 without regard to any appended suffix.
4668 @item %j@var{SUFFIX}
4669 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
4670 writable, and if save-temps is off; otherwise, substitute the name
4671 of a temporary file, just like @samp{%u}.  This temporary file is not
4672 meant for communication between processes, but rather as a junk
4673 disposal mechanism.
4675 @item %.@var{SUFFIX}
4676 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4677 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
4678 terminated by the next space or %.
4680 @item %w
4681 Marks the argument containing or following the @samp{%w} as the
4682 designated output file of this compilation.  This puts the argument
4683 into the sequence of arguments that @samp{%o} will substitute later.
4685 @item %o
4686 Substitutes the names of all the output files, with spaces
4687 automatically placed around them.  You should write spaces
4688 around the @samp{%o} as well or the results are undefined.
4689 @samp{%o} is for use in the specs for running the linker.
4690 Input files whose names have no recognized suffix are not compiled
4691 at all, but they are included among the output files, so they will
4692 be linked.
4694 @item %O
4695 Substitutes the suffix for object files.  Note that this is
4696 handled specially when it immediately follows @samp{%g, %u, or %U},
4697 because of the need for those to form complete file names.  The
4698 handling is such that @samp{%O} is treated exactly as if it had already
4699 been substituted, except that @samp{%g, %u, and %U} do not currently
4700 support additional @var{suffix} characters following @samp{%O} as they would
4701 following, for example, @samp{.o}.
4703 @item %p
4704 Substitutes the standard macro predefinitions for the
4705 current target machine.  Use this when running @code{cpp}.
4707 @item %P
4708 Like @samp{%p}, but puts @samp{__} before and after the name of each
4709 predefined macro, except for macros that start with @samp{__} or with
4710 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4713 @item %I
4714 Substitute a @option{-iprefix} option made from @env{GCC_EXEC_PREFIX}.
4716 @item %s
4717 Current argument is the name of a library or startup file of some sort.
4718 Search for that file in a standard list of directories and substitute
4719 the full name found.
4721 @item %e@var{str}
4722 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4723 Use this when inconsistent options are detected.
4725 @item %|
4726 Output @samp{-} if the input for the current command is coming from a pipe.
4728 @item %(@var{name})
4729 Substitute the contents of spec string @var{name} at this point.
4731 @item %[@var{name}]
4732 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
4734 @item %x@{@var{option}@}
4735 Accumulate an option for @samp{%X}.
4737 @item %X
4738 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
4739 spec string.
4741 @item %Y
4742 Output the accumulated assembler options specified by @option{-Wa}.
4744 @item %Z
4745 Output the accumulated preprocessor options specified by @option{-Wp}.
4747 @item %v1
4748 Substitute the major version number of GCC@.
4749 (For version 2.9.5, this is 2.)
4751 @item %v2
4752 Substitute the minor version number of GCC@.
4753 (For version 2.9.5, this is 9.)
4755 @item %v3
4756 Substitute the patch level number of GCC@.
4757 (For version 2.9.5, this is 5.)
4759 @item %a
4760 Process the @code{asm} spec.  This is used to compute the
4761 switches to be passed to the assembler.
4763 @item %A
4764 Process the @code{asm_final} spec.  This is a spec string for
4765 passing switches to an assembler post-processor, if such a program is
4766 needed.
4768 @item %l
4769 Process the @code{link} spec.  This is the spec for computing the
4770 command line passed to the linker.  Typically it will make use of the
4771 @samp{%L %G %S %D and %E} sequences.
4773 @item %D
4774 Dump out a @option{-L} option for each directory that GCC believes might
4775 contain startup files.  If the target supports multilibs then the
4776 current multilib directory will be prepended to each of these paths.
4778 @item %M
4779 Output the multilib directory with directory separators replaced with
4780 @samp{_}.  If multilib directories are not set, or the multilib directory is
4781 @file{.} then this option emits nothing.
4783 @item %L
4784 Process the @code{lib} spec.  This is a spec string for deciding which
4785 libraries should be included on the command line to the linker.
4787 @item %G
4788 Process the @code{libgcc} spec.  This is a spec string for deciding
4789 which GCC support library should be included on the command line to the linker.
4791 @item %S
4792 Process the @code{startfile} spec.  This is a spec for deciding which
4793 object files should be the first ones passed to the linker.  Typically
4794 this might be a file named @file{crt0.o}.
4796 @item %E
4797 Process the @code{endfile} spec.  This is a spec string that specifies
4798 the last object files that will be passed to the linker.
4800 @item %C
4801 Process the @code{cpp} spec.  This is used to construct the arguments
4802 to be passed to the C preprocessor.
4804 @item %c
4805 Process the @code{signed_char} spec.  This is intended to be used
4806 to tell cpp whether a char is signed.  It typically has the definition:
4807 @smallexample
4808 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4809 @end smallexample
4811 @item %1
4812 Process the @code{cc1} spec.  This is used to construct the options to be
4813 passed to the actual C compiler (@samp{cc1}).
4815 @item %2
4816 Process the @code{cc1plus} spec.  This is used to construct the options to be
4817 passed to the actual C++ compiler (@samp{cc1plus}).
4819 @item %*
4820 Substitute the variable part of a matched option.  See below.
4821 Note that each comma in the substituted string is replaced by
4822 a single space.
4824 @item %@{@code{S}@}
4825 Substitutes the @code{-S} switch, if that switch was given to GCC@.
4826 If that switch was not specified, this substitutes nothing.  Note that
4827 the leading dash is omitted when specifying this option, and it is
4828 automatically inserted if the substitution is performed.  Thus the spec
4829 string @samp{%@{foo@}} would match the command-line option @option{-foo}
4830 and would output the command line option @option{-foo}.
4832 @item %W@{@code{S}@}
4833 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4834 deleted on failure.
4836 @item %@{@code{S}*@}
4837 Substitutes all the switches specified to GCC whose names start
4838 with @code{-S}, but which also take an argument.  This is used for
4839 switches like @option{-o}, @option{-D}, @option{-I}, etc.
4840 GCC considers @option{-o foo} as being
4841 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4842 text, including the space.  Thus two arguments would be generated.
4844 @item %@{^@code{S}*@}
4845 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4846 argument.  Thus %@{^o*@} would only generate one argument, not two.
4848 @item %@{@code{S}*&@code{T}*@}
4849 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4850 (the order of @code{S} and @code{T} in the spec is not significant).
4851 There can be any number of ampersand-separated variables; for each the
4852 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4854 @item %@{<@code{S}@}
4855 Remove all occurrences of @code{-S} from the command line.  Note---this
4856 command is position dependent.  @samp{%} commands in the spec string
4857 before this option will see @code{-S}, @samp{%} commands in the spec
4858 string after this option will not.
4860 @item %@{@code{S}*:@code{X}@}
4861 Substitutes @code{X} if one or more switches whose names start with
4862 @code{-S} are specified to GCC@.  Note that the tail part of the
4863 @code{-S} option (i.e.@: the part matched by the @samp{*}) will be substituted
4864 for each occurrence of @samp{%*} within @code{X}.
4866 @item %@{@code{S}:@code{X}@}
4867 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC@.
4869 @item %@{!@code{S}:@code{X}@}
4870 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC@.
4872 @item %@{|@code{S}:@code{X}@}
4873 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4875 @item %@{|!@code{S}:@code{X}@}
4876 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4878 @item %@{.@code{S}:@code{X}@}
4879 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4881 @item %@{!.@code{S}:@code{X}@}
4882 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4884 @item %@{@code{S}|@code{P}:@code{X}@}
4885 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.  This may be
4886 combined with @samp{!} and @samp{.} sequences as well, although they
4887 have a stronger binding than the @samp{|}.  For example a spec string
4888 like this:
4890 @smallexample
4891 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4892 @end smallexample
4894 will output the following command-line options from the following input
4895 command-line options:
4897 @smallexample
4898 fred.c        -foo -baz
4899 jim.d         -bar -boggle
4900 -d fred.c     -foo -baz -boggle
4901 -d jim.d      -bar -baz -boggle
4902 @end smallexample
4904 @end table
4906 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4907 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4908 or spaces, or even newlines.  They are processed as usual, as described
4909 above.
4911 The @option{-O}, @option{-f}, @option{-m}, and @option{-W}
4912 switches are handled specifically in these
4913 constructs.  If another value of @option{-O} or the negated form of a @option{-f}, @option{-m}, or
4914 @option{-W} switch is found later in the command line, the earlier switch
4915 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4916 letter, which passes all matching options.
4918 The character @samp{|} at the beginning of the predicate text is used to indicate
4919 that a command should be piped to the following command, but only if @option{-pipe}
4920 is specified.
4922 It is built into GCC which switches take arguments and which do not.
4923 (You might think it would be useful to generalize this to allow each
4924 compiler's spec to say which switches take arguments.  But this cannot
4925 be done in a consistent fashion.  GCC cannot even decide which input
4926 files have been specified without knowing which switches take arguments,
4927 and it must know which input files to compile in order to tell which
4928 compilers to run).
4930 GCC also knows implicitly that arguments starting in @option{-l} are to be
4931 treated as compiler output files, and passed to the linker in their
4932 proper position among the other output files.
4934 @c man begin OPTIONS
4936 @node Target Options
4937 @section Specifying Target Machine and Compiler Version
4938 @cindex target options
4939 @cindex cross compiling
4940 @cindex specifying machine version
4941 @cindex specifying compiler version and target machine
4942 @cindex compiler version, specifying
4943 @cindex target machine, specifying
4945 By default, GCC compiles code for the same type of machine that you
4946 are using.  However, it can also be installed as a cross-compiler, to
4947 compile for some other type of machine.  In fact, several different
4948 configurations of GCC, for different target machines, can be
4949 installed side by side.  Then you specify which one to use with the
4950 @option{-b} option.
4952 In addition, older and newer versions of GCC can be installed side
4953 by side.  One of them (probably the newest) will be the default, but
4954 you may sometimes wish to use another.
4956 @table @gcctabopt
4957 @item -b @var{machine}
4958 @opindex b
4959 The argument @var{machine} specifies the target machine for compilation.
4960 This is useful when you have installed GCC as a cross-compiler.
4962 The value to use for @var{machine} is the same as was specified as the
4963 machine type when configuring GCC as a cross-compiler.  For
4964 example, if a cross-compiler was configured with @samp{configure
4965 i386v}, meaning to compile for an 80386 running System V, then you
4966 would specify @option{-b i386v} to run that cross compiler.
4968 When you do not specify @option{-b}, it normally means to compile for
4969 the same type of machine that you are using.
4971 @item -V @var{version}
4972 @opindex V
4973 The argument @var{version} specifies which version of GCC to run.
4974 This is useful when multiple versions are installed.  For example,
4975 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4977 The default version, when you do not specify @option{-V}, is the last
4978 version of GCC that you installed.
4979 @end table
4981 The @option{-b} and @option{-V} options actually work by controlling part of
4982 the file name used for the executable files and libraries used for
4983 compilation.  A given version of GCC, for a given target machine, is
4984 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.
4986 Thus, sites can customize the effect of @option{-b} or @option{-V} either by
4987 changing the names of these directories or adding alternate names (or
4988 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4989 file @file{80386} is a link to the file @file{i386v}, then @option{-b
4990 80386} becomes an alias for @option{-b i386v}.
4992 In one respect, the @option{-b} or @option{-V} do not completely change
4993 to a different compiler: the top-level driver program @command{gcc}
4994 that you originally invoked continues to run and invoke the other
4995 executables (preprocessor, compiler per se, assembler and linker)
4996 that do the real work.  However, since no real work is done in the
4997 driver program, it usually does not matter that the driver program
4998 in use is not the one for the specified target.  It is common for the
4999 interface to the other executables to change incompatibly between
5000 compiler versions, so unless the version specified is very close to that
5001 of the driver (for example, @option{-V 3.0} with a driver program from GCC
5002 version 3.0.1), use of @option{-V} may not work; for example, using
5003 @option{-V 2.95.2} will not work with a driver program from GCC 3.0.
5005 The only way that the driver program depends on the target machine is
5006 in the parsing and handling of special machine-specific options.
5007 However, this is controlled by a file which is found, along with the
5008 other executables, in the directory for the specified version and
5009 target machine.  As a result, a single installed driver program adapts
5010 to any specified target machine, and sufficiently similar compiler
5011 versions.
5013 The driver program executable does control one significant thing,
5014 however: the default version and target machine.  Therefore, you can
5015 install different instances of the driver program, compiled for
5016 different targets or versions, under different names.
5018 For example, if the driver for version 2.0 is installed as @command{ogcc}
5019 and that for version 2.1 is installed as @command{gcc}, then the command
5020 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
5021 2.0 by default.  However, you can choose either version with either
5022 command with the @option{-V} option.
5024 @node Submodel Options
5025 @section Hardware Models and Configurations
5026 @cindex submodel options
5027 @cindex specifying hardware config
5028 @cindex hardware models and configurations, specifying
5029 @cindex machine dependent options
5031 Earlier we discussed the standard option @option{-b} which chooses among
5032 different installed compilers for completely different target
5033 machines, such as VAX vs.@: 68000 vs.@: 80386.
5035 In addition, each of these target machine types can have its own
5036 special options, starting with @samp{-m}, to choose among various
5037 hardware models or configurations---for example, 68010 vs 68020,
5038 floating coprocessor or none.  A single installed version of the
5039 compiler can compile for any model or configuration, according to the
5040 options specified.
5042 Some configurations of the compiler also support additional special
5043 options, usually for compatibility with other compilers on the same
5044 platform.
5046 These options are defined by the macro @code{TARGET_SWITCHES} in the
5047 machine description.  The default for the options is also defined by
5048 that macro, which enables you to change the defaults.
5050 @menu
5051 * M680x0 Options::
5052 * M68hc1x Options::
5053 * VAX Options::
5054 * SPARC Options::
5055 * Convex Options::
5056 * AMD29K Options::
5057 * ARM Options::
5058 * MN10200 Options::
5059 * MN10300 Options::
5060 * M32R/D Options::
5061 * M88K Options::
5062 * RS/6000 and PowerPC Options::
5063 * RT Options::
5064 * MIPS Options::
5065 * i386 and x86-64 Options::
5066 * HPPA Options::
5067 * Intel 960 Options::
5068 * DEC Alpha Options::
5069 * DEC Alpha/VMS Options::
5070 * Clipper Options::
5071 * H8/300 Options::
5072 * SH Options::
5073 * System V Options::
5074 * TMS320C3x/C4x Options::
5075 * V850 Options::
5076 * ARC Options::
5077 * NS32K Options::
5078 * AVR Options::
5079 * MCore Options::
5080 * IA-64 Options::
5081 * D30V Options::
5082 * S/390 and zSeries Options::
5083 * CRIS Options::
5084 * MMIX Options::
5085 @end menu
5087 @node M680x0 Options
5088 @subsection M680x0 Options
5089 @cindex M680x0 options
5091 These are the @samp{-m} options defined for the 68000 series.  The default
5092 values for these options depends on which style of 68000 was selected when
5093 the compiler was configured; the defaults for the most common choices are
5094 given below.
5096 @table @gcctabopt
5097 @item -m68000
5098 @itemx -mc68000
5099 @opindex m68000
5100 @opindex mc68000
5101 Generate output for a 68000.  This is the default
5102 when the compiler is configured for 68000-based systems.
5104 Use this option for microcontrollers with a 68000 or EC000 core,
5105 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5107 @item -m68020
5108 @itemx -mc68020
5109 @opindex m68020
5110 @opindex mc68020
5111 Generate output for a 68020.  This is the default
5112 when the compiler is configured for 68020-based systems.
5114 @item -m68881
5115 @opindex m68881
5116 Generate output containing 68881 instructions for floating point.
5117 This is the default for most 68020 systems unless @option{--nfp} was
5118 specified when the compiler was configured.
5120 @item -m68030
5121 @opindex m68030
5122 Generate output for a 68030.  This is the default when the compiler is
5123 configured for 68030-based systems.
5125 @item -m68040
5126 @opindex m68040
5127 Generate output for a 68040.  This is the default when the compiler is
5128 configured for 68040-based systems.
5130 This option inhibits the use of 68881/68882 instructions that have to be
5131 emulated by software on the 68040.  Use this option if your 68040 does not
5132 have code to emulate those instructions.
5134 @item -m68060
5135 @opindex m68060
5136 Generate output for a 68060.  This is the default when the compiler is
5137 configured for 68060-based systems.
5139 This option inhibits the use of 68020 and 68881/68882 instructions that
5140 have to be emulated by software on the 68060.  Use this option if your 68060
5141 does not have code to emulate those instructions.
5143 @item -mcpu32
5144 @opindex mcpu32
5145 Generate output for a CPU32.  This is the default
5146 when the compiler is configured for CPU32-based systems.
5148 Use this option for microcontrollers with a
5149 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5150 68336, 68340, 68341, 68349 and 68360.
5152 @item -m5200
5153 @opindex m5200
5154 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5155 when the compiler is configured for 520X-based systems.
5157 Use this option for microcontroller with a 5200 core, including
5158 the MCF5202, MCF5203, MCF5204 and MCF5202.
5161 @item -m68020-40
5162 @opindex m68020-40
5163 Generate output for a 68040, without using any of the new instructions.
5164 This results in code which can run relatively efficiently on either a
5165 68020/68881 or a 68030 or a 68040.  The generated code does use the
5166 68881 instructions that are emulated on the 68040.
5168 @item -m68020-60
5169 @opindex m68020-60
5170 Generate output for a 68060, without using any of the new instructions.
5171 This results in code which can run relatively efficiently on either a
5172 68020/68881 or a 68030 or a 68040.  The generated code does use the
5173 68881 instructions that are emulated on the 68060.
5175 @item -mfpa
5176 @opindex mfpa
5177 Generate output containing Sun FPA instructions for floating point.
5179 @item -msoft-float
5180 @opindex msoft-float
5181 Generate output containing library calls for floating point.
5182 @strong{Warning:} the requisite libraries are not available for all m68k
5183 targets.  Normally the facilities of the machine's usual C compiler are
5184 used, but this can't be done directly in cross-compilation.  You must
5185 make your own arrangements to provide suitable library functions for
5186 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5187 @samp{m68k-*-coff} do provide software floating point support.
5189 @item -mshort
5190 @opindex mshort
5191 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5193 @item -mnobitfield
5194 @opindex mnobitfield
5195 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5196 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5198 @item -mbitfield
5199 @opindex mbitfield
5200 Do use the bit-field instructions.  The @option{-m68020} option implies
5201 @option{-mbitfield}.  This is the default if you use a configuration
5202 designed for a 68020.
5204 @item -mrtd
5205 @opindex mrtd
5206 Use a different function-calling convention, in which functions
5207 that take a fixed number of arguments return with the @code{rtd}
5208 instruction, which pops their arguments while returning.  This
5209 saves one instruction in the caller since there is no need to pop
5210 the arguments there.
5212 This calling convention is incompatible with the one normally
5213 used on Unix, so you cannot use it if you need to call libraries
5214 compiled with the Unix compiler.
5216 Also, you must provide function prototypes for all functions that
5217 take variable numbers of arguments (including @code{printf});
5218 otherwise incorrect code will be generated for calls to those
5219 functions.
5221 In addition, seriously incorrect code will result if you call a
5222 function with too many arguments.  (Normally, extra arguments are
5223 harmlessly ignored.)
5225 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5226 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5228 @item -malign-int
5229 @itemx -mno-align-int
5230 @opindex malign-int
5231 @opindex mno-align-int
5232 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5233 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5234 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5235 Aligning variables on 32-bit boundaries produces code that runs somewhat
5236 faster on processors with 32-bit busses at the expense of more memory.
5238 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5239 align structures containing the above types  differently than
5240 most published application binary interface specifications for the m68k.
5242 @item -mpcrel
5243 @opindex mpcrel
5244 Use the pc-relative addressing mode of the 68000 directly, instead of
5245 using a global offset table.  At present, this option implies @option{-fpic},
5246 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5247 not presently supported with @option{-mpcrel}, though this could be supported for
5248 68020 and higher processors.
5250 @item -mno-strict-align
5251 @itemx -mstrict-align
5252 @opindex mno-strict-align
5253 @opindex mstrict-align
5254 Do not (do) assume that unaligned memory references will be handled by
5255 the system.
5257 @end table
5259 @node M68hc1x Options
5260 @subsection M68hc1x Options
5261 @cindex M68hc1x options
5263 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5264 microcontrollers.  The default values for these options depends on
5265 which style of microcontroller was selected when the compiler was configured;
5266 the defaults for the most common choices are given below.
5268 @table @gcctabopt
5269 @item -m6811
5270 @itemx -m68hc11
5271 @opindex m6811
5272 @opindex m68hc11
5273 Generate output for a 68HC11.  This is the default
5274 when the compiler is configured for 68HC11-based systems.
5276 @item -m6812
5277 @itemx -m68hc12
5278 @opindex m6812
5279 @opindex m68hc12
5280 Generate output for a 68HC12.  This is the default
5281 when the compiler is configured for 68HC12-based systems.
5283 @item -mauto-incdec
5284 @opindex mauto-incdec
5285 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5286 addressing modes.
5288 @item -mshort
5289 @opindex mshort
5290 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5292 @item -msoft-reg-count=@var{count}
5293 @opindex msoft-reg-count
5294 Specify the number of pseudo-soft registers which are used for the
5295 code generation.  The maximum number is 32.  Using more pseudo-soft
5296 register may or may not result in better code depending on the program.
5297 The default is 4 for 68HC11 and 2 for 68HC12.
5299 @end table
5301 @node VAX Options
5302 @subsection VAX Options
5303 @cindex VAX options
5305 These @samp{-m} options are defined for the VAX:
5307 @table @gcctabopt
5308 @item -munix
5309 @opindex munix
5310 Do not output certain jump instructions (@code{aobleq} and so on)
5311 that the Unix assembler for the VAX cannot handle across long
5312 ranges.
5314 @item -mgnu
5315 @opindex mgnu
5316 Do output those jump instructions, on the assumption that you
5317 will assemble with the GNU assembler.
5319 @item -mg
5320 @opindex mg
5321 Output code for g-format floating point numbers instead of d-format.
5322 @end table
5324 @node SPARC Options
5325 @subsection SPARC Options
5326 @cindex SPARC options
5328 These @samp{-m} switches are supported on the SPARC:
5330 @table @gcctabopt
5331 @item -mno-app-regs
5332 @itemx -mapp-regs
5333 @opindex mno-app-regs
5334 @opindex mapp-regs
5335 Specify @option{-mapp-regs} to generate output using the global registers
5336 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5337 is the default.
5339 To be fully SVR4 ABI compliant at the cost of some performance loss,
5340 specify @option{-mno-app-regs}.  You should compile libraries and system
5341 software with this option.
5343 @item -mfpu
5344 @itemx -mhard-float
5345 @opindex mfpu
5346 @opindex mhard-float
5347 Generate output containing floating point instructions.  This is the
5348 default.
5350 @item -mno-fpu
5351 @itemx -msoft-float
5352 @opindex mno-fpu
5353 @opindex msoft-float
5354 Generate output containing library calls for floating point.
5355 @strong{Warning:} the requisite libraries are not available for all SPARC
5356 targets.  Normally the facilities of the machine's usual C compiler are
5357 used, but this cannot be done directly in cross-compilation.  You must make
5358 your own arrangements to provide suitable library functions for
5359 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5360 @samp{sparclite-*-*} do provide software floating point support.
5362 @option{-msoft-float} changes the calling convention in the output file;
5363 therefore, it is only useful if you compile @emph{all} of a program with
5364 this option.  In particular, you need to compile @file{libgcc.a}, the
5365 library that comes with GCC, with @option{-msoft-float} in order for
5366 this to work.
5368 @item -mhard-quad-float
5369 @opindex mhard-quad-float
5370 Generate output containing quad-word (long double) floating point
5371 instructions.
5373 @item -msoft-quad-float
5374 @opindex msoft-quad-float
5375 Generate output containing library calls for quad-word (long double)
5376 floating point instructions.  The functions called are those specified
5377 in the SPARC ABI@.  This is the default.
5379 As of this writing, there are no sparc implementations that have hardware
5380 support for the quad-word floating point instructions.  They all invoke
5381 a trap handler for one of these instructions, and then the trap handler
5382 emulates the effect of the instruction.  Because of the trap handler overhead,
5383 this is much slower than calling the ABI library routines.  Thus the
5384 @option{-msoft-quad-float} option is the default.
5386 @item -mno-epilogue
5387 @itemx -mepilogue
5388 @opindex mno-epilogue
5389 @opindex mepilogue
5390 With @option{-mepilogue} (the default), the compiler always emits code for
5391 function exit at the end of each function.  Any function exit in
5392 the middle of the function (such as a return statement in C) will
5393 generate a jump to the exit code at the end of the function.
5395 With @option{-mno-epilogue}, the compiler tries to emit exit code inline
5396 at every function exit.
5398 @item -mno-flat
5399 @itemx -mflat
5400 @opindex mno-flat
5401 @opindex mflat
5402 With @option{-mflat}, the compiler does not generate save/restore instructions
5403 and will use a ``flat'' or single register window calling convention.
5404 This model uses %i7 as the frame pointer and is compatible with the normal
5405 register window model.  Code from either may be intermixed.
5406 The local registers and the input registers (0--5) are still treated as
5407 ``call saved'' registers and will be saved on the stack as necessary.
5409 With @option{-mno-flat} (the default), the compiler emits save/restore
5410 instructions (except for leaf functions) and is the normal mode of operation.
5412 @item -mno-unaligned-doubles
5413 @itemx -munaligned-doubles
5414 @opindex mno-unaligned-doubles
5415 @opindex munaligned-doubles
5416 Assume that doubles have 8 byte alignment.  This is the default.
5418 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5419 alignment only if they are contained in another type, or if they have an
5420 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5421 Specifying this option avoids some rare compatibility problems with code
5422 generated by other compilers.  It is not the default because it results
5423 in a performance loss, especially for floating point code.
5425 @item -mno-faster-structs
5426 @itemx -mfaster-structs
5427 @opindex mno-faster-structs
5428 @opindex mfaster-structs
5429 With @option{-mfaster-structs}, the compiler assumes that structures
5430 should have 8 byte alignment.  This enables the use of pairs of
5431 @code{ldd} and @code{std} instructions for copies in structure
5432 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5433 However, the use of this changed alignment directly violates the Sparc
5434 ABI@.  Thus, it's intended only for use on targets where the developer
5435 acknowledges that their resulting code will not be directly in line with
5436 the rules of the ABI@.
5438 @item -mv8
5439 @itemx -msparclite
5440 @opindex mv8
5441 @opindex msparclite
5442 These two options select variations on the SPARC architecture.
5444 By default (unless specifically configured for the Fujitsu SPARClite),
5445 GCC generates code for the v7 variant of the SPARC architecture.
5447 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5448 code is that the compiler emits the integer multiply and integer
5449 divide instructions which exist in SPARC v8 but not in SPARC v7.
5451 @option{-msparclite} will give you SPARClite code.  This adds the integer
5452 multiply, integer divide step and scan (@code{ffs}) instructions which
5453 exist in SPARClite but not in SPARC v7.
5455 These options are deprecated and will be deleted in a future GCC release.
5456 They have been replaced with @option{-mcpu=xxx}.
5458 @item -mcypress
5459 @itemx -msupersparc
5460 @opindex mcypress
5461 @opindex msupersparc
5462 These two options select the processor for which the code is optimized.
5464 With @option{-mcypress} (the default), the compiler optimizes code for the
5465 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
5466 This is also appropriate for the older SparcStation 1, 2, IPX etc.
5468 With @option{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
5469 used in the SparcStation 10, 1000 and 2000 series.  This flag also enables use
5470 of the full SPARC v8 instruction set.
5472 These options are deprecated and will be deleted in a future GCC release.
5473 They have been replaced with @option{-mcpu=xxx}.
5475 @item -mcpu=@var{cpu_type}
5476 @opindex mcpu
5477 Set the instruction set, register set, and instruction scheduling parameters
5478 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5479 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5480 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5481 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
5483 Default instruction scheduling parameters are used for values that select
5484 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5485 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5487 Here is a list of each supported architecture and their supported
5488 implementations.
5490 @smallexample
5491     v7:             cypress
5492     v8:             supersparc, hypersparc
5493     sparclite:      f930, f934, sparclite86x
5494     sparclet:       tsc701
5495     v9:             ultrasparc
5496 @end smallexample
5498 @item -mtune=@var{cpu_type}
5499 @opindex mtune
5500 Set the instruction scheduling parameters for machine type
5501 @var{cpu_type}, but do not set the instruction set or register set that the
5502 option @option{-mcpu=@var{cpu_type}} would.
5504 The same values for @option{-mcpu=@var{cpu_type}} can be used for
5505 @option{-mtune=@var{cpu_type}}, but the only useful values are those
5506 that select a particular cpu implementation.  Those are @samp{cypress},
5507 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
5508 @samp{sparclite86x}, @samp{tsc701}, and @samp{ultrasparc}.
5510 @end table
5512 These @samp{-m} switches are supported in addition to the above
5513 on the SPARCLET processor.
5515 @table @gcctabopt
5516 @item -mlittle-endian
5517 @opindex mlittle-endian
5518 Generate code for a processor running in little-endian mode.
5520 @item -mlive-g0
5521 @opindex mlive-g0
5522 Treat register @code{%g0} as a normal register.
5523 GCC will continue to clobber it as necessary but will not assume
5524 it always reads as 0.
5526 @item -mbroken-saverestore
5527 @opindex mbroken-saverestore
5528 Generate code that does not use non-trivial forms of the @code{save} and
5529 @code{restore} instructions.  Early versions of the SPARCLET processor do
5530 not correctly handle @code{save} and @code{restore} instructions used with
5531 arguments.  They correctly handle them used without arguments.  A @code{save}
5532 instruction used without arguments increments the current window pointer
5533 but does not allocate a new stack frame.  It is assumed that the window
5534 overflow trap handler will properly handle this case as will interrupt
5535 handlers.
5536 @end table
5538 These @samp{-m} switches are supported in addition to the above
5539 on SPARC V9 processors in 64-bit environments.
5541 @table @gcctabopt
5542 @item -mlittle-endian
5543 @opindex mlittle-endian
5544 Generate code for a processor running in little-endian mode.
5546 @item -m32
5547 @itemx -m64
5548 @opindex m32
5549 @opindex m64
5550 Generate code for a 32-bit or 64-bit environment.
5551 The 32-bit environment sets int, long and pointer to 32 bits.
5552 The 64-bit environment sets int to 32 bits and long and pointer
5553 to 64 bits.
5555 @item -mcmodel=medlow
5556 @opindex mcmodel=medlow
5557 Generate code for the Medium/Low code model: the program must be linked
5558 in the low 32 bits of the address space.  Pointers are 64 bits.
5559 Programs can be statically or dynamically linked.
5561 @item -mcmodel=medmid
5562 @opindex mcmodel=medmid
5563 Generate code for the Medium/Middle code model: the program must be linked
5564 in the low 44 bits of the address space, the text segment must be less than
5565 2G bytes, and data segment must be within 2G of the text segment.
5566 Pointers are 64 bits.
5568 @item -mcmodel=medany
5569 @opindex mcmodel=medany
5570 Generate code for the Medium/Anywhere code model: the program may be linked
5571 anywhere in the address space, the text segment must be less than
5572 2G bytes, and data segment must be within 2G of the text segment.
5573 Pointers are 64 bits.
5575 @item -mcmodel=embmedany
5576 @opindex mcmodel=embmedany
5577 Generate code for the Medium/Anywhere code model for embedded systems:
5578 assume a 32-bit text and a 32-bit data segment, both starting anywhere
5579 (determined at link time).  Register %g4 points to the base of the
5580 data segment.  Pointers are still 64 bits.
5581 Programs are statically linked, PIC is not supported.
5583 @item -mstack-bias
5584 @itemx -mno-stack-bias
5585 @opindex mstack-bias
5586 @opindex mno-stack-bias
5587 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
5588 frame pointer if present, are offset by @minus{}2047 which must be added back
5589 when making stack frame references.
5590 Otherwise, assume no such offset is present.
5591 @end table
5593 @node Convex Options
5594 @subsection Convex Options
5595 @cindex Convex options
5597 These @samp{-m} options are defined for Convex:
5599 @table @gcctabopt
5600 @item -mc1
5601 @opindex mc1
5602 Generate output for C1.  The code will run on any Convex machine.
5603 The preprocessor symbol @code{__convex__c1__} is defined.
5605 @item -mc2
5606 @opindex mc2
5607 Generate output for C2.  Uses instructions not available on C1.
5608 Scheduling and other optimizations are chosen for max performance on C2.
5609 The preprocessor symbol @code{__convex_c2__} is defined.
5611 @item -mc32
5612 @opindex mc32
5613 Generate output for C32xx.  Uses instructions not available on C1.
5614 Scheduling and other optimizations are chosen for max performance on C32.
5615 The preprocessor symbol @code{__convex_c32__} is defined.
5617 @item -mc34
5618 @opindex mc34
5619 Generate output for C34xx.  Uses instructions not available on C1.
5620 Scheduling and other optimizations are chosen for max performance on C34.
5621 The preprocessor symbol @code{__convex_c34__} is defined.
5623 @item -mc38
5624 @opindex mc38
5625 Generate output for C38xx.  Uses instructions not available on C1.
5626 Scheduling and other optimizations are chosen for max performance on C38.
5627 The preprocessor symbol @code{__convex_c38__} is defined.
5629 @item -margcount
5630 @opindex margcount
5631 Generate code which puts an argument count in the word preceding each
5632 argument list.  This is compatible with regular CC, and a few programs
5633 may need the argument count word.  GDB and other source-level debuggers
5634 do not need it; this info is in the symbol table.
5636 @item -mnoargcount
5637 @opindex mnoargcount
5638 Omit the argument count word.  This is the default.
5640 @item -mvolatile-cache
5641 @opindex mvolatile-cache
5642 Allow volatile references to be cached.  This is the default.
5644 @item -mvolatile-nocache
5645 @opindex mvolatile-nocache
5646 Volatile references bypass the data cache, going all the way to memory.
5647 This is only needed for multi-processor code that does not use standard
5648 synchronization instructions.  Making non-volatile references to volatile
5649 locations will not necessarily work.
5651 @item -mlong32
5652 @opindex mlong32
5653 Type long is 32 bits, the same as type int.  This is the default.
5655 @item -mlong64
5656 @opindex mlong64
5657 Type long is 64 bits, the same as type long long.  This option is useless,
5658 because no library support exists for it.
5659 @end table
5661 @node AMD29K Options
5662 @subsection AMD29K Options
5663 @cindex AMD29K options
5665 These @samp{-m} options are defined for the AMD Am29000:
5667 @table @gcctabopt
5668 @item -mdw
5669 @opindex mdw
5670 @cindex DW bit (29k)
5671 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
5672 halfword operations are directly supported by the hardware.  This is the
5673 default.
5675 @item -mndw
5676 @opindex mndw
5677 Generate code that assumes the @code{DW} bit is not set.
5679 @item -mbw
5680 @opindex mbw
5681 @cindex byte writes (29k)
5682 Generate code that assumes the system supports byte and halfword write
5683 operations.  This is the default.
5685 @item -mnbw
5686 @opindex mnbw
5687 Generate code that assumes the systems does not support byte and
5688 halfword write operations.  @option{-mnbw} implies @option{-mndw}.
5690 @item -msmall
5691 @opindex msmall
5692 @cindex memory model (29k)
5693 Use a small memory model that assumes that all function addresses are
5694 either within a single 256 KB segment or at an absolute address of less
5695 than 256k.  This allows the @code{call} instruction to be used instead
5696 of a @code{const}, @code{consth}, @code{calli} sequence.
5698 @item -mnormal
5699 @opindex mnormal
5700 Use the normal memory model: Generate @code{call} instructions only when
5701 calling functions in the same file and @code{calli} instructions
5702 otherwise.  This works if each file occupies less than 256 KB but allows
5703 the entire executable to be larger than 256 KB@.  This is the default.
5705 @item -mlarge
5706 @opindex mlarge
5707 Always use @code{calli} instructions.  Specify this option if you expect
5708 a single file to compile into more than 256 KB of code.
5710 @item -m29050
5711 @opindex m29050
5712 @cindex processor selection (29k)
5713 Generate code for the Am29050.
5715 @item -m29000
5716 @opindex m29000
5717 Generate code for the Am29000.  This is the default.
5719 @item -mkernel-registers
5720 @opindex mkernel-registers
5721 @cindex kernel and user registers (29k)
5722 Generate references to registers @code{gr64-gr95} instead of to
5723 registers @code{gr96-gr127}.  This option can be used when compiling
5724 kernel code that wants a set of global registers disjoint from that used
5725 by user-mode code.
5727 Note that when this option is used, register names in @samp{-f} flags
5728 must use the normal, user-mode, names.
5730 @item -muser-registers
5731 @opindex muser-registers
5732 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5733 default.
5735 @item -mstack-check
5736 @itemx -mno-stack-check
5737 @opindex mstack-check
5738 @opindex mno-stack-check
5739 @cindex stack checks (29k)
5740 Insert (or do not insert) a call to @code{__msp_check} after each stack
5741 adjustment.  This is often used for kernel code.
5743 @item -mstorem-bug
5744 @itemx -mno-storem-bug
5745 @opindex mstorem-bug
5746 @opindex mno-storem-bug
5747 @cindex storem bug (29k)
5748 @option{-mstorem-bug} handles 29k processors which cannot handle the
5749 separation of a mtsrim insn and a storem instruction (most 29000 chips
5750 to date, but not the 29050).
5752 @item -mno-reuse-arg-regs
5753 @itemx -mreuse-arg-regs
5754 @opindex mno-reuse-arg-regs
5755 @opindex mreuse-arg-regs
5756 @option{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5757 registers for copying out arguments.  This helps detect calling a function
5758 with fewer arguments than it was declared with.
5760 @item -mno-impure-text
5761 @itemx -mimpure-text
5762 @opindex mno-impure-text
5763 @opindex mimpure-text
5764 @option{-mimpure-text}, used in addition to @option{-shared}, tells the compiler to
5765 not pass @option{-assert pure-text} to the linker when linking a shared object.
5767 @item -msoft-float
5768 @opindex msoft-float
5769 Generate output containing library calls for floating point.
5770 @strong{Warning:} the requisite libraries are not part of GCC@.
5771 Normally the facilities of the machine's usual C compiler are used, but
5772 this can't be done directly in cross-compilation.  You must make your
5773 own arrangements to provide suitable library functions for
5774 cross-compilation.
5776 @item -mno-multm
5777 @opindex mno-multm
5778 Do not generate multm or multmu instructions.  This is useful for some embedded
5779 systems which do not have trap handlers for these instructions.
5780 @end table
5782 @node ARM Options
5783 @subsection ARM Options
5784 @cindex ARM options
5786 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5787 architectures:
5789 @table @gcctabopt
5790 @item -mapcs-frame
5791 @opindex mapcs-frame
5792 Generate a stack frame that is compliant with the ARM Procedure Call
5793 Standard for all functions, even if this is not strictly necessary for
5794 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
5795 with this option will cause the stack frames not to be generated for
5796 leaf functions.  The default is @option{-mno-apcs-frame}.
5798 @item -mapcs
5799 @opindex mapcs
5800 This is a synonym for @option{-mapcs-frame}.
5802 @item -mapcs-26
5803 @opindex mapcs-26
5804 Generate code for a processor running with a 26-bit program counter,
5805 and conforming to the function calling standards for the APCS 26-bit
5806 option.  This option replaces the @option{-m2} and @option{-m3} options
5807 of previous releases of the compiler.
5809 @item -mapcs-32
5810 @opindex mapcs-32
5811 Generate code for a processor running with a 32-bit program counter,
5812 and conforming to the function calling standards for the APCS 32-bit
5813 option.  This option replaces the @option{-m6} option of previous releases
5814 of the compiler.
5816 @ignore
5817 @c not currently implemented
5818 @item -mapcs-stack-check
5819 @opindex mapcs-stack-check
5820 Generate code to check the amount of stack space available upon entry to
5821 every function (that actually uses some stack space).  If there is
5822 insufficient space available then either the function
5823 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5824 called, depending upon the amount of stack space required.  The run time
5825 system is required to provide these functions.  The default is
5826 @option{-mno-apcs-stack-check}, since this produces smaller code.
5828 @c not currently implemented
5829 @item -mapcs-float
5830 @opindex mapcs-float
5831 Pass floating point arguments using the float point registers.  This is
5832 one of the variants of the APCS@.  This option is recommended if the
5833 target hardware has a floating point unit or if a lot of floating point
5834 arithmetic is going to be performed by the code.  The default is
5835 @option{-mno-apcs-float}, since integer only code is slightly increased in
5836 size if @option{-mapcs-float} is used.
5838 @c not currently implemented
5839 @item -mapcs-reentrant
5840 @opindex mapcs-reentrant
5841 Generate reentrant, position independent code.  The default is
5842 @option{-mno-apcs-reentrant}.
5843 @end ignore
5845 @item -mthumb-interwork
5846 @opindex mthumb-interwork
5847 Generate code which supports calling between the ARM and Thumb
5848 instruction sets.  Without this option the two instruction sets cannot
5849 be reliably used inside one program.  The default is
5850 @option{-mno-thumb-interwork}, since slightly larger code is generated
5851 when @option{-mthumb-interwork} is specified.
5853 @item -mno-sched-prolog
5854 @opindex mno-sched-prolog
5855 Prevent the reordering of instructions in the function prolog, or the
5856 merging of those instruction with the instructions in the function's
5857 body.  This means that all functions will start with a recognizable set
5858 of instructions (or in fact one of a choice from a small set of
5859 different function prologues), and this information can be used to
5860 locate the start if functions inside an executable piece of code.  The
5861 default is @option{-msched-prolog}.
5863 @item -mhard-float
5864 @opindex mhard-float
5865 Generate output containing floating point instructions.  This is the
5866 default.
5868 @item -msoft-float
5869 @opindex msoft-float
5870 Generate output containing library calls for floating point.
5871 @strong{Warning:} the requisite libraries are not available for all ARM
5872 targets.  Normally the facilities of the machine's usual C compiler are
5873 used, but this cannot be done directly in cross-compilation.  You must make
5874 your own arrangements to provide suitable library functions for
5875 cross-compilation.
5877 @option{-msoft-float} changes the calling convention in the output file;
5878 therefore, it is only useful if you compile @emph{all} of a program with
5879 this option.  In particular, you need to compile @file{libgcc.a}, the
5880 library that comes with GCC, with @option{-msoft-float} in order for
5881 this to work.
5883 @item -mlittle-endian
5884 @opindex mlittle-endian
5885 Generate code for a processor running in little-endian mode.  This is
5886 the default for all standard configurations.
5888 @item -mbig-endian
5889 @opindex mbig-endian
5890 Generate code for a processor running in big-endian mode; the default is
5891 to compile code for a little-endian processor.
5893 @item -mwords-little-endian
5894 @opindex mwords-little-endian
5895 This option only applies when generating code for big-endian processors.
5896 Generate code for a little-endian word order but a big-endian byte
5897 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5898 option should only be used if you require compatibility with code for
5899 big-endian ARM processors generated by versions of the compiler prior to
5900 2.8.
5902 @item -malignment-traps
5903 @opindex malignment-traps
5904 Generate code that will not trap if the MMU has alignment traps enabled.
5905 On ARM architectures prior to ARMv4, there were no instructions to
5906 access half-word objects stored in memory.  However, when reading from
5907 memory a feature of the ARM architecture allows a word load to be used,
5908 even if the address is unaligned, and the processor core will rotate the
5909 data as it is being loaded.  This option tells the compiler that such
5910 misaligned accesses will cause a MMU trap and that it should instead
5911 synthesise the access as a series of byte accesses.  The compiler can
5912 still use word accesses to load half-word data if it knows that the
5913 address is aligned to a word boundary.
5915 This option is ignored when compiling for ARM architecture 4 or later,
5916 since these processors have instructions to directly access half-word
5917 objects in memory.
5919 @item -mno-alignment-traps
5920 @opindex mno-alignment-traps
5921 Generate code that assumes that the MMU will not trap unaligned
5922 accesses.  This produces better code when the target instruction set
5923 does not have half-word memory operations (i.e.@: implementations prior to
5924 ARMv4).
5926 Note that you cannot use this option to access unaligned word objects,
5927 since the processor will only fetch one 32-bit aligned object from
5928 memory.
5930 The default setting for most targets is @option{-mno-alignment-traps}, since
5931 this produces better code when there are no half-word memory
5932 instructions available.
5934 @item -mshort-load-bytes
5935 @itemx -mno-short-load-words
5936 @opindex mshort-load-bytes
5937 @opindex mno-short-load-words
5938 These are deprecated aliases for @option{-malignment-traps}.
5940 @item -mno-short-load-bytes
5941 @itemx -mshort-load-words
5942 @opindex mno-short-load-bytes
5943 @opindex mshort-load-words
5944 This are deprecated aliases for @option{-mno-alignment-traps}.
5946 @item -mbsd
5947 @opindex mbsd
5948 This option only applies to RISC iX@.  Emulate the native BSD-mode
5949 compiler.  This is the default if @option{-ansi} is not specified.
5951 @item -mxopen
5952 @opindex mxopen
5953 This option only applies to RISC iX@.  Emulate the native X/Open-mode
5954 compiler.
5956 @item -mno-symrename
5957 @opindex mno-symrename
5958 This option only applies to RISC iX@.  Do not run the assembler
5959 post-processor, @samp{symrename}, after code has been assembled.
5960 Normally it is necessary to modify some of the standard symbols in
5961 preparation for linking with the RISC iX C library; this option
5962 suppresses this pass.  The post-processor is never run when the
5963 compiler is built for cross-compilation.
5965 @item -mcpu=@var{name}
5966 @opindex mcpu
5967 This specifies the name of the target ARM processor.  GCC uses this name
5968 to determine what kind of instructions it can emit when generating
5969 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
5970 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
5971 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
5972 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
5973 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
5974 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
5975 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
5976 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
5977 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
5978 @samp{arm1020t}, @samp{xscale}.
5980 @itemx -mtune=@var{name}
5981 @opindex mtune
5982 This option is very similar to the @option{-mcpu=} option, except that
5983 instead of specifying the actual target processor type, and hence
5984 restricting which instructions can be used, it specifies that GCC should
5985 tune the performance of the code as if the target were of the type
5986 specified in this option, but still choosing the instructions that it
5987 will generate based on the cpu specified by a @option{-mcpu=} option.
5988 For some ARM implementations better performance can be obtained by using
5989 this option.
5991 @item -march=@var{name}
5992 @opindex march
5993 This specifies the name of the target ARM architecture.  GCC uses this
5994 name to determine what kind of instructions it can emit when generating
5995 assembly code.  This option can be used in conjunction with or instead
5996 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
5997 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
5998 @samp{armv5}, @samp{armv5t}, @samp{armv5te}.
6000 @item -mfpe=@var{number}
6001 @itemx -mfp=@var{number}
6002 @opindex mfpe
6003 @opindex mfp
6004 This specifies the version of the floating point emulation available on
6005 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6006 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6008 @item -mstructure-size-boundary=@var{n}
6009 @opindex mstructure-size-boundary
6010 The size of all structures and unions will be rounded up to a multiple
6011 of the number of bits set by this option.  Permissible values are 8 and
6012 32.  The default value varies for different toolchains.  For the COFF
6013 targeted toolchain the default value is 8.  Specifying the larger number
6014 can produce faster, more efficient code, but can also increase the size
6015 of the program.  The two values are potentially incompatible.  Code
6016 compiled with one value cannot necessarily expect to work with code or
6017 libraries compiled with the other value, if they exchange information
6018 using structures or unions.
6020 @item -mabort-on-noreturn
6021 @opindex mabort-on-noreturn
6022 Generate a call to the function @code{abort} at the end of a
6023 @code{noreturn} function.  It will be executed if the function tries to
6024 return.
6026 @item -mlong-calls
6027 @itemx -mno-long-calls
6028 @opindex mlong-calls
6029 @opindex mno-long-calls
6030 Tells the compiler to perform function calls by first loading the
6031 address of the function into a register and then performing a subroutine
6032 call on this register.  This switch is needed if the target function
6033 will lie outside of the 64 megabyte addressing range of the offset based
6034 version of subroutine call instruction.
6036 Even if this switch is enabled, not all function calls will be turned
6037 into long calls.  The heuristic is that static functions, functions
6038 which have the @samp{short-call} attribute, functions that are inside
6039 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6040 definitions have already been compiled within the current compilation
6041 unit, will not be turned into long calls.  The exception to this rule is
6042 that weak function definitions, functions with the @samp{long-call}
6043 attribute or the @samp{section} attribute, and functions that are within
6044 the scope of a @samp{#pragma long_calls} directive, will always be
6045 turned into long calls.
6047 This feature is not enabled by default.  Specifying
6048 @option{-mno-long-calls} will restore the default behavior, as will
6049 placing the function calls within the scope of a @samp{#pragma
6050 long_calls_off} directive.  Note these switches have no effect on how
6051 the compiler generates code to handle function calls via function
6052 pointers.
6054 @item -mnop-fun-dllimport
6055 @opindex mnop-fun-dllimport
6056 Disable support for the @code{dllimport} attribute.
6058 @item -msingle-pic-base
6059 @opindex msingle-pic-base
6060 Treat the register used for PIC addressing as read-only, rather than
6061 loading it in the prologue for each function.  The run-time system is
6062 responsible for initializing this register with an appropriate value
6063 before execution begins.
6065 @item -mpic-register=@var{reg}
6066 @opindex mpic-register
6067 Specify the register to be used for PIC addressing.  The default is R10
6068 unless stack-checking is enabled, when R9 is used.
6070 @item -mpoke-function-name
6071 @opindex mpoke-function-name
6072 Write the name of each function into the text section, directly
6073 preceding the function prologue.  The generated code is similar to this:
6075 @smallexample
6076      t0
6077          .ascii "arm_poke_function_name", 0
6078          .align
6079      t1
6080          .word 0xff000000 + (t1 - t0)
6081      arm_poke_function_name
6082          mov     ip, sp
6083          stmfd   sp!, @{fp, ip, lr, pc@}
6084          sub     fp, ip, #4
6085 @end smallexample
6087 When performing a stack backtrace, code can inspect the value of
6088 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6089 location @code{pc - 12} and the top 8 bits are set, then we know that
6090 there is a function name embedded immediately preceding this location
6091 and has length @code{((pc[-3]) & 0xff000000)}.
6093 @item -mthumb
6094 @opindex mthumb
6095 Generate code for the 16-bit Thumb instruction set.  The default is to
6096 use the 32-bit ARM instruction set.
6098 @item -mtpcs-frame
6099 @opindex mtpcs-frame
6100 Generate a stack frame that is compliant with the Thumb Procedure Call
6101 Standard for all non-leaf functions.  (A leaf function is one that does
6102 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6104 @item -mtpcs-leaf-frame
6105 @opindex mtpcs-leaf-frame
6106 Generate a stack frame that is compliant with the Thumb Procedure Call
6107 Standard for all leaf functions.  (A leaf function is one that does
6108 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6110 @item -mcallee-super-interworking
6111 @opindex mcallee-super-interworking
6112 Gives all externally visible functions in the file being compiled an ARM
6113 instruction set header which switches to Thumb mode before executing the
6114 rest of the function.  This allows these functions to be called from
6115 non-interworking code.
6117 @item -mcaller-super-interworking
6118 @opindex mcaller-super-interworking
6119 Allows calls via function pointers (including virtual functions) to
6120 execute correctly regardless of whether the target code has been
6121 compiled for interworking or not.  There is a small overhead in the cost
6122 of executing a function pointer if this option is enabled.
6124 @end table
6126 @node MN10200 Options
6127 @subsection MN10200 Options
6128 @cindex MN10200 options
6129 These @option{-m} options are defined for Matsushita MN10200 architectures:
6130 @table @gcctabopt
6132 @item -mrelax
6133 @opindex mrelax
6134 Indicate to the linker that it should perform a relaxation optimization pass
6135 to shorten branches, calls and absolute memory addresses.  This option only
6136 has an effect when used on the command line for the final link step.
6138 This option makes symbolic debugging impossible.
6139 @end table
6141 @node MN10300 Options
6142 @subsection MN10300 Options
6143 @cindex MN10300 options
6144 These @option{-m} options are defined for Matsushita MN10300 architectures:
6146 @table @gcctabopt
6147 @item -mmult-bug
6148 @opindex mmult-bug
6149 Generate code to avoid bugs in the multiply instructions for the MN10300
6150 processors.  This is the default.
6152 @item -mno-mult-bug
6153 @opindex mno-mult-bug
6154 Do not generate code to avoid bugs in the multiply instructions for the
6155 MN10300 processors.
6157 @item -mam33
6158 @opindex mam33
6159 Generate code which uses features specific to the AM33 processor.
6161 @item -mno-am33
6162 @opindex mno-am33
6163 Do not generate code which uses features specific to the AM33 processor.  This
6164 is the default.
6166 @item -mno-crt0
6167 @opindex mno-crt0
6168 Do not link in the C run-time initialization object file.
6170 @item -mrelax
6171 @opindex mrelax
6172 Indicate to the linker that it should perform a relaxation optimization pass
6173 to shorten branches, calls and absolute memory addresses.  This option only
6174 has an effect when used on the command line for the final link step.
6176 This option makes symbolic debugging impossible.
6177 @end table
6180 @node M32R/D Options
6181 @subsection M32R/D Options
6182 @cindex M32R/D options
6184 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6186 @table @gcctabopt
6187 @item -m32rx
6188 @opindex m32rx
6189 Generate code for the M32R/X@.
6191 @item -m32r
6192 @opindex m32r
6193 Generate code for the M32R@.  This is the default.
6195 @item -mcode-model=small
6196 @opindex mcode-model=small
6197 Assume all objects live in the lower 16MB of memory (so that their addresses
6198 can be loaded with the @code{ld24} instruction), and assume all subroutines
6199 are reachable with the @code{bl} instruction.
6200 This is the default.
6202 The addressability of a particular object can be set with the
6203 @code{model} attribute.
6205 @item -mcode-model=medium
6206 @opindex mcode-model=medium
6207 Assume objects may be anywhere in the 32-bit address space (the compiler
6208 will generate @code{seth/add3} instructions to load their addresses), and
6209 assume all subroutines are reachable with the @code{bl} instruction.
6211 @item -mcode-model=large
6212 @opindex mcode-model=large
6213 Assume objects may be anywhere in the 32-bit address space (the compiler
6214 will generate @code{seth/add3} instructions to load their addresses), and
6215 assume subroutines may not be reachable with the @code{bl} instruction
6216 (the compiler will generate the much slower @code{seth/add3/jl}
6217 instruction sequence).
6219 @item -msdata=none
6220 @opindex msdata=none
6221 Disable use of the small data area.  Variables will be put into
6222 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6223 @code{section} attribute has been specified).
6224 This is the default.
6226 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6227 Objects may be explicitly put in the small data area with the
6228 @code{section} attribute using one of these sections.
6230 @item -msdata=sdata
6231 @opindex msdata=sdata
6232 Put small global and static data in the small data area, but do not
6233 generate special code to reference them.
6235 @item -msdata=use
6236 @opindex msdata=use
6237 Put small global and static data in the small data area, and generate
6238 special instructions to reference them.
6240 @item -G @var{num}
6241 @opindex G
6242 @cindex smaller data references
6243 Put global and static objects less than or equal to @var{num} bytes
6244 into the small data or bss sections instead of the normal data or bss
6245 sections.  The default value of @var{num} is 8.
6246 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6247 for this option to have any effect.
6249 All modules should be compiled with the same @option{-G @var{num}} value.
6250 Compiling with different values of @var{num} may or may not work; if it
6251 doesn't the linker will give an error message---incorrect code will not be
6252 generated.
6254 @end table
6256 @node M88K Options
6257 @subsection M88K Options
6258 @cindex M88k options
6260 These @samp{-m} options are defined for Motorola 88k architectures:
6262 @table @gcctabopt
6263 @item -m88000
6264 @opindex m88000
6265 Generate code that works well on both the m88100 and the
6266 m88110.
6268 @item -m88100
6269 @opindex m88100
6270 Generate code that works best for the m88100, but that also
6271 runs on the m88110.
6273 @item -m88110
6274 @opindex m88110
6275 Generate code that works best for the m88110, and may not run
6276 on the m88100.
6278 @item -mbig-pic
6279 @opindex mbig-pic
6280 Obsolete option to be removed from the next revision.
6281 Use @option{-fPIC}.
6283 @item -midentify-revision
6284 @opindex midentify-revision
6285 @cindex identifying source, compiler (88k)
6286 Include an @code{ident} directive in the assembler output recording the
6287 source file name, compiler name and version, timestamp, and compilation
6288 flags used.
6290 @item -mno-underscores
6291 @opindex mno-underscores
6292 @cindex underscores, avoiding (88k)
6293 In assembler output, emit symbol names without adding an underscore
6294 character at the beginning of each name.  The default is to use an
6295 underscore as prefix on each name.
6297 @item -mocs-debug-info
6298 @itemx -mno-ocs-debug-info
6299 @opindex mocs-debug-info
6300 @opindex mno-ocs-debug-info
6301 @cindex OCS (88k)
6302 @cindex debugging, 88k OCS
6303 Include (or omit) additional debugging information (about registers used
6304 in each stack frame) as specified in the 88open Object Compatibility
6305 Standard, ``OCS''@.  This extra information allows debugging of code that
6306 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
6307 Delta 88 SVr3.2 is to include this information; other 88k configurations
6308 omit this information by default.
6310 @item -mocs-frame-position
6311 @opindex mocs-frame-position
6312 @cindex register positions in frame (88k)
6313 When emitting COFF debugging information for automatic variables and
6314 parameters stored on the stack, use the offset from the canonical frame
6315 address, which is the stack pointer (register 31) on entry to the
6316 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
6317 @option{-mocs-frame-position}; other 88k configurations have the default
6318 @option{-mno-ocs-frame-position}.
6320 @item -mno-ocs-frame-position
6321 @opindex mno-ocs-frame-position
6322 @cindex register positions in frame (88k)
6323 When emitting COFF debugging information for automatic variables and
6324 parameters stored on the stack, use the offset from the frame pointer
6325 register (register 30).  When this option is in effect, the frame
6326 pointer is not eliminated when debugging information is selected by the
6327 -g switch.
6329 @item -moptimize-arg-area
6330 @opindex moptimize-arg-area
6331 @cindex arguments in frame (88k)
6332 Save space by reorganizing the stack frame.  This option generates code
6333 that does not agree with the 88open specifications, but uses less
6334 memory.
6336 @itemx -mno-optimize-arg-area
6337 @opindex mno-optimize-arg-area
6338 Do not reorganize the stack frame to save space.  This is the default.
6339 The generated conforms to the specification, but uses more memory.
6341 @item -mshort-data-@var{num}
6342 @opindex mshort-data
6343 @cindex smaller data references (88k)
6344 @cindex r0-relative references (88k)
6345 Generate smaller data references by making them relative to @code{r0},
6346 which allows loading a value using a single instruction (rather than the
6347 usual two).  You control which data references are affected by
6348 specifying @var{num} with this option.  For example, if you specify
6349 @option{-mshort-data-512}, then the data references affected are those
6350 involving displacements of less than 512 bytes.
6351 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6352 than 64k.
6354 @item -mserialize-volatile
6355 @opindex mserialize-volatile
6356 @itemx -mno-serialize-volatile
6357 @opindex mno-serialize-volatile
6358 @cindex sequential consistency on 88k
6359 Do, or don't, generate code to guarantee sequential consistency
6360 of volatile memory references.  By default, consistency is
6361 guaranteed.
6363 The order of memory references made by the MC88110 processor does
6364 not always match the order of the instructions requesting those
6365 references.  In particular, a load instruction may execute before
6366 a preceding store instruction.  Such reordering violates
6367 sequential consistency of volatile memory references, when there
6368 are multiple processors.   When consistency must be guaranteed,
6369 GCC generates special instructions, as needed, to force
6370 execution in the proper order.
6372 The MC88100 processor does not reorder memory references and so
6373 always provides sequential consistency.  However, by default, GCC
6374 generates the special instructions to guarantee consistency
6375 even when you use @option{-m88100}, so that the code may be run on an
6376 MC88110 processor.  If you intend to run your code only on the
6377 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6379 The extra code generated to guarantee consistency may affect the
6380 performance of your application.  If you know that you can safely
6381 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6383 @item -msvr4
6384 @itemx -msvr3
6385 @opindex msvr4
6386 @opindex msvr3
6387 @cindex assembler syntax, 88k
6388 @cindex SVr4
6389 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6390 related to System V release 4 (SVr4).  This controls the following:
6392 @enumerate
6393 @item
6394 Which variant of the assembler syntax to emit.
6395 @item
6396 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6397 that is used on System V release 4.
6398 @item
6399 @option{-msvr4} makes GCC issue additional declaration directives used in
6400 SVr4.
6401 @end enumerate
6403 @option{-msvr4} is the default for the m88k-motorola-sysv4 and
6404 m88k-dg-dgux m88k configurations.  @option{-msvr3} is the default for all
6405 other m88k configurations.
6407 @item -mversion-03.00
6408 @opindex mversion-03.00
6409 This option is obsolete, and is ignored.
6410 @c ??? which asm syntax better for GAS?  option there too?
6412 @item -mno-check-zero-division
6413 @itemx -mcheck-zero-division
6414 @opindex mno-check-zero-division
6415 @opindex mcheck-zero-division
6416 @cindex zero division on 88k
6417 Do, or don't, generate code to guarantee that integer division by
6418 zero will be detected.  By default, detection is guaranteed.
6420 Some models of the MC88100 processor fail to trap upon integer
6421 division by zero under certain conditions.  By default, when
6422 compiling code that might be run on such a processor, GCC
6423 generates code that explicitly checks for zero-valued divisors
6424 and traps with exception number 503 when one is detected.  Use of
6425 @option{-mno-check-zero-division} suppresses such checking for code
6426 generated to run on an MC88100 processor.
6428 GCC assumes that the MC88110 processor correctly detects all instances
6429 of integer division by zero.  When @option{-m88110} is specified, no
6430 explicit checks for zero-valued divisors are generated, and both
6431 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6432 ignored.
6434 @item -muse-div-instruction
6435 @opindex muse-div-instruction
6436 @cindex divide instruction, 88k
6437 Use the div instruction for signed integer division on the
6438 MC88100 processor.  By default, the div instruction is not used.
6440 On the MC88100 processor the signed integer division instruction
6441 div) traps to the operating system on a negative operand.  The
6442 operating system transparently completes the operation, but at a
6443 large cost in execution time.  By default, when compiling code
6444 that might be run on an MC88100 processor, GCC emulates signed
6445 integer division using the unsigned integer division instruction
6446 divu), thereby avoiding the large penalty of a trap to the
6447 operating system.  Such emulation has its own, smaller, execution
6448 cost in both time and space.  To the extent that your code's
6449 important signed integer division operations are performed on two
6450 nonnegative operands, it may be desirable to use the div
6451 instruction directly.
6453 On the MC88110 processor the div instruction (also known as the
6454 divs instruction) processes negative operands without trapping to
6455 the operating system.  When @option{-m88110} is specified,
6456 @option{-muse-div-instruction} is ignored, and the div instruction is used
6457 for signed integer division.
6459 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6460 particular, the behavior of such a division with and without
6461 @option{-muse-div-instruction} may differ.
6463 @item -mtrap-large-shift
6464 @itemx -mhandle-large-shift
6465 @opindex mtrap-large-shift
6466 @opindex mhandle-large-shift
6467 @cindex bit shift overflow (88k)
6468 @cindex large bit shifts (88k)
6469 Include code to detect bit-shifts of more than 31 bits; respectively,
6470 trap such shifts or emit code to handle them properly.  By default GCC
6471 makes no special provision for large bit shifts.
6473 @item -mwarn-passed-structs
6474 @opindex mwarn-passed-structs
6475 @cindex structure passing (88k)
6476 Warn when a function passes a struct as an argument or result.
6477 Structure-passing conventions have changed during the evolution of the C
6478 language, and are often the source of portability problems.  By default,
6479 GCC issues no such warning.
6480 @end table
6482 @c break page here to avoid unsightly interparagraph stretch.
6483 @c -zw, 2001-8-17
6484 @page
6486 @node RS/6000 and PowerPC Options
6487 @subsection IBM RS/6000 and PowerPC Options
6488 @cindex RS/6000 and PowerPC Options
6489 @cindex IBM RS/6000 and PowerPC Options
6491 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6492 @table @gcctabopt
6493 @item -mpower
6494 @itemx -mno-power
6495 @itemx -mpower2
6496 @itemx -mno-power2
6497 @itemx -mpowerpc
6498 @itemx -mno-powerpc
6499 @itemx -mpowerpc-gpopt
6500 @itemx -mno-powerpc-gpopt
6501 @itemx -mpowerpc-gfxopt
6502 @itemx -mno-powerpc-gfxopt
6503 @itemx -mpowerpc64
6504 @itemx -mno-powerpc64
6505 @opindex mpower
6506 @opindex mno-power
6507 @opindex mpower2
6508 @opindex mno-power2
6509 @opindex mpowerpc
6510 @opindex mno-powerpc
6511 @opindex mpowerpc-gpopt
6512 @opindex mno-powerpc-gpopt
6513 @opindex mpowerpc-gfxopt
6514 @opindex mno-powerpc-gfxopt
6515 @opindex mpowerpc64
6516 @opindex mno-powerpc64
6517 GCC supports two related instruction set architectures for the
6518 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6519 instructions supported by the @samp{rios} chip set used in the original
6520 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6521 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6522 the IBM 4xx microprocessors.
6524 Neither architecture is a subset of the other.  However there is a
6525 large common subset of instructions supported by both.  An MQ
6526 register is included in processors supporting the POWER architecture.
6528 You use these options to specify which instructions are available on the
6529 processor you are using.  The default value of these options is
6530 determined when configuring GCC@.  Specifying the
6531 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6532 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6533 rather than the options listed above.
6535 The @option{-mpower} option allows GCC to generate instructions that
6536 are found only in the POWER architecture and to use the MQ register.
6537 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6538 to generate instructions that are present in the POWER2 architecture but
6539 not the original POWER architecture.
6541 The @option{-mpowerpc} option allows GCC to generate instructions that
6542 are found only in the 32-bit subset of the PowerPC architecture.
6543 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6544 GCC to use the optional PowerPC architecture instructions in the
6545 General Purpose group, including floating-point square root.  Specifying
6546 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6547 use the optional PowerPC architecture instructions in the Graphics
6548 group, including floating-point select.
6550 The @option{-mpowerpc64} option allows GCC to generate the additional
6551 64-bit instructions that are found in the full PowerPC64 architecture
6552 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6553 @option{-mno-powerpc64}.
6555 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6556 will use only the instructions in the common subset of both
6557 architectures plus some special AIX common-mode calls, and will not use
6558 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6559 permits GCC to use any instruction from either architecture and to
6560 allow use of the MQ register; specify this for the Motorola MPC601.
6562 @item -mnew-mnemonics
6563 @itemx -mold-mnemonics
6564 @opindex mnew-mnemonics
6565 @opindex mold-mnemonics
6566 Select which mnemonics to use in the generated assembler code.  With
6567 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6568 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6569 assembler mnemonics defined for the POWER architecture.  Instructions
6570 defined in only one architecture have only one mnemonic; GCC uses that
6571 mnemonic irrespective of which of these options is specified.
6573 GCC defaults to the mnemonics appropriate for the architecture in
6574 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6575 value of these option.  Unless you are building a cross-compiler, you
6576 should normally not specify either @option{-mnew-mnemonics} or
6577 @option{-mold-mnemonics}, but should instead accept the default.
6579 @item -mcpu=@var{cpu_type}
6580 @opindex mcpu
6581 Set architecture type, register usage, choice of mnemonics, and
6582 instruction scheduling parameters for machine type @var{cpu_type}.
6583 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6584 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6585 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6586 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6587 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6588 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6590 @option{-mcpu=common} selects a completely generic processor.  Code
6591 generated under this option will run on any POWER or PowerPC processor.
6592 GCC will use only the instructions in the common subset of both
6593 architectures, and will not use the MQ register.  GCC assumes a generic
6594 processor model for scheduling purposes.
6596 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6597 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6598 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6599 types, with an appropriate, generic processor model assumed for
6600 scheduling purposes.
6602 The other options specify a specific processor.  Code generated under
6603 those options will run best on that processor, and may not run at all on
6604 others.
6606 The @option{-mcpu} options automatically enable or disable other
6607 @option{-m} options as follows:
6609 @table @samp
6610 @item common
6611 @option{-mno-power}, @option{-mno-powerc}
6613 @item power
6614 @itemx power2
6615 @itemx rios1
6616 @itemx rios2
6617 @itemx rsc
6618 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6620 @item powerpc
6621 @itemx rs64a
6622 @itemx 602
6623 @itemx 603
6624 @itemx 603e
6625 @itemx 604
6626 @itemx 620
6627 @itemx 630
6628 @itemx 740
6629 @itemx 7400
6630 @itemx 7450
6631 @itemx 750
6632 @itemx 505
6633 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6635 @item 601
6636 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6638 @item 403
6639 @itemx 821
6640 @itemx 860
6641 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6642 @end table
6644 @item -mtune=@var{cpu_type}
6645 @opindex mtune
6646 Set the instruction scheduling parameters for machine type
6647 @var{cpu_type}, but do not set the architecture type, register usage, or
6648 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6649 values for @var{cpu_type} are used for @option{-mtune} as for
6650 @option{-mcpu}.  If both are specified, the code generated will use the
6651 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6652 scheduling parameters set by @option{-mtune}.
6654 @item -maltivec
6655 @itemx -mno-altivec
6656 @opindex maltivec
6657 @opindex mno-altivec
6658 These switches enable or disable the use of built-in functions that
6659 allow access to the AltiVec instruction set.  You may also need to set
6660 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6661 enhancements.
6663 @item -mfull-toc
6664 @itemx -mno-fp-in-toc
6665 @itemx -mno-sum-in-toc
6666 @itemx -mminimal-toc
6667 @opindex mfull-toc
6668 @opindex mno-fp-in-toc
6669 @opindex mno-sum-in-toc
6670 @opindex mminimal-toc
6671 Modify generation of the TOC (Table Of Contents), which is created for
6672 every executable file.  The @option{-mfull-toc} option is selected by
6673 default.  In that case, GCC will allocate at least one TOC entry for
6674 each unique non-automatic variable reference in your program.  GCC
6675 will also place floating-point constants in the TOC@.  However, only
6676 16,384 entries are available in the TOC@.
6678 If you receive a linker error message that saying you have overflowed
6679 the available TOC space, you can reduce the amount of TOC space used
6680 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
6681 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
6682 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
6683 generate code to calculate the sum of an address and a constant at
6684 run-time instead of putting that sum into the TOC@.  You may specify one
6685 or both of these options.  Each causes GCC to produce very slightly
6686 slower and larger code at the expense of conserving TOC space.
6688 If you still run out of space in the TOC even when you specify both of
6689 these options, specify @option{-mminimal-toc} instead.  This option causes
6690 GCC to make only one TOC entry for every file.  When you specify this
6691 option, GCC will produce code that is slower and larger but which
6692 uses extremely little TOC space.  You may wish to use this option
6693 only on files that contain less frequently executed code.
6695 @item -maix64
6696 @itemx -maix32
6697 @opindex maix64
6698 @opindex maix32
6699 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
6700 @code{long} type, and the infrastructure needed to support them.
6701 Specifying @option{-maix64} implies @option{-mpowerpc64} and
6702 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
6703 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
6705 @item -mxl-call
6706 @itemx -mno-xl-call
6707 @opindex mxl-call
6708 @opindex mno-xl-call
6709 On AIX, pass floating-point arguments to prototyped functions beyond the
6710 register save area (RSA) on the stack in addition to argument FPRs.  The
6711 AIX calling convention was extended but not initially documented to
6712 handle an obscure K&R C case of calling a function that takes the
6713 address of its arguments with fewer arguments than declared.  AIX XL
6714 compilers access floating point arguments which do not fit in the
6715 RSA from the stack when a subroutine is compiled without
6716 optimization.  Because always storing floating-point arguments on the
6717 stack is inefficient and rarely needed, this option is not enabled by
6718 default and only is necessary when calling subroutines compiled by AIX
6719 XL compilers without optimization.
6721 @item -mpe
6722 @opindex mpe
6723 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
6724 application written to use message passing with special startup code to
6725 enable the application to run.  The system must have PE installed in the
6726 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6727 must be overridden with the @option{-specs=} option to specify the
6728 appropriate directory location.  The Parallel Environment does not
6729 support threads, so the @option{-mpe} option and the @option{-pthread}
6730 option are incompatible.
6732 @item -msoft-float
6733 @itemx -mhard-float
6734 @opindex msoft-float
6735 @opindex mhard-float
6736 Generate code that does not use (uses) the floating-point register set.
6737 Software floating point emulation is provided if you use the
6738 @option{-msoft-float} option, and pass the option to GCC when linking.
6740 @item -mmultiple
6741 @itemx -mno-multiple
6742 @opindex mmultiple
6743 @opindex mno-multiple
6744 Generate code that uses (does not use) the load multiple word
6745 instructions and the store multiple word instructions.  These
6746 instructions are generated by default on POWER systems, and not
6747 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
6748 endian PowerPC systems, since those instructions do not work when the
6749 processor is in little endian mode.  The exceptions are PPC740 and
6750 PPC750 which permit the instructions usage in little endian mode.
6752 @item -mstring
6753 @itemx -mno-string
6754 @opindex mstring
6755 @opindex mno-string
6756 Generate code that uses (does not use) the load string instructions
6757 and the store string word instructions to save multiple registers and
6758 do small block moves.  These instructions are generated by default on
6759 POWER systems, and not generated on PowerPC systems.  Do not use
6760 @option{-mstring} on little endian PowerPC systems, since those
6761 instructions do not work when the processor is in little endian mode.
6762 The exceptions are PPC740 and PPC750 which permit the instructions
6763 usage in little endian mode.
6765 @item -mupdate
6766 @itemx -mno-update
6767 @opindex mupdate
6768 @opindex mno-update
6769 Generate code that uses (does not use) the load or store instructions
6770 that update the base register to the address of the calculated memory
6771 location.  These instructions are generated by default.  If you use
6772 @option{-mno-update}, there is a small window between the time that the
6773 stack pointer is updated and the address of the previous frame is
6774 stored, which means code that walks the stack frame across interrupts or
6775 signals may get corrupted data.
6777 @item -mfused-madd
6778 @itemx -mno-fused-madd
6779 @opindex mfused-madd
6780 @opindex mno-fused-madd
6781 Generate code that uses (does not use) the floating point multiply and
6782 accumulate instructions.  These instructions are generated by default if
6783 hardware floating is used.
6785 @item -mno-bit-align
6786 @itemx -mbit-align
6787 @opindex mno-bit-align
6788 @opindex mbit-align
6789 On System V.4 and embedded PowerPC systems do not (do) force structures
6790 and unions that contain bit-fields to be aligned to the base type of the
6791 bit-field.
6793 For example, by default a structure containing nothing but 8
6794 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
6795 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
6796 the structure would be aligned to a 1 byte boundary and be one byte in
6797 size.
6799 @item -mno-strict-align
6800 @itemx -mstrict-align
6801 @opindex mno-strict-align
6802 @opindex mstrict-align
6803 On System V.4 and embedded PowerPC systems do not (do) assume that
6804 unaligned memory references will be handled by the system.
6806 @item -mrelocatable
6807 @itemx -mno-relocatable
6808 @opindex mrelocatable
6809 @opindex mno-relocatable
6810 On embedded PowerPC systems generate code that allows (does not allow)
6811 the program to be relocated to a different address at runtime.  If you
6812 use @option{-mrelocatable} on any module, all objects linked together must
6813 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
6815 @item -mrelocatable-lib
6816 @itemx -mno-relocatable-lib
6817 @opindex mrelocatable-lib
6818 @opindex mno-relocatable-lib
6819 On embedded PowerPC systems generate code that allows (does not allow)
6820 the program to be relocated to a different address at runtime.  Modules
6821 compiled with @option{-mrelocatable-lib} can be linked with either modules
6822 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
6823 with modules compiled with the @option{-mrelocatable} options.
6825 @item -mno-toc
6826 @itemx -mtoc
6827 @opindex mno-toc
6828 @opindex mtoc
6829 On System V.4 and embedded PowerPC systems do not (do) assume that
6830 register 2 contains a pointer to a global area pointing to the addresses
6831 used in the program.
6833 @item -mlittle
6834 @itemx -mlittle-endian
6835 @opindex mlittle
6836 @opindex mlittle-endian
6837 On System V.4 and embedded PowerPC systems compile code for the
6838 processor in little endian mode.  The @option{-mlittle-endian} option is
6839 the same as @option{-mlittle}.
6841 @item -mbig
6842 @itemx -mbig-endian
6843 @opindex mbig
6844 @opindex mbig-endian
6845 On System V.4 and embedded PowerPC systems compile code for the
6846 processor in big endian mode.  The @option{-mbig-endian} option is
6847 the same as @option{-mbig}.
6849 @item -mcall-sysv
6850 @opindex mcall-sysv
6851 On System V.4 and embedded PowerPC systems compile code using calling
6852 conventions that adheres to the March 1995 draft of the System V
6853 Application Binary Interface, PowerPC processor supplement.  This is the
6854 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6856 @item -mcall-sysv-eabi
6857 @opindex mcall-sysv-eabi
6858 Specify both @option{-mcall-sysv} and @option{-meabi} options.
6860 @item -mcall-sysv-noeabi
6861 @opindex mcall-sysv-noeabi
6862 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
6864 @item -mcall-aix
6865 @opindex mcall-aix
6866 On System V.4 and embedded PowerPC systems compile code using calling
6867 conventions that are similar to those used on AIX@.  This is the
6868 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6870 @item -mcall-solaris
6871 @opindex mcall-solaris
6872 On System V.4 and embedded PowerPC systems compile code for the Solaris
6873 operating system.
6875 @item -mcall-linux
6876 @opindex mcall-linux
6877 On System V.4 and embedded PowerPC systems compile code for the
6878 Linux-based GNU system.
6880 @item -mcall-gnu
6881 @opindex mcall-gnu
6882 On System V.4 and embedded PowerPC systems compile code for the
6883 Hurd-based GNU system.
6885 @item -mcall-netbsd
6886 @opindex mcall-netbsd
6887 On System V.4 and embedded PowerPC systems compile code for the
6888 NetBSD operating system.
6890 @item -maix-struct-return
6891 @opindex maix-struct-return
6892 Return all structures in memory (as specified by the AIX ABI)@.
6894 @item -msvr4-struct-return
6895 @opindex msvr4-struct-return
6896 Return structures smaller than 8 bytes in registers (as specified by the
6897 SVR4 ABI)@.
6899 @item -mabi=altivec
6900 @opindex mabi=altivec
6901 Extend the current ABI with AltiVec ABI extensions.  This does not
6902 change the default ABI, instead it adds the AltiVec ABI extensions to
6903 the current ABI@.
6905 @item -mprototype
6906 @itemx -mno-prototype
6907 @opindex mprototype
6908 @opindex mno-prototype
6909 On System V.4 and embedded PowerPC systems assume that all calls to
6910 variable argument functions are properly prototyped.  Otherwise, the
6911 compiler must insert an instruction before every non prototyped call to
6912 set or clear bit 6 of the condition code register (@var{CR}) to
6913 indicate whether floating point values were passed in the floating point
6914 registers in case the function takes a variable arguments.  With
6915 @option{-mprototype}, only calls to prototyped variable argument functions
6916 will set or clear the bit.
6918 @item -msim
6919 @opindex msim
6920 On embedded PowerPC systems, assume that the startup module is called
6921 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6922 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6923 configurations.
6925 @item -mmvme
6926 @opindex mmvme
6927 On embedded PowerPC systems, assume that the startup module is called
6928 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6929 @file{libc.a}.
6931 @item -mads
6932 @opindex mads
6933 On embedded PowerPC systems, assume that the startup module is called
6934 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6935 @file{libc.a}.
6937 @item -myellowknife
6938 @opindex myellowknife
6939 On embedded PowerPC systems, assume that the startup module is called
6940 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6941 @file{libc.a}.
6943 @item -mvxworks
6944 @opindex mvxworks
6945 On System V.4 and embedded PowerPC systems, specify that you are
6946 compiling for a VxWorks system.
6948 @item -memb
6949 @opindex memb
6950 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6951 header to indicate that @samp{eabi} extended relocations are used.
6953 @item -meabi
6954 @itemx -mno-eabi
6955 @opindex meabi
6956 @opindex mno-eabi
6957 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6958 Embedded Applications Binary Interface (eabi) which is a set of
6959 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6960 means that the stack is aligned to an 8 byte boundary, a function
6961 @code{__eabi} is called to from @code{main} to set up the eabi
6962 environment, and the @option{-msdata} option can use both @code{r2} and
6963 @code{r13} to point to two separate small data areas.  Selecting
6964 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6965 do not call an initialization function from @code{main}, and the
6966 @option{-msdata} option will only use @code{r13} to point to a single
6967 small data area.  The @option{-meabi} option is on by default if you
6968 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6970 @item -msdata=eabi
6971 @opindex msdata=eabi
6972 On System V.4 and embedded PowerPC systems, put small initialized
6973 @code{const} global and static data in the @samp{.sdata2} section, which
6974 is pointed to by register @code{r2}.  Put small initialized
6975 non-@code{const} global and static data in the @samp{.sdata} section,
6976 which is pointed to by register @code{r13}.  Put small uninitialized
6977 global and static data in the @samp{.sbss} section, which is adjacent to
6978 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
6979 incompatible with the @option{-mrelocatable} option.  The
6980 @option{-msdata=eabi} option also sets the @option{-memb} option.
6982 @item -msdata=sysv
6983 @opindex msdata=sysv
6984 On System V.4 and embedded PowerPC systems, put small global and static
6985 data in the @samp{.sdata} section, which is pointed to by register
6986 @code{r13}.  Put small uninitialized global and static data in the
6987 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6988 The @option{-msdata=sysv} option is incompatible with the
6989 @option{-mrelocatable} option.
6991 @item -msdata=default
6992 @itemx -msdata
6993 @opindex msdata=default
6994 @opindex msdata
6995 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
6996 compile code the same as @option{-msdata=eabi}, otherwise compile code the
6997 same as @option{-msdata=sysv}.
6999 @item -msdata-data
7000 @opindex msdata-data
7001 On System V.4 and embedded PowerPC systems, put small global and static
7002 data in the @samp{.sdata} section.  Put small uninitialized global and
7003 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7004 to address small data however.  This is the default behavior unless
7005 other @option{-msdata} options are used.
7007 @item -msdata=none
7008 @itemx -mno-sdata
7009 @opindex msdata=none
7010 @opindex mno-sdata
7011 On embedded PowerPC systems, put all initialized global and static data
7012 in the @samp{.data} section, and all uninitialized data in the
7013 @samp{.bss} section.
7015 @item -G @var{num}
7016 @opindex G
7017 @cindex smaller data references (PowerPC)
7018 @cindex .sdata/.sdata2 references (PowerPC)
7019 On embedded PowerPC systems, put global and static items less than or
7020 equal to @var{num} bytes into the small data or bss sections instead of
7021 the normal data or bss section.  By default, @var{num} is 8.  The
7022 @option{-G @var{num}} switch is also passed to the linker.
7023 All modules should be compiled with the same @option{-G @var{num}} value.
7025 @item -mregnames
7026 @itemx -mno-regnames
7027 @opindex mregnames
7028 @opindex mno-regnames
7029 On System V.4 and embedded PowerPC systems do (do not) emit register
7030 names in the assembly language output using symbolic forms.
7032 @item -pthread
7033 @opindex pthread
7034 Adds support for multithreading with the @dfn{pthreads} library.
7035 This option sets flags for both the preprocessor and linker.
7037 @end table
7039 @node RT Options
7040 @subsection IBM RT Options
7041 @cindex RT options
7042 @cindex IBM RT options
7044 These @samp{-m} options are defined for the IBM RT PC:
7046 @table @gcctabopt
7047 @item -min-line-mul
7048 @opindex min-line-mul
7049 Use an in-line code sequence for integer multiplies.  This is the
7050 default.
7052 @item -mcall-lib-mul
7053 @opindex mcall-lib-mul
7054 Call @code{lmul$$} for integer multiples.
7056 @item -mfull-fp-blocks
7057 @opindex mfull-fp-blocks
7058 Generate full-size floating point data blocks, including the minimum
7059 amount of scratch space recommended by IBM@.  This is the default.
7061 @item -mminimum-fp-blocks
7062 @opindex mminimum-fp-blocks
7063 Do not include extra scratch space in floating point data blocks.  This
7064 results in smaller code, but slower execution, since scratch space must
7065 be allocated dynamically.
7067 @cindex @file{varargs.h} and RT PC
7068 @cindex @file{stdarg.h} and RT PC
7069 @item -mfp-arg-in-fpregs
7070 @opindex mfp-arg-in-fpregs
7071 Use a calling sequence incompatible with the IBM calling convention in
7072 which floating point arguments are passed in floating point registers.
7073 Note that @code{varargs.h} and @code{stdarg.h} will not work with
7074 floating point operands if this option is specified.
7076 @item -mfp-arg-in-gregs
7077 @opindex mfp-arg-in-gregs
7078 Use the normal calling convention for floating point arguments.  This is
7079 the default.
7081 @item -mhc-struct-return
7082 @opindex mhc-struct-return
7083 Return structures of more than one word in memory, rather than in a
7084 register.  This provides compatibility with the MetaWare HighC (hc)
7085 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7086 with the Portable C Compiler (pcc).
7088 @item -mnohc-struct-return
7089 @opindex mnohc-struct-return
7090 Return some structures of more than one word in registers, when
7091 convenient.  This is the default.  For compatibility with the
7092 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7093 option @option{-mhc-struct-return}.
7094 @end table
7096 @node MIPS Options
7097 @subsection MIPS Options
7098 @cindex MIPS options
7100 These @samp{-m} options are defined for the MIPS family of computers:
7102 @table @gcctabopt
7104 @item -march=@var{cpu-type}
7105 @opindex march
7106 Assume the defaults for the machine type @var{cpu-type} when generating
7107 instructions.  The choices for @var{cpu-type} are  @samp{r2000}, @samp{r3000},
7108 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7109 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7110 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7111 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7112 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.
7114 @item -mtune=@var{cpu-type}
7115 @opindex mtune
7116 Assume the defaults for the machine type @var{cpu-type} when scheduling
7117 instructions.  The choices for @var{cpu-type} are @samp{r2000}, @samp{r3000},
7118 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
7119 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
7120 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
7121 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
7122 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
7123 @var{cpu-type} will schedule things appropriately for that particular
7124 chip, the compiler will not generate any code that does not meet level 1
7125 of the MIPS ISA (instruction set architecture) without a @option{-mipsX}
7126 or @option{-mabi} switch being used.
7128 @item -mcpu=@var{cpu-type}
7129 @opindex mcpu
7130 This is identical to specifying both @option{-march} and @option{-mtune}.
7132 @item -mips1
7133 @opindex mips1
7134 Issue instructions from level 1 of the MIPS ISA@.  This is the default.
7135 @samp{r3000} is the default @var{cpu-type} at this ISA level.
7137 @item -mips2
7138 @opindex mips2
7139 Issue instructions from level 2 of the MIPS ISA (branch likely, square
7140 root instructions).  @samp{r6000} is the default @var{cpu-type} at this
7141 ISA level.
7143 @item -mips3
7144 @opindex mips3
7145 Issue instructions from level 3 of the MIPS ISA (64-bit instructions).
7146 @samp{r4000} is the default @var{cpu-type} at this ISA level.
7148 @item -mips4
7149 @opindex mips4
7150 Issue instructions from level 4 of the MIPS ISA (conditional move,
7151 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
7152 @var{cpu-type} at this ISA level.
7154 @item -mfp32
7155 @opindex mfp32
7156 Assume that 32 32-bit floating point registers are available.  This is
7157 the default.
7159 @item -mfp64
7160 @opindex mfp64
7161 Assume that 32 64-bit floating point registers are available.  This is
7162 the default when the @option{-mips3} option is used.
7164 @item -mfused-madd
7165 @itemx -mno-fused-madd
7166 @opindex mfused-madd
7167 @opindex mno-fused-madd
7168 Generate code that uses (does not use) the floating point multiply and
7169 accumulate instructions, when they are available.  These instructions
7170 are generated by default if they are available, but this may be
7171 undesirable if the extra precision causes problems or on certain chips
7172 in the mode where denormals are rounded to zero where denormals
7173 generated by multiply and accumulate instructions cause exceptions
7174 anyway.
7176 @item -mgp32
7177 @opindex mgp32
7178 Assume that 32 32-bit general purpose registers are available.  This is
7179 the default.
7181 @item -mgp64
7182 @opindex mgp64
7183 Assume that 32 64-bit general purpose registers are available.  This is
7184 the default when the @option{-mips3} option is used.
7186 @item -mint64
7187 @opindex mint64
7188 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7189 explanation of the default, and the width of pointers.
7191 @item -mlong64
7192 @opindex mlong64
7193 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7194 explanation of the default, and the width of pointers.
7196 @item -mlong32
7197 @opindex mlong32
7198 Force long, int, and pointer types to be 32 bits wide.
7200 If none of @option{-mlong32}, @option{-mlong64}, or @option{-mint64} are set,
7201 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
7202 For @option{-mabi=32}, and @option{-mabi=n32}, ints and longs are 32 bits
7203 wide.  For @option{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
7204 For @option{-mabi=eabi} and either @option{-mips1} or @option{-mips2}, ints
7205 and longs are 32 bits wide.  For @option{-mabi=eabi} and higher ISAs, ints
7206 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
7207 the smaller of the width of longs or the width of general purpose
7208 registers (which in turn depends on the ISA)@.
7210 @item -mabi=32
7211 @itemx -mabi=o64
7212 @itemx -mabi=n32
7213 @itemx -mabi=64
7214 @itemx -mabi=eabi
7215 @opindex mabi=32
7216 @opindex mabi=o64
7217 @opindex mabi=n32
7218 @opindex mabi=64
7219 @opindex mabi=eabi
7220 Generate code for the indicated ABI@.  The default instruction level is
7221 @option{-mips1} for @samp{32}, @option{-mips3} for @samp{n32}, and
7222 @option{-mips4} otherwise.  Conversely, with @option{-mips1} or
7223 @option{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
7224 is @samp{64}.
7226 @item -mmips-as
7227 @opindex mmips-as
7228 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7229 add normal debug information.  This is the default for all
7230 platforms except for the OSF/1 reference platform, using the OSF/rose
7231 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7232 switches are used, the @file{mips-tfile} program will encapsulate the
7233 stabs within MIPS ECOFF@.
7235 @item -mgas
7236 @opindex mgas
7237 Generate code for the GNU assembler.  This is the default on the OSF/1
7238 reference platform, using the OSF/rose object format.  Also, this is
7239 the default if the configure option @option{--with-gnu-as} is used.
7241 @item -msplit-addresses
7242 @itemx -mno-split-addresses
7243 @opindex msplit-addresses
7244 @opindex mno-split-addresses
7245 Generate code to load the high and low parts of address constants separately.
7246 This allows GCC to optimize away redundant loads of the high order
7247 bits of addresses.  This optimization requires GNU as and GNU ld.
7248 This optimization is enabled by default for some embedded targets where
7249 GNU as and GNU ld are standard.
7251 @item -mrnames
7252 @itemx -mno-rnames
7253 @opindex mrnames
7254 @opindex mno-rnames
7255 The @option{-mrnames} switch says to output code using the MIPS software
7256 names for the registers, instead of the hardware names (ie, @var{a0}
7257 instead of @var{$4}).  The only known assembler that supports this option
7258 is the Algorithmics assembler.
7260 @item -mgpopt
7261 @itemx -mno-gpopt
7262 @opindex mgpopt
7263 @opindex mno-gpopt
7264 The @option{-mgpopt} switch says to write all of the data declarations
7265 before the instructions in the text section, this allows the MIPS
7266 assembler to generate one word memory references instead of using two
7267 words for short global or static data items.  This is on by default if
7268 optimization is selected.
7270 @item -mstats
7271 @itemx -mno-stats
7272 @opindex mstats
7273 @opindex mno-stats
7274 For each non-inline function processed, the @option{-mstats} switch
7275 causes the compiler to emit one line to the standard error file to
7276 print statistics about the program (number of registers saved, stack
7277 size, etc.).
7279 @item -mmemcpy
7280 @itemx -mno-memcpy
7281 @opindex mmemcpy
7282 @opindex mno-memcpy
7283 The @option{-mmemcpy} switch makes all block moves call the appropriate
7284 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7285 generating inline code.
7287 @item -mmips-tfile
7288 @itemx -mno-mips-tfile
7289 @opindex mmips-tfile
7290 @opindex mno-mips-tfile
7291 The @option{-mno-mips-tfile} switch causes the compiler not
7292 postprocess the object file with the @file{mips-tfile} program,
7293 after the MIPS assembler has generated it to add debug support.  If
7294 @file{mips-tfile} is not run, then no local variables will be
7295 available to the debugger.  In addition, @file{stage2} and
7296 @file{stage3} objects will have the temporary file names passed to the
7297 assembler embedded in the object file, which means the objects will
7298 not compare the same.  The @option{-mno-mips-tfile} switch should only
7299 be used when there are bugs in the @file{mips-tfile} program that
7300 prevents compilation.
7302 @item -msoft-float
7303 @opindex msoft-float
7304 Generate output containing library calls for floating point.
7305 @strong{Warning:} the requisite libraries are not part of GCC@.
7306 Normally the facilities of the machine's usual C compiler are used, but
7307 this can't be done directly in cross-compilation.  You must make your
7308 own arrangements to provide suitable library functions for
7309 cross-compilation.
7311 @item -mhard-float
7312 @opindex mhard-float
7313 Generate output containing floating point instructions.  This is the
7314 default if you use the unmodified sources.
7316 @item -mabicalls
7317 @itemx -mno-abicalls
7318 @opindex mabicalls
7319 @opindex mno-abicalls
7320 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7321 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7322 position independent code.
7324 @item -mlong-calls
7325 @itemx -mno-long-calls
7326 @opindex mlong-calls
7327 @opindex mno-long-calls
7328 Do all calls with the @samp{JALR} instruction, which requires
7329 loading up a function's address into a register before the call.
7330 You need to use this switch, if you call outside of the current
7331 512 megabyte segment to functions that are not through pointers.
7333 @item -mhalf-pic
7334 @itemx -mno-half-pic
7335 @opindex mhalf-pic
7336 @opindex mno-half-pic
7337 Put pointers to extern references into the data section and load them
7338 up, rather than put the references in the text section.
7340 @item -membedded-pic
7341 @itemx -mno-embedded-pic
7342 @opindex membedded-pic
7343 @opindex mno-embedded-pic
7344 Generate PIC code suitable for some embedded systems.  All calls are
7345 made using PC relative address, and all data is addressed using the $gp
7346 register.  No more than 65536 bytes of global data may be used.  This
7347 requires GNU as and GNU ld which do most of the work.  This currently
7348 only works on targets which use ECOFF; it does not work with ELF@.
7350 @item -membedded-data
7351 @itemx -mno-embedded-data
7352 @opindex membedded-data
7353 @opindex mno-embedded-data
7354 Allocate variables to the read-only data section first if possible, then
7355 next in the small data section if possible, otherwise in data.  This gives
7356 slightly slower code than the default, but reduces the amount of RAM required
7357 when executing, and thus may be preferred for some embedded systems.
7359 @item -muninit-const-in-rodata
7360 @itemx -mno-uninit-const-in-rodata
7361 @opindex muninit-const-in-rodata
7362 @opindex mno-uninit-const-in-rodata
7363 When used together with @option{-membedded-data}, it will always store uninitialized
7364 const variables in the read-only data section.
7366 @item -msingle-float
7367 @itemx -mdouble-float
7368 @opindex msingle-float
7369 @opindex mdouble-float
7370 The @option{-msingle-float} switch tells gcc to assume that the floating
7371 point coprocessor only supports single precision operations, as on the
7372 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7373 double precision operations.  This is the default.
7375 @item -mmad
7376 @itemx -mno-mad
7377 @opindex mmad
7378 @opindex mno-mad
7379 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7380 as on the @samp{r4650} chip.
7382 @item -m4650
7383 @opindex m4650
7384 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7385 @option{-mcpu=r4650}.
7387 @item -mips16
7388 @itemx -mno-mips16
7389 @opindex mips16
7390 @opindex mno-mips16
7391 Enable 16-bit instructions.
7393 @item -mentry
7394 @opindex mentry
7395 Use the entry and exit pseudo ops.  This option can only be used with
7396 @option{-mips16}.
7398 @item -EL
7399 @opindex EL
7400 Compile code for the processor in little endian mode.
7401 The requisite libraries are assumed to exist.
7403 @item -EB
7404 @opindex EB
7405 Compile code for the processor in big endian mode.
7406 The requisite libraries are assumed to exist.
7408 @item -G @var{num}
7409 @opindex G
7410 @cindex smaller data references (MIPS)
7411 @cindex gp-relative references (MIPS)
7412 Put global and static items less than or equal to @var{num} bytes into
7413 the small data or bss sections instead of the normal data or bss
7414 section.  This allows the assembler to emit one word memory reference
7415 instructions based on the global pointer (@var{gp} or @var{$28}),
7416 instead of the normal two words used.  By default, @var{num} is 8 when
7417 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7418 @option{-G @var{num}} switch is also passed to the assembler and linker.
7419 All modules should be compiled with the same @option{-G @var{num}}
7420 value.
7422 @item -nocpp
7423 @opindex nocpp
7424 Tell the MIPS assembler to not run its preprocessor over user
7425 assembler files (with a @samp{.s} suffix) when assembling them.
7427 @item -mfix7000
7428 @opindex mfix7000
7429 Pass an option to gas which will cause nops to be inserted if
7430 the read of the destination register of an mfhi or mflo instruction
7431 occurs in the following two instructions.
7433 @item -no-crt0
7434 @opindex no-crt0
7435 Do not include the default crt0.
7437 @item -mflush-func=@var{func}
7438 @itemx -mno-flush-func
7439 @opindex mflush-func
7440 Specifies the function to call to flush the I and D caches, or to not
7441 call any such function.  If called, the function must take the same
7442 arguments as the common @code{_flush_func()}, that is, the address of the
7443 memory range for which the cache is being flushed, the size of the
7444 memory range, and the number 3 (to flush both caches).  The default
7445 depends on the target gcc was configured for, but commonly is either
7446 @samp{_flush_func} or @samp{__cpu_flush}.
7447 @end table
7449 These options are defined by the macro
7450 @code{TARGET_SWITCHES} in the machine description.  The default for the
7451 options is also defined by that macro, which enables you to change the
7452 defaults.
7454 @node i386 and x86-64 Options
7455 @subsection Intel 386 and AMD x86-64 Options
7456 @cindex i386 Options
7457 @cindex x86-64 Options
7458 @cindex Intel 386 Options
7459 @cindex AMD x86-64 Options
7461 These @samp{-m} options are defined for the i386 and x86-64 family of
7462 computers:
7464 @table @gcctabopt
7465 @item -mcpu=@var{cpu-type}
7466 @opindex mcpu
7467 Tune to @var{cpu-type} everything applicable about the generated code, except
7468 for the ABI and the set of available instructions.  The choices for
7469 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
7470 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
7471 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
7472 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp}
7473 and @samp{athlon-mp}.
7475 While picking a specific @var{cpu-type} will schedule things appropriately
7476 for that particular chip, the compiler will not generate any code that
7477 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7478 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
7479 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
7480 AMD chips as opposed to the Intel ones.
7482 @item -march=@var{cpu-type}
7483 @opindex march
7484 Generate instructions for the machine type @var{cpu-type}.  The choices
7485 for @var{cpu-type} are the same as for @option{-mcpu}.  Moreover,
7486 specifying @option{-march=@var{cpu-type}} implies @option{-mcpu=@var{cpu-type}}.
7488 @item -m386
7489 @itemx -m486
7490 @itemx -mpentium
7491 @itemx -mpentiumpro
7492 @opindex m386
7493 @opindex m486
7494 @opindex mpentium
7495 @opindex mpentiumpro
7496 These options are synonyms for @option{-mcpu=i386}, @option{-mcpu=i486},
7497 @option{-mcpu=pentium}, and @option{-mcpu=pentiumpro} respectively.
7498 These synonyms are deprecated.
7500 @item -mfpmath=@var{unit}
7501 @opindex march
7502 generate floating point arithmetics for selected unit @var{unit}.  the choices
7503 for @var{unit} are:
7505 @table @samp
7506 @item 387
7507 Use the standard 387 floating point coprocessor present majority of chips and
7508 emulated otherwise.  Code compiled with this option will run almost everywhere.
7509 The temporary results are computed in 80bit precesion instead of precision
7510 specified by the type resulting in slightly different results compared to most
7511 of other chips. See @option{-ffloat-store} for more detailed description.
7513 This is the default choice for i386 compiler.
7515 @item sse
7516 Use scalar floating point instructions present in the SSE instruction set.
7517 This instruction set is supported by Pentium3 and newer chips, in the AMD line
7518 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
7519 instruction set supports only single precision arithmetics, thus the double and
7520 extended precision arithmetics is still done using 387.  Later version, present
7521 only in Pentium4 and the future AMD x86-64 chips supports double precision
7522 arithmetics too.
7524 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
7525 @option{-msse2} switches to enable SSE extensions and make this option
7526 effective.  For x86-64 compiler, these extensions are enabled by default.
7528 The resulting code should be considerably faster in majority of cases and avoid
7529 the numerical instability problems of 387 code, but may break some existing
7530 code that expects temporaries to be 80bit.
7532 This is the default choice for x86-64 compiler.
7534 @item sse,387
7535 Attempt to utilize both instruction sets at once.  This effectivly double the
7536 amount of available registers and on chips with separate execution units for
7537 387 and SSE the execution resources too.  Use this option with care, as it is
7538 still experimental, because gcc register allocator does not model separate
7539 functional units well resulting in instable performance.
7540 @end table
7542 @item -masm=@var{dialect}
7543 @opindex masm=@var{dialect}
7544 Output asm instructions using selected @var{dialect}. Supported choices are
7545 @samp{intel} or @samp{att} (the default one).
7547 @item -mieee-fp
7548 @itemx -mno-ieee-fp
7549 @opindex mieee-fp
7550 @opindex mno-ieee-fp
7551 Control whether or not the compiler uses IEEE floating point
7552 comparisons.  These handle correctly the case where the result of a
7553 comparison is unordered.
7555 @item -msoft-float
7556 @opindex msoft-float
7557 Generate output containing library calls for floating point.
7558 @strong{Warning:} the requisite libraries are not part of GCC@.
7559 Normally the facilities of the machine's usual C compiler are used, but
7560 this can't be done directly in cross-compilation.  You must make your
7561 own arrangements to provide suitable library functions for
7562 cross-compilation.
7564 On machines where a function returns floating point results in the 80387
7565 register stack, some floating point opcodes may be emitted even if
7566 @option{-msoft-float} is used.
7568 @item -mno-fp-ret-in-387
7569 @opindex mno-fp-ret-in-387
7570 Do not use the FPU registers for return values of functions.
7572 The usual calling convention has functions return values of types
7573 @code{float} and @code{double} in an FPU register, even if there
7574 is no FPU@.  The idea is that the operating system should emulate
7575 an FPU@.
7577 The option @option{-mno-fp-ret-in-387} causes such values to be returned
7578 in ordinary CPU registers instead.
7580 @item -mno-fancy-math-387
7581 @opindex mno-fancy-math-387
7582 Some 387 emulators do not support the @code{sin}, @code{cos} and
7583 @code{sqrt} instructions for the 387.  Specify this option to avoid
7584 generating those instructions.  This option is the default on FreeBSD@.
7585 As of revision 2.6.1, these instructions are not generated unless you
7586 also use the @option{-funsafe-math-optimizations} switch.
7588 @item -malign-double
7589 @itemx -mno-align-double
7590 @opindex malign-double
7591 @opindex mno-align-double
7592 Control whether GCC aligns @code{double}, @code{long double}, and
7593 @code{long long} variables on a two word boundary or a one word
7594 boundary.  Aligning @code{double} variables on a two word boundary will
7595 produce code that runs somewhat faster on a @samp{Pentium} at the
7596 expense of more memory.
7598 @item -m128bit-long-double
7599 @opindex m128bit-long-double
7600 Control the size of @code{long double} type. i386 application binary interface
7601 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
7602 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
7603 impossible to reach with 12 byte long doubles in the array accesses.
7605 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
7606 structures and arrays containing @code{long double} will change their size as
7607 well as function calling convention for function taking @code{long double}
7608 will be modified.
7610 @item -m96bit-long-double
7611 @opindex m96bit-long-double
7612 Set the size of @code{long double} to 96 bits as required by the i386
7613 application binary interface.  This is the default.
7615 @item -msvr3-shlib
7616 @itemx -mno-svr3-shlib
7617 @opindex msvr3-shlib
7618 @opindex mno-svr3-shlib
7619 Control whether GCC places uninitialized local variables into the
7620 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
7621 into @code{bss}.  These options are meaningful only on System V Release 3.
7623 @item -mrtd
7624 @opindex mrtd
7625 Use a different function-calling convention, in which functions that
7626 take a fixed number of arguments return with the @code{ret} @var{num}
7627 instruction, which pops their arguments while returning.  This saves one
7628 instruction in the caller since there is no need to pop the arguments
7629 there.
7631 You can specify that an individual function is called with this calling
7632 sequence with the function attribute @samp{stdcall}.  You can also
7633 override the @option{-mrtd} option by using the function attribute
7634 @samp{cdecl}.  @xref{Function Attributes}.
7636 @strong{Warning:} this calling convention is incompatible with the one
7637 normally used on Unix, so you cannot use it if you need to call
7638 libraries compiled with the Unix compiler.
7640 Also, you must provide function prototypes for all functions that
7641 take variable numbers of arguments (including @code{printf});
7642 otherwise incorrect code will be generated for calls to those
7643 functions.
7645 In addition, seriously incorrect code will result if you call a
7646 function with too many arguments.  (Normally, extra arguments are
7647 harmlessly ignored.)
7649 @item -mregparm=@var{num}
7650 @opindex mregparm
7651 Control how many registers are used to pass integer arguments.  By
7652 default, no registers are used to pass arguments, and at most 3
7653 registers can be used.  You can control this behavior for a specific
7654 function by using the function attribute @samp{regparm}.
7655 @xref{Function Attributes}.
7657 @strong{Warning:} if you use this switch, and
7658 @var{num} is nonzero, then you must build all modules with the same
7659 value, including any libraries.  This includes the system libraries and
7660 startup modules.
7662 @item -mpreferred-stack-boundary=@var{num}
7663 @opindex mpreferred-stack-boundary
7664 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
7665 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
7666 the default is 4 (16 bytes or 128 bits), except when optimizing for code
7667 size (@option{-Os}), in which case the default is the minimum correct
7668 alignment (4 bytes for x86, and 8 bytes for x86-64).
7670 On Pentium and PentiumPro, @code{double} and @code{long double} values
7671 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
7672 suffer significant run time performance penalties.  On Pentium III, the
7673 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
7674 penalties if it is not 16 byte aligned.
7676 To ensure proper alignment of this values on the stack, the stack boundary
7677 must be as aligned as that required by any value stored on the stack.
7678 Further, every function must be generated such that it keeps the stack
7679 aligned.  Thus calling a function compiled with a higher preferred
7680 stack boundary from a function compiled with a lower preferred stack
7681 boundary will most likely misalign the stack.  It is recommended that
7682 libraries that use callbacks always use the default setting.
7684 This extra alignment does consume extra stack space, and generally
7685 increases code size.  Code that is sensitive to stack space usage, such
7686 as embedded systems and operating system kernels, may want to reduce the
7687 preferred alignment to @option{-mpreferred-stack-boundary=2}.
7689 @item -mmmx
7690 @itemx -mno-mmx
7691 @item -msse
7692 @itemx -mno-sse
7693 @item -msse2
7694 @itemx -mno-sse2
7695 @item -m3dnow
7696 @itemx -mno-3dnow
7697 @opindex mmmx
7698 @opindex mno-mmx
7699 @opindex msse
7700 @opindex mno-sse
7701 @opindex m3dnow
7702 @opindex mno-3dnow
7703 These switches enable or disable the use of built-in functions that allow
7704 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
7706 The following machine modes are available for use with MMX built-in functions
7707 (@pxref{Vector Extensions}): @code{V2SI} for a vector of two 32 bit integers,
7708 @code{V4HI} for a vector of four 16 bit integers, and @code{V8QI} for a
7709 vector of eight 8 bit integers.  Some of the built-in functions operate on
7710 MMX registers as a whole 64 bit entity, these use @code{DI} as their mode.
7712 If 3Dnow extensions are enabled, @code{V2SF} is used as a mode for a vector
7713 of two 32 bit floating point values.
7715 If SSE extensions are enabled, @code{V4SF} is used for a vector of four 32 bit
7716 floating point values.  Some instructions use a vector of four 32 bit
7717 integers, these use @code{V4SI}.  Finally, some instructions operate on an
7718 entire vector register, interpreting it as a 128 bit integer, these use mode
7719 @code{TI}.
7721 The following built-in functions are made available by @option{-mmmx}:
7722 @table @code
7723 @item v8qi __builtin_ia32_paddb (v8qi, v8qi)
7724 Generates the @code{paddb} machine instruction.
7725 @item v4hi __builtin_ia32_paddw (v4hi, v4hi)
7726 Generates the @code{paddw} machine instruction.
7727 @item v2si __builtin_ia32_paddd (v2si, v2si)
7728 Generates the @code{paddd} machine instruction.
7729 @item v8qi __builtin_ia32_psubb (v8qi, v8qi)
7730 Generates the @code{psubb} machine instruction.
7731 @item v4hi __builtin_ia32_psubw (v4hi, v4hi)
7732 Generates the @code{psubw} machine instruction.
7733 @item v2si __builtin_ia32_psubd (v2si, v2si)
7734 Generates the @code{psubd} machine instruction.
7736 @item v8qi __builtin_ia32_paddsb (v8qi, v8qi)
7737 Generates the @code{paddsb} machine instruction.
7738 @item v4hi __builtin_ia32_paddsw (v4hi, v4hi)
7739 Generates the @code{paddsw} machine instruction.
7740 @item v8qi __builtin_ia32_psubsb (v8qi, v8qi)
7741 Generates the @code{psubsb} machine instruction.
7742 @item v4hi __builtin_ia32_psubsw (v4hi, v4hi)
7743 Generates the @code{psubsw} machine instruction.
7745 @item v8qi __builtin_ia32_paddusb (v8qi, v8qi)
7746 Generates the @code{paddusb} machine instruction.
7747 @item v4hi __builtin_ia32_paddusw (v4hi, v4hi)
7748 Generates the @code{paddusw} machine instruction.
7749 @item v8qi __builtin_ia32_psubusb (v8qi, v8qi)
7750 Generates the @code{psubusb} machine instruction.
7751 @item v4hi __builtin_ia32_psubusw (v4hi, v4hi)
7752 Generates the @code{psubusw} machine instruction.
7754 @item v4hi __builtin_ia32_pmullw (v4hi, v4hi)
7755 Generates the @code{pmullw} machine instruction.
7756 @item v4hi __builtin_ia32_pmulhw (v4hi, v4hi)
7757 Generates the @code{pmulhw} machine instruction.
7759 @item di __builtin_ia32_pand (di, di)
7760 Generates the @code{pand} machine instruction.
7761 @item di __builtin_ia32_pandn (di,di)
7762 Generates the @code{pandn} machine instruction.
7763 @item di __builtin_ia32_por (di, di)
7764 Generates the @code{por} machine instruction.
7765 @item di __builtin_ia32_pxor (di, di)
7766 Generates the @code{pxor} machine instruction.
7768 @item v8qi __builtin_ia32_pcmpeqb (v8qi, v8qi)
7769 Generates the @code{pcmpeqb} machine instruction.
7770 @item v4hi __builtin_ia32_pcmpeqw (v4hi, v4hi)
7771 Generates the @code{pcmpeqw} machine instruction.
7772 @item v2si __builtin_ia32_pcmpeqd (v2si, v2si)
7773 Generates the @code{pcmpeqd} machine instruction.
7774 @item v8qi __builtin_ia32_pcmpgtb (v8qi, v8qi)
7775 Generates the @code{pcmpgtb} machine instruction.
7776 @item v4hi __builtin_ia32_pcmpgtw (v4hi, v4hi)
7777 Generates the @code{pcmpgtw} machine instruction.
7778 @item v2si __builtin_ia32_pcmpgtd (v2si, v2si)
7779 Generates the @code{pcmpgtd} machine instruction.
7781 @item v8qi __builtin_ia32_punpckhbw (v8qi, v8qi)
7782 Generates the @code{punpckhbw} machine instruction.
7783 @item v4hi __builtin_ia32_punpckhwd (v4hi, v4hi)
7784 Generates the @code{punpckhwd} machine instruction.
7785 @item v2si __builtin_ia32_punpckhdq (v2si, v2si)
7786 Generates the @code{punpckhdq} machine instruction.
7787 @item v8qi __builtin_ia32_punpcklbw (v8qi, v8qi)
7788 Generates the @code{punpcklbw} machine instruction.
7789 @item v4hi __builtin_ia32_punpcklwd (v4hi, v4hi)
7790 Generates the @code{punpcklwd} machine instruction.
7791 @item v2si __builtin_ia32_punpckldq (v2si, v2si)
7792 Generates the @code{punpckldq} machine instruction.
7794 @item v8qi __builtin_ia32_packsswb (v4hi, v4hi)
7795 Generates the @code{packsswb} machine instruction.
7796 @item v4hi __builtin_ia32_packssdw (v2si, v2si)
7797 Generates the @code{packssdw} machine instruction.
7798 @item v8qi __builtin_ia32_packuswb (v4hi, v4hi)
7799 Generates the @code{packuswb} machine instruction.
7801 @end table
7803 The following built-in functions are made available either with @option{-msse}, or
7804 with a combination of @option{-m3dnow} and @option{-march=athlon}.
7805 @table @code
7807 @item v4hi __builtin_ia32_pmulhuw (v4hi, v4hi)
7808 Generates the @code{pmulhuw} machine instruction.
7810 @item v8qi __builtin_ia32_pavgb (v8qi, v8qi)
7811 Generates the @code{pavgb} machine instruction.
7812 @item v4hi __builtin_ia32_pavgw (v4hi, v4hi)
7813 Generates the @code{pavgw} machine instruction.
7814 @item v4hi __builtin_ia32_psadbw (v8qi, v8qi)
7815 Generates the @code{psadbw} machine instruction.
7817 @item v8qi __builtin_ia32_pmaxub (v8qi, v8qi)
7818 Generates the @code{pmaxub} machine instruction.
7819 @item v4hi __builtin_ia32_pmaxsw (v4hi, v4hi)
7820 Generates the @code{pmaxsw} machine instruction.
7821 @item v8qi __builtin_ia32_pminub (v8qi, v8qi)
7822 Generates the @code{pminub} machine instruction.
7823 @item v4hi __builtin_ia32_pminsw (v4hi, v4hi)
7824 Generates the @code{pminsw} machine instruction.
7826 @item int __builtin_ia32_pextrw (v4hi, int)
7827 Generates the @code{pextrw} machine instruction.
7828 @item v4hi __builtin_ia32_pinsrw (v4hi, int, int)
7829 Generates the @code{pinsrw} machine instruction.
7831 @item int __builtin_ia32_pmovmskb (v8qi)
7832 Generates the @code{pmovmskb} machine instruction.
7833 @item void __builtin_ia32_maskmovq (v8qi, v8qi, char *)
7834 Generates the @code{maskmovq} machine instruction.
7835 @item void __builtin_ia32_movntq (di *, di)
7836 Generates the @code{movntq} machine instruction.
7837 @item void __builtin_ia32_sfence (void)
7838 Generates the @code{sfence} machine instruction.
7839 @item void __builtin_ia32_prefetch (char *, int selector)
7840 Generates a prefetch machine instruction, depending on the value of
7841 selector.  If @code{selector} is 0, it generates @code{prefetchnta}; for
7842 a value of 1, it generates @code{prefetcht0}; for a value of 2, it generates
7843 @code{prefetcht1}; and for a value of 3 it generates @code{prefetcht2}.
7845 @end table
7847 The following built-in functions are available when @option{-msse} is used.
7849 @table @code
7850 @item int __builtin_ia32_comieq (v4sf, v4sf)
7851 Generates the @code{comiss} machine instruction and performs an equality
7852 comparison.  The return value is the truth value of that comparison.
7853 @item int __builtin_ia32_comineq (v4sf, v4sf)
7854 Generates the @code{comiss} machine instruction and performs an inequality
7855 comparison.  The return value is the truth value of that comparison.
7856 @item int __builtin_ia32_comilt (v4sf, v4sf)
7857 Generates the @code{comiss} machine instruction and performs a ``less than''
7858 comparison.  The return value is the truth value of that comparison.
7859 @item int __builtin_ia32_comile (v4sf, v4sf)
7860 Generates the @code{comiss} machine instruction and performs a ``less or
7861 equal'' comparison.  The return value is the truth value of that comparison.
7862 @item int __builtin_ia32_comigt (v4sf, v4sf)
7863 Generates the @code{comiss} machine instruction and performs a ``greater than''
7864 comparison.  The return value is the truth value of that comparison.
7865 @item int __builtin_ia32_comige (v4sf, v4sf)
7866 Generates the @code{comiss} machine instruction and performs a ``greater or
7867 equal'' comparison.  The return value is the truth value of that comparison.
7869 @item int __builtin_ia32_ucomieq (v4sf, v4sf)
7870 Generates the @code{ucomiss} machine instruction and performs an equality
7871 comparison.  The return value is the truth value of that comparison.
7872 @item int __builtin_ia32_ucomineq (v4sf, v4sf)
7873 Generates the @code{ucomiss} machine instruction and performs an inequality
7874 comparison.  The return value is the truth value of that comparison.
7875 @item int __builtin_ia32_ucomilt (v4sf, v4sf)
7876 Generates the @code{ucomiss} machine instruction and performs a ``less than''
7877 comparison.  The return value is the truth value of that comparison.
7878 @item int __builtin_ia32_ucomile (v4sf, v4sf)
7879 Generates the @code{ucomiss} machine instruction and performs a ``less or
7880 equal'' comparison.  The return value is the truth value of that comparison.
7881 @item int __builtin_ia32_ucomigt (v4sf, v4sf)
7882 Generates the @code{ucomiss} machine instruction and performs a ``greater than''
7883 comparison.  The return value is the truth value of that comparison.
7884 @item int __builtin_ia32_ucomige (v4sf, v4sf)
7885 Generates the @code{ucomiss} machine instruction and performs a ``greater or
7886 equal'' comparison.  The return value is the truth value of that comparison.
7888 @item v4sf __builtin_ia32_addps (v4sf, v4sf)
7889 Generates the @code{addps} machine instruction.
7890 @item v4sf __builtin_ia32_addss (v4sf, v4sf)
7891 Generates the @code{addss} machine instruction.
7892 @item v4sf __builtin_ia32_subps (v4sf, v4sf)
7893 Generates the @code{subps} machine instruction.
7894 @item v4sf __builtin_ia32_subss (v4sf, v4sf)
7895 Generates the @code{subss} machine instruction.
7896 @item v4sf __builtin_ia32_mulps (v4sf, v4sf)
7897 Generates the @code{mulps} machine instruction.
7898 @item v4sf __builtin_ia32_mulss (v4sf, v4sf)
7899 Generates the @code{mulss} machine instruction.
7900 @item v4sf __builtin_ia32_divps (v4sf, v4sf)
7901 Generates the @code{divps} machine instruction.
7902 @item v4sf __builtin_ia32_divss (v4sf, v4sf)
7903 Generates the @code{divss} machine instruction.
7905 @item v4si __builtin_ia32_cmpeqps (v4sf, v4sf)
7906 Generates the @code{cmpeqps} machine instruction.
7907 @item v4si __builtin_ia32_cmplts (v4sf, v4sf)
7908 Generates the @code{cmpltps} machine instruction.
7909 @item v4si __builtin_ia32_cmpleps (v4sf, v4sf)
7910 Generates the @code{cmpleps} machine instruction.
7911 @item v4si __builtin_ia32_cmpgtps (v4sf, v4sf)
7912 Generates the @code{cmpgtps} machine instruction.
7913 @item v4si __builtin_ia32_cmpgeps (v4sf, v4sf)
7914 Generates the @code{cmpgeps} machine instruction.
7915 @item v4si __builtin_ia32_cmpunordps (v4sf, v4sf)
7916 Generates the @code{cmpunodps} machine instruction.
7917 @item v4si __builtin_ia32_cmpneqps (v4sf, v4sf)
7918 Generates the @code{cmpeqps} machine instruction.
7919 @item v4si __builtin_ia32_cmpnltps (v4sf, v4sf)
7920 Generates the @code{cmpltps} machine instruction.
7921 @item v4si __builtin_ia32_cmpnleps (v4sf, v4sf)
7922 Generates the @code{cmpleps} machine instruction.
7923 @item v4si __builtin_ia32_cmpngtps (v4sf, v4sf)
7924 Generates the @code{cmpgtps} machine instruction.
7925 @item v4si __builtin_ia32_cmpngeps (v4sf, v4sf)
7926 Generates the @code{cmpgeps} machine instruction.
7927 @item v4si __builtin_ia32_cmpordps (v4sf, v4sf)
7928 Generates the @code{cmpunodps} machine instruction.
7930 @item v4si __builtin_ia32_cmpeqss (v4sf, v4sf)
7931 Generates the @code{cmpeqss} machine instruction.
7932 @item v4si __builtin_ia32_cmpltss (v4sf, v4sf)
7933 Generates the @code{cmpltss} machine instruction.
7934 @item v4si __builtin_ia32_cmpless (v4sf, v4sf)
7935 Generates the @code{cmpless} machine instruction.
7936 @item v4si __builtin_ia32_cmpgtss (v4sf, v4sf)
7937 Generates the @code{cmpgtss} machine instruction.
7938 @item v4si __builtin_ia32_cmpgess (v4sf, v4sf)
7939 Generates the @code{cmpgess} machine instruction.
7940 @item v4si __builtin_ia32_cmpunordss (v4sf, v4sf)
7941 Generates the @code{cmpunodss} machine instruction.
7942 @item v4si __builtin_ia32_cmpneqss (v4sf, v4sf)
7943 Generates the @code{cmpeqss} machine instruction.
7944 @item v4si __builtin_ia32_cmpnlts (v4sf, v4sf)
7945 Generates the @code{cmpltss} machine instruction.
7946 @item v4si __builtin_ia32_cmpnless (v4sf, v4sf)
7947 Generates the @code{cmpless} machine instruction.
7948 @item v4si __builtin_ia32_cmpngtss (v4sf, v4sf)
7949 Generates the @code{cmpgtss} machine instruction.
7950 @item v4si __builtin_ia32_cmpngess (v4sf, v4sf)
7951 Generates the @code{cmpgess} machine instruction.
7952 @item v4si __builtin_ia32_cmpordss (v4sf, v4sf)
7953 Generates the @code{cmpunodss} machine instruction.
7955 @item v4sf __builtin_ia32_maxps (v4sf, v4sf)
7956 Generates the @code{maxps} machine instruction.
7957 @item v4sf __builtin_ia32_maxsss (v4sf, v4sf)
7958 Generates the @code{maxss} machine instruction.
7959 @item v4sf __builtin_ia32_minps (v4sf, v4sf)
7960 Generates the @code{minps} machine instruction.
7961 @item v4sf __builtin_ia32_minsss (v4sf, v4sf)
7962 Generates the @code{minss} machine instruction.
7964 @item ti __builtin_ia32_andps (ti, ti)
7965 Generates the @code{andps} machine instruction.
7966 @item ti __builtin_ia32_andnps (ti, ti)
7967 Generates the @code{andnps} machine instruction.
7968 @item ti __builtin_ia32_orps (ti, ti)
7969 Generates the @code{orps} machine instruction.
7970 @item ti __builtin_ia32_xorps (ti, ti)
7971 Generates the @code{xorps} machine instruction.
7973 @item v4sf __builtin_ia32_movps (v4sf, v4sf)
7974 Generates the @code{movps} machine instruction.
7975 @item v4sf __builtin_ia32_movhlps (v4sf, v4sf)
7976 Generates the @code{movhlps} machine instruction.
7977 @item v4sf __builtin_ia32_movlhps (v4sf, v4sf)
7978 Generates the @code{movlhps} machine instruction.
7979 @item v4sf __builtin_ia32_unpckhps (v4sf, v4sf)
7980 Generates the @code{unpckhps} machine instruction.
7981 @item v4sf __builtin_ia32_unpcklps (v4sf, v4sf)
7982 Generates the @code{unpcklps} machine instruction.
7984 @item v4sf __builtin_ia32_cvtpi2ps (v4sf, v2si)
7985 Generates the @code{cvtpi2ps} machine instruction.
7986 @item v2si __builtin_ia32_cvtps2pi (v4sf)
7987 Generates the @code{cvtps2pi} machine instruction.
7988 @item v4sf __builtin_ia32_cvtsi2ss (v4sf, int)
7989 Generates the @code{cvtsi2ss} machine instruction.
7990 @item int __builtin_ia32_cvtss2si (v4sf)
7991 Generates the @code{cvtsi2ss} machine instruction.
7992 @item v2si __builtin_ia32_cvttps2pi (v4sf)
7993 Generates the @code{cvttps2pi} machine instruction.
7994 @item int __builtin_ia32_cvttss2si (v4sf)
7995 Generates the @code{cvttsi2ss} machine instruction.
7997 @item v4sf __builtin_ia32_rcpps (v4sf)
7998 Generates the @code{rcpps} machine instruction.
7999 @item v4sf __builtin_ia32_rsqrtps (v4sf)
8000 Generates the @code{rsqrtps} machine instruction.
8001 @item v4sf __builtin_ia32_sqrtps (v4sf)
8002 Generates the @code{sqrtps} machine instruction.
8003 @item v4sf __builtin_ia32_rcpss (v4sf)
8004 Generates the @code{rcpss} machine instruction.
8005 @item v4sf __builtin_ia32_rsqrtss (v4sf)
8006 Generates the @code{rsqrtss} machine instruction.
8007 @item v4sf __builtin_ia32_sqrtss (v4sf)
8008 Generates the @code{sqrtss} machine instruction.
8010 @item v4sf __builtin_ia32_shufps (v4sf, v4sf, int)
8011 Generates the @code{shufps} machine instruction.
8013 @item v4sf __builtin_ia32_loadaps (float *)
8014 Generates the @code{movaps} machine instruction as a load from memory.
8015 @item void __builtin_ia32_storeaps (float *, v4sf)
8016 Generates the @code{movaps} machine instruction as a store to memory.
8017 @item v4sf __builtin_ia32_loadups (float *)
8018 Generates the @code{movups} machine instruction as a load from memory.
8019 @item void __builtin_ia32_storeups (float *, v4sf)
8020 Generates the @code{movups} machine instruction as a store to memory.
8021 @item v4sf __builtin_ia32_loadsss (float *)
8022 Generates the @code{movss} machine instruction as a load from memory.
8023 @item void __builtin_ia32_storess (float *, v4sf)
8024 Generates the @code{movss} machine instruction as a store to memory.
8026 @item v4sf __builtin_ia32_loadhps (v4sf, v2si *)
8027 Generates the @code{movhps} machine instruction as a load from memory.
8028 @item v4sf __builtin_ia32_loadlps (v4sf, v2si *)
8029 Generates the @code{movlps} machine instruction as a load from memory
8030 @item void __builtin_ia32_storehps (v4sf, v2si *)
8031 Generates the @code{movhps} machine instruction as a store to memory.
8032 @item void __builtin_ia32_storelps (v4sf, v2si *)
8033 Generates the @code{movlps} machine instruction as a store to memory.
8035 @item void __builtin_ia32_movntps (float *, v4sf)
8036 Generates the @code{movntps} machine instruction.
8037 @item int __builtin_ia32_movmskps (v4sf)
8038 Generates the @code{movntps} machine instruction.
8040 @item void __builtin_ia32_storeps1 (float *, v4sf)
8041 Generates the @code{movaps} machine instruction as a store to memory.
8042 Before storing, the value is modified with a @code{shufps} instruction
8043 so that the lowest of the four floating point elements is replicated
8044 across the entire vector that is stored.
8045 @item void __builtin_ia32_storerps (float *, v4sf)
8046 Generates the @code{movaps} machine instruction as a store to memory.
8047 Before storing, the value is modified with a @code{shufps} instruction
8048 so that the order of the four floating point elements in the vector is
8049 reversed.
8050 @item v4sf __builtin_ia32_loadps1 (float *)
8051 Generates a @code{movss} machine instruction to load a floating point
8052 value from memory, and a @code{shufps} instruction to replicate the
8053 loaded value across all four elements of the result vector.
8054 @item v4sf __builtin_ia32_loadrps (float *)
8055 Generates a @code{movaps} machine instruction to load a vector from
8056 memory, and a @code{shufps} instruction to reverse the order of the
8057 four floating point elements in the result vector.
8058 @item v4sf __builtin_ia32_setps (float, float, float, float)
8059 Constructs a vector from four single floating point values.  The return
8060 value is equal to the value that would result from storing the four
8061 arguments into consecutive memory locations and then executing a
8062 @code{movaps} to load the vector from memory.
8063 @item v4sf __builtin_ia32_setps1 (float)
8064 Constructs a vector from a single floating point value by replicating
8065 it across all four elements of the result vector.
8066 @end table
8068 @item -mpush-args
8069 @itemx -mno-push-args
8070 @opindex mpush-args
8071 @opindex mno-push-args
8072 Use PUSH operations to store outgoing parameters.  This method is shorter
8073 and usually equally fast as method using SUB/MOV operations and is enabled
8074 by default.  In some cases disabling it may improve performance because of
8075 improved scheduling and reduced dependencies.
8077 @item -maccumulate-outgoing-args
8078 @opindex maccumulate-outgoing-args
8079 If enabled, the maximum amount of space required for outgoing arguments will be
8080 computed in the function prologue.  This is faster on most modern CPUs
8081 because of reduced dependencies, improved scheduling and reduced stack usage
8082 when preferred stack boundary is not equal to 2.  The drawback is a notable
8083 increase in code size.  This switch implies @option{-mno-push-args}.
8085 @item -mthreads
8086 @opindex mthreads
8087 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8088 on thread-safe exception handling must compile and link all code with the
8089 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8090 @option{-D_MT}; when linking, it links in a special thread helper library
8091 @option{-lmingwthrd} which cleans up per thread exception handling data.
8093 @item -mno-align-stringops
8094 @opindex mno-align-stringops
8095 Do not align destination of inlined string operations.  This switch reduces
8096 code size and improves performance in case the destination is already aligned,
8097 but gcc don't know about it.
8099 @item -minline-all-stringops
8100 @opindex minline-all-stringops
8101 By default GCC inlines string operations only when destination is known to be
8102 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8103 size, but may improve performance of code that depends on fast memcpy, strlen
8104 and memset for short lengths.
8106 @item -momit-leaf-frame-pointer
8107 @opindex momit-leaf-frame-pointer
8108 Don't keep the frame pointer in a register for leaf functions.  This
8109 avoids the instructions to save, set up and restore frame pointers and
8110 makes an extra register available in leaf functions.  The option
8111 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8112 which might make debugging harder.
8113 @end table
8115 These @samp{-m} switches are supported in addition to the above
8116 on AMD x86-64 processors in 64-bit environments.
8118 @table @gcctabopt
8119 @item -m32
8120 @itemx -m64
8121 @opindex m32
8122 @opindex m64
8123 Generate code for a 32-bit or 64-bit environment.
8124 The 32-bit environment sets int, long and pointer to 32 bits and
8125 generates code that runs on any i386 system.
8126 The 64-bit environment sets int to 32 bits and long and pointer
8127 to 64 bits and generates code for AMD's x86-64 architecture.
8129 @item -mno-red-zone
8130 @opindex no-red-zone
8131 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8132 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8133 stack pointer that will not be modified by signal or interrupt handlers
8134 and therefore can be used for temporary data without adjusting the stack
8135 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8136 @end table
8138 @node HPPA Options
8139 @subsection HPPA Options
8140 @cindex HPPA Options
8142 These @samp{-m} options are defined for the HPPA family of computers:
8144 @table @gcctabopt
8145 @item -march=@var{architecture-type}
8146 @opindex march
8147 Generate code for the specified architecture.  The choices for
8148 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8149 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8150 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8151 architecture option for your machine.  Code compiled for lower numbered
8152 architectures will run on higher numbered architectures, but not the
8153 other way around.
8155 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8156 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8157 support.
8159 @item -mpa-risc-1-0
8160 @itemx -mpa-risc-1-1
8161 @itemx -mpa-risc-2-0
8162 @opindex mpa-risc-1-0
8163 @opindex mpa-risc-1-1
8164 @opindex mpa-risc-2-0
8165 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8167 @item -mbig-switch
8168 @opindex mbig-switch
8169 Generate code suitable for big switch tables.  Use this option only if
8170 the assembler/linker complain about out of range branches within a switch
8171 table.
8173 @item -mjump-in-delay
8174 @opindex mjump-in-delay
8175 Fill delay slots of function calls with unconditional jump instructions
8176 by modifying the return pointer for the function call to be the target
8177 of the conditional jump.
8179 @item -mdisable-fpregs
8180 @opindex mdisable-fpregs
8181 Prevent floating point registers from being used in any manner.  This is
8182 necessary for compiling kernels which perform lazy context switching of
8183 floating point registers.  If you use this option and attempt to perform
8184 floating point operations, the compiler will abort.
8186 @item -mdisable-indexing
8187 @opindex mdisable-indexing
8188 Prevent the compiler from using indexing address modes.  This avoids some
8189 rather obscure problems when compiling MIG generated code under MACH@.
8191 @item -mno-space-regs
8192 @opindex mno-space-regs
8193 Generate code that assumes the target has no space registers.  This allows
8194 GCC to generate faster indirect calls and use unscaled index address modes.
8196 Such code is suitable for level 0 PA systems and kernels.
8198 @item -mfast-indirect-calls
8199 @opindex mfast-indirect-calls
8200 Generate code that assumes calls never cross space boundaries.  This
8201 allows GCC to emit code which performs faster indirect calls.
8203 This option will not work in the presence of shared libraries or nested
8204 functions.
8206 @item -mlong-load-store
8207 @opindex mlong-load-store
8208 Generate 3-instruction load and store sequences as sometimes required by
8209 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8210 the HP compilers.
8212 @item -mportable-runtime
8213 @opindex mportable-runtime
8214 Use the portable calling conventions proposed by HP for ELF systems.
8216 @item -mgas
8217 @opindex mgas
8218 Enable the use of assembler directives only GAS understands.
8220 @item -mschedule=@var{cpu-type}
8221 @opindex mschedule
8222 Schedule code according to the constraints for the machine type
8223 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8224 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to
8225 @file{/usr/lib/sched.models} on an HP-UX system to determine the
8226 proper scheduling option for your machine.
8228 @item -mlinker-opt
8229 @opindex mlinker-opt
8230 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
8231 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
8232 in which they give bogus error messages when linking some programs.
8234 @item -msoft-float
8235 @opindex msoft-float
8236 Generate output containing library calls for floating point.
8237 @strong{Warning:} the requisite libraries are not available for all HPPA
8238 targets.  Normally the facilities of the machine's usual C compiler are
8239 used, but this cannot be done directly in cross-compilation.  You must make
8240 your own arrangements to provide suitable library functions for
8241 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8242 does provide software floating point support.
8244 @option{-msoft-float} changes the calling convention in the output file;
8245 therefore, it is only useful if you compile @emph{all} of a program with
8246 this option.  In particular, you need to compile @file{libgcc.a}, the
8247 library that comes with GCC, with @option{-msoft-float} in order for
8248 this to work.
8249 @end table
8251 @node Intel 960 Options
8252 @subsection Intel 960 Options
8254 These @samp{-m} options are defined for the Intel 960 implementations:
8256 @table @gcctabopt
8257 @item -m@var{cpu-type}
8258 @opindex mka
8259 @opindex mkb
8260 @opindex mmc
8261 @opindex mca
8262 @opindex mcf
8263 @opindex msa
8264 @opindex msb
8265 Assume the defaults for the machine type @var{cpu-type} for some of
8266 the other options, including instruction scheduling, floating point
8267 support, and addressing modes.  The choices for @var{cpu-type} are
8268 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8269 @samp{sa}, and @samp{sb}.
8270 The default is
8271 @samp{kb}.
8273 @item -mnumerics
8274 @itemx -msoft-float
8275 @opindex mnumerics
8276 @opindex msoft-float
8277 The @option{-mnumerics} option indicates that the processor does support
8278 floating-point instructions.  The @option{-msoft-float} option indicates
8279 that floating-point support should not be assumed.
8281 @item -mleaf-procedures
8282 @itemx -mno-leaf-procedures
8283 @opindex mleaf-procedures
8284 @opindex mno-leaf-procedures
8285 Do (or do not) attempt to alter leaf procedures to be callable with the
8286 @code{bal} instruction as well as @code{call}.  This will result in more
8287 efficient code for explicit calls when the @code{bal} instruction can be
8288 substituted by the assembler or linker, but less efficient code in other
8289 cases, such as calls via function pointers, or using a linker that doesn't
8290 support this optimization.
8292 @item -mtail-call
8293 @itemx -mno-tail-call
8294 @opindex mtail-call
8295 @opindex mno-tail-call
8296 Do (or do not) make additional attempts (beyond those of the
8297 machine-independent portions of the compiler) to optimize tail-recursive
8298 calls into branches.  You may not want to do this because the detection of
8299 cases where this is not valid is not totally complete.  The default is
8300 @option{-mno-tail-call}.
8302 @item -mcomplex-addr
8303 @itemx -mno-complex-addr
8304 @opindex mcomplex-addr
8305 @opindex mno-complex-addr
8306 Assume (or do not assume) that the use of a complex addressing mode is a
8307 win on this implementation of the i960.  Complex addressing modes may not
8308 be worthwhile on the K-series, but they definitely are on the C-series.
8309 The default is currently @option{-mcomplex-addr} for all processors except
8310 the CB and CC@.
8312 @item -mcode-align
8313 @itemx -mno-code-align
8314 @opindex mcode-align
8315 @opindex mno-code-align
8316 Align code to 8-byte boundaries for faster fetching (or don't bother).
8317 Currently turned on by default for C-series implementations only.
8319 @ignore
8320 @item -mclean-linkage
8321 @itemx -mno-clean-linkage
8322 @opindex mclean-linkage
8323 @opindex mno-clean-linkage
8324 These options are not fully implemented.
8325 @end ignore
8327 @item -mic-compat
8328 @itemx -mic2.0-compat
8329 @itemx -mic3.0-compat
8330 @opindex mic-compat
8331 @opindex mic2.0-compat
8332 @opindex mic3.0-compat
8333 Enable compatibility with iC960 v2.0 or v3.0.
8335 @item -masm-compat
8336 @itemx -mintel-asm
8337 @opindex masm-compat
8338 @opindex mintel-asm
8339 Enable compatibility with the iC960 assembler.
8341 @item -mstrict-align
8342 @itemx -mno-strict-align
8343 @opindex mstrict-align
8344 @opindex mno-strict-align
8345 Do not permit (do permit) unaligned accesses.
8347 @item -mold-align
8348 @opindex mold-align
8349 Enable structure-alignment compatibility with Intel's gcc release version
8350 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8352 @item -mlong-double-64
8353 @opindex mlong-double-64
8354 Implement type @samp{long double} as 64-bit floating point numbers.
8355 Without the option @samp{long double} is implemented by 80-bit
8356 floating point numbers.  The only reason we have it because there is
8357 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8358 is only useful for people using soft-float targets.  Otherwise, we
8359 should recommend against use of it.
8361 @end table
8363 @node DEC Alpha Options
8364 @subsection DEC Alpha Options
8366 These @samp{-m} options are defined for the DEC Alpha implementations:
8368 @table @gcctabopt
8369 @item -mno-soft-float
8370 @itemx -msoft-float
8371 @opindex mno-soft-float
8372 @opindex msoft-float
8373 Use (do not use) the hardware floating-point instructions for
8374 floating-point operations.  When @option{-msoft-float} is specified,
8375 functions in @file{libgcc.a} will be used to perform floating-point
8376 operations.  Unless they are replaced by routines that emulate the
8377 floating-point operations, or compiled in such a way as to call such
8378 emulations routines, these routines will issue floating-point
8379 operations.   If you are compiling for an Alpha without floating-point
8380 operations, you must ensure that the library is built so as not to call
8381 them.
8383 Note that Alpha implementations without floating-point operations are
8384 required to have floating-point registers.
8386 @item -mfp-reg
8387 @itemx -mno-fp-regs
8388 @opindex mfp-reg
8389 @opindex mno-fp-regs
8390 Generate code that uses (does not use) the floating-point register set.
8391 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8392 register set is not used, floating point operands are passed in integer
8393 registers as if they were integers and floating-point results are passed
8394 in $0 instead of $f0.  This is a non-standard calling sequence, so any
8395 function with a floating-point argument or return value called by code
8396 compiled with @option{-mno-fp-regs} must also be compiled with that
8397 option.
8399 A typical use of this option is building a kernel that does not use,
8400 and hence need not save and restore, any floating-point registers.
8402 @item -mieee
8403 @opindex mieee
8404 The Alpha architecture implements floating-point hardware optimized for
8405 maximum performance.  It is mostly compliant with the IEEE floating
8406 point standard.  However, for full compliance, software assistance is
8407 required.  This option generates code fully IEEE compliant code
8408 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8409 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8410 defined during compilation.  The resulting code is less efficient but is
8411 able to correctly support denormalized numbers and exceptional IEEE
8412 values such as not-a-number and plus/minus infinity.  Other Alpha
8413 compilers call this option @option{-ieee_with_no_inexact}.
8415 @item -mieee-with-inexact
8416 @opindex mieee-with-inexact
8417 This is like @option{-mieee} except the generated code also maintains
8418 the IEEE @var{inexact-flag}.  Turning on this option causes the
8419 generated code to implement fully-compliant IEEE math.  In addition to
8420 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8421 macro.  On some Alpha implementations the resulting code may execute
8422 significantly slower than the code generated by default.  Since there is
8423 very little code that depends on the @var{inexact-flag}, you should
8424 normally not specify this option.  Other Alpha compilers call this
8425 option @option{-ieee_with_inexact}.
8427 @item -mfp-trap-mode=@var{trap-mode}
8428 @opindex mfp-trap-mode
8429 This option controls what floating-point related traps are enabled.
8430 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8431 The trap mode can be set to one of four values:
8433 @table @samp
8434 @item n
8435 This is the default (normal) setting.  The only traps that are enabled
8436 are the ones that cannot be disabled in software (e.g., division by zero
8437 trap).
8439 @item u
8440 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8441 as well.
8443 @item su
8444 Like @samp{su}, but the instructions are marked to be safe for software
8445 completion (see Alpha architecture manual for details).
8447 @item sui
8448 Like @samp{su}, but inexact traps are enabled as well.
8449 @end table
8451 @item -mfp-rounding-mode=@var{rounding-mode}
8452 @opindex mfp-rounding-mode
8453 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8454 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8457 @table @samp
8458 @item n
8459 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8460 the nearest machine number or towards the even machine number in case
8461 of a tie.
8463 @item m
8464 Round towards minus infinity.
8466 @item c
8467 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8469 @item d
8470 Dynamic rounding mode.  A field in the floating point control register
8471 (@var{fpcr}, see Alpha architecture reference manual) controls the
8472 rounding mode in effect.  The C library initializes this register for
8473 rounding towards plus infinity.  Thus, unless your program modifies the
8474 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8475 @end table
8477 @item -mtrap-precision=@var{trap-precision}
8478 @opindex mtrap-precision
8479 In the Alpha architecture, floating point traps are imprecise.  This
8480 means without software assistance it is impossible to recover from a
8481 floating trap and program execution normally needs to be terminated.
8482 GCC can generate code that can assist operating system trap handlers
8483 in determining the exact location that caused a floating point trap.
8484 Depending on the requirements of an application, different levels of
8485 precisions can be selected:
8487 @table @samp
8488 @item p
8489 Program precision.  This option is the default and means a trap handler
8490 can only identify which program caused a floating point exception.
8492 @item f
8493 Function precision.  The trap handler can determine the function that
8494 caused a floating point exception.
8496 @item i
8497 Instruction precision.  The trap handler can determine the exact
8498 instruction that caused a floating point exception.
8499 @end table
8501 Other Alpha compilers provide the equivalent options called
8502 @option{-scope_safe} and @option{-resumption_safe}.
8504 @item -mieee-conformant
8505 @opindex mieee-conformant
8506 This option marks the generated code as IEEE conformant.  You must not
8507 use this option unless you also specify @option{-mtrap-precision=i} and either
8508 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8509 is to emit the line @samp{.eflag 48} in the function prologue of the
8510 generated assembly file.  Under DEC Unix, this has the effect that
8511 IEEE-conformant math library routines will be linked in.
8513 @item -mbuild-constants
8514 @opindex mbuild-constants
8515 Normally GCC examines a 32- or 64-bit integer constant to
8516 see if it can construct it from smaller constants in two or three
8517 instructions.  If it cannot, it will output the constant as a literal and
8518 generate code to load it from the data segment at runtime.
8520 Use this option to require GCC to construct @emph{all} integer constants
8521 using code, even if it takes more instructions (the maximum is six).
8523 You would typically use this option to build a shared library dynamic
8524 loader.  Itself a shared library, it must relocate itself in memory
8525 before it can find the variables and constants in its own data segment.
8527 @item -malpha-as
8528 @itemx -mgas
8529 @opindex malpha-as
8530 @opindex mgas
8531 Select whether to generate code to be assembled by the vendor-supplied
8532 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8534 @item -mbwx
8535 @itemx -mno-bwx
8536 @itemx -mcix
8537 @itemx -mno-cix
8538 @itemx -mmax
8539 @itemx -mno-max
8540 @opindex mbwx
8541 @opindex mno-bwx
8542 @opindex mcix
8543 @opindex mno-cix
8544 @opindex mmax
8545 @opindex mno-max
8546 Indicate whether GCC should generate code to use the optional BWX,
8547 CIX, and MAX instruction sets.  The default is to use the instruction sets
8548 supported by the CPU type specified via @option{-mcpu=} option or that
8549 of the CPU on which GCC was built if none was specified.
8551 @item -mcpu=@var{cpu_type}
8552 @opindex mcpu
8553 Set the instruction set, register set, and instruction scheduling
8554 parameters for machine type @var{cpu_type}.  You can specify either the
8555 @samp{EV} style name or the corresponding chip number.  GCC
8556 supports scheduling parameters for the EV4 and EV5 family of processors
8557 and will choose the default values for the instruction set from
8558 the processor you specify.  If you do not specify a processor type,
8559 GCC will default to the processor on which the compiler was built.
8561 Supported values for @var{cpu_type} are
8563 @table @samp
8564 @item ev4
8565 @itemx 21064
8566 Schedules as an EV4 and has no instruction set extensions.
8568 @item ev5
8569 @itemx 21164
8570 Schedules as an EV5 and has no instruction set extensions.
8572 @item ev56
8573 @itemx 21164a
8574 Schedules as an EV5 and supports the BWX extension.
8576 @item pca56
8577 @itemx 21164pc
8578 @itemx 21164PC
8579 Schedules as an EV5 and supports the BWX and MAX extensions.
8581 @item ev6
8582 @itemx 21264
8583 Schedules as an EV5 (until Digital releases the scheduling parameters
8584 for the EV6) and supports the BWX, CIX, and MAX extensions.
8585 @end table
8587 @item -mmemory-latency=@var{time}
8588 @opindex mmemory-latency
8589 Sets the latency the scheduler should assume for typical memory
8590 references as seen by the application.  This number is highly
8591 dependent on the memory access patterns used by the application
8592 and the size of the external cache on the machine.
8594 Valid options for @var{time} are
8596 @table @samp
8597 @item @var{number}
8598 A decimal number representing clock cycles.
8600 @item L1
8601 @itemx L2
8602 @itemx L3
8603 @itemx main
8604 The compiler contains estimates of the number of clock cycles for
8605 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8606 (also called Dcache, Scache, and Bcache), as well as to main memory.
8607 Note that L3 is only valid for EV5.
8609 @end table
8610 @end table
8612 @node DEC Alpha/VMS Options
8613 @subsection DEC Alpha/VMS Options
8615 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8617 @table @gcctabopt
8618 @item -mvms-return-codes
8619 @opindex mvms-return-codes
8620 Return VMS condition codes from main.  The default is to return POSIX
8621 style condition (e.g.@ error) codes.
8622 @end table
8624 @node Clipper Options
8625 @subsection Clipper Options
8627 These @samp{-m} options are defined for the Clipper implementations:
8629 @table @gcctabopt
8630 @item -mc300
8631 @opindex mc300
8632 Produce code for a C300 Clipper processor.  This is the default.
8634 @item -mc400
8635 @opindex mc400
8636 Produce code for a C400 Clipper processor, i.e.@: use floating point
8637 registers f8--f15.
8638 @end table
8640 @node H8/300 Options
8641 @subsection H8/300 Options
8643 These @samp{-m} options are defined for the H8/300 implementations:
8645 @table @gcctabopt
8646 @item -mrelax
8647 @opindex mrelax
8648 Shorten some address references at link time, when possible; uses the
8649 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8650 ld.info, Using ld}, for a fuller description.
8652 @item -mh
8653 @opindex mh
8654 Generate code for the H8/300H@.
8656 @item -ms
8657 @opindex ms
8658 Generate code for the H8/S@.
8660 @item -ms2600
8661 @opindex ms2600
8662 Generate code for the H8/S2600.  This switch must be used with @option{-ms}.
8664 @item -mint32
8665 @opindex mint32
8666 Make @code{int} data 32 bits by default.
8668 @item -malign-300
8669 @opindex malign-300
8670 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
8671 The default for the H8/300H and H8/S is to align longs and floats on 4
8672 byte boundaries.
8673 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8674 This option has no effect on the H8/300.
8675 @end table
8677 @node SH Options
8678 @subsection SH Options
8680 These @samp{-m} options are defined for the SH implementations:
8682 @table @gcctabopt
8683 @item -m1
8684 @opindex m1
8685 Generate code for the SH1.
8687 @item -m2
8688 @opindex m2
8689 Generate code for the SH2.
8691 @item -m3
8692 @opindex m3
8693 Generate code for the SH3.
8695 @item -m3e
8696 @opindex m3e
8697 Generate code for the SH3e.
8699 @item -m4-nofpu
8700 @opindex m4-nofpu
8701 Generate code for the SH4 without a floating-point unit.
8703 @item -m4-single-only
8704 @opindex m4-single-only
8705 Generate code for the SH4 with a floating-point unit that only
8706 supports single-precision arithmetic.
8708 @item -m4-single
8709 @opindex m4-single
8710 Generate code for the SH4 assuming the floating-point unit is in
8711 single-precision mode by default.
8713 @item -m4
8714 @opindex m4
8715 Generate code for the SH4.
8717 @item -mb
8718 @opindex mb
8719 Compile code for the processor in big endian mode.
8721 @item -ml
8722 @opindex ml
8723 Compile code for the processor in little endian mode.
8725 @item -mdalign
8726 @opindex mdalign
8727 Align doubles at 64-bit boundaries.  Note that this changes the calling
8728 conventions, and thus some functions from the standard C library will
8729 not work unless you recompile it first with @option{-mdalign}.
8731 @item -mrelax
8732 @opindex mrelax
8733 Shorten some address references at link time, when possible; uses the
8734 linker option @option{-relax}.
8736 @item -mbigtable
8737 @opindex mbigtable
8738 Use 32-bit offsets in @code{switch} tables.  The default is to use
8739 16-bit offsets.
8741 @item -mfmovd
8742 @opindex mfmovd
8743 Enable the use of the instruction @code{fmovd}.
8745 @item -mhitachi
8746 @opindex mhitachi
8747 Comply with the calling conventions defined by Hitachi.
8749 @item -mnomacsave
8750 @opindex mnomacsave
8751 Mark the @code{MAC} register as call-clobbered, even if
8752 @option{-mhitachi} is given.
8754 @item -mieee
8755 @opindex mieee
8756 Increase IEEE-compliance of floating-point code.
8758 @item -misize
8759 @opindex misize
8760 Dump instruction size and location in the assembly code.
8762 @item -mpadstruct
8763 @opindex mpadstruct
8764 This option is deprecated.  It pads structures to multiple of 4 bytes,
8765 which is incompatible with the SH ABI@.
8767 @item -mspace
8768 @opindex mspace
8769 Optimize for space instead of speed.  Implied by @option{-Os}.
8771 @item -mprefergot
8772 @opindex mprefergot
8773 When generating position-independent code, emit function calls using
8774 the Global Offset Table instead of the Procedure Linkage Table.
8776 @item -musermode
8777 @opindex musermode
8778 Generate a library function call to invalidate instruction cache
8779 entries, after fixing up a trampoline.  This library function call
8780 doesn't assume it can write to the whole memory address space.  This
8781 is the default when the target is @code{sh-*-linux*}.
8782 @end table
8784 @node System V Options
8785 @subsection Options for System V
8787 These additional options are available on System V Release 4 for
8788 compatibility with other compilers on those systems:
8790 @table @gcctabopt
8791 @item -G
8792 @opindex G
8793 Create a shared object.
8794 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
8796 @item -Qy
8797 @opindex Qy
8798 Identify the versions of each tool used by the compiler, in a
8799 @code{.ident} assembler directive in the output.
8801 @item -Qn
8802 @opindex Qn
8803 Refrain from adding @code{.ident} directives to the output file (this is
8804 the default).
8806 @item -YP,@var{dirs}
8807 @opindex YP
8808 Search the directories @var{dirs}, and no others, for libraries
8809 specified with @option{-l}.
8811 @item -Ym,@var{dir}
8812 @opindex Ym
8813 Look in the directory @var{dir} to find the M4 preprocessor.
8814 The assembler uses this option.
8815 @c This is supposed to go with a -Yd for predefined M4 macro files, but
8816 @c the generic assembler that comes with Solaris takes just -Ym.
8817 @end table
8819 @node TMS320C3x/C4x Options
8820 @subsection TMS320C3x/C4x Options
8821 @cindex TMS320C3x/C4x Options
8823 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
8825 @table @gcctabopt
8827 @item -mcpu=@var{cpu_type}
8828 @opindex mcpu
8829 Set the instruction set, register set, and instruction scheduling
8830 parameters for machine type @var{cpu_type}.  Supported values for
8831 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
8832 @samp{c44}.  The default is @samp{c40} to generate code for the
8833 TMS320C40.
8835 @item -mbig-memory
8836 @item -mbig
8837 @itemx -msmall-memory
8838 @itemx -msmall
8839 @opindex mbig-memory
8840 @opindex mbig
8841 @opindex msmall-memory
8842 @opindex msmall
8843 Generates code for the big or small memory model.  The small memory
8844 model assumed that all data fits into one 64K word page.  At run-time
8845 the data page (DP) register must be set to point to the 64K page
8846 containing the .bss and .data program sections.  The big memory model is
8847 the default and requires reloading of the DP register for every direct
8848 memory access.
8850 @item -mbk
8851 @itemx -mno-bk
8852 @opindex mbk
8853 @opindex mno-bk
8854 Allow (disallow) allocation of general integer operands into the block
8855 count register BK@.
8857 @item -mdb
8858 @itemx -mno-db
8859 @opindex mdb
8860 @opindex mno-db
8861 Enable (disable) generation of code using decrement and branch,
8862 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
8863 on the safe side, this is disabled for the C3x, since the maximum
8864 iteration count on the C3x is @math{2^23 + 1} (but who iterates loops more than
8865 @math{2^23} times on the C3x?).  Note that GCC will try to reverse a loop so
8866 that it can utilise the decrement and branch instruction, but will give
8867 up if there is more than one memory reference in the loop.  Thus a loop
8868 where the loop counter is decremented can generate slightly more
8869 efficient code, in cases where the RPTB instruction cannot be utilised.
8871 @item -mdp-isr-reload
8872 @itemx -mparanoid
8873 @opindex mdp-isr-reload
8874 @opindex mparanoid
8875 Force the DP register to be saved on entry to an interrupt service
8876 routine (ISR), reloaded to point to the data section, and restored on
8877 exit from the ISR@.  This should not be required unless someone has
8878 violated the small memory model by modifying the DP register, say within
8879 an object library.
8881 @item -mmpyi
8882 @itemx -mno-mpyi
8883 @opindex mmpyi
8884 @opindex mno-mpyi
8885 For the C3x use the 24-bit MPYI instruction for integer multiplies
8886 instead of a library call to guarantee 32-bit results.  Note that if one
8887 of the operands is a constant, then the multiplication will be performed
8888 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
8889 then squaring operations are performed inline instead of a library call.
8891 @item -mfast-fix
8892 @itemx -mno-fast-fix
8893 @opindex mfast-fix
8894 @opindex mno-fast-fix
8895 The C3x/C4x FIX instruction to convert a floating point value to an
8896 integer value chooses the nearest integer less than or equal to the
8897 floating point value rather than to the nearest integer.  Thus if the
8898 floating point number is negative, the result will be incorrectly
8899 truncated an additional code is necessary to detect and correct this
8900 case.  This option can be used to disable generation of the additional
8901 code required to correct the result.
8903 @item -mrptb
8904 @itemx -mno-rptb
8905 @opindex mrptb
8906 @opindex mno-rptb
8907 Enable (disable) generation of repeat block sequences using the RPTB
8908 instruction for zero overhead looping.  The RPTB construct is only used
8909 for innermost loops that do not call functions or jump across the loop
8910 boundaries.  There is no advantage having nested RPTB loops due to the
8911 overhead required to save and restore the RC, RS, and RE registers.
8912 This is enabled by default with @option{-O2}.
8914 @item -mrpts=@var{count}
8915 @itemx -mno-rpts
8916 @opindex mrpts
8917 @opindex mno-rpts
8918 Enable (disable) the use of the single instruction repeat instruction
8919 RPTS@.  If a repeat block contains a single instruction, and the loop
8920 count can be guaranteed to be less than the value @var{count}, GCC will
8921 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
8922 then a RPTS will be emitted even if the loop count cannot be determined
8923 at compile time.  Note that the repeated instruction following RPTS does
8924 not have to be reloaded from memory each iteration, thus freeing up the
8925 CPU buses for operands.  However, since interrupts are blocked by this
8926 instruction, it is disabled by default.
8928 @item -mloop-unsigned
8929 @itemx -mno-loop-unsigned
8930 @opindex mloop-unsigned
8931 @opindex mno-loop-unsigned
8932 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
8933 is @math{2^31 + 1} since these instructions test if the iteration count is
8934 negative to terminate the loop.  If the iteration count is unsigned
8935 there is a possibility than the @math{2^31 + 1} maximum iteration count may be
8936 exceeded.  This switch allows an unsigned iteration count.
8938 @item -mti
8939 @opindex mti
8940 Try to emit an assembler syntax that the TI assembler (asm30) is happy
8941 with.  This also enforces compatibility with the API employed by the TI
8942 C3x C compiler.  For example, long doubles are passed as structures
8943 rather than in floating point registers.
8945 @item -mregparm
8946 @itemx -mmemparm
8947 @opindex mregparm
8948 @opindex mmemparm
8949 Generate code that uses registers (stack) for passing arguments to functions.
8950 By default, arguments are passed in registers where possible rather
8951 than by pushing arguments on to the stack.
8953 @item -mparallel-insns
8954 @itemx -mno-parallel-insns
8955 @opindex mparallel-insns
8956 @opindex mno-parallel-insns
8957 Allow the generation of parallel instructions.  This is enabled by
8958 default with @option{-O2}.
8960 @item -mparallel-mpy
8961 @itemx -mno-parallel-mpy
8962 @opindex mparallel-mpy
8963 @opindex mno-parallel-mpy
8964 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
8965 provided @option{-mparallel-insns} is also specified.  These instructions have
8966 tight register constraints which can pessimize the code generation
8967 of large functions.
8969 @end table
8971 @node V850 Options
8972 @subsection V850 Options
8973 @cindex V850 Options
8975 These @samp{-m} options are defined for V850 implementations:
8977 @table @gcctabopt
8978 @item -mlong-calls
8979 @itemx -mno-long-calls
8980 @opindex mlong-calls
8981 @opindex mno-long-calls
8982 Treat all calls as being far away (near).  If calls are assumed to be
8983 far away, the compiler will always load the functions address up into a
8984 register, and call indirect through the pointer.
8986 @item -mno-ep
8987 @itemx -mep
8988 @opindex mno-ep
8989 @opindex mep
8990 Do not optimize (do optimize) basic blocks that use the same index
8991 pointer 4 or more times to copy pointer into the @code{ep} register, and
8992 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
8993 option is on by default if you optimize.
8995 @item -mno-prolog-function
8996 @itemx -mprolog-function
8997 @opindex mno-prolog-function
8998 @opindex mprolog-function
8999 Do not use (do use) external functions to save and restore registers at
9000 the prolog and epilog of a function.  The external functions are slower,
9001 but use less code space if more than one function saves the same number
9002 of registers.  The @option{-mprolog-function} option is on by default if
9003 you optimize.
9005 @item -mspace
9006 @opindex mspace
9007 Try to make the code as small as possible.  At present, this just turns
9008 on the @option{-mep} and @option{-mprolog-function} options.
9010 @item -mtda=@var{n}
9011 @opindex mtda
9012 Put static or global variables whose size is @var{n} bytes or less into
9013 the tiny data area that register @code{ep} points to.  The tiny data
9014 area can hold up to 256 bytes in total (128 bytes for byte references).
9016 @item -msda=@var{n}
9017 @opindex msda
9018 Put static or global variables whose size is @var{n} bytes or less into
9019 the small data area that register @code{gp} points to.  The small data
9020 area can hold up to 64 kilobytes.
9022 @item -mzda=@var{n}
9023 @opindex mzda
9024 Put static or global variables whose size is @var{n} bytes or less into
9025 the first 32 kilobytes of memory.
9027 @item -mv850
9028 @opindex mv850
9029 Specify that the target processor is the V850.
9031 @item -mbig-switch
9032 @opindex mbig-switch
9033 Generate code suitable for big switch tables.  Use this option only if
9034 the assembler/linker complain about out of range branches within a switch
9035 table.
9036 @end table
9038 @node ARC Options
9039 @subsection ARC Options
9040 @cindex ARC Options
9042 These options are defined for ARC implementations:
9044 @table @gcctabopt
9045 @item -EL
9046 @opindex EL
9047 Compile code for little endian mode.  This is the default.
9049 @item -EB
9050 @opindex EB
9051 Compile code for big endian mode.
9053 @item -mmangle-cpu
9054 @opindex mmangle-cpu
9055 Prepend the name of the cpu to all public symbol names.
9056 In multiple-processor systems, there are many ARC variants with different
9057 instruction and register set characteristics.  This flag prevents code
9058 compiled for one cpu to be linked with code compiled for another.
9059 No facility exists for handling variants that are ``almost identical''.
9060 This is an all or nothing option.
9062 @item -mcpu=@var{cpu}
9063 @opindex mcpu
9064 Compile code for ARC variant @var{cpu}.
9065 Which variants are supported depend on the configuration.
9066 All variants support @option{-mcpu=base}, this is the default.
9068 @item -mtext=@var{text-section}
9069 @itemx -mdata=@var{data-section}
9070 @itemx -mrodata=@var{readonly-data-section}
9071 @opindex mtext
9072 @opindex mdata
9073 @opindex mrodata
9074 Put functions, data, and readonly data in @var{text-section},
9075 @var{data-section}, and @var{readonly-data-section} respectively
9076 by default.  This can be overridden with the @code{section} attribute.
9077 @xref{Variable Attributes}.
9079 @end table
9081 @node NS32K Options
9082 @subsection NS32K Options
9083 @cindex NS32K options
9085 These are the @samp{-m} options defined for the 32000 series.  The default
9086 values for these options depends on which style of 32000 was selected when
9087 the compiler was configured; the defaults for the most common choices are
9088 given below.
9090 @table @gcctabopt
9091 @item -m32032
9092 @itemx -m32032
9093 @opindex m32032
9094 @opindex m32032
9095 Generate output for a 32032.  This is the default
9096 when the compiler is configured for 32032 and 32016 based systems.
9098 @item -m32332
9099 @itemx -m32332
9100 @opindex m32332
9101 @opindex m32332
9102 Generate output for a 32332.  This is the default
9103 when the compiler is configured for 32332-based systems.
9105 @item -m32532
9106 @itemx -m32532
9107 @opindex m32532
9108 @opindex m32532
9109 Generate output for a 32532.  This is the default
9110 when the compiler is configured for 32532-based systems.
9112 @item -m32081
9113 @opindex m32081
9114 Generate output containing 32081 instructions for floating point.
9115 This is the default for all systems.
9117 @item -m32381
9118 @opindex m32381
9119 Generate output containing 32381 instructions for floating point.  This
9120 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9121 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9123 @item -mmulti-add
9124 @opindex mmulti-add
9125 Try and generate multiply-add floating point instructions @code{polyF}
9126 and @code{dotF}.  This option is only available if the @option{-m32381}
9127 option is in effect.  Using these instructions requires changes to
9128 register allocation which generally has a negative impact on
9129 performance.  This option should only be enabled when compiling code
9130 particularly likely to make heavy use of multiply-add instructions.
9132 @item -mnomulti-add
9133 @opindex mnomulti-add
9134 Do not try and generate multiply-add floating point instructions
9135 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9137 @item -msoft-float
9138 @opindex msoft-float
9139 Generate output containing library calls for floating point.
9140 @strong{Warning:} the requisite libraries may not be available.
9142 @item -mnobitfield
9143 @opindex mnobitfield
9144 Do not use the bit-field instructions.  On some machines it is faster to
9145 use shifting and masking operations.  This is the default for the pc532.
9147 @item -mbitfield
9148 @opindex mbitfield
9149 Do use the bit-field instructions.  This is the default for all platforms
9150 except the pc532.
9152 @item -mrtd
9153 @opindex mrtd
9154 Use a different function-calling convention, in which functions
9155 that take a fixed number of arguments return pop their
9156 arguments on return with the @code{ret} instruction.
9158 This calling convention is incompatible with the one normally
9159 used on Unix, so you cannot use it if you need to call libraries
9160 compiled with the Unix compiler.
9162 Also, you must provide function prototypes for all functions that
9163 take variable numbers of arguments (including @code{printf});
9164 otherwise incorrect code will be generated for calls to those
9165 functions.
9167 In addition, seriously incorrect code will result if you call a
9168 function with too many arguments.  (Normally, extra arguments are
9169 harmlessly ignored.)
9171 This option takes its name from the 680x0 @code{rtd} instruction.
9174 @item -mregparam
9175 @opindex mregparam
9176 Use a different function-calling convention where the first two arguments
9177 are passed in registers.
9179 This calling convention is incompatible with the one normally
9180 used on Unix, so you cannot use it if you need to call libraries
9181 compiled with the Unix compiler.
9183 @item -mnoregparam
9184 @opindex mnoregparam
9185 Do not pass any arguments in registers.  This is the default for all
9186 targets.
9188 @item -msb
9189 @opindex msb
9190 It is OK to use the sb as an index register which is always loaded with
9191 zero.  This is the default for the pc532-netbsd target.
9193 @item -mnosb
9194 @opindex mnosb
9195 The sb register is not available for use or has not been initialized to
9196 zero by the run time system.  This is the default for all targets except
9197 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9198 @option{-fpic} is set.
9200 @item -mhimem
9201 @opindex mhimem
9202 Many ns32000 series addressing modes use displacements of up to 512MB@.
9203 If an address is above 512MB then displacements from zero can not be used.
9204 This option causes code to be generated which can be loaded above 512MB@.
9205 This may be useful for operating systems or ROM code.
9207 @item -mnohimem
9208 @opindex mnohimem
9209 Assume code will be loaded in the first 512MB of virtual address space.
9210 This is the default for all platforms.
9213 @end table
9215 @node AVR Options
9216 @subsection AVR Options
9217 @cindex AVR Options
9219 These options are defined for AVR implementations:
9221 @table @gcctabopt
9222 @item -mmcu=@var{mcu}
9223 @opindex mmcu
9224 Specify ATMEL AVR instruction set or MCU type.
9226 Instruction set avr1 is for the minimal AVR core, not supported by the C
9227 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9228 attiny11, attiny12, attiny15, attiny28).
9230 Instruction set avr2 (default) is for the classic AVR core with up to
9231 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9232 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9233 at90c8534, at90s8535).
9235 Instruction set avr3 is for the classic AVR core with up to 128K program
9236 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9238 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9239 memory space (MCU types: atmega8, atmega83, atmega85).
9241 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9242 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9243 atmega64, atmega128, at43usb355, at94k).
9245 @item -msize
9246 @opindex msize
9247 Output instruction sizes to the asm file.
9249 @item -minit-stack=@var{N}
9250 @opindex minit-stack
9251 Specify the initial stack address, which may be a symbol or numeric value,
9252 @samp{__stack} is the default.
9254 @item -mno-interrupts
9255 @opindex mno-interrupts
9256 Generated code is not compatible with hardware interrupts.
9257 Code size will be smaller.
9259 @item -mcall-prologues
9260 @opindex mcall-prologues
9261 Functions prologues/epilogues expanded as call to appropriate
9262 subroutines.  Code size will be smaller.
9264 @item -mno-tablejump
9265 @opindex mno-tablejump
9266 Do not generate tablejump insns which sometimes increase code size.
9268 @item -mtiny-stack
9269 @opindex mtiny-stack
9270 Change only the low 8 bits of the stack pointer.
9271 @end table
9273 @node MCore Options
9274 @subsection MCore Options
9275 @cindex MCore options
9277 These are the @samp{-m} options defined for the Motorola M*Core
9278 processors.
9280 @table @gcctabopt
9282 @item -mhardlit
9283 @itemx -mhardlit
9284 @itemx -mno-hardlit
9285 @opindex mhardlit
9286 @opindex mhardlit
9287 @opindex mno-hardlit
9288 Inline constants into the code stream if it can be done in two
9289 instructions or less.
9291 @item -mdiv
9292 @itemx -mdiv
9293 @itemx -mno-div
9294 @opindex mdiv
9295 @opindex mdiv
9296 @opindex mno-div
9297 Use the divide instruction.  (Enabled by default).
9299 @item -mrelax-immediate
9300 @itemx -mrelax-immediate
9301 @itemx -mno-relax-immediate
9302 @opindex mrelax-immediate
9303 @opindex mrelax-immediate
9304 @opindex mno-relax-immediate
9305 Allow arbitrary sized immediates in bit operations.
9307 @item -mwide-bitfields
9308 @itemx -mwide-bitfields
9309 @itemx -mno-wide-bitfields
9310 @opindex mwide-bitfields
9311 @opindex mwide-bitfields
9312 @opindex mno-wide-bitfields
9313 Always treat bit-fields as int-sized.
9315 @item -m4byte-functions
9316 @itemx -m4byte-functions
9317 @itemx -mno-4byte-functions
9318 @opindex m4byte-functions
9319 @opindex m4byte-functions
9320 @opindex mno-4byte-functions
9321 Force all functions to be aligned to a four byte boundary.
9323 @item -mcallgraph-data
9324 @itemx -mcallgraph-data
9325 @itemx -mno-callgraph-data
9326 @opindex mcallgraph-data
9327 @opindex mcallgraph-data
9328 @opindex mno-callgraph-data
9329 Emit callgraph information.
9331 @item -mslow-bytes
9332 @itemx -mslow-bytes
9333 @itemx -mno-slow-bytes
9334 @opindex mslow-bytes
9335 @opindex mslow-bytes
9336 @opindex mno-slow-bytes
9337 Prefer word access when reading byte quantities.
9339 @item -mlittle-endian
9340 @itemx -mlittle-endian
9341 @itemx -mbig-endian
9342 @opindex mlittle-endian
9343 @opindex mlittle-endian
9344 @opindex mbig-endian
9345 Generate code for a little endian target.
9347 @item -m210
9348 @itemx -m210
9349 @itemx -m340
9350 @opindex m210
9351 @opindex m210
9352 @opindex m340
9353 Generate code for the 210 processor.
9354 @end table
9356 @node IA-64 Options
9357 @subsection IA-64 Options
9358 @cindex IA-64 Options
9360 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9362 @table @gcctabopt
9363 @item -mbig-endian
9364 @opindex mbig-endian
9365 Generate code for a big endian target.  This is the default for HPUX@.
9367 @item -mlittle-endian
9368 @opindex mlittle-endian
9369 Generate code for a little endian target.  This is the default for AIX5
9370 and Linux.
9372 @item -mgnu-as
9373 @itemx -mno-gnu-as
9374 @opindex mgnu-as
9375 @opindex mno-gnu-as
9376 Generate (or don't) code for the GNU assembler.  This is the default.
9377 @c Also, this is the default if the configure option @option{--with-gnu-as}
9378 @c is used.
9380 @item -mgnu-ld
9381 @itemx -mno-gnu-ld
9382 @opindex mgnu-ld
9383 @opindex mno-gnu-ld
9384 Generate (or don't) code for the GNU linker.  This is the default.
9385 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9386 @c is used.
9388 @item -mno-pic
9389 @opindex mno-pic
9390 Generate code that does not use a global pointer register.  The result
9391 is not position independent code, and violates the IA-64 ABI@.
9393 @item -mvolatile-asm-stop
9394 @itemx -mno-volatile-asm-stop
9395 @opindex mvolatile-asm-stop
9396 @opindex mno-volatile-asm-stop
9397 Generate (or don't) a stop bit immediately before and after volatile asm
9398 statements.
9400 @item -mb-step
9401 @opindex mb-step
9402 Generate code that works around Itanium B step errata.
9404 @item -mregister-names
9405 @itemx -mno-register-names
9406 @opindex mregister-names
9407 @opindex mno-register-names
9408 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9409 the stacked registers.  This may make assembler output more readable.
9411 @item -mno-sdata
9412 @itemx -msdata
9413 @opindex mno-sdata
9414 @opindex msdata
9415 Disable (or enable) optimizations that use the small data section.  This may
9416 be useful for working around optimizer bugs.
9418 @item -mconstant-gp
9419 @opindex mconstant-gp
9420 Generate code that uses a single constant global pointer value.  This is
9421 useful when compiling kernel code.
9423 @item -mauto-pic
9424 @opindex mauto-pic
9425 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9426 This is useful when compiling firmware code.
9428 @item -minline-divide-min-latency
9429 @opindex minline-divide-min-latency
9430 Generate code for inline divides using the minimum latency algorithm.
9432 @item -minline-divide-max-throughput
9433 @opindex minline-divide-max-throughput
9434 Generate code for inline divides using the maximum throughput algorithm.
9436 @item -mno-dwarf2-asm
9437 @itemx -mdwarf2-asm
9438 @opindex mno-dwarf2-asm
9439 @opindex mdwarf2-asm
9440 Don't (or do) generate assembler code for the DWARF2 line number debugging
9441 info.  This may be useful when not using the GNU assembler.
9443 @item -mfixed-range=@var{register-range}
9444 @opindex mfixed-range
9445 Generate code treating the given register range as fixed registers.
9446 A fixed register is one that the register allocator can not use.  This is
9447 useful when compiling kernel code.  A register range is specified as
9448 two registers separated by a dash.  Multiple register ranges can be
9449 specified separated by a comma.
9450 @end table
9452 @node D30V Options
9453 @subsection D30V Options
9454 @cindex D30V Options
9456 These @samp{-m} options are defined for D30V implementations:
9458 @table @gcctabopt
9459 @item -mextmem
9460 @opindex mextmem
9461 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9462 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9463 memory, which starts at location @code{0x80000000}.
9465 @item -mextmemory
9466 @opindex mextmemory
9467 Same as the @option{-mextmem} switch.
9469 @item -monchip
9470 @opindex monchip
9471 Link the @samp{.text} section into onchip text memory, which starts at
9472 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9473 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9474 into onchip data memory, which starts at location @code{0x20000000}.
9476 @item -mno-asm-optimize
9477 @itemx -masm-optimize
9478 @opindex mno-asm-optimize
9479 @opindex masm-optimize
9480 Disable (enable) passing @option{-O} to the assembler when optimizing.
9481 The assembler uses the @option{-O} option to automatically parallelize
9482 adjacent short instructions where possible.
9484 @item -mbranch-cost=@var{n}
9485 @opindex mbranch-cost
9486 Increase the internal costs of branches to @var{n}.  Higher costs means
9487 that the compiler will issue more instructions to avoid doing a branch.
9488 The default is 2.
9490 @item -mcond-exec=@var{n}
9491 @opindex mcond-exec
9492 Specify the maximum number of conditionally executed instructions that
9493 replace a branch.  The default is 4.
9494 @end table
9496 @node S/390 and zSeries Options
9497 @subsection S/390 and zSeries Options
9498 @cindex S/390 and zSeries Options
9500 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9502 @table @gcctabopt
9503 @item -mhard-float
9504 @itemx -msoft-float
9505 @opindex mhard-float
9506 @opindex msoft-float
9507 Use (do not use) the hardware floating-point instructions and registers
9508 for floating-point operations.  When @option{-msoft-float} is specified,
9509 functions in @file{libgcc.a} will be used to perform floating-point
9510 operations.  When @option{-mhard-float} is specified, the compiler
9511 generates IEEE floating-point instructions.  This is the default.
9513 @item -mbackchain
9514 @itemx -mno-backchain
9515 @opindex mbackchain
9516 @opindex mno-backchain
9517 Generate (or do not generate) code which maintains an explicit 
9518 backchain within the stack frame that points to the caller's frame.
9519 This is currently needed to allow debugging.  The default is to
9520 generate the backchain.
9522 @item -msmall-exec
9523 @itemx -mno-small-exec
9524 @opindex msmall-exec
9525 @opindex mno-small-exec
9526 Generate (or do not generate) code using the @code{bras} instruction 
9527 to do subroutine calls. 
9528 This only works reliably if the total executable size does not
9529 exceed 64k.  The default is to use the @code{basr} instruction instead,
9530 which does not have this limitation.
9532 @item -m64
9533 @itemx -m31
9534 @opindex m64
9535 @opindex m31
9536 When @option{-m31} is specified, generate code compliant to the
9537 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9538 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9539 particular to generate 64-bit instructions.  For the @samp{s390}
9540 targets, the default is @option{-m31}, while the @samp{s390x} 
9541 targets default to @option{-m64}.
9543 @item -mmvcle
9544 @itemx -mno-mvcle
9545 @opindex mmvcle
9546 @opindex mno-mvcle
9547 Generate (or do not generate) code using the @code{mvcle} instruction 
9548 to perform block moves.  When @option{-mno-mvcle} is specifed,
9549 use a @code{mvc} loop instead.  This is the default.
9551 @item -mdebug
9552 @itemx -mno-debug
9553 @opindex mdebug
9554 @opindex mno-debug
9555 Print (or do not print) additional debug information when compiling.
9556 The default is to not print debug information.
9558 @end table
9560 @node CRIS Options
9561 @subsection CRIS Options
9562 @cindex CRIS Options
9564 These options are defined specifically for the CRIS ports.
9566 @table @gcctabopt
9567 @item -march=@var{architecture-type}
9568 @itemx -mcpu=@var{architecture-type}
9569 @opindex march
9570 @opindex mcpu
9571 Generate code for the specified architecture.  The choices for
9572 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9573 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
9574 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9575 @samp{v10}.
9577 @item -mtune=@var{architecture-type}
9578 @opindex mtune
9579 Tune to @var{architecture-type} everything applicable about the generated
9580 code, except for the ABI and the set of available instructions.  The
9581 choices for @var{architecture-type} are the same as for
9582 @option{-march=@var{architecture-type}}.
9584 @item -mmax-stack-frame=@var{n}
9585 @opindex mmax-stack-frame
9586 Warn when the stack frame of a function exceeds @var{n} bytes.
9588 @item -melinux-stacksize=@var{n}
9589 @opindex melinux-stacksize
9590 Only available with the @samp{cris-axis-aout} target.  Arranges for
9591 indications in the program to the kernel loader that the stack of the
9592 program should be set to @var{n} bytes.
9594 @item -metrax4
9595 @itemx -metrax100
9596 @opindex metrax4
9597 @opindex metrax100
9598 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9599 @option{-march=v3} and @option{-march=v8} respectively.
9601 @item -mpdebug
9602 @opindex mpdebug
9603 Enable CRIS-specific verbose debug-related information in the assembly
9604 code.  This option also has the effect to turn off the @samp{#NO_APP}
9605 formatted-code indicator to the assembler at the beginning of the
9606 assembly file.
9608 @item -mcc-init
9609 @opindex mcc-init
9610 Do not use condition-code results from previous instruction; always emit
9611 compare and test instructions before use of condition codes.
9613 @item -mno-side-effects
9614 @opindex mno-side-effects
9615 Do not emit instructions with side-effects in addressing modes other than
9616 post-increment.
9618 @item -mstack-align
9619 @itemx -mno-stack-align
9620 @itemx -mdata-align
9621 @itemx -mno-data-align
9622 @itemx -mconst-align
9623 @itemx -mno-const-align
9624 @opindex mstack-align
9625 @opindex mno-stack-align
9626 @opindex mdata-align
9627 @opindex mno-data-align
9628 @opindex mconst-align
9629 @opindex mno-const-align
9630 These options (no-options) arranges (eliminate arrangements) for the
9631 stack-frame, individual data and constants to be aligned for the maximum
9632 single data access size for the chosen CPU model.  The default is to
9633 arrange for 32-bit alignment.  ABI details such as structure layout are
9634 not affected by these options.
9636 @item -m32-bit
9637 @itemx -m16-bit
9638 @itemx -m8-bit
9639 @opindex m32-bit
9640 @opindex m16-bit
9641 @opindex m8-bit
9642 Similar to the stack- data- and const-align options above, these options
9643 arrange for stack-frame, writable data and constants to all be 32-bit,
9644 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9646 @item -mno-prologue-epilogue
9647 @itemx -mprologue-epilogue
9648 @opindex mno-prologue-epilogue
9649 @opindex mprologue-epilogue
9650 With @option{-mno-prologue-epilogue}, the normal function prologue and
9651 epilogue that sets up the stack-frame are omitted and no return
9652 instructions or return sequences are generated in the code.  Use this
9653 option only together with visual inspection of the compiled code: no
9654 warnings or errors are generated when call-saved registers must be saved,
9655 or storage for local variable needs to be allocated.
9657 @item -mno-gotplt
9658 @itemx -mgotplt
9659 @opindex mno-gotplt
9660 @opindex mgotplt
9661 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9662 instruction sequences that load addresses for functions from the PLT part
9663 of the GOT rather than (traditional on other architectures) calls to the
9664 PLT.  The default is @option{-mgotplt}.
9666 @item -maout
9667 @opindex maout
9668 Legacy no-op option only recognized with the cris-axis-aout target.
9670 @item -melf
9671 @opindex melf
9672 Legacy no-op option only recognized with the cris-axis-elf and
9673 cris-axis-linux-gnu targets.
9675 @item -melinux
9676 @opindex melinux
9677 Only recognized with the cris-axis-aout target, where it selects a
9678 GNU/linux-like multilib, include files and instruction set for
9679 @option{-march=v8}.
9681 @item -mlinux
9682 @opindex mlinux
9683 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9685 @item -sim
9686 @opindex sim
9687 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9688 to link with input-output functions from a simulator library.  Code,
9689 initialized data and zero-initialized data are allocated consecutively.
9691 @item -sim2
9692 @opindex sim2
9693 Like @option{-sim}, but pass linker options to locate initialized data at
9694 0x40000000 and zero-initialized data at 0x80000000.
9695 @end table
9697 @node MMIX Options
9698 @subsection MMIX Options
9699 @cindex MMIX Options
9701 These options are defined for the MMIX:
9703 @table @code
9704 @item -mlibfuncs
9705 @itemx -mno-libfuncs
9706 Specify that intrinsic library functions are being compiled, passing all
9707 values in registers, no matter the size.
9709 @item -mepsilon
9710 @itemx -mno-epsilon
9711 Generate floating-point comparison instructions that compare with respect
9712 to the @code{rE} epsilon register.
9714 @item -mabi=mmixware
9715 @itemx -mabi=gnu
9716 Generate code that passes function parameters and return values that (in
9717 the called function) are seen as registers @code{$0} and up, as opposed to
9718 the GNU ABI which uses global registers @code{$231} and up.
9720 @item -mzero-extend
9721 @itemx -mno-zero-extend
9722 When reading data from memory in sizes shorter than 64 bits, use (do not
9723 use) zero-extending load instructions by default, rather than
9724 sign-extending ones.
9726 @item -mknuthdiv
9727 @itemx -mno-knuthdiv
9728 Make the result of a division yielding a remainder have the same sign as
9729 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9730 remainder follows the sign of the dividend.  Both methods are
9731 arithmetically valid, the latter being almost exclusively used.
9733 @item -mtoplevel-symbols
9734 @itemx -mno-toplevel-symbols
9735 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9736 code can be used with the @code{PREFIX} assembly directive.
9738 @item -melf
9739 Generate an executable in the ELF format, rather than the default
9740 @samp{mmo} format used by the @command{mmix} simulator.
9742 @item -mbranch-predict
9743 @itemx -mno-branch-predict
9744 Use (do not use) the probable-branch instructions, when static branch
9745 prediction indicates a probable branch.
9747 @item -mreg-stack-fill-bug-workaround
9748 @itemx -mno-reg-stack-fill-bug-workaround
9749 Work around (do not work around) an inconsistency in the circular
9750 register stack mechanism in the @command{mmix} simulator, which
9751 causes entries in the register stack to not be flushed to memory if
9752 the instruction causing the fill-up is @code{PUSHJ} or @code{PUSHGO}.
9753 @end table
9755 @node Code Gen Options
9756 @section Options for Code Generation Conventions
9757 @cindex code generation conventions
9758 @cindex options, code generation
9759 @cindex run-time options
9761 These machine-independent options control the interface conventions
9762 used in code generation.
9764 Most of them have both positive and negative forms; the negative form
9765 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
9766 one of the forms is listed---the one which is not the default.  You
9767 can figure out the other form by either removing @samp{no-} or adding
9770 @table @gcctabopt
9771 @item -fexceptions
9772 @opindex fexceptions
9773 Enable exception handling.  Generates extra code needed to propagate
9774 exceptions.  For some targets, this implies GCC will generate frame
9775 unwind information for all functions, which can produce significant data
9776 size overhead, although it does not affect execution.  If you do not
9777 specify this option, GCC will enable it by default for languages like
9778 C++ which normally require exception handling, and disable it for
9779 languages like C that do not normally require it.  However, you may need
9780 to enable this option when compiling C code that needs to interoperate
9781 properly with exception handlers written in C++.  You may also wish to
9782 disable this option if you are compiling older C++ programs that don't
9783 use exception handling.
9785 @item -fnon-call-exceptions
9786 @opindex fnon-call-exceptions
9787 Generate code that allows trapping instructions to throw exceptions.
9788 Note that this requires platform-specific runtime support that does
9789 not exist everywhere.  Moreover, it only allows @emph{trapping}
9790 instructions to throw exceptions, i.e.@: memory references or floating
9791 point instructions.  It does not allow exceptions to be thrown from
9792 arbitrary signal handlers such as @code{SIGALRM}.
9794 @item -funwind-tables
9795 @opindex funwind-tables
9796 Similar to @option{-fexceptions}, except that it will just generate any needed
9797 static data, but will not affect the generated code in any other way.
9798 You will normally not enable this option; instead, a language processor
9799 that needs this handling would enable it on your behalf.
9801 @item -fasynchronous-unwind-tables
9802 @opindex funwind-tables
9803 Generate unwind table in dwarf2 format, if supported by target machine.  The
9804 table is exact at each instruction boundary, so it can be used for stack
9805 unwinding from asynchronous events (such as debugger or garbage collector).
9807 @item -fpcc-struct-return
9808 @opindex fpcc-struct-return
9809 Return ``short'' @code{struct} and @code{union} values in memory like
9810 longer ones, rather than in registers.  This convention is less
9811 efficient, but it has the advantage of allowing intercallability between
9812 GCC-compiled files and files compiled with other compilers.
9814 The precise convention for returning structures in memory depends
9815 on the target configuration macros.
9817 Short structures and unions are those whose size and alignment match
9818 that of some integer type.
9820 @item -freg-struct-return
9821 @opindex freg-struct-return
9822 Return @code{struct} and @code{union} values in registers when possible.
9823 This is more efficient for small structures than
9824 @option{-fpcc-struct-return}.
9826 If you specify neither @option{-fpcc-struct-return} nor
9827 @option{-freg-struct-return}, GCC defaults to whichever convention is
9828 standard for the target.  If there is no standard convention, GCC
9829 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
9830 the principal compiler.  In those cases, we can choose the standard, and
9831 we chose the more efficient register return alternative.
9833 @item -fshort-enums
9834 @opindex fshort-enums
9835 Allocate to an @code{enum} type only as many bytes as it needs for the
9836 declared range of possible values.  Specifically, the @code{enum} type
9837 will be equivalent to the smallest integer type which has enough room.
9839 @item -fshort-double
9840 @opindex fshort-double
9841 Use the same size for @code{double} as for @code{float}.
9843 @item -fshared-data
9844 @opindex fshared-data
9845 Requests that the data and non-@code{const} variables of this
9846 compilation be shared data rather than private data.  The distinction
9847 makes sense only on certain operating systems, where shared data is
9848 shared between processes running the same program, while private data
9849 exists in one copy per process.
9851 @item -fno-common
9852 @opindex fno-common
9853 In C, allocate even uninitialized global variables in the data section of the
9854 object file, rather than generating them as common blocks.  This has the
9855 effect that if the same variable is declared (without @code{extern}) in
9856 two different compilations, you will get an error when you link them.
9857 The only reason this might be useful is if you wish to verify that the
9858 program will work on other systems which always work this way.
9860 @item -fno-ident
9861 @opindex fno-ident
9862 Ignore the @samp{#ident} directive.
9864 @item -fno-gnu-linker
9865 @opindex fno-gnu-linker
9866 Do not output global initializations (such as C++ constructors and
9867 destructors) in the form used by the GNU linker (on systems where the GNU
9868 linker is the standard method of handling them).  Use this option when
9869 you want to use a non-GNU linker, which also requires using the
9870 @command{collect2} program to make sure the system linker includes
9871 constructors and destructors.  (@command{collect2} is included in the GCC
9872 distribution.)  For systems which @emph{must} use @command{collect2}, the
9873 compiler driver @command{gcc} is configured to do this automatically.
9875 @item -finhibit-size-directive
9876 @opindex finhibit-size-directive
9877 Don't output a @code{.size} assembler directive, or anything else that
9878 would cause trouble if the function is split in the middle, and the
9879 two halves are placed at locations far apart in memory.  This option is
9880 used when compiling @file{crtstuff.c}; you should not need to use it
9881 for anything else.
9883 @item -fverbose-asm
9884 @opindex fverbose-asm
9885 Put extra commentary information in the generated assembly code to
9886 make it more readable.  This option is generally only of use to those
9887 who actually need to read the generated assembly code (perhaps while
9888 debugging the compiler itself).
9890 @option{-fno-verbose-asm}, the default, causes the
9891 extra information to be omitted and is useful when comparing two assembler
9892 files.
9894 @item -fvolatile
9895 @opindex fvolatile
9896 Consider all memory references through pointers to be volatile.
9898 @item -fvolatile-global
9899 @opindex fvolatile-global
9900 Consider all memory references to extern and global data items to
9901 be volatile.  GCC does not consider static data items to be volatile
9902 because of this switch.
9904 @item -fvolatile-static
9905 @opindex fvolatile-static
9906 Consider all memory references to static data to be volatile.
9908 @item -fpic
9909 @opindex fpic
9910 @cindex global offset table
9911 @cindex PIC
9912 Generate position-independent code (PIC) suitable for use in a shared
9913 library, if supported for the target machine.  Such code accesses all
9914 constant addresses through a global offset table (GOT)@.  The dynamic
9915 loader resolves the GOT entries when the program starts (the dynamic
9916 loader is not part of GCC; it is part of the operating system).  If
9917 the GOT size for the linked executable exceeds a machine-specific
9918 maximum size, you get an error message from the linker indicating that
9919 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
9920 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
9921 on the m68k and RS/6000.  The 386 has no such limit.)
9923 Position-independent code requires special support, and therefore works
9924 only on certain machines.  For the 386, GCC supports PIC for System V
9925 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
9926 position-independent.
9928 @item -fPIC
9929 @opindex fPIC
9930 If supported for the target machine, emit position-independent code,
9931 suitable for dynamic linking and avoiding any limit on the size of the
9932 global offset table.  This option makes a difference on the m68k, m88k,
9933 and the Sparc.
9935 Position-independent code requires special support, and therefore works
9936 only on certain machines.
9938 @item -ffixed-@var{reg}
9939 @opindex ffixed
9940 Treat the register named @var{reg} as a fixed register; generated code
9941 should never refer to it (except perhaps as a stack pointer, frame
9942 pointer or in some other fixed role).
9944 @var{reg} must be the name of a register.  The register names accepted
9945 are machine-specific and are defined in the @code{REGISTER_NAMES}
9946 macro in the machine description macro file.
9948 This flag does not have a negative form, because it specifies a
9949 three-way choice.
9951 @item -fcall-used-@var{reg}
9952 @opindex fcall-used
9953 Treat the register named @var{reg} as an allocable register that is
9954 clobbered by function calls.  It may be allocated for temporaries or
9955 variables that do not live across a call.  Functions compiled this way
9956 will not save and restore the register @var{reg}.
9958 It is an error to used this flag with the frame pointer or stack pointer.
9959 Use of this flag for other registers that have fixed pervasive roles in
9960 the machine's execution model will produce disastrous results.
9962 This flag does not have a negative form, because it specifies a
9963 three-way choice.
9965 @item -fcall-saved-@var{reg}
9966 @opindex fcall-saved
9967 Treat the register named @var{reg} as an allocable register saved by
9968 functions.  It may be allocated even for temporaries or variables that
9969 live across a call.  Functions compiled this way will save and restore
9970 the register @var{reg} if they use it.
9972 It is an error to used this flag with the frame pointer or stack pointer.
9973 Use of this flag for other registers that have fixed pervasive roles in
9974 the machine's execution model will produce disastrous results.
9976 A different sort of disaster will result from the use of this flag for
9977 a register in which function values may be returned.
9979 This flag does not have a negative form, because it specifies a
9980 three-way choice.
9982 @item -fpack-struct
9983 @opindex fpack-struct
9984 Pack all structure members together without holes.  Usually you would
9985 not want to use this option, since it makes the code suboptimal, and
9986 the offsets of structure members won't agree with system libraries.
9988 @item -finstrument-functions
9989 @opindex finstrument-functions
9990 Generate instrumentation calls for entry and exit to functions.  Just
9991 after function entry and just before function exit, the following
9992 profiling functions will be called with the address of the current
9993 function and its call site.  (On some platforms,
9994 @code{__builtin_return_address} does not work beyond the current
9995 function, so the call site information may not be available to the
9996 profiling functions otherwise.)
9998 @example
9999 void __cyg_profile_func_enter (void *this_fn,
10000                                void *call_site);
10001 void __cyg_profile_func_exit  (void *this_fn,
10002                                void *call_site);
10003 @end example
10005 The first argument is the address of the start of the current function,
10006 which may be looked up exactly in the symbol table.
10008 This instrumentation is also done for functions expanded inline in other
10009 functions.  The profiling calls will indicate where, conceptually, the
10010 inline function is entered and exited.  This means that addressable
10011 versions of such functions must be available.  If all your uses of a
10012 function are expanded inline, this may mean an additional expansion of
10013 code size.  If you use @samp{extern inline} in your C code, an
10014 addressable version of such functions must be provided.  (This is
10015 normally the case anyways, but if you get lucky and the optimizer always
10016 expands the functions inline, you might have gotten away without
10017 providing static copies.)
10019 A function may be given the attribute @code{no_instrument_function}, in
10020 which case this instrumentation will not be done.  This can be used, for
10021 example, for the profiling functions listed above, high-priority
10022 interrupt routines, and any functions from which the profiling functions
10023 cannot safely be called (perhaps signal handlers, if the profiling
10024 routines generate output or allocate memory).
10026 @item -fstack-check
10027 @opindex fstack-check
10028 Generate code to verify that you do not go beyond the boundary of the
10029 stack.  You should specify this flag if you are running in an
10030 environment with multiple threads, but only rarely need to specify it in
10031 a single-threaded environment since stack overflow is automatically
10032 detected on nearly all systems if there is only one stack.
10034 Note that this switch does not actually cause checking to be done; the
10035 operating system must do that.  The switch causes generation of code
10036 to ensure that the operating system sees the stack being extended.
10038 @item -fstack-limit-register=@var{reg}
10039 @itemx -fstack-limit-symbol=@var{sym}
10040 @itemx -fno-stack-limit
10041 @opindex fstack-limit-register
10042 @opindex fstack-limit-symbol
10043 @opindex fno-stack-limit
10044 Generate code to ensure that the stack does not grow beyond a certain value,
10045 either the value of a register or the address of a symbol.  If the stack
10046 would grow beyond the value, a signal is raised.  For most targets,
10047 the signal is raised before the stack overruns the boundary, so
10048 it is possible to catch the signal without taking special precautions.
10050 For instance, if the stack starts at absolute address @samp{0x80000000}
10051 and grows downwards, you can use the flags
10052 @option{-fstack-limit-symbol=__stack_limit} and
10053 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
10054 of 128KB@.  Note that this may only work with the GNU linker.
10056 @cindex aliasing of parameters
10057 @cindex parameters, aliased
10058 @item -fargument-alias
10059 @itemx -fargument-noalias
10060 @itemx -fargument-noalias-global
10061 @opindex fargument-alias
10062 @opindex fargument-noalias
10063 @opindex fargument-noalias-global
10064 Specify the possible relationships among parameters and between
10065 parameters and global data.
10067 @option{-fargument-alias} specifies that arguments (parameters) may
10068 alias each other and may alias global storage.@*
10069 @option{-fargument-noalias} specifies that arguments do not alias
10070 each other, but may alias global storage.@*
10071 @option{-fargument-noalias-global} specifies that arguments do not
10072 alias each other and do not alias global storage.
10074 Each language will automatically use whatever option is required by
10075 the language standard.  You should not need to use these options yourself.
10077 @item -fleading-underscore
10078 @opindex fleading-underscore
10079 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
10080 change the way C symbols are represented in the object file.  One use
10081 is to help link with legacy assembly code.
10083 Be warned that you should know what you are doing when invoking this
10084 option, and that not all targets provide complete support for it.
10085 @end table
10087 @c man end
10089 @node Environment Variables
10090 @section Environment Variables Affecting GCC
10091 @cindex environment variables
10093 @c man begin ENVIRONMENT
10095 This section describes several environment variables that affect how GCC
10096 operates.  Some of them work by specifying directories or prefixes to use
10097 when searching for various kinds of files.  Some are used to specify other
10098 aspects of the compilation environment.
10100 Note that you can also specify places to search using options such as
10101 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
10102 take precedence over places specified using environment variables, which
10103 in turn take precedence over those specified by the configuration of GCC@.
10104 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
10105 GNU Compiler Collection (GCC) Internals}.
10107 @table @env
10108 @item LANG
10109 @itemx LC_CTYPE
10110 @c @itemx LC_COLLATE
10111 @itemx LC_MESSAGES
10112 @c @itemx LC_MONETARY
10113 @c @itemx LC_NUMERIC
10114 @c @itemx LC_TIME
10115 @itemx LC_ALL
10116 @findex LANG
10117 @findex LC_CTYPE
10118 @c @findex LC_COLLATE
10119 @findex LC_MESSAGES
10120 @c @findex LC_MONETARY
10121 @c @findex LC_NUMERIC
10122 @c @findex LC_TIME
10123 @findex LC_ALL
10124 @cindex locale
10125 These environment variables control the way that GCC uses
10126 localization information that allow GCC to work with different
10127 national conventions.  GCC inspects the locale categories
10128 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
10129 so.  These locale categories can be set to any value supported by your
10130 installation.  A typical value is @samp{en_UK} for English in the United
10131 Kingdom.
10133 The @env{LC_CTYPE} environment variable specifies character
10134 classification.  GCC uses it to determine the character boundaries in
10135 a string; this is needed for some multibyte encodings that contain quote
10136 and escape characters that would otherwise be interpreted as a string
10137 end or escape.
10139 The @env{LC_MESSAGES} environment variable specifies the language to
10140 use in diagnostic messages.
10142 If the @env{LC_ALL} environment variable is set, it overrides the value
10143 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
10144 and @env{LC_MESSAGES} default to the value of the @env{LANG}
10145 environment variable.  If none of these variables are set, GCC
10146 defaults to traditional C English behavior.
10148 @item TMPDIR
10149 @findex TMPDIR
10150 If @env{TMPDIR} is set, it specifies the directory to use for temporary
10151 files.  GCC uses temporary files to hold the output of one stage of
10152 compilation which is to be used as input to the next stage: for example,
10153 the output of the preprocessor, which is the input to the compiler
10154 proper.
10156 @item GCC_EXEC_PREFIX
10157 @findex GCC_EXEC_PREFIX
10158 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
10159 names of the subprograms executed by the compiler.  No slash is added
10160 when this prefix is combined with the name of a subprogram, but you can
10161 specify a prefix that ends with a slash if you wish.
10163 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
10164 an appropriate prefix to use based on the pathname it was invoked with.
10166 If GCC cannot find the subprogram using the specified prefix, it
10167 tries looking in the usual places for the subprogram.
10169 The default value of @env{GCC_EXEC_PREFIX} is
10170 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
10171 of @code{prefix} when you ran the @file{configure} script.
10173 Other prefixes specified with @option{-B} take precedence over this prefix.
10175 This prefix is also used for finding files such as @file{crt0.o} that are
10176 used for linking.
10178 In addition, the prefix is used in an unusual way in finding the
10179 directories to search for header files.  For each of the standard
10180 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
10181 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
10182 replacing that beginning with the specified prefix to produce an
10183 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
10184 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
10185 These alternate directories are searched first; the standard directories
10186 come next.
10188 @item COMPILER_PATH
10189 @findex COMPILER_PATH
10190 The value of @env{COMPILER_PATH} is a colon-separated list of
10191 directories, much like @env{PATH}.  GCC tries the directories thus
10192 specified when searching for subprograms, if it can't find the
10193 subprograms using @env{GCC_EXEC_PREFIX}.
10195 @item LIBRARY_PATH
10196 @findex LIBRARY_PATH
10197 The value of @env{LIBRARY_PATH} is a colon-separated list of
10198 directories, much like @env{PATH}.  When configured as a native compiler,
10199 GCC tries the directories thus specified when searching for special
10200 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
10201 using GCC also uses these directories when searching for ordinary
10202 libraries for the @option{-l} option (but directories specified with
10203 @option{-L} come first).
10205 @item C_INCLUDE_PATH
10206 @itemx CPLUS_INCLUDE_PATH
10207 @itemx OBJC_INCLUDE_PATH
10208 @findex C_INCLUDE_PATH
10209 @findex CPLUS_INCLUDE_PATH
10210 @findex OBJC_INCLUDE_PATH
10211 @c @itemx OBJCPLUS_INCLUDE_PATH
10212 These environment variables pertain to particular languages.  Each
10213 variable's value is a colon-separated list of directories, much like
10214 @env{PATH}.  When GCC searches for header files, it tries the
10215 directories listed in the variable for the language you are using, after
10216 the directories specified with @option{-I} but before the standard header
10217 file directories.
10219 @item DEPENDENCIES_OUTPUT
10220 @findex DEPENDENCIES_OUTPUT
10221 @cindex dependencies for make as output
10222 If this variable is set, its value specifies how to output dependencies
10223 for Make based on the header files processed by the compiler.  This
10224 output looks much like the output from the @option{-M} option
10225 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
10226 in addition to the usual results of compilation.
10228 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
10229 which case the Make rules are written to that file, guessing the target
10230 name from the source file name.  Or the value can have the form
10231 @samp{@var{file} @var{target}}, in which case the rules are written to
10232 file @var{file} using @var{target} as the target name.
10234 @item LANG
10235 @findex LANG
10236 @cindex locale definition
10237 This variable is used to pass locale information to the compiler.  One way in
10238 which this information is used is to determine the character set to be used
10239 when character literals, string literals and comments are parsed in C and C++.
10240 When the compiler is configured to allow multibyte characters,
10241 the following values for @env{LANG} are recognized:
10243 @table @samp
10244 @item C-JIS
10245 Recognize JIS characters.
10246 @item C-SJIS
10247 Recognize SJIS characters.
10248 @item C-EUCJP
10249 Recognize EUCJP characters.
10250 @end table
10252 If @env{LANG} is not defined, or if it has some other value, then the
10253 compiler will use mblen and mbtowc as defined by the default locale to
10254 recognize and translate multibyte characters.
10255 @end table
10257 @c man end
10259 @node Running Protoize
10260 @section Running Protoize
10262 The program @code{protoize} is an optional part of GCC@.  You can use
10263 it to add prototypes to a program, thus converting the program to ISO
10264 C in one respect.  The companion program @code{unprotoize} does the
10265 reverse: it removes argument types from any prototypes that are found.
10267 When you run these programs, you must specify a set of source files as
10268 command line arguments.  The conversion programs start out by compiling
10269 these files to see what functions they define.  The information gathered
10270 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
10272 After scanning comes actual conversion.  The specified files are all
10273 eligible to be converted; any files they include (whether sources or
10274 just headers) are eligible as well.
10276 But not all the eligible files are converted.  By default,
10277 @code{protoize} and @code{unprotoize} convert only source and header
10278 files in the current directory.  You can specify additional directories
10279 whose files should be converted with the @option{-d @var{directory}}
10280 option.  You can also specify particular files to exclude with the
10281 @option{-x @var{file}} option.  A file is converted if it is eligible, its
10282 directory name matches one of the specified directory names, and its
10283 name within the directory has not been excluded.
10285 Basic conversion with @code{protoize} consists of rewriting most
10286 function definitions and function declarations to specify the types of
10287 the arguments.  The only ones not rewritten are those for varargs
10288 functions.
10290 @code{protoize} optionally inserts prototype declarations at the
10291 beginning of the source file, to make them available for any calls that
10292 precede the function's definition.  Or it can insert prototype
10293 declarations with block scope in the blocks where undeclared functions
10294 are called.
10296 Basic conversion with @code{unprotoize} consists of rewriting most
10297 function declarations to remove any argument types, and rewriting
10298 function definitions to the old-style pre-ISO form.
10300 Both conversion programs print a warning for any function declaration or
10301 definition that they can't convert.  You can suppress these warnings
10302 with @option{-q}.
10304 The output from @code{protoize} or @code{unprotoize} replaces the
10305 original source file.  The original file is renamed to a name ending
10306 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
10307 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
10308 for DOS) file already exists, then the source file is simply discarded.
10310 @code{protoize} and @code{unprotoize} both depend on GCC itself to
10311 scan the program and collect information about the functions it uses.
10312 So neither of these programs will work until GCC is installed.
10314 Here is a table of the options you can use with @code{protoize} and
10315 @code{unprotoize}.  Each option works with both programs unless
10316 otherwise stated.
10318 @table @code
10319 @item -B @var{directory}
10320 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
10321 usual directory (normally @file{/usr/local/lib}).  This file contains
10322 prototype information about standard system functions.  This option
10323 applies only to @code{protoize}.
10325 @item -c @var{compilation-options}
10326 Use  @var{compilation-options} as the options when running @code{gcc} to
10327 produce the @samp{.X} files.  The special option @option{-aux-info} is
10328 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
10330 Note that the compilation options must be given as a single argument to
10331 @code{protoize} or @code{unprotoize}.  If you want to specify several
10332 @code{gcc} options, you must quote the entire set of compilation options
10333 to make them a single word in the shell.
10335 There are certain @code{gcc} arguments that you cannot use, because they
10336 would produce the wrong kind of output.  These include @option{-g},
10337 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
10338 the @var{compilation-options}, they are ignored.
10340 @item -C
10341 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
10342 systems) instead of @samp{.c}.  This is convenient if you are converting
10343 a C program to C++.  This option applies only to @code{protoize}.
10345 @item -g
10346 Add explicit global declarations.  This means inserting explicit
10347 declarations at the beginning of each source file for each function
10348 that is called in the file and was not declared.  These declarations
10349 precede the first function definition that contains a call to an
10350 undeclared function.  This option applies only to @code{protoize}.
10352 @item -i @var{string}
10353 Indent old-style parameter declarations with the string @var{string}.
10354 This option applies only to @code{protoize}.
10356 @code{unprotoize} converts prototyped function definitions to old-style
10357 function definitions, where the arguments are declared between the
10358 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
10359 uses five spaces as the indentation.  If you want to indent with just
10360 one space instead, use @option{-i " "}.
10362 @item -k
10363 Keep the @samp{.X} files.  Normally, they are deleted after conversion
10364 is finished.
10366 @item -l
10367 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
10368 a prototype declaration for each function in each block which calls the
10369 function without any declaration.  This option applies only to
10370 @code{protoize}.
10372 @item -n
10373 Make no real changes.  This mode just prints information about the conversions
10374 that would have been done without @option{-n}.
10376 @item -N
10377 Make no @samp{.save} files.  The original files are simply deleted.
10378 Use this option with caution.
10380 @item -p @var{program}
10381 Use the program @var{program} as the compiler.  Normally, the name
10382 @file{gcc} is used.
10384 @item -q
10385 Work quietly.  Most warnings are suppressed.
10387 @item -v
10388 Print the version number, just like @option{-v} for @code{gcc}.
10389 @end table
10391 If you need special compiler options to compile one of your program's
10392 source files, then you should generate that file's @samp{.X} file
10393 specially, by running @code{gcc} on that source file with the
10394 appropriate options and the option @option{-aux-info}.  Then run
10395 @code{protoize} on the entire set of files.  @code{protoize} will use
10396 the existing @samp{.X} file because it is newer than the source file.
10397 For example:
10399 @example
10400 gcc -Dfoo=bar file1.c -aux-info file1.X
10401 protoize *.c
10402 @end example
10404 @noindent
10405 You need to include the special files along with the rest in the
10406 @code{protoize} command, even though their @samp{.X} files already
10407 exist, because otherwise they won't get converted.
10409 @xref{Protoize Caveats}, for more information on how to use
10410 @code{protoize} successfully.